paste.gg 1.0.1 → 1.0.5

package/dist/interfaces.js

@@ -1,3 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxyXG4gKiBDb3B5cmlnaHQgwqkgU2VyZW5Nb2R6MjEgMjAxOCAtIDIwMjAgQWxsIFJpZ2h0cyBSZXNlcnZlZC5cclxuICogVW5hdXRob3JpemVkIGRpc3RyaWJ1dGlvbiBvZiBhbnkgY29kZSB3aXRoaW4gdGhpcyBwcm9qZWN0IG1heSByZXN1bHQgaW4gY29uc2VxdWVuY2VzIGNob3NlbiBieSB0aGUgQm9hcmQgTWVtYmVycy5cclxuICogUmVmZXIgdG8gdGhlIFJFQURNRSBmb3IgbW9yZSBpbmZvcm1hdGlvbi5cclxuICovXHJcblxyXG5leHBvcnQgdHlwZSBJSGVhZGVyID0ge1xyXG4gIFwiQ29udGVudC1UeXBlXCI/OiBzdHJpbmc7XHJcbiAgQXV0aG9yaXphdGlvbj86IHN0cmluZztcclxufVxyXG5cclxuZXhwb3J0IGludGVyZmFjZSBQYXN0ZUdHT3B0aW9ucyB7XHJcbiAgYmFzZVVybDogc3RyaW5nO1xyXG4gIHZlcnNpb246IG51bWJlcjtcclxufVxyXG5cclxuZXhwb3J0IGludGVyZmFjZSBQYXN0ZU91dHB1dCB7XHJcbiAgc3RhdHVzOiBzdHJpbmc7XHJcbiAgcmVzdWx0Pzoge1xyXG4gICAgaWQ6IHN0cmluZztcclxuICAgIG5hbWU/OiBzdHJpbmc7XHJcbiAgICBkZXNjcmlwdGlvbj86IHN0cmluZztcclxuICAgIHZpc2liaWxpdHk/OiBcInB1YmxpY1wiIHwgXCIqdW5saXN0ZWRcIiB8IFwidW5saXN0ZWRcIiB8IFwicHJpdmF0ZVwiO1xyXG4gICAgY3JlYXRlZF9hdDogc3RyaW5nO1xyXG4gICAgdXBkYXRlZF9hdDogc3RyaW5nO1xyXG4gICAgZXhwaXJlcz86IHN0cmluZztcclxuICAgIGZpbGVzPzogRmlsZXNbXTtcclxuICAgIGRlbGV0aW9uX2tleT86IHN0cmluZztcclxuICB9O1xyXG4gIGVycm9yPzogc3RyaW5nO1xyXG4gIG1lc3NhZ2U/OiBzdHJpbmc7XHJcbn1cclxuXHJcbmV4cG9ydCBpbnRlcmZhY2UgUG9zdFBhc3RlIHtcclxuICBuYW1lPzogc3RyaW5nO1xyXG4gIGRlc2NyaXB0aW9uPzogc3RyaW5nO1xyXG4gIHZpc2liaWxpdHk/OiBcInB1YmxpY1wiIHwgXCIqdW5saXN0ZWRcIiB8IFwidW5saXN0ZWRcIiB8IFwicHJpdmF0ZVwiO1xyXG4gIGV4cGlyZXM/OiBzdHJpbmc7XHJcbiAgZmlsZXM6IFBvc3RGaWxlc1tdO1xyXG59XHJcblxyXG5leHBvcnQgaW50ZXJmYWNlIFVwZGF0ZVBvc3Qge1xyXG4gIG5hbWU/OiBzdHJpbmc7XHJcbiAgZGVzY3JpcHRpb246IHN0cmluZztcclxufVxyXG5cclxuaW50ZXJmYWNlIEZpbGVzIHtcclxuICBpZDogc3RyaW5nO1xyXG4gIG5hbWU6IHN0cmluZztcclxuICBoaWdobGlnaHRfbGFuZ3VhZ2U6IHN0cmluZyB8IG51bGw7XHJcbn1cclxuXHJcbmludGVyZmFjZSBQb3N0RmlsZXMge1xyXG4gIG5hbWU/OiBzdHJpbmc7XHJcbiAgY29udGVudDoge1xyXG4gICAgZm9ybWF0OiBcInRleHRcIiB8IFwiYmFzZTY0XCIgfCBcImd6aXBcIiB8IFwieHpcIjtcclxuICAgIGhpZ2hsaWdodF9sYW5ndWFnZT86IHN0cmluZztcclxuICAgIHZhbHVlOiBzdHJpbmc7XHJcbiAgfVxyXG59Il19
+"use strict";
+/*
+ * Copyright © SerenModz21 2018 - 2021 All Rights Reserved.
+ * Unauthorized distribution of any code within this project may result in consequences chosen.
+ * Refer to the README for more information.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Methods = void 0;
+var Methods;
+(function (Methods) {
+    Methods["GET"] = "GET";
+    Methods["POST"] = "POST";
+    Methods["DELETE"] = "DELETE";
+    Methods["PATCH"] = "PATCH";
+})(Methods = exports.Methods || (exports.Methods = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQTs7OztHQUlHOzs7QUFFSCxJQUFZLE9BS1g7QUFMRCxXQUFZLE9BQU87SUFDakIsc0JBQVcsQ0FBQTtJQUNYLHdCQUFhLENBQUE7SUFDYiw0QkFBaUIsQ0FBQTtJQUNqQiwwQkFBZSxDQUFBO0FBQ2pCLENBQUMsRUFMVyxPQUFPLEdBQVAsZUFBTyxLQUFQLGVBQU8sUUFLbEIiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IMKpIFNlcmVuTW9kejIxIDIwMTggLSAyMDIxIEFsbCBSaWdodHMgUmVzZXJ2ZWQuXG4gKiBVbmF1dGhvcml6ZWQgZGlzdHJpYnV0aW9uIG9mIGFueSBjb2RlIHdpdGhpbiB0aGlzIHByb2plY3QgbWF5IHJlc3VsdCBpbiBjb25zZXF1ZW5jZXMgY2hvc2VuLlxuICogUmVmZXIgdG8gdGhlIFJFQURNRSBmb3IgbW9yZSBpbmZvcm1hdGlvbi5cbiAqL1xuXG5leHBvcnQgZW51bSBNZXRob2RzIHtcbiAgR0VUID0gXCJHRVRcIixcbiAgUE9TVCA9IFwiUE9TVFwiLFxuICBERUxFVEUgPSBcIkRFTEVURVwiLFxuICBQQVRDSCA9IFwiUEFUQ0hcIixcbn1cblxuZXhwb3J0IHR5cGUgSUhlYWRlciA9IHtcbiAgXCJDb250ZW50LVR5cGVcIj86IHN0cmluZztcbiAgQXV0aG9yaXphdGlvbj86IHN0cmluZztcbn07XG5cbmV4cG9ydCBpbnRlcmZhY2UgT3B0aW9ucyB7XG4gIGJhc2VVcmw6IHN0cmluZztcbiAgbWFpblVybDogc3RyaW5nO1xuICB2ZXJzaW9uOiBudW1iZXI7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgUmVzdWx0IHtcbiAgaWQ6IHN0cmluZztcbiAgbmFtZT86IHN0cmluZztcbiAgdXJsPzogc3RyaW5nO1xuICBhdXRob3I/OiBBdXRob3I7XG4gIGRlc2NyaXB0aW9uPzogc3RyaW5nO1xuICB2aXNpYmlsaXR5PzogXCJwdWJsaWNcIiB8IFwidW5saXN0ZWRcIiB8IFwicHJpdmF0ZVwiO1xuICBjcmVhdGVkX2F0OiBzdHJpbmc7XG4gIHVwZGF0ZWRfYXQ6IHN0cmluZztcbiAgZXhwaXJlcz86IHN0cmluZztcbiAgZmlsZXM/OiBGaWxlW107XG4gIGRlbGV0aW9uX2tleT86IHN0cmluZztcbn1cblxuZXhwb3J0IGludGVyZmFjZSBPdXRwdXQge1xuICBzdGF0dXM6IHN0cmluZztcbiAgcmVzdWx0PzogUmVzdWx0O1xuICBlcnJvcj86IHN0cmluZztcbiAgbWVzc2FnZT86IHN0cmluZztcbn1cblxuZXhwb3J0IGludGVyZmFjZSBBdXRob3Ige1xuICBpZD86IHN0cmluZztcbiAgdXNlcm5hbWU/OiBzdHJpbmc7XG4gIG5hbWU/OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgUG9zdFxuICBleHRlbmRzIFBpY2s8UmVzdWx0LCBcIm5hbWVcIiB8IFwiZGVzY3JpcHRpb25cIiB8IFwidmlzaWJpbGl0eVwiIHwgXCJleHBpcmVzXCI+IHtcbiAgZmlsZXM6IEZpbGVPdXRbXTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBVcGRhdGUgZXh0ZW5kcyBQaWNrPFJlc3VsdCwgXCJuYW1lXCI+IHtcbiAgZGVzY3JpcHRpb246IHN0cmluZztcbn1cblxuZXhwb3J0IGludGVyZmFjZSBGaWxlIHtcbiAgaWQ6IHN0cmluZztcbiAgbmFtZTogc3RyaW5nO1xuICBoaWdobGlnaHRfbGFuZ3VhZ2U/OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgRmlsZU91dCB7XG4gIG5hbWU/OiBzdHJpbmc7XG4gIGNvbnRlbnQ6IENvbnRlbnQ7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQ29udGVudCBleHRlbmRzIFBpY2s8RmlsZSwgXCJoaWdobGlnaHRfbGFuZ3VhZ2VcIj4ge1xuICBmb3JtYXQ6IFwidGV4dFwiIHwgXCJiYXNlNjRcIiB8IFwiZ3ppcFwiIHwgXCJ4elwiO1xuICB2YWx1ZTogc3RyaW5nO1xufVxuIl19

package/package.json

@@ -1,29 +1,37 @@
-{
-  "name": "paste.gg",
-  "version": "1.0.1",
-  "description": "A wrapper for the paste.gg api",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "author": "Seren_Modz 21",
-  "repository": "SerenModz21/paste.gg",
-  "bugs": "https://github.com/SerenModz21/paste.gg",
-  "license": "MIT",
-  "keywords": [
-    "paste.gg",
-    "api",
-    "wrapper"
-  ],
-  "scripts": {
-    "build": "rimraf ./dist && tsc",
-    "prepublishOnly": "yarn build"
-  },
-  "devDependencies": {
-    "@types/node": "^14.14.14",
-    "@types/node-fetch": "^2.5.7",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.1.3"
-  },
-  "dependencies": {
-    "node-fetch": "^2.6.1"
-  }
-}
+{
+  "name": "paste.gg",
+  "version": "1.0.5",
+  "description": "An easy-to-use library for interacting with the Paste.GG API. Contains examples, strong JSDocs, TypeScript types, and support for Node.js 12+. Works in both JavaScript and TypeScript.",
+  "main": "./dist/index.js",
+  "typings": "./typings/index.d.ts",
+  "license": "MIT",
+  "author": "Seren_Modz 21",
+  "homepage": "https://github.com/SerenModz21/paste.gg#readme",
+  "repository": "git://github.com/SerenModz21/paste.gg.git",
+  "bugs": {
+    "url": "https://github.com/SerenModz21/paste.gg/issues"
+  },
+  "keywords": [
+    "paste.gg",
+    "api",
+    "wrapper"
+  ],
+  "scripts": {
+    "build": "rimraf ./dist && tsc",
+    "test": "ts-node test/index.ts",
+    "prepublishOnly": "yarn build"
+  },
+  "dependencies": {
+    "node-fetch": "2.6.7"
+  },
+  "devDependencies": {
+    "@types/node": "^16.6.1",
+    "@types/node-fetch": "^2.5.10",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.3.5"
+  },
+  "engines": {
+    "node": ">=12.0.0",
+    "yarn": ">=1.0.0"
+  }
+}

package/typings/index.d.ts

@@ -0,0 +1,172 @@
+import { Options, Output, Post, Update } from "./interfaces";
+/**
+ * The main class for interacting with the Paste.gg API
+ */
+declare class PasteGG {
+    #private;
+    readonly options: Options;
+    readonly version: string;
+    /**
+     * Create a new instance of PasteGG
+     * @param {string} auth Optional auth key
+     * @param {Options} options Options for the paste server
+     * @class PasteGG
+     * @public
+     * @example
+     * // If you want to be anonymous
+     * const pasteGG = new PasteGG()
+     *
+     * // If you want to use an api key
+     * const pasteGG = new PasteGG("apiKeyHere")
+     */
+    constructor(auth?: string, options?: Options);
+    /**
+     * Make a request to the API.
+     * @param {keyof typeof Methods} method
+     * @param {string} path
+     * @param {object} body
+     * @param {string} key
+     * @returns {Promise<T>}
+     * @private
+     */
+    private _request;
+    /**
+     * Get an existing paste.
+     * @see https://github.com/ascclemens/paste/blob/master/api.md#get-pastesid
+     * @param {string} id The ID of the paste.
+     * @param {boolean} full Includes the contents of files if true.
+     * @returns {Promise<Output>}
+     * @public
+     * @example
+     * // if you would like to exclude file contents
+     * await pasteGG.get("idHere")
+     *
+     * // If you would like to include file contents
+     * await pasteGG.get("idHere", true)
+     */
+    get(id: string, full?: boolean): Promise<Output>;
+    /**
+     * Create a new paste.
+     * @see https://github.com/ascclemens/paste/blob/master/api.md#post-pastes
+     * @param {Post} input The information to create the paste with.
+     * @returns {Promise<Output>}
+     * @public
+     * @example
+     * await pasteGG.post({
+     *   name: "Paste name", // Optional
+     *   description: "Paste description", // Optional
+     *   expires: "2020-12-21T02:25:56.428Z", // Optional (must be a UTC ISO 8601 string)
+     *   files: [{
+     *     name: "file.txt", // Optional
+     *     content: {
+     *       format: "text",
+     *       value: "This is where the file content will go"
+     *     }
+     *   }]
+     * })
+     */
+    post(input: Post): Promise<Output>;
+    /**
+     * Deletes an existing paste.
+     * @see https://github.com/ascclemens/paste/blob/master/api.md#delete-pastesid
+     * @param {string} id The ID of the paste to delete.
+     * @param {string} [key] Auth key or deletion key (leave blank if you have set the auth key in the constructor)
+     * @returns {Promise<Output | void>}
+     * @public
+     * @example
+     * // Delete with deletion key
+     * await pasteGG.delete("idHere", "deletionKeyHere")
+     *
+     * // Delete with auth key if not set in constructor
+     * await pasteGG.delete("idHere", "authKeyHere")
+     *
+     * // Leave blank if auth key is in the class constructor
+     * await pasteGG.delete("idHere")
+     */
+    delete(id: string, key?: string): Promise<Output | void>;
+    /**
+     * Update an existing paste.
+     * @see https://github.com/ascclemens/paste/blob/master/api.md#patch-pastesid
+     * @param {string} id The ID for the paste to update.
+     * @param {Update} options The options you wish to update.
+     * @returns {Promise<Output | void>}
+     * @public
+     * @example
+     * await pasteGG.update("idHere", {
+     *   name: "new name", // Optional (if you want to remove the name)
+     *   description: "new description"
+     * })
+     */
+    update(id: string, options: Update): Promise<Output | void>;
+}
+export { PasteGG };
+export default PasteGG;
+/**
+ * The header options
+ * @typedef {IHeader} IHeader
+ * @property {string} [Content-Type] The request content type
+ * @property {string} [Authorization] Authorization for the request
+ */
+/**
+ * @typedef {Options} Options
+ * @property {string} [baseUrl=https://api.paste.gg] The base URL of the API
+ * @property {string} [mainUrl=https://paste.gg] The URL of the main website
+ * @property {number} [version=1] The version of the API
+ */
+/**
+ * @typedef {Result} Result
+ * @property {string} id The ID of the created paste
+ * @property {string} [name] The name of the created paste
+ * @property {string} [url] The URL for the result
+ * @property {Author} [author] The author of the paste
+ * @property {string} [description] The description of the created paste
+ * @property {public | unlisted | private} [visibility=unlisted] The visibility of the created paste
+ * @property {string} created_at The date the paste was created
+ * @property {string} updated_at The date the paste was last updated
+ * @property {string} [expires] The date when the paste expires
+ * @property {File[]} [files] The files used in the created paste
+ * @property {string} [deletion_key] The deletion key of the created paste
+ */
+/**
+ * @typedef {Output} Output
+ * @property {string} status The output status
+ * @property {Result} [result] The result data object
+ * @property {string} [error] The error key
+ * @property {string} [message] The error message
+ */
+/**
+ * @typedef {Post} Post
+ * @property {string} [name] The name of the paste
+ * @property {string} [description] The description of the paste (must be less than 25 KiB)
+ * @property {public | unlisted | private} [visibility=unlisted] The visibility of the paste
+ * @property {string} [expires] The expiration date of the paste (must be a UTC ISO 8601 string)
+ * @property {FileOut[]} files Array of files to add to the paste (at least one file)
+ */
+/**
+ * @typedef {Author} Author
+ * @property {string} [id] The ID of the author
+ * @property {string} [username] The username of the author
+ * @property {string} [name] The name of the author
+ */
+/**
+ * @typedef {Update} Update
+ * @property {string} [name] The new name of the post
+ * @property {string} description The new description of the post
+ */
+/**
+ * @typedef {File} File
+ * @property {string} id The ID of the file
+ * @property {string} name The name of the file
+ * @property {string | null} highlight_language The syntax highlighting language used
+ */
+/**
+ * @typedef {Content} Content
+ * @property {text | base64 | gzip | xz} format The format of the file
+ * @property {string} [highlight_language] The syntax highlighting language to use
+ * @property {string} value The value of the file contents
+ */
+/**
+ * @typedef {FileOut} FileOut
+ * @property {string} [name] The name of the file
+ * @property {Content} content The content of the file
+ */

package/typings/interfaces.d.ts

@@ -0,0 +1,58 @@
+export declare enum Methods {
+    GET = "GET",
+    POST = "POST",
+    DELETE = "DELETE",
+    PATCH = "PATCH"
+}
+export declare type IHeader = {
+    "Content-Type"?: string;
+    Authorization?: string;
+};
+export interface Options {
+    baseUrl: string;
+    mainUrl: string;
+    version: number;
+}
+export interface Result {
+    id: string;
+    name?: string;
+    url?: string;
+    author?: Author;
+    description?: string;
+    visibility?: "public" | "unlisted" | "private";
+    created_at: string;
+    updated_at: string;
+    expires?: string;
+    files?: File[];
+    deletion_key?: string;
+}
+export interface Output {
+    status: string;
+    result?: Result;
+    error?: string;
+    message?: string;
+}
+export interface Author {
+    id?: string;
+    username?: string;
+    name?: string;
+}
+export interface Post extends Pick<Result, "name" | "description" | "visibility" | "expires"> {
+    files: FileOut[];
+}
+export interface Update extends Pick<Result, "name"> {
+    description: string;
+}
+export interface File {
+    id: string;
+    name: string;
+    highlight_language?: string;
+}
+export interface FileOut {
+    name?: string;
+    content: Content;
+}
+export interface Content extends Pick<File, "highlight_language"> {
+    format: "text" | "base64" | "gzip" | "xz";
+    value: string;
+}

package/.idea/codeStyles/Project.xml

@@ -1,28 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <DBN-PSQL>
-      <case-options enabled="true">
-        <option name="KEYWORD_CASE" value="lower" />
-        <option name="FUNCTION_CASE" value="lower" />
-        <option name="PARAMETER_CASE" value="lower" />
-        <option name="DATATYPE_CASE" value="lower" />
-        <option name="OBJECT_CASE" value="preserve" />
-      </case-options>
-      <formatting-settings enabled="false" />
-    </DBN-PSQL>
-    <DBN-SQL>
-      <case-options enabled="true">
-        <option name="KEYWORD_CASE" value="lower" />
-        <option name="FUNCTION_CASE" value="lower" />
-        <option name="PARAMETER_CASE" value="lower" />
-        <option name="DATATYPE_CASE" value="lower" />
-        <option name="OBJECT_CASE" value="preserve" />
-      </case-options>
-      <formatting-settings enabled="false">
-        <option name="STATEMENT_SPACING" value="one_line" />
-        <option name="CLAUSE_CHOP_DOWN" value="chop_down_if_statement_long" />
-        <option name="ITERATION_ELEMENTS_WRAPPING" value="chop_down_if_not_single" />
-      </formatting-settings>
-    </DBN-SQL>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
-  </state>
-</component>