1.1.0

Author: Kitosight

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 2023
+
+### April
+
+#### 1.1.0
+- Source Code Refactoring
+- Dependencies Switch
+    - From `node-fetch` to `centra`
+- Updated README
+    - Added `TypeScript Specials` article
+    - Added badges
+- Added LICENSE
+- Added CHANGELOG
+
+#### 1.0.0 - 1.0.3
+- First Release & Public Access

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 NightNutSky
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,9 @@
 # BPAPI
+
+[![NPM: Version](https://img.shields.io/npm/v/@nightnutsky/bpapi?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@nightnutsky/bpapi)
+[![GitHub: Stars](https://img.shields.io/github/stars/NightNutSky/bpapi?logo=github&style=for-the-badge)](https://github.com/NightNutSky/bpapi/stargazers)
+[![GitHub: Source Code](https://img.shields.io/badge/Source%20Code-GitHub-green?logo=github&style=for-the-badge)](https://github.com/NightNutSky/bpapi)
+
 BPAPI allows you to retrieve and work with information from [BDFD](https://botdesignerdiscord.com) [Public API](https://nilpointer-software.github.io/bdfd-wiki/nightly/resources/api.html) more easier.
 
 # Install
@@ -82,6 +87,19 @@ functionTagList().then(tagList => {
     }
 });
 ```
+## TypeScript Specials
+If you ever worked with TypeScript, then you know that you can (and sometimes must) assign types for your consts, etc.
+
+If you want to work with plain BDFD Public API, for example, do request to the `api/function_list` endpoint  yourself, BPAPI can help you using one of its type - `PublicAPIResponse`.\
+Import this type and assign it to the request's response.
+
+> Original BDFD Public API's response is a bit different and contains unused or deprecated (and now unused) properties. Unlike BDFD Public API, BPAPI only shows actual and a bit modified properties for your comfort.
+
+| Showcase |
+| :------: |
+| ![Showcase](https://user-images.githubusercontent.com/70456337/230720560-c425f057-d09c-4e91-8f68-8f9312d07455.png) |
+| ![Showcase](https://user-images.githubusercontent.com/70456337/230720600-f89d6185-ae72-47c8-ab37-cee6f1d6a9e5.png) |
+
 
 ## Raw Returns
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@nightnutsky/bpapi",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "BPAPI allows you to retrieve and work with information from BDFD Public API more easier",
   "author": "NightNutSky",
   "main": "dist/index.js",
@@ -20,9 +20,9 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "node-fetch": "2.6.7"
+    "centra": "^2.6.0"
   },
   "devDependencies": {
-    "@types/node-fetch": "2.6.3"
+    "@types/centra": "^2.2.0"
   }
 }

package.json

@@ -0,0 +1,21 @@
+export const API = 'https://botdesignerdiscord.com/public/api/';
+export const INTENTS = Object.freeze({
+    Members: 'Members',
+    Presence: 'Presence',
+    None: 'None'
+});
+export const RAW_INTENTS = Object.freeze({
+    Members: 2,
+    Presence: 256,
+    None: 0
+});
+export const ENDPOINT = Object.freeze({
+    Function: 'function',
+    FunctionList: 'functionList',
+    FunctionTagList: 'functionTagList'
+});
+export const ENDPOINT_PATH = Object.freeze({
+    Function: 'function/',
+    FunctionList: 'function_list',
+    FunctionTagList: 'function_tag_list'
+});