@discordjs/rest 0.6.0 → 1.0.1-dev.1658331002-a05386a.0

package/dist/lib/utils/utils.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="node" />
+import { URLSearchParams } from 'node:url';
+import { type Dispatcher, type RequestInit } from 'undici';
+import type { RequestOptions } from '../REST';
+export declare function parseHeader(header: string | string[] | undefined): string | undefined;
+/**
+ * Creates and populates an URLSearchParams instance from an object, stripping
+ * out null and undefined values, while also coercing non-strings to strings.
+ *
+ * @param options - The options to use
+ *
+ * @returns A populated URLSearchParams instance
+ */
+export declare function makeURLSearchParams(options?: Record<string, unknown>): URLSearchParams;
+/**
+ * Converts the response to usable data
+ *
+ * @param res - The fetch response
+ */
+export declare function parseResponse(res: Dispatcher.ResponseData): Promise<unknown>;
+/**
+ * Check whether a request falls under a sublimit
+ *
+ * @param bucketRoute - The buckets route identifier
+ * @param body - The options provided as JSON data
+ * @param method - The HTTP method that will be used to make the request
+ *
+ * @returns Whether the request falls under a sublimit
+ */
+export declare function hasSublimit(bucketRoute: string, body?: unknown, method?: string): boolean;
+export declare function resolveBody(body: RequestInit['body']): Promise<RequestOptions['body']>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/lib/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/utils.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C,OAAO,EAAY,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG9C,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAQrF;AAuBD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,mBAUpE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,CAAC,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAO5E;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAczF;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CA2C5F"}

package/dist/lib/utils/utils.mjs

@@ -0,0 +1,103 @@
+import { Blob } from 'node:buffer';
+import { URLSearchParams } from 'node:url';
+import { types } from 'node:util';
+import { FormData } from 'undici';
+import { RequestMethod } from '../RequestManager.mjs';
+
+function parseHeader(header) {
+  if (header === void 0) {
+    return header;
+  } else if (typeof header === "string") {
+    return header;
+  }
+  return header.join(";");
+}
+function serializeSearchParam(value) {
+  switch (typeof value) {
+    case "string":
+      return value;
+    case "number":
+    case "bigint":
+    case "boolean":
+      return value.toString();
+    case "object":
+      if (value === null)
+        return null;
+      if (value instanceof Date) {
+        return Number.isNaN(value.getTime()) ? null : value.toISOString();
+      }
+      if (typeof value.toString === "function" && value.toString !== Object.prototype.toString)
+        return value.toString();
+      return null;
+    default:
+      return null;
+  }
+}
+function makeURLSearchParams(options) {
+  const params = new URLSearchParams();
+  if (!options)
+    return params;
+  for (const [key, value] of Object.entries(options)) {
+    const serialized = serializeSearchParam(value);
+    if (serialized !== null)
+      params.append(key, serialized);
+  }
+  return params;
+}
+function parseResponse(res) {
+  const header = parseHeader(res.headers["content-type"]);
+  if (header?.startsWith("application/json")) {
+    return res.body.json();
+  }
+  return res.body.arrayBuffer();
+}
+function hasSublimit(bucketRoute, body, method) {
+  if (bucketRoute === "/channels/:id") {
+    if (typeof body !== "object" || body === null)
+      return false;
+    if (method !== RequestMethod.Patch)
+      return false;
+    const castedBody = body;
+    return ["name", "topic"].some((key) => Reflect.has(castedBody, key));
+  }
+  return true;
+}
+async function resolveBody(body) {
+  if (body == null) {
+    return null;
+  } else if (typeof body === "string") {
+    return body;
+  } else if (types.isUint8Array(body)) {
+    return body;
+  } else if (types.isArrayBuffer(body)) {
+    return new Uint8Array(body);
+  } else if (body instanceof URLSearchParams) {
+    return body.toString();
+  } else if (body instanceof DataView) {
+    return new Uint8Array(body.buffer);
+  } else if (body instanceof Blob) {
+    return new Uint8Array(await body.arrayBuffer());
+  } else if (body instanceof FormData) {
+    return body;
+  } else if (body[Symbol.iterator]) {
+    const chunks = [...body];
+    const length = chunks.reduce((a, b) => a + b.length, 0);
+    const uint8 = new Uint8Array(length);
+    let lengthUsed = 0;
+    return chunks.reduce((a, b) => {
+      a.set(b, lengthUsed);
+      lengthUsed += b.length;
+      return a;
+    }, uint8);
+  } else if (body[Symbol.asyncIterator]) {
+    const chunks = [];
+    for await (const chunk of body) {
+      chunks.push(chunk);
+    }
+    return Buffer.concat(chunks);
+  }
+  throw new TypeError(`Unable to resolve body.`);
+}
+
+export { hasSublimit, makeURLSearchParams, parseHeader, parseResponse, resolveBody };
+//# sourceMappingURL=utils.mjs.map

package/dist/lib/utils/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","sources":["../../../src/lib/utils/utils.ts"],"sourcesContent":["import { Blob } from 'node:buffer';\nimport { URLSearchParams } from 'node:url';\nimport { types } from 'node:util';\nimport type { RESTPatchAPIChannelJSONBody } from 'discord-api-types/v10';\nimport { FormData, type Dispatcher, type RequestInit } from 'undici';\nimport type { RequestOptions } from '../REST';\nimport { RequestMethod } from '../RequestManager';\n\nexport function parseHeader(header: string | string[] | undefined): string | undefined {\n\tif (header === undefined) {\n\t\treturn header;\n\t} else if (typeof header === 'string') {\n\t\treturn header;\n\t}\n\n\treturn header.join(';');\n}\n\nfunction serializeSearchParam(value: unknown): string | null {\n\tswitch (typeof value) {\n\t\tcase 'string':\n\t\t\treturn value;\n\t\tcase 'number':\n\t\tcase 'bigint':\n\t\tcase 'boolean':\n\t\t\treturn value.toString();\n\t\tcase 'object':\n\t\t\tif (value === null) return null;\n\t\t\tif (value instanceof Date) {\n\t\t\t\treturn Number.isNaN(value.getTime()) ? null : value.toISOString();\n\t\t\t}\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-base-to-string\n\t\t\tif (typeof value.toString === 'function' && value.toString !== Object.prototype.toString) return value.toString();\n\t\t\treturn null;\n\t\tdefault:\n\t\t\treturn null;\n\t}\n}\n\n/**\n * Creates and populates an URLSearchParams instance from an object, stripping\n * out null and undefined values, while also coercing non-strings to strings.\n *\n * @param options - The options to use\n *\n * @returns A populated URLSearchParams instance\n */\nexport function makeURLSearchParams(options?: Record<string, unknown>) {\n\tconst params = new URLSearchParams();\n\tif (!options) return params;\n\n\tfor (const [key, value] of Object.entries(options)) {\n\t\tconst serialized = serializeSearchParam(value);\n\t\tif (serialized !== null) params.append(key, serialized);\n\t}\n\n\treturn params;\n}\n\n/**\n * Converts the response to usable data\n *\n * @param res - The fetch response\n */\nexport function parseResponse(res: Dispatcher.ResponseData): Promise<unknown> {\n\tconst header = parseHeader(res.headers['content-type']);\n\tif (header?.startsWith('application/json')) {\n\t\treturn res.body.json();\n\t}\n\n\treturn res.body.arrayBuffer();\n}\n\n/**\n * Check whether a request falls under a sublimit\n *\n * @param bucketRoute - The buckets route identifier\n * @param body - The options provided as JSON data\n * @param method - The HTTP method that will be used to make the request\n *\n * @returns Whether the request falls under a sublimit\n */\nexport function hasSublimit(bucketRoute: string, body?: unknown, method?: string): boolean {\n\t// TODO: Update for new sublimits\n\t// Currently known sublimits:\n\t// Editing channel `name` or `topic`\n\tif (bucketRoute === '/channels/:id') {\n\t\tif (typeof body !== 'object' || body === null) return false;\n\t\t// This should never be a POST body, but just in case\n\t\tif (method !== RequestMethod.Patch) return false;\n\t\tconst castedBody = body as RESTPatchAPIChannelJSONBody;\n\t\treturn ['name', 'topic'].some((key) => Reflect.has(castedBody, key));\n\t}\n\n\t// If we are checking if a request has a sublimit on a route not checked above, sublimit all requests to avoid a flood of 429s\n\treturn true;\n}\n\nexport async function resolveBody(body: RequestInit['body']): Promise<RequestOptions['body']> {\n\t// eslint-disable-next-line no-eq-null\n\tif (body == null) {\n\t\treturn null;\n\t} else if (typeof body === 'string') {\n\t\treturn body;\n\t} else if (types.isUint8Array(body)) {\n\t\treturn body;\n\t} else if (types.isArrayBuffer(body)) {\n\t\treturn new Uint8Array(body);\n\t} else if (body instanceof URLSearchParams) {\n\t\treturn body.toString();\n\t} else if (body instanceof DataView) {\n\t\treturn new Uint8Array(body.buffer);\n\t} else if (body instanceof Blob) {\n\t\treturn new Uint8Array(await body.arrayBuffer());\n\t} else if (body instanceof FormData) {\n\t\treturn body;\n\t\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n\t} else if ((body as Iterable<Uint8Array>)[Symbol.iterator]) {\n\t\tconst chunks = [...(body as Iterable<Uint8Array>)];\n\t\tconst length = chunks.reduce((a, b) => a + b.length, 0);\n\n\t\tconst uint8 = new Uint8Array(length);\n\t\tlet lengthUsed = 0;\n\n\t\treturn chunks.reduce((a, b) => {\n\t\t\ta.set(b, lengthUsed);\n\t\t\tlengthUsed += b.length;\n\t\t\treturn a;\n\t\t}, uint8);\n\t\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n\t} else if ((body as AsyncIterable<Uint8Array>)[Symbol.asyncIterator]) {\n\t\tconst chunks: Uint8Array[] = [];\n\n\t\tfor await (const chunk of body as AsyncIterable<Uint8Array>) {\n\t\t\tchunks.push(chunk);\n\t\t}\n\n\t\treturn Buffer.concat(chunks);\n\t}\n\n\tthrow new TypeError(`Unable to resolve body.`);\n}\n"],"names":[],"mappings":";;;;;;AAKO,SAAS,WAAW,CAAC,MAAM,EAAE;AACpC,EAAE,IAAI,MAAM,KAAK,KAAK,CAAC,EAAE;AACzB,IAAI,OAAO,MAAM,CAAC;AAClB,GAAG,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;AACzC,IAAI,OAAO,MAAM,CAAC;AAClB,GAAG;AACH,EAAE,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AACD,SAAS,oBAAoB,CAAC,KAAK,EAAE;AACrC,EAAE,QAAQ,OAAO,KAAK;AACtB,IAAI,KAAK,QAAQ;AACjB,MAAM,OAAO,KAAK,CAAC;AACnB,IAAI,KAAK,QAAQ,CAAC;AAClB,IAAI,KAAK,QAAQ,CAAC;AAClB,IAAI,KAAK,SAAS;AAClB,MAAM,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;AAC9B,IAAI,KAAK,QAAQ;AACjB,MAAM,IAAI,KAAK,KAAK,IAAI;AACxB,QAAQ,OAAO,IAAI,CAAC;AACpB,MAAM,IAAI,KAAK,YAAY,IAAI,EAAE;AACjC,QAAQ,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;AAC1E,OAAO;AACP,MAAM,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU,IAAI,KAAK,CAAC,QAAQ,KAAK,MAAM,CAAC,SAAS,CAAC,QAAQ;AAC9F,QAAQ,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;AAChC,MAAM,OAAO,IAAI,CAAC;AAClB,IAAI;AACJ,MAAM,OAAO,IAAI,CAAC;AAClB,GAAG;AACH,CAAC;AACM,SAAS,mBAAmB,CAAC,OAAO,EAAE;AAC7C,EAAE,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;AACvC,EAAE,IAAI,CAAC,OAAO;AACd,IAAI,OAAO,MAAM,CAAC;AAClB,EAAE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;AACtD,IAAI,MAAM,UAAU,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;AACnD,IAAI,IAAI,UAAU,KAAK,IAAI;AAC3B,MAAM,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;AACrC,GAAG;AACH,EAAE,OAAO,MAAM,CAAC;AAChB,CAAC;AACM,SAAS,aAAa,CAAC,GAAG,EAAE;AACnC,EAAE,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;AAC1D,EAAE,IAAI,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC,EAAE;AAC9C,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;AAC3B,GAAG;AACH,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;AAChC,CAAC;AACM,SAAS,WAAW,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE;AACvD,EAAE,IAAI,WAAW,KAAK,eAAe,EAAE;AACvC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;AACjD,MAAM,OAAO,KAAK,CAAC;AACnB,IAAI,IAAI,MAAM,KAAK,aAAa,CAAC,KAAK;AACtC,MAAM,OAAO,KAAK,CAAC;AACnB,IAAI,MAAM,UAAU,GAAG,IAAI,CAAC;AAC5B,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC;AACzE,GAAG;AACH,EAAE,OAAO,IAAI,CAAC;AACd,CAAC;AACM,eAAe,WAAW,CAAC,IAAI,EAAE;AACxC,EAAE,IAAI,IAAI,IAAI,IAAI,EAAE;AACpB,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG,MAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;AACvC,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;AACvC,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE;AACxC,IAAI,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;AAChC,GAAG,MAAM,IAAI,IAAI,YAAY,eAAe,EAAE;AAC9C,IAAI,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;AAC3B,GAAG,MAAM,IAAI,IAAI,YAAY,QAAQ,EAAE;AACvC,IAAI,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACvC,GAAG,MAAM,IAAI,IAAI,YAAY,IAAI,EAAE;AACnC,IAAI,OAAO,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACpD,GAAG,MAAM,IAAI,IAAI,YAAY,QAAQ,EAAE;AACvC,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;AACpC,IAAI,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AAC7B,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAC5D,IAAI,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AACzC,IAAI,IAAI,UAAU,GAAG,CAAC,CAAC;AACvB,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK;AACnC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;AAC3B,MAAM,UAAU,IAAI,CAAC,CAAC,MAAM,CAAC;AAC7B,MAAM,OAAO,CAAC,CAAC;AACf,KAAK,EAAE,KAAK,CAAC,CAAC;AACd,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;AACzC,IAAI,MAAM,MAAM,GAAG,EAAE,CAAC;AACtB,IAAI,WAAW,MAAM,KAAK,IAAI,IAAI,EAAE;AACpC,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACzB,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACjC,GAAG;AACH,EAAE,MAAM,IAAI,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC;AACjD;;;;"}

package/package.json

@@ -1,23 +1,24 @@
 {
   "name": "@discordjs/rest",
-  "version": "0.6.0",
+  "version": "1.0.1-dev.1658331002-a05386a.0",
   "description": "The REST API for discord.js",
   "scripts": {
     "test": "vitest run",
-    "build": "tsup",
+    "build": "unbuild",
     "lint": "prettier --check . && eslint src __tests__ --ext mjs,js,ts",
     "format": "prettier --write . && eslint src __tests__ --ext mjs,js,ts --fix",
-    "docs": "docgen -i src/index.ts -c docs/index.json -o docs/docs.json --typescript && api-extractor run --local",
+    "fmt": "yarn format",
+    "docs": "downlevel-dts . docs --to=3.7 && docgen -i src/index.ts -c docs/index.json -o docs/docs.json --typescript && api-extractor run --local",
     "prepack": "yarn build && yarn lint",
     "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/rest/*'",
     "release": "cliff-jumper"
   },
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "typings": "./dist/index.d.ts",
   "exports": {
     "import": "./dist/index.mjs",
-    "require": "./dist/index.js",
+    "require": "./dist/index.cjs",
     "types": "./dist/index.d.ts"
   },
   "directories": {
@@ -51,25 +52,27 @@
   },
   "homepage": "https://discord.js.org",
   "dependencies": {
-    "@discordjs/collection": "^0.8.0",
+    "@discordjs/collection": "^1.0.0",
     "@sapphire/async-queue": "^1.3.2",
     "@sapphire/snowflake": "^3.2.2",
     "discord-api-types": "^0.36.2",
     "file-type": "^17.1.2",
     "tslib": "^2.4.0",
-    "undici": "^5.7.0"
+    "undici": "^5.8.0"
   },
   "devDependencies": {
-    "@discordjs/docgen": "^0.12.0-dev",
-    "@discordjs/scripts": "^0.1.0-dev",
+    "@discordjs/docgen": "^0.12.0",
     "@favware/cliff-jumper": "^1.8.5",
     "@microsoft/api-extractor": "^7.28.4",
     "@types/node": "^16.11.45",
-    "c8": "^7.11.3",
+    "c8": "^7.12.0",
+    "downlevel-dts": "^0.10.0",
     "eslint": "^8.20.0",
     "prettier": "^2.7.1",
+    "rollup-plugin-typescript2": "0.32.1",
     "tsup": "^6.1.3",
     "typescript": "^4.7.4",
+    "unbuild": "^0.7.4",
     "vitest": "^0.18.1"
   },
   "engines": {