@sapphire/plugin-api - npm Package Compare versions

Comparing version 3.0.0-next.4529394.0 to 3.0.0-next.29607111.0

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

@@ -1,2 +0,2 @@
-import { Awaited } from '@sapphire/utilities';
+import { Awaitable } from '@sapphire/utilities';
 import { RESTGetAPICurrentUserConnectionsResult, RESTGetAPICurrentUserGuildsResult, RESTGetAPICurrentUserResult, Snowflake } from 'discord-api-types/v9';
@@ -162,4 +162,4 @@ export declare class Auth {
      */
-    (data: LoginData): Awaited<T>;
+    (data: LoginData): Awaitable<T>;
 }
 //# sourceMappingURL=Auth.d.ts.map

dist/lib/structures/MediaParser.d.ts

 /// <reference types="node" />
 import { Piece } from '@sapphire/pieces';
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import type { ApiRequest } from './api/ApiRequest';
@@ -15,3 +15,3 @@ import type { Route } from './Route';
      */
-    abstract run(request: ApiRequest): Awaited<unknown>;
+    abstract run(request: ApiRequest): Awaitable<unknown>;
     /**
@@ -18,0 +18,0 @@ * Checks if a route accepts the media type from this parser.

dist/lib/structures/Middleware.d.ts

 import { Piece, PieceContext, PieceOptions } from '@sapphire/pieces';
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import type { ApiRequest } from './api/ApiRequest';
@@ -28,3 +28,3 @@ import type { ApiResponse } from './api/ApiResponse';
      */
-    abstract run(request: ApiRequest, response: ApiResponse, route: Route | null): Awaited<unknown>;
+    abstract run(request: ApiRequest, response: ApiResponse, route: Route | null): Awaitable<unknown>;
 }
@@ -31,0 +31,0 @@ /**

dist/lib/structures/Route.d.ts

 import { Piece, PieceContext, PieceOptions } from '@sapphire/pieces';
-import type { Awaited } from '@sapphire/utilities';
+import type { Awaitable } from '@sapphire/utilities';
 import { Collection } from 'discord.js';
@@ -33,3 +33,3 @@ import { RouteData } from '../utils/RouteData';
      */
-    onLoad(): Awaited<unknown>;
+    onLoad(): Awaitable<unknown>;
     /**
@@ -39,3 +39,3 @@ * Per-piece listener that is called when the piece is unloaded from the store.
      */
-    onUnload(): Awaited<unknown>;
+    onUnload(): Awaitable<unknown>;
 }
@@ -42,0 +42,0 @@ export interface RouteOptions extends PieceOptions {

dist/lib/utils/RouteData.d.ts

@@ -30,2 +30,6 @@ /**
 }
+export interface ParsedPart {
+    value: string;
+    type: TypeState;
+}
 //# sourceMappingURL=RouteData.d.ts.map

package.json

 {
 	"name": "@sapphire/plugin-api",
-	"version": "3.0.0-next.4529394.0",
+	"version": "3.0.0-next.29607111.0",
 	"description": "Plugin for @sapphire/framework to expose a REST API",
@@ -10,2 +10,3 @@ "author": "@sapphire",
 	"types": "dist/index.d.ts",
+	"typedocMain": "src/index.ts",
 	"exports": {
@@ -30,4 +31,3 @@ ".": {
 		"lint": "eslint src tests --ext ts --fix",
-		"build": "tsc -b src",
-		"postbuild": "run-p esm:**",
+		"build": "tsc -b src && yarn esm:register && yarn esm:default",
 		"esm:register": "gen-esm-wrapper dist/register.js dist/register.mjs",
@@ -40,3 +40,3 @@ "esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs",
 		"@types/psl": "^1.1.0",
-		"@types/ws": "7.4.7",
+		"@types/ws": "8.2.0",
 		"node-fetch": "^2.6.5",
@@ -57,4 +57,4 @@ "psl": "^1.8.0",
 	"engines": {
-		"node": ">=14",
-		"npm": ">=6"
+		"node": ">=v14.18.0",
+		"npm": ">=7.24.2"
 	},
@@ -77,3 +77,3 @@ "keywords": [
 	},
-	"gitHead": "452939429bd738008f671d44580f952810e26471"
+	"gitHead": "29607111c4e4f61ece463e10854982f205879996"
 }

README.md

@@ -13,3 +13,2 @@ <div align="center">
 [![npm](https://img.shields.io/npm/v/@sapphire/plugin-api?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/plugin-api)
-[![Depfu](https://badges.depfu.com/badges/11bbf7392987e6fd51fc6559e1d42dfc/count.svg)](https://depfu.com/github/sapphiredev/plugins?project_id=15201)
 
@@ -122,3 +121,3 @@ </div>
     <td align="center"><a href="https://favware.tech/"><img src="https://avatars3.githubusercontent.com/u/4019718?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jeroen Claassens</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=Favna" title="Code">💻</a> <a href="#infra-Favna" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#projectManagement-Favna" title="Project Management">📆</a></td>
-    <td align="center"><a href="https://quantumlytangled.com"><img src="https://avatars1.githubusercontent.com/u/7919610?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nejc Drobnic</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=QuantumlyTangled" title="Code">💻</a> <a href="https://github.com/sapphiredev/plugins/commits?author=QuantumlyTangled" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://Quantumlyy.com"><img src="https://avatars1.githubusercontent.com/u/7919610?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nejc Drobnic</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=Quantumlyy" title="Code">💻</a> <a href="https://github.com/sapphiredev/plugins/commits?author=Quantumlyy" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/kyranet"><img src="https://avatars0.githubusercontent.com/u/24852502?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Antonio Román</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=kyranet" title="Code">💻</a></td>
@@ -131,6 +130,9 @@ <td align="center"><a href="https://github.com/vladfrangu"><img src="https://avatars3.githubusercontent.com/u/17960496?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vlad Frangu</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/pulls?q=is%3Apr+reviewed-by%3Avladfrangu" title="Reviewed Pull Requests">👀</a></td>
   <tr>
-    <td align="center"><a href="https://github.com/Nytelife26"><img src="https://avatars1.githubusercontent.com/u/22531310?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tyler J Russell</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=Nytelife26" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Nytelife26"><img src="https://avatars1.githubusercontent.com/u/22531310?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tyler J Russell</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=Nytelife26" title="Code">💻</a> <a href="https://github.com/sapphiredev/plugins/commits?author=Nytelife26" title="Documentation">📖</a></td>
     <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>
     <td align="center"><a href="https://kaname.netlify.app"><img src="https://avatars.githubusercontent.com/u/56084970?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kaname</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=kaname-png" title="Code">💻</a> <a href="https://github.com/sapphiredev/plugins/commits?author=kaname-png" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/noftaly"><img src="https://avatars.githubusercontent.com/u/34779161?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Elliot</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=noftaly" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Lioness100"><img src="https://avatars.githubusercontent.com/u/65814829?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lioness100</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=Lioness100" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/UndiedGamer"><img src="https://avatars.githubusercontent.com/u/84702365?v=4?s=100" width="100px;" alt=""/><br /><sub><b>UndiedGamer</b></sub></a><br /><a href="https://github.com/sapphiredev/plugins/commits?author=UndiedGamer" title="Code">💻</a></td>
   </tr>
@@ -137,0 +139,0 @@ </table>

No alert changes

Improved metrics

Total package byte prevSize

200534

increased by0.53%

Lines of code

3273

increased by0.12%

Number of lines in readme file

144

increased by1.41%

Dependency changes

• + Added@types/ws@8.2.0(transitive)

• - Removed@types/ws@7.4.7(transitive)

• Updated@types/ws@8.2.0