Generate typescript declarations & mappings

Author: Majored

package.json

@@ -3,6 +3,7 @@
   "version": "1.1.1",
   "description": "An official asynchronous JavaScript (Node.js) wrapper for MC-Market's Ultimate REST API.",
   "main": "./src/index.js",
+  "types": "./types/index.d.ts",
   "scripts": {
     "test": "node ./tests/test.js && npx eslint ./src/"
   },

types/Error.d.ts

@@ -0,0 +1,17 @@
+/** A type which represents a parsed error from the API, or an internal wrapper error. */
+export class Error {
+    /** Constructs a new Error which originated within the wrapper.
+     *
+     * @param {string} message The internal error message.
+     * @returns {Error} The newly-constructed error.
+     */
+    static internal(message: string): Error;
+    constructor(json: any);
+    /** Converts this error into a human-readable string.
+     *
+     * @returns {string} A string representation of this error.
+     */
+    toString(): string;
+    #private;
+}
+//# sourceMappingURL=Error.d.ts.map

types/Error.d.ts.map

@@ -0,0 +1,63 @@
+/** A type that handles raw HTTP requests to the API. */
+export class Http {
+    /** The maximum number of objects returned by a list endpoint for a single request. */
+    static "__#2@#PER_PAGE": number;
+    /** The content type used for WRITE operations with bodies (ie. POST/PATCH). */
+    static "__#2@#WRITE_HEADERS": {
+        headers: {
+            "Content-Type": string;
+        };
+    };
+    constructor(client: any, throtter: any);
+    /** Schedules a GET request for a specific endpoint.
+     *
+     * @param {string} endpoint The path of the endpoint (incl. any path parameters).
+     * @param {SortOptions} sort The optional set of sort options.
+     *
+     * @return {*} The response data on success.
+     */
+    get(endpoint: string, sort?: SortOptions): any;
+    /** Schedules a POST request for a specific endpoint.
+     *
+     * @param {string} endpoint The path of the endpoint (incl. any path parameters).
+     * @param {object} body The request body options.
+     *
+     * @return {number} The response data on success (ie. a content identifier).
+     */
+    post(endpoint: string, body: object): number;
+    /** Schedules a PATCH request for a specific endpoint.
+     *
+     * @param {string} endpoint The path of the endpoint (incl. any path parameters).
+     * @param {object} body The request body options.
+     */
+    patch(endpoint: string, body: object): any;
+    /** Schedules a DELETE request for a specific endpoint.
+     *
+     * @param {string} endpoint The path of the endpoint (incl. any path parameters).
+     */
+    delete(endpoint: string): any;
+    /** A raw function returning a compiled list of objects from all available pages or until we decide to stop.
+     *
+     * <br><br>
+     *
+     * 'shouldContinue' expects a function with a single parameter and should return a boolean representing if we
+     * should continue to add the current (and future) objects to the final list (and thus, if we should continue
+     * to make requests). This function is called for every single object as a parameter within each request's
+     * returned list.
+     *
+     * <br><br>
+     *
+     * This function continuously makes requests to a specific endpoint with a set of sort options, and increments the
+     * sort option page count after each request.
+     *
+     * @param {string} endpoint The path of the endpoint (incl. any path parameters).
+     * @param {function(object):boolean} shouldContinue A function which determines if further pages are requested.
+     * @param {SortOptions} sort An optional set of sort options.
+     *
+     * @return {Array<object>} An array of raw objects.
+     */
+    listUntil(endpoint: string, shouldContinue: (arg0: object) => boolean, sort?: SortOptions): Array<object>;
+    #private;
+}
+import { SortOptions } from "./SortOptions.js";
+//# sourceMappingURL=Http.d.ts.map

types/Http.d.ts

@@ -0,0 +1,17 @@
+/** A type representing the sorting options available for listing-style endpoints. */
+export class SortOptions {
+    sort: any;
+    order: any;
+    page: any;
+    /** Convets this SortOptions instance into a query string.
+     *
+     * @returns {string} The query-string representation.
+     */
+    toQueryString(): string;
+    /** Returns whether or not any sort options have been set.
+     *
+     * @returns {bool} Whether or not any sort options have been set.
+     */
+    isSet(): bool;
+}
+//# sourceMappingURL=SortOptions.d.ts.map

types/Http.d.ts.map

@@ -0,0 +1,9 @@
+export class Throttler {
+    setRead(retry: any): void;
+    setWrite(retry: any): void;
+    resetRead(): void;
+    resetWrite(): void;
+    stallIfRequired(write: any): Promise<void>;
+    #private;
+}
+//# sourceMappingURL=Throttler.d.ts.map

types/SortOptions.d.ts

@@ -0,0 +1,19 @@
+/** A type representing an API authentication token. */
+export class Token {
+    /** Constructs a new token from its constituents.
+     *
+     * @param {TokenType} type The type of this token.
+     * @param {string} value The value of this token.
+     */
+    constructor(type: TokenType, value: string);
+    /** Constructs an object containing the header representation of this token.
+     *
+     * @returns An object with a single attribute, 'Authorization'.
+     */
+    asHeader(): {
+        Authorization: string;
+    };
+    #private;
+}
+import { TokenType } from "./TokenType.js";
+//# sourceMappingURL=Token.d.ts.map