@discordjs/rest 0.4.0-dev.1649505800-3c0bbac → 0.4.0

package/README.md

@@ -1,3 +1,92 @@
-# `@discordjs/rest`
+<div align="center">
+  <br />
+  <p>
+    <a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
+  </p>
+  <br />
+  <p>
+    <a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
+    <a href="https://www.npmjs.com/package/@discordjs/rest"><img src="https://img.shields.io/npm/v/@discordjs/rest.svg?maxAge=3600" alt="npm version" /></a>
+    <a href="https://www.npmjs.com/package/@discordjs/rest"><img src="https://img.shields.io/npm/dt/@discordjs/rest.svg?maxAge=3600" alt="npm downloads" /></a>
+    <a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Tests status" /></a>
+  </p>
+</div>
 
-> The REST API module for Discord.js
+## Installation
+
+**Node.js 16.9.0 or newer is required.**
+
+```sh-session
+npm install @discordjs/rest
+yarn add @discordjs/rest
+pnpm add @discordjs/rest
+```
+
+## Examples
+
+Install all required dependencies:
+
+```sh-session
+npm install @discordjs/rest discord-api-types
+yarn add @discordjs/rest discord-api-types
+pnpm add @discordjs/rest discord-api-types
+```
+
+Send a basic message:
+
+```js
+import { REST } from '@discordjs/rest';
+import { Routes } from 'discord-api-types/v10';
+
+const rest = new REST({ version: '10' }).setToken('token');
+
+try {
+	await rest.post(Routes.channelMessages(CHANNEL_ID), {
+		body: {
+			content: 'A message via REST!',
+		},
+	});
+} catch (error) {
+	console.error(error);
+}
+```
+
+Create a thread from an existing message to be archived after 60 minutes of inactivity:
+
+```js
+import { REST } from '@discordjs/rest';
+import { Routes } from 'discord-api-types/v10';
+
+const rest = new REST({ version: '10' }).setToken('token');
+
+try {
+	await rest.post(Routes.threads(CHANNEL_ID, MESSAGE_ID), {
+		body: {
+			name: 'Thread',
+			auto_archive_duration: 60,
+		},
+	});
+} catch (error) {
+	console.error(error);
+}
+```
+
+## Links
+
+- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website))
+- [Dev documentation](https://discord.js.org/#/docs/rest/main/general/welcome) (stable coming soon)
+- [discord.js Discord server](https://discord.gg/djs)
+- [Discord API Discord server](https://discord.gg/discord-api)
+- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/rest)
+- [npm](https://www.npmjs.com/package/@discordjs/rest)
+- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries)
+
+## Contributing
+
+Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
+[documentation](https://discord.js.org/#/docs/rest/main/general/welcome).  
+See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR.
+
+## Help
+
+If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server](https://discord.gg/djs).

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export * from './lib/errors/RateLimitError';
 export * from './lib/RequestManager';
 export * from './lib/REST';
 export * from './lib/utils/constants';
+export { makeURLSearchParams } from './lib/utils/utils';

package/dist/index.js

@@ -6,7 +6,6 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __commonJS = (cb, mod) => function __require() {
   return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
@@ -15,22 +14,16 @@ var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
+  return to;
 };
-var __toESM = (module2, isNodeMode) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", !isNodeMode && module2 && module2.__esModule ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var __publicField = (obj, key, value) => {
   __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
@@ -59,7 +52,7 @@ var require_package = __commonJS({
   "package.json"(exports, module2) {
     module2.exports = {
       name: "@discordjs/rest",
-      version: "0.4.0-dev",
+      version: "0.4.0",
       description: "The REST API for discord.js",
       scripts: {
         build: "tsup && tsc --emitDeclarationOnly --incremental",
@@ -110,35 +103,35 @@ var require_package = __commonJS({
       homepage: "https://discord.js.org",
       dependencies: {
         "@discordjs/collection": "workspace:^",
-        "@sapphire/async-queue": "^1.2.0",
-        "@sapphire/snowflake": "^3.1.0",
-        "@types/node-fetch": "^2.5.12",
+        "@sapphire/async-queue": "^1.3.1",
+        "@sapphire/snowflake": "^3.2.1",
+        "@types/node-fetch": "^2.6.1",
         "discord-api-types": "^0.29.0",
         "form-data": "^4.0.0",
         "node-fetch": "^2.6.7",
         tslib: "^2.3.1"
       },
       devDependencies: {
-        "@babel/core": "^7.17.2",
-        "@babel/plugin-proposal-decorators": "^7.17.2",
+        "@babel/core": "^7.17.9",
+        "@babel/plugin-proposal-decorators": "^7.17.9",
         "@babel/preset-env": "^7.16.11",
         "@babel/preset-typescript": "^7.16.7",
-        "@discordjs/ts-docgen": "^0.3.4",
-        "@types/jest": "^27.4.0",
-        "@typescript-eslint/eslint-plugin": "^5.11.0",
-        "@typescript-eslint/parser": "^5.11.0",
+        "@discordjs/ts-docgen": "^0.4.1",
+        "@types/jest": "^27.4.1",
+        "@typescript-eslint/eslint-plugin": "^5.19.0",
+        "@typescript-eslint/parser": "^5.19.0",
         "babel-plugin-const-enum": "^1.2.0",
         "babel-plugin-transform-typescript-metadata": "^0.3.2",
-        eslint: "^8.9.0",
-        "eslint-config-marine": "^9.3.2",
-        "eslint-config-prettier": "^8.3.0",
-        "eslint-plugin-prettier": "^4.0.0",
+        eslint: "^8.13.0",
+        "eslint-config-marine": "^9.4.1",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-import": "^2.26.0",
         jest: "^27.5.1",
         nock: "^13.2.4",
-        prettier: "^2.5.1",
-        tsup: "^5.11.13",
-        typedoc: "^0.22.11",
-        typescript: "^4.5.5"
+        prettier: "^2.6.2",
+        tsup: "^5.12.5",
+        typedoc: "^0.22.15",
+        typescript: "^4.6.3"
       },
       engines: {
         node: ">=16.9.0"
@@ -165,8 +158,10 @@ __export(src_exports, {
   RESTEvents: () => RESTEvents,
   RateLimitError: () => RateLimitError,
   RequestManager: () => RequestManager,
-  RequestMethod: () => RequestMethod
+  RequestMethod: () => RequestMethod,
+  makeURLSearchParams: () => makeURLSearchParams
 });
+module.exports = __toCommonJS(src_exports);
 
 // src/lib/utils/constants.ts
 var import_v10 = require("discord-api-types/v10");
@@ -377,12 +372,12 @@ var RateLimitError = class extends Error {
 __name(RateLimitError, "RateLimitError");
 
 // src/lib/RequestManager.ts
-var import_collection = __toESM(require("@discordjs/collection"));
-var import_form_data = __toESM(require("form-data"));
-var import_snowflake = require("@sapphire/snowflake");
 var import_node_events = require("events");
-var import_node_https = require("https");
 var import_node_http = require("http");
+var import_node_https = require("https");
+var import_collection = __toESM(require("@discordjs/collection"));
+var import_snowflake = require("@sapphire/snowflake");
+var import_form_data = __toESM(require("form-data"));
 
 // src/lib/handlers/SequentialHandler.ts
 var import_promises = require("timers/promises");
@@ -390,6 +385,40 @@ var import_async_queue = require("@sapphire/async-queue");
 var import_node_fetch = __toESM(require("node-fetch"));
 
 // src/lib/utils/utils.ts
+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;
+  }
+}
+__name(serializeSearchParam, "serializeSearchParam");
+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;
+}
+__name(makeURLSearchParams, "makeURLSearchParams");
 function parseResponse(res) {
   if (res.headers.get("Content-Type")?.startsWith("application/json")) {
     return res.json();
@@ -908,7 +937,6 @@ var REST = class extends import_node_events2.EventEmitter {
   }
 };
 __name(REST, "REST");
-module.exports = __toCommonJS(src_exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ALLOWED_EXTENSIONS,
@@ -923,6 +951,7 @@ module.exports = __toCommonJS(src_exports);
   RESTEvents,
   RateLimitError,
   RequestManager,
-  RequestMethod
+  RequestMethod,
+  makeURLSearchParams
 });
 //# sourceMappingURL=index.js.map