@sapphire/plugin-api - npm Package Compare versions

Comparing version 2.1.4 to 2.1.5-next.29bb43f.0

dist/lib/structures/api/CookieStore.d.ts

@@ -14,3 +14,3 @@ import type { ApiRequest } from './ApiRequest';
     /**
-     * Parses a host using the {@link https://github.com/lupomontero/psl psl} library to extract the domain.
+     * Parses a host using the {@linkplain https://github.com/lupomontero/psl psl} library to extract the domain.
      * This is used for the domain of the cookie
@@ -17,0 +17,0 @@ * @param host The hot to parse

dist/lib/structures/api/CookieStore.js

@@ -103,3 +103,3 @@ "use strict";
     /**
-     * Parses a host using the {@link https://github.com/lupomontero/psl psl} library to extract the domain.
+     * Parses a host using the {@linkplain https://github.com/lupomontero/psl psl} library to extract the domain.
      * This is used for the domain of the cookie
@@ -106,0 +106,0 @@ * @param host The hot to parse

dist/lib/structures/http/Auth.d.ts

@@ -26,3 +26,3 @@ import { Awaited } from '@sapphire/utilities';
     /**
-     * The transformers used for [[Auth.fetchData]].
+     * The transformers used for {@link Auth.fetchData}.
      * @since 1.4.0
@@ -115,3 +115,3 @@ */
     /**
-     * The redirect uri. This will default to [[OAuth2BodyData.redirectUri]] if missing.
+     * The redirect uri. This will default to {@link OAuth2BodyData.redirectUri} if missing.
      * @since 1.0.0
@@ -121,3 +121,3 @@ */
     /**
-     * The login data transformers used for [[Auth.fetchData]].
+     * The login data transformers used for {@link Auth.fetchData}.
      * @since 1.4.0
@@ -124,0 +124,0 @@ * @default []

dist/lib/structures/http/Auth.js

 "use strict";
-var _secret;
+var _Auth_secret;
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -53,3 +53,3 @@ exports.Auth = void 0;
         /**
-         * The transformers used for [[Auth.fetchData]].
+         * The transformers used for {@link Auth.fetchData}.
          * @since 1.4.0
@@ -70,3 +70,3 @@ */
         // eslint-disable-next-line @typescript-eslint/explicit-member-accessibility
-        _secret.set(this, void 0);
+        _Auth_secret.set(this, void 0);
         this.id = options.id;
@@ -76,3 +76,3 @@ this.cookie = (_a = options.cookie) !== null && _a !== void 0 ? _a : 'SAPPHIRE_AUTH';
         this.redirect = options.redirect;
-        tslib_1.__classPrivateFieldSet(this, _secret, options.secret);
+        tslib_1.__classPrivateFieldSet(this, _Auth_secret, options.secret, "f");
         this.transformers = (_c = options.transformers) !== null && _c !== void 0 ? _c : [];
@@ -86,3 +86,3 @@ this.domainOverwrite = (_d = options.domainOverwrite) !== null && _d !== void 0 ? _d : null;
     get secret() {
-        return tslib_1.__classPrivateFieldGet(this, _secret);
+        return tslib_1.__classPrivateFieldGet(this, _Auth_secret, "f");
     }
@@ -97,3 +97,3 @@ /**
         const iv = crypto_1.randomBytes(16);
-        const cipher = crypto_1.createCipheriv('aes-256-cbc', tslib_1.__classPrivateFieldGet(this, _secret), iv);
+        const cipher = crypto_1.createCipheriv('aes-256-cbc', tslib_1.__classPrivateFieldGet(this, _Auth_secret, "f"), iv);
         return `${cipher.update(JSON.stringify(data), 'utf8', 'base64') + cipher.final('base64')}.${iv.toString('base64')}`;
@@ -109,3 +109,3 @@ }
         const [data, iv] = token.split('.');
-        const decipher = crypto_1.createDecipheriv('aes-256-cbc', tslib_1.__classPrivateFieldGet(this, _secret), Buffer.from(iv, 'base64'));
+        const decipher = crypto_1.createDecipheriv('aes-256-cbc', tslib_1.__classPrivateFieldGet(this, _Auth_secret, "f"), Buffer.from(iv, 'base64'));
         try {
@@ -160,3 +160,3 @@ const parsed = JSON.parse(decipher.update(data, 'base64', 'utf8') + decipher.final('utf8'));
 exports.Auth = Auth;
-_secret = new WeakMap();
+_Auth_secret = new WeakMap();
 //# sourceMappingURL=Auth.js.map

dist/lib/structures/http/Server.d.ts

@@ -147,3 +147,3 @@ /// <reference types="node" />
 /**
- * The [[ServerOptions]] without [[ServerOptions.auth]].
+ * The {@link ServerOptions} without {@link ServerOptions.auth}.
  * @since 1.0.0
@@ -150,0 +150,0 @@ */

package.json

 {
 	"name": "@sapphire/plugin-api",
-	"version": "2.1.4",
+	"version": "2.1.5-next.29bb43f.0",
 	"description": "Plugin for @sapphire/framework to expose a REST API",
@@ -20,2 +20,7 @@ "author": "@sapphire",
 	},
+	"sideEffects": [
+		"./dist/register.js",
+		"./register.js",
+		"./register.mjs"
+	],
 	"homepage": "https://github.com/sapphiredev/plugins/tree/main/packages/api",
@@ -32,26 +37,9 @@ "scripts": {
 	"dependencies": {
+		"@types/node-fetch": "^2.5.10",
 		"@types/psl": "^1.1.0",
+		"@types/ws": "latest",
 		"node-fetch": "^2.6.1",
 		"psl": "^1.8.0",
-		"tslib": "^2.2.0"
+		"tslib": "^2.3.0"
 	},
-	"peerDependencies": {
-		"@sapphire/framework": "^1.x",
-		"@sapphire/pieces": "1.x",
-		"@types/node-fetch": "^2.x",
-		"@types/ws": "latest",
-		"discord-api-types": "^0.18.x",
-		"discord.js": "12.x"
-	},
-	"peerDependenciesMeta": {
-		"@types/ws": {
-			"optional": true
-		},
-		"@types/node-fetch": {
-			"optional": true
-		},
-		"discord-api-types": {
-			"optional": true
-		}
-	},
 	"repository": {
@@ -87,3 +75,3 @@ "type": "git",
 	},
-	"gitHead": "41f78721aaaeca636969c4270b1db12cc59d0cbb"
+	"gitHead": "29bb43fda77f722c3481380a5dafe9288fd204cc"
 }

README.md

@@ -19,3 +19,3 @@ <div align="center">
 
-T.B.D.
+This plugin provides an API endpoint for your bot that can be called from external services. A good exemplary use case for this is once your bot grows to have enough configuration options that you want to offer a website to your end-users to change those settings, and your website needs to interface with the bot for this to work.
 
@@ -28,7 +28,17 @@ ## Features
 -   Includes ESM ready entrypoint
+-   Premade OAuth 2.0 endpoints
 
 ## Installation
 
+`@sapphire/plugin-api` depends on the following packages. Be sure to install these along with this package!
+
+-   [`@sapphire/framework`](https://www.npmjs.com/package/@sapphire/framework)
+-   [`@sapphire/pieces v1.x`](https://www.npmjs.com/package/@sapphire/pieces/v/1.2.5)
+-   [`discord.js`](https://www.npmjs.com/package/discord.js)
+-   [`discord-api-types`](https://www.npmjs.com/package/discord-api-types)
+
+You can use the following command to install this package, or replace `npm install` with your package manager of choice.
+
 ```sh
-yarn add @sapphire/plugin-api
+npm install @sapphire/plugin-api @sapphire/framework @sapphire/pieces@1 discord.js discord-api-types
 ```
@@ -40,4 +50,49 @@
 
-T.B.D.
+Start by importing the registration file in your project to use the plugin:
 
+**JavaScript**
+
+```js
+require('@sapphire/plugin-api/register');
+```
+
+**TypeScript**
+
+```ts
+import '@sapphire/plugin-api/register';
+```
+
+Then, you can use the following configuration options in your SapphireClient extension class or initializer. This will either be located in your `new SapphireClient` constructor call, or `super` in your constructor method if you use an extension class.
+
+```js
+{
+  auth: {
+	// The application/client ID of your bot.
+	// You can find this at https://discord.com/developers/applications
+    id: '',
+	// The client secret of your bot.
+	// You can find this at https://discord.com/developers/applications
+    secret: '',
+	// The name of the authentication cookie.
+    cookie: 'SAPPHIRE_AUTH',
+	// The URL that users should be redirected to after a successful authentication
+    redirect: '',
+	// The scopes that should be given to the authentication.
+    scopes: ['identify'],
+	// Transformers to transform the raw data from Discord to a different structure.
+    transformers: []
+  },
+  // The prefix for all routes, e.g. / or v1/.
+  prefix: '',
+  // The origin header to be set on every request at 'Access-Control-Allow-Origin.
+  origin: '*',
+  // Any options passed to the NodeJS "net" internal server.listen function
+  // See https://nodejs.org/api/net.html#net_server_listen_options_callback
+  listenOptions: {
+	// The port the API will listen on.
+    port: 4000
+  }
+}
+```
+
 ## API Documentation
@@ -80,2 +135,3 @@
     <td align="center"><a href="https://github.com/Stitch07"><img src="https://avatars.githubusercontent.com/u/29275227?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stitch07</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=Stitch07" title="Code">💻</a> <a href="https://github.com/sapphiredev/plugins/issues?q=author%3AStitch07" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/PlatinBae"><img src="https://avatars.githubusercontent.com/u/50950966?v=4?s=100" width="100px;" alt=""/><br /><sub><b>PlatinBae</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=PlatinBae" title="Documentation">📖</a></td>
   </tr>
@@ -82,0 +138,0 @@ </table>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dependency count

6

decreased by-40%

Number of downloads

1628

increased by36.23%

Number of lines in readme file

142

increased by65.12%

Published versions last months

33

increased by3.13%

Published versions last year

208

increased by0.48%

Worsened metrics

Total package byte prevSize

199301

decreased by-3.15%

Number of package files

136

decreased by-0.73%

Lines of code

3261

decreased by-0.06%

Number of low quality alerts

1

increased byInfinity%

Published versions last week

3

decreased by-25%

Dependency changes

• + Added@types/node-fetch@^2.5.10

• + Added@types/ws@latest

• + Addedpsl@1.14.0(transitive)

• - Removed@discordjs/collection@0.1.6(transitive)

• - Removed@discordjs/form-data@3.0.1(transitive)

• - Removed@sapphire/discord-utilities@2.12.0(transitive)

• - Removed@sapphire/discord.js-utilities@1.6.0(transitive)

• - Removed@sapphire/framework@1.0.2(transitive)

• - Removed@sapphire/pieces@1.2.5(transitive)

• - Removed@sapphire/ratelimits@1.2.5(transitive)

• - Removed@sapphire/utilities@1.7.0(transitive)

• - Removedabort-controller@3.0.0(transitive)

• - Removeddiscord-api-types@0.18.10.36.3(transitive)

• - Removeddiscord.js@12.5.3(transitive)

• - Removedevent-target-shim@5.0.1(transitive)

• - Removedlexure@0.17.0(transitive)

• - Removedprism-media@1.3.5(transitive)

• - Removedpsl@1.13.0(transitive)

• - Removedsetimmediate@1.0.5(transitive)

• - Removedtweetnacl@1.0.3(transitive)

• - Removedws@7.5.10(transitive)

• Updatedtslib@^2.3.0