npm - @nerimity/nerimity.js - Versions diffs - 1.11.1 → 1.12.1 - Mend

@nerimity/nerimity.js 1.11.1 → 1.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

package/.eslintrc.js CHANGED Viewed

@@ -4,18 +4,18 @@ module.exports = {
     es2021: true,
     node: true,
   },
-  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
   overrides: [],
-  parser: '@typescript-eslint/parser',
+  parser: "@typescript-eslint/parser",
   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
+    ecmaVersion: "latest",
+    sourceType: "module",
   },
-  plugins: ['@typescript-eslint'],
+  plugins: ["@typescript-eslint"],
   rules: {
-    indent: ['error', 2],
-    'linebreak-style': ['error', 'windows'],
-    quotes: ['error', 'single'],
-    semi: ['error', 'always'],
+    indent: ["error", 2],
+    "linebreak-style": ["error", "windows"],
+    quotes: ["error", "multi"],
+    semi: ["error", "always"],
   },
 };

package/build/RawData.d.ts CHANGED Viewed

@@ -15,6 +15,7 @@ export interface RawBotCommand {
     description: string;
     args: string;
     botUserId: string;
+    permissions?: number;
 }
 export interface MessageButtonClickPayload {
     messageId: string;

package/build/RawData.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"RawData.d.ts","sourceRoot":"","sources":["../src/RawData.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,aAAa,EAAE,eAAe,EAAE,CAAC;IACjC,eAAe,EAAE,GAAG,EAAE,CAAC;IACvB,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,SAAS,EAAE,GAAG,EAAE,CAAC;IACjB,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,KAAK,EAAE,GAAG,EAAE,CAAC;IACb,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;~~CACnB~~;AAED,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,GAAG,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE;QACP,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,WAAW;IACrB,OAAO,IAAI;IACX,WAAW,IAAI;IACf,YAAY,IAAI;IAChB,SAAS,IAAI;IACb,QAAQ,IAAI;CACb;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,WAAW,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,oBAAY,WAAW;IACrB,OAAO,IAAI;IACX,WAAW,IAAI;IACf,QAAQ,IAAI;CACb;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC1B,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,EAAE,CAAC;IACvE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,GAAG,CAAC;IAElB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ"}
1	+ {"version":3,"file":"RawData.d.ts","sourceRoot":"","sources":["../src/RawData.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,aAAa,EAAE,eAAe,EAAE,CAAC;IACjC,eAAe,EAAE,GAAG,EAAE,CAAC;IACvB,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,SAAS,EAAE,GAAG,EAAE,CAAC;IACjB,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,KAAK,EAAE,GAAG,EAAE,CAAC;IACb,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,GAAG,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE;QACP,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,WAAW;IACrB,OAAO,IAAI;IACX,WAAW,IAAI;IACf,YAAY,IAAI;IAChB,SAAS,IAAI;IACb,QAAQ,IAAI;CACb;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,WAAW,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,oBAAY,WAAW;IACrB,OAAO,IAAI;IACX,WAAW,IAAI;IACf,QAAQ,IAAI;CACb;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC1B,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,EAAE,CAAC;IACvE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,GAAG,CAAC;IAElB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ"}

package/build/RawData.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"RawData.js","sourceRoot":"","sources":["../src/RawData.ts"],"names":[],"mappings":";;;~~AA0DA~~,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,2DAAe,CAAA;IACf,6DAAgB,CAAA;IAChB,uDAAa,CAAA;IACb,qDAAY,CAAA;AACd,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AA8BD,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,2DAAe,CAAA;IACf,qDAAY,CAAA;AACd,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB"}
1	+ {"version":3,"file":"RawData.js","sourceRoot":"","sources":["../src/RawData.ts"],"names":[],"mappings":";;;AA2DA,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,2DAAe,CAAA;IACf,6DAAgB,CAAA;IAChB,uDAAa,CAAA;IACb,qDAAY,CAAA;AACd,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AA8BD,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,mDAAW,CAAA;IACX,2DAAe,CAAA;IACf,qDAAY,CAAA;AACd,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB"}

package/build/Webhooks.d.ts ADDED Viewed

@@ -0,0 +1,73 @@
+/**
+ * Options for sending a webhook message.
+ */
+export interface WebhookOptions {
+    /** Message content. */
+    content?: string;
+    /** Username to display. */
+    username?: string;
+    /** Avatar URL to display. */
+    avatarUrl?: string;
+}
+/**
+ * Nerimity.js implementation for sending Nerimity webhooks.
+ */
+export declare class WebhookBuilder {
+    private channelId;
+    private token;
+    private options;
+    /**
+     * Creates a new WebhookBuilder instance.
+     *
+     * @param webhook - The webhook identifier. Can be:
+     *   - Full URL: `"https://nerimity.com/api/webhooks/{channelId}/{token}"`
+     * @param options - Optional webhook message options (content, username, avatarUrl).
+     *
+     * @throws If the webhook format is invalid or missing required fields.
+     */
+    constructor(webhook: string | {
+        channelId: string;
+        token: string;
+    }, options?: WebhookOptions);
+    /**
+     * Parse webhook string format and extract channelId + token.
+     *
+     * @param webhook - Webhook string in one of the accepted formats.
+     * @throws If the string is not a valid webhook format.
+     */
+    private parseWebhookString;
+    /**
+     * Validate message options (content, username, avatarUrl).
+     *
+     * @param options - The options object to validate.
+     * @throws If an option type is invalid.
+     */
+    private validateOptions;
+    /**
+     * Set the username override for the webhook.
+     *
+     * @param username - The custom username.
+     * @returns The current WebhookBuilder instance (for chaining).
+     *
+     * @throws If username is not a string.
+     */
+    setUsername(username: string): this;
+    /**
+     * Set the avatar image for the webhook.
+     *
+     * @param avatarUrl - The avatar image URL.
+     * @returns The current WebhookBuilder instance (for chaining).
+     *
+     * @throws If avatarUrl is not a string.
+     */
+    setAvatar(avatarUrl: string): this;
+    /**
+     * Sends the webhook request to Nerimity's API.
+     *
+     * @returns A Promise resolving with the JSON response from the API.
+     *
+     * @throws If the request fails, is unauthorized, or returns invalid JSON.
+     */
+    send(content: string): Promise<any>;
+}
+//# sourceMappingURL=Webhooks.d.ts.map

package/build/Webhooks.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"Webhooks.d.ts","sourceRoot":"","sources":["../src/Webhooks.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,cAAc;IACvB,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,OAAO,CAAiB;IAEhC;;;;;;;;OAQG;gBAEC,OAAO,EAAE,MAAM,GAAG;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EACtD,OAAO,GAAE,cAAmB;IAgBhC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAOvB;;;;;;;OAOG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM;IAOnC;;;;;;;OAOG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM;IAOlC;;;;;;OAMG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CA8BnD"}

package/build/Webhooks.js ADDED Viewed

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookBuilder = void 0;
+/**
+ * Nerimity.js implementation for sending Nerimity webhooks.
+ */
+class WebhookBuilder {
+    /**
+     * Creates a new WebhookBuilder instance.
+     *
+     * @param webhook - The webhook identifier. Can be:
+     *   - Full URL: `"https://nerimity.com/api/webhooks/{channelId}/{token}"`
+     * @param options - Optional webhook message options (content, username, avatarUrl).
+     *
+     * @throws If the webhook format is invalid or missing required fields.
+     */
+    constructor(webhook, options = {}) {
+        this.channelId = "";
+        this.token = "";
+        this.options = options;
+        if (typeof webhook === "object") {
+            if (!webhook.channelId || !webhook.token)
+                throw new Error("Webhook object must have channelId and token");
+            this.channelId = webhook.channelId;
+            this.token = webhook.token;
+        }
+        else {
+            this.parseWebhookString(webhook);
+        }
+        this.validateOptions(this.options);
+    }
+    /**
+     * Parse webhook string format and extract channelId + token.
+     *
+     * @param webhook - Webhook string in one of the accepted formats.
+     * @throws If the string is not a valid webhook format.
+     */
+    parseWebhookString(webhook) {
+        if (!webhook || typeof webhook !== "string")
+            throw new Error("Webhook must be a non-empty string");
+        if (webhook.startsWith("http")) {
+            const match = webhook.match(/\/webhooks\/(\d+)\/(.+)$/);
+            if (!match)
+                throw new Error(`Invalid webhook URL: ${webhook}`);
+            this.channelId = match[1];
+            this.token = match[2];
+        }
+        else {
+            throw new Error(`Unrecognized webhook format: ${webhook}`);
+        }
+    }
+    /**
+     * Validate message options (content, username, avatarUrl).
+     *
+     * @param options - The options object to validate.
+     * @throws If an option type is invalid.
+     */
+    validateOptions(options) {
+        if (options.username && typeof options.username !== "string")
+            throw new Error("Webhook option 'username' must be a string");
+        if (options.avatarUrl && typeof options.avatarUrl !== "string")
+            throw new Error("Webhook option 'avatarUrl' must be a string");
+    }
+    /**
+     * Set the username override for the webhook.
+     *
+     * @param username - The custom username.
+     * @returns The current WebhookBuilder instance (for chaining).
+     *
+     * @throws If username is not a string.
+     */
+    setUsername(username) {
+        if (typeof username !== "string")
+            throw new Error("Username must be a string");
+        this.options.username = username;
+        return this;
+    }
+    /**
+     * Set the avatar image for the webhook.
+     *
+     * @param avatarUrl - The avatar image URL.
+     * @returns The current WebhookBuilder instance (for chaining).
+     *
+     * @throws If avatarUrl is not a string.
+     */
+    setAvatar(avatarUrl) {
+        if (typeof avatarUrl !== "string")
+            throw new Error("Avatar URL must be a string");
+        this.options.avatarUrl = avatarUrl;
+        return this;
+    }
+    /**
+     * Sends the webhook request to Nerimity's API.
+     *
+     * @returns A Promise resolving with the JSON response from the API.
+     *
+     * @throws If the request fails, is unauthorized, or returns invalid JSON.
+     */
+    async send(content) {
+        const url = `https://nerimity.com/api/webhooks/${this.channelId}/${this.token}`;
+        try {
+            const res = await fetch(url, {
+                method: "POST",
+                headers: { "Content-Type": "application/json" },
+                body: JSON.stringify({ content, ...this.options }),
+            });
+            if (!res.ok) {
+                const body = await res.text().catch(() => "");
+                throw new Error(`HTTP ${res.status} ${res.statusText}${body ? ` - ${body}` : ""}`);
+            }
+            const json = await res.json().catch(() => {
+                throw new Error("Webhook returned invalid JSON");
+            });
+            return json;
+        }
+        catch (err) {
+            throw new Error(`Failed to send webhook: ${err.message}`);
+        }
+    }
+}
+exports.WebhookBuilder = WebhookBuilder;
+//# sourceMappingURL=Webhooks.js.map

package/build/Webhooks.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"Webhooks.js","sourceRoot":"","sources":["../src/Webhooks.ts"],"names":[],"mappings":";;;AAYA;;GAEG;AACH,MAAa,cAAc;IAKvB;;;;;;;;OAQG;IACH,YACI,OAAsD,EACtD,UAA0B,EAAE;QAfxB,cAAS,GAAW,EAAE,CAAC;QACvB,UAAK,GAAW,EAAE,CAAC;QAgBvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK;gBACpC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;YACpE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;YACnC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC/B,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACK,kBAAkB,CAAC,OAAe;QACtC,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;YACvC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAE1D,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;YACxD,IAAI,CAAC,KAAK;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;YAC/D,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,EAAE,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,eAAe,CAAC,OAAuB;QAC3C,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ;YACxD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAClE,IAAI,OAAO,CAAC,SAAS,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ;YAC1D,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACI,WAAW,CAAC,QAAgB;QAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,SAAiB;QAC9B,IAAI,OAAO,SAAS,KAAK,QAAQ;YAC7B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CAAC,OAAe;QAC7B,MAAM,GAAG,GAAG,qCAAqC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAEhF,IAAI,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBACzB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAC,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAC,CAAC;aACnD,CAAC,CAAC;YAEH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACV,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC9C,MAAM,IAAI,KAAK,CACX,QAAQ,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,GAChC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,EAC1B,EAAE,CACL,CAAC;YACN,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;gBACrC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACrD,CAAC,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACX,2BAA2B,GAAG,CAAC,OAAO,EAAE,CAC3C,CAAC;QACN,CAAC;IACL,CAAC;CACJ;AApID,wCAoIC"}

package/build/index.d.ts CHANGED Viewed

@@ -1,4 +1,5 @@
 export { Client, Events } from "./Client";
 export { AttachmentBuilder } from "./Attachment";
 export { RPCClient, EmitPayload } from "./RPCClient";
+export { WebhookBuilder } from "./Webhooks";
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}

package/build/index.js CHANGED Viewed

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RPCClient = exports.AttachmentBuilder = exports.Events = exports.Client = void 0;
+exports.WebhookBuilder = exports.RPCClient = exports.AttachmentBuilder = exports.Events = exports.Client = void 0;
 var Client_1 = require("./Client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return Client_1.Client; } });
 Object.defineProperty(exports, "Events", { enumerable: true, get: function () { return Client_1.Events; } });
@@ -8,4 +8,6 @@ var Attachment_1 = require("./Attachment");
 Object.defineProperty(exports, "AttachmentBuilder", { enumerable: true, get: function () { return Attachment_1.AttachmentBuilder; } });
 var RPCClient_1 = require("./RPCClient");
 Object.defineProperty(exports, "RPCClient", { enumerable: true, get: function () { return RPCClient_1.RPCClient; } });
+var Webhooks_1 = require("./Webhooks");
+Object.defineProperty(exports, "WebhookBuilder", { enumerable: true, get: function () { return Webhooks_1.WebhookBuilder; } });
 //# sourceMappingURL=index.js.map

package/build/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAA0C;AAAjC,gGAAA,MAAM,OAAA;AAAE,gGAAA,MAAM,OAAA;AACvB,2CAAiD;AAAxC,+GAAA,iBAAiB,OAAA;AAC1B,yCAAqD;AAA5C,sGAAA,SAAS,OAAA"}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAA0C;AAAjC,gGAAA,MAAM,OAAA;AAAE,gGAAA,MAAM,OAAA;AACvB,2CAAiD;AAAxC,+GAAA,iBAAiB,OAAA;AAC1B,yCAAqD;AAA5C,sGAAA,SAAS,OAAA;AAClB,uCAA4C;AAAnC,0GAAA,cAAc,OAAA"}

package/examples/webooks.js ADDED Viewed

@@ -0,0 +1,10 @@
+const { WebhookBuilder } = require("../build");
+const webhook = new WebhookBuilder({
+  channelId: "1234",
+  token: "token",
+});
+webhook.setAvatar("https://example.com/avatar.png");
+webhook.setUsername("Test");
+webhook.send("Hello, world!");

package/package.json CHANGED Viewed

@@ -1,37 +1,38 @@
-{
-  "name": "@nerimity/nerimity.js",
-  "version": "1.11.1",
-  "description": "",
-  "main": "build/index.js",
-  "keywords": [],
-  "author": "SupertigerDev",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/node-fetch": "^2.6.12",
-    "@types/ws": "^8.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.0.1",
-    "@typescript-eslint/parser": "^7.0.1",
-    "eslint": "^8.56.0",
-    "nodemon": "^3.0.3",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
-  },
-  "dependencies": {
-    "eventemitter3": "^5.0.1",
-    "node-fetch": "^2.7.0",
-    "socket.io-client": "^4.7.4",
-    "ws": "^8.18.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Nerimity/nerimity.js.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Nerimity/nerimity.js/issues"
-  },
-  "homepage": "https://github.com/Nerimity/nerimity.js#readme",
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc && node tests/test.js"
-  }
-}
+{
+  "name": "@nerimity/nerimity.js",
+  "version": "1.12.1",
+  "description": "",
+  "main": "build/index.js",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "tsc",
+    "dev": "tsc && node tests/test.js"
+  },
+  "keywords": [],
+  "author": "SupertigerDev",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node-fetch": "^2.6.12",
+    "@types/ws": "^8.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.0.1",
+    "@typescript-eslint/parser": "^7.0.1",
+    "eslint": "^8.56.0",
+    "nodemon": "^3.0.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "eventemitter3": "^5.0.1",
+    "node-fetch": "^2.7.0",
+    "socket.io-client": "^4.7.4",
+    "ws": "^8.18.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Nerimity/nerimity.js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Nerimity/nerimity.js/issues"
+  },
+  "homepage": "https://github.com/Nerimity/nerimity.js#readme"
+}

package/src/RawData.ts CHANGED Viewed

@@ -17,6 +17,7 @@ export interface RawBotCommand {
   description: string;
   args: string;
   botUserId: string;
+  permissions?: number;
 }
 export interface MessageButtonClickPayload {

package/src/Webhooks.ts ADDED Viewed

@@ -0,0 +1,148 @@
+/**
+ * Options for sending a webhook message.
+ */
+export interface WebhookOptions {
+    /** Message content. */
+    content?: string;
+    /** Username to display. */
+    username?: string;
+    /** Avatar URL to display. */
+    avatarUrl?: string;
+}
+/**
+ * Nerimity.js implementation for sending Nerimity webhooks.
+ */
+export class WebhookBuilder {
+    private channelId: string = "";
+    private token: string = "";
+    private options: WebhookOptions;
+    /**
+     * Creates a new WebhookBuilder instance.
+     *
+     * @param webhook - The webhook identifier. Can be:
+     *   - Full URL: `"https://nerimity.com/api/webhooks/{channelId}/{token}"`
+     * @param options - Optional webhook message options (content, username, avatarUrl).
+     *
+     * @throws If the webhook format is invalid or missing required fields.
+     */
+    constructor(
+        webhook: string | { channelId: string; token: string },
+        options: WebhookOptions = {}
+    ) {
+        this.options = options;
+        if (typeof webhook === "object") {
+            if (!webhook.channelId || !webhook.token)
+                throw new Error("Webhook object must have channelId and token");
+            this.channelId = webhook.channelId;
+            this.token = webhook.token;
+        } else {
+            this.parseWebhookString(webhook);
+        }
+        this.validateOptions(this.options);
+    }
+    /**
+     * Parse webhook string format and extract channelId + token.
+     *
+     * @param webhook - Webhook string in one of the accepted formats.
+     * @throws If the string is not a valid webhook format.
+     */
+    private parseWebhookString(webhook: string) {
+        if (!webhook || typeof webhook !== "string")
+            throw new Error("Webhook must be a non-empty string");
+        if (webhook.startsWith("http")) {
+            const match = webhook.match(/\/webhooks\/(\d+)\/(.+)$/);
+            if (!match) throw new Error(`Invalid webhook URL: ${webhook}`);
+            this.channelId = match[1];
+            this.token = match[2];
+        } else {
+            throw new Error(`Unrecognized webhook format: ${webhook}`);
+        }
+    }
+    /**
+     * Validate message options (content, username, avatarUrl).
+     *
+     * @param options - The options object to validate.
+     * @throws If an option type is invalid.
+     */
+    private validateOptions(options: WebhookOptions) {
+        if (options.username && typeof options.username !== "string")
+            throw new Error("Webhook option 'username' must be a string");
+        if (options.avatarUrl && typeof options.avatarUrl !== "string")
+            throw new Error("Webhook option 'avatarUrl' must be a string");
+    }
+    /**
+     * Set the username override for the webhook.
+     *
+     * @param username - The custom username.
+     * @returns The current WebhookBuilder instance (for chaining).
+     *
+     * @throws If username is not a string.
+     */
+    public setUsername(username: string) {
+        if (typeof username !== "string")
+            throw new Error("Username must be a string");
+        this.options.username = username;
+        return this;
+    }
+    /**
+     * Set the avatar image for the webhook.
+     *
+     * @param avatarUrl - The avatar image URL.
+     * @returns The current WebhookBuilder instance (for chaining).
+     *
+     * @throws If avatarUrl is not a string.
+     */
+    public setAvatar(avatarUrl: string) {
+        if (typeof avatarUrl !== "string")
+            throw new Error("Avatar URL must be a string");
+        this.options.avatarUrl = avatarUrl;
+        return this;
+    }
+    /**
+     * Sends the webhook request to Nerimity's API.
+     *
+     * @returns A Promise resolving with the JSON response from the API.
+     *
+     * @throws If the request fails, is unauthorized, or returns invalid JSON.
+     */
+    public async send(content: string): Promise<any> {
+        const url = `https://nerimity.com/api/webhooks/${this.channelId}/${this.token}`;
+        try {
+            const res = await fetch(url, {
+                method: "POST",
+                headers: { "Content-Type": "application/json" },
+                body: JSON.stringify({content, ...this.options}),
+            });
+            if (!res.ok) {
+                const body = await res.text().catch(() => "");
+                throw new Error(
+                    `HTTP ${res.status} ${res.statusText}${
+                        body ? ` - ${body}` : ""
+                    }`
+                );
+            }
+            const json = await res.json().catch(() => {
+                throw new Error("Webhook returned invalid JSON");
+            });
+            return json;
+        } catch (err: any) {
+            throw new Error(
+                `Failed to send webhook: ${err.message}`
+            );
+        }
+    }
+}

package/src/index.ts CHANGED Viewed

@@ -1,3 +1,4 @@
 export { Client, Events } from "./Client";
 export { AttachmentBuilder } from "./Attachment";
 export { RPCClient, EmitPayload } from "./RPCClient";
+export { WebhookBuilder } from "./Webhooks";