novaapp-sdk 1.0.9 → 1.0.10

package/dist/index.d.mts

@@ -498,7 +498,8 @@ declare class ServersAPI {
 
 declare class InteractionsAPI {
     private readonly http;
-    constructor(http: HttpClient);
+    private readonly emitter;
+    constructor(http: HttpClient, emitter: EventEmitter);
     /**
      * Acknowledge an interaction without sending a visible response.
      * Shows a loading state to the user. You must follow up with `respond()`.
@@ -538,6 +539,47 @@ declare class InteractionsAPI {
      * }
      */
     poll(options?: PollInteractionsOptions): Promise<Interaction[]>;
+    /**
+     * Open a modal for the user who triggered an interaction and await their submission.
+     *
+     * Internally this:
+     *  1. Calls `respond(interactionId, { modal })` to push the modal to the client UI.
+     *  2. Listens for the next `interactionCreate` event whose type is `MODAL_SUBMIT`
+     *     and whose `customId` matches your modal's `customId`.
+     *  3. Resolves with the submitted `Interaction` (containing `modalData`), or `null`
+     *     if the user closes the modal without submitting within the timeout.
+     *
+     * @param interactionId - ID of the triggering interaction.
+     * @param modal         - Modal definition (title, customId, fields).
+     * @param options.timeout - Max milliseconds to wait (default: 300 000 = 5 min).
+     *
+     * @example
+     * client.on('interactionCreate', async (interaction) => {
+     *   if (interaction.commandName === 'report') {
+     *     const submitted = await client.interactions.awaitModal(interaction.id, {
+     *       title: 'Submit a report',
+     *       customId: 'report_modal',
+     *       fields: [
+     *         { customId: 'reason', label: 'Reason', type: 'paragraph', required: true, maxLength: 500 },
+     *       ],
+     *     })
+     *
+     *     if (!submitted) {
+     *       // User dismissed the modal or timed out — nothing to do
+     *       return
+     *     }
+     *
+     *     const reason = submitted.modalData?.reason
+     *     await client.interactions.respond(submitted.id, {
+     *       content: `Report received: ${reason}`,
+     *       ephemeral: true,
+     *     })
+     *   }
+     * })
+     */
+    awaitModal(interactionId: string, modal: BotModalDefinition, options?: {
+        timeout?: number;
+    }): Promise<Interaction | null>;
 }
 
 declare class PermissionsAPI {

package/dist/index.d.ts

@@ -498,7 +498,8 @@ declare class ServersAPI {
 
 declare class InteractionsAPI {
     private readonly http;
-    constructor(http: HttpClient);
+    private readonly emitter;
+    constructor(http: HttpClient, emitter: EventEmitter);
     /**
      * Acknowledge an interaction without sending a visible response.
      * Shows a loading state to the user. You must follow up with `respond()`.
@@ -538,6 +539,47 @@ declare class InteractionsAPI {
      * }
      */
     poll(options?: PollInteractionsOptions): Promise<Interaction[]>;
+    /**
+     * Open a modal for the user who triggered an interaction and await their submission.
+     *
+     * Internally this:
+     *  1. Calls `respond(interactionId, { modal })` to push the modal to the client UI.
+     *  2. Listens for the next `interactionCreate` event whose type is `MODAL_SUBMIT`
+     *     and whose `customId` matches your modal's `customId`.
+     *  3. Resolves with the submitted `Interaction` (containing `modalData`), or `null`
+     *     if the user closes the modal without submitting within the timeout.
+     *
+     * @param interactionId - ID of the triggering interaction.
+     * @param modal         - Modal definition (title, customId, fields).
+     * @param options.timeout - Max milliseconds to wait (default: 300 000 = 5 min).
+     *
+     * @example
+     * client.on('interactionCreate', async (interaction) => {
+     *   if (interaction.commandName === 'report') {
+     *     const submitted = await client.interactions.awaitModal(interaction.id, {
+     *       title: 'Submit a report',
+     *       customId: 'report_modal',
+     *       fields: [
+     *         { customId: 'reason', label: 'Reason', type: 'paragraph', required: true, maxLength: 500 },
+     *       ],
+     *     })
+     *
+     *     if (!submitted) {
+     *       // User dismissed the modal or timed out — nothing to do
+     *       return
+     *     }
+     *
+     *     const reason = submitted.modalData?.reason
+     *     await client.interactions.respond(submitted.id, {
+     *       content: `Report received: ${reason}`,
+     *       ephemeral: true,
+     *     })
+     *   }
+     * })
+     */
+    awaitModal(interactionId: string, modal: BotModalDefinition, options?: {
+        timeout?: number;
+    }): Promise<Interaction | null>;
 }
 
 declare class PermissionsAPI {

package/dist/index.js

@@ -273,8 +273,9 @@ var ServersAPI = class {
 
 // src/api/interactions.ts
 var InteractionsAPI = class {
-  constructor(http) {
+  constructor(http, emitter) {
     this.http = http;
+    this.emitter = emitter;
   }
   /**
    * Acknowledge an interaction without sending a visible response.
@@ -323,6 +324,71 @@ var InteractionsAPI = class {
     const qs = params.toString();
     return this.http.get(`/interactions${qs ? `?${qs}` : ""}`);
   }
+  /**
+   * Open a modal for the user who triggered an interaction and await their submission.
+   *
+   * Internally this:
+   *  1. Calls `respond(interactionId, { modal })` to push the modal to the client UI.
+   *  2. Listens for the next `interactionCreate` event whose type is `MODAL_SUBMIT`
+   *     and whose `customId` matches your modal's `customId`.
+   *  3. Resolves with the submitted `Interaction` (containing `modalData`), or `null`
+   *     if the user closes the modal without submitting within the timeout.
+   *
+   * @param interactionId - ID of the triggering interaction.
+   * @param modal         - Modal definition (title, customId, fields).
+   * @param options.timeout - Max milliseconds to wait (default: 300 000 = 5 min).
+   *
+   * @example
+   * client.on('interactionCreate', async (interaction) => {
+   *   if (interaction.commandName === 'report') {
+   *     const submitted = await client.interactions.awaitModal(interaction.id, {
+   *       title: 'Submit a report',
+   *       customId: 'report_modal',
+   *       fields: [
+   *         { customId: 'reason', label: 'Reason', type: 'paragraph', required: true, maxLength: 500 },
+   *       ],
+   *     })
+   *
+   *     if (!submitted) {
+   *       // User dismissed the modal or timed out — nothing to do
+   *       return
+   *     }
+   *
+   *     const reason = submitted.modalData?.reason
+   *     await client.interactions.respond(submitted.id, {
+   *       content: `Report received: ${reason}`,
+   *       ephemeral: true,
+   *     })
+   *   }
+   * })
+   */
+  awaitModal(interactionId, modal, options = {}) {
+    const ms = options.timeout ?? 3e5;
+    let listener = null;
+    let timer = null;
+    const waitPromise = new Promise((resolve) => {
+      timer = setTimeout(() => {
+        if (listener) this.emitter.off("interactionCreate", listener);
+        resolve(null);
+      }, ms);
+      listener = (interaction) => {
+        if (interaction.type === "MODAL_SUBMIT" && interaction.customId === modal.customId) {
+          if (timer) clearTimeout(timer);
+          if (listener) this.emitter.off("interactionCreate", listener);
+          resolve(interaction);
+        }
+      };
+      this.emitter.on("interactionCreate", listener);
+    });
+    return this.respond(interactionId, { modal }).then(
+      () => waitPromise,
+      (err) => {
+        if (timer) clearTimeout(timer);
+        if (listener) this.emitter.off("interactionCreate", listener);
+        return Promise.reject(err);
+      }
+    );
+  }
 };
 
 // src/api/permissions.ts
@@ -401,7 +467,7 @@ var NovaClient = class extends import_node_events.EventEmitter {
     this.commands = new CommandsAPI(this.http);
     this.members = new MembersAPI(this.http);
     this.servers = new ServersAPI(this.http);
-    this.interactions = new InteractionsAPI(this.http);
+    this.interactions = new InteractionsAPI(this.http, this);
     this.permissions = new PermissionsAPI(this.http);
     this.on("error", () => {
     });

package/dist/index.mjs

@@ -240,8 +240,9 @@ var ServersAPI = class {
 
 // src/api/interactions.ts
 var InteractionsAPI = class {
-  constructor(http) {
+  constructor(http, emitter) {
     this.http = http;
+    this.emitter = emitter;
   }
   /**
    * Acknowledge an interaction without sending a visible response.
@@ -290,6 +291,71 @@ var InteractionsAPI = class {
     const qs = params.toString();
     return this.http.get(`/interactions${qs ? `?${qs}` : ""}`);
   }
+  /**
+   * Open a modal for the user who triggered an interaction and await their submission.
+   *
+   * Internally this:
+   *  1. Calls `respond(interactionId, { modal })` to push the modal to the client UI.
+   *  2. Listens for the next `interactionCreate` event whose type is `MODAL_SUBMIT`
+   *     and whose `customId` matches your modal's `customId`.
+   *  3. Resolves with the submitted `Interaction` (containing `modalData`), or `null`
+   *     if the user closes the modal without submitting within the timeout.
+   *
+   * @param interactionId - ID of the triggering interaction.
+   * @param modal         - Modal definition (title, customId, fields).
+   * @param options.timeout - Max milliseconds to wait (default: 300 000 = 5 min).
+   *
+   * @example
+   * client.on('interactionCreate', async (interaction) => {
+   *   if (interaction.commandName === 'report') {
+   *     const submitted = await client.interactions.awaitModal(interaction.id, {
+   *       title: 'Submit a report',
+   *       customId: 'report_modal',
+   *       fields: [
+   *         { customId: 'reason', label: 'Reason', type: 'paragraph', required: true, maxLength: 500 },
+   *       ],
+   *     })
+   *
+   *     if (!submitted) {
+   *       // User dismissed the modal or timed out — nothing to do
+   *       return
+   *     }
+   *
+   *     const reason = submitted.modalData?.reason
+   *     await client.interactions.respond(submitted.id, {
+   *       content: `Report received: ${reason}`,
+   *       ephemeral: true,
+   *     })
+   *   }
+   * })
+   */
+  awaitModal(interactionId, modal, options = {}) {
+    const ms = options.timeout ?? 3e5;
+    let listener = null;
+    let timer = null;
+    const waitPromise = new Promise((resolve) => {
+      timer = setTimeout(() => {
+        if (listener) this.emitter.off("interactionCreate", listener);
+        resolve(null);
+      }, ms);
+      listener = (interaction) => {
+        if (interaction.type === "MODAL_SUBMIT" && interaction.customId === modal.customId) {
+          if (timer) clearTimeout(timer);
+          if (listener) this.emitter.off("interactionCreate", listener);
+          resolve(interaction);
+        }
+      };
+      this.emitter.on("interactionCreate", listener);
+    });
+    return this.respond(interactionId, { modal }).then(
+      () => waitPromise,
+      (err) => {
+        if (timer) clearTimeout(timer);
+        if (listener) this.emitter.off("interactionCreate", listener);
+        return Promise.reject(err);
+      }
+    );
+  }
 };
 
 // src/api/permissions.ts
@@ -368,7 +434,7 @@ var NovaClient = class extends EventEmitter {
     this.commands = new CommandsAPI(this.http);
     this.members = new MembersAPI(this.http);
     this.servers = new ServersAPI(this.http);
-    this.interactions = new InteractionsAPI(this.http);
+    this.interactions = new InteractionsAPI(this.http, this);
     this.permissions = new PermissionsAPI(this.http);
     this.on("error", () => {
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "novaapp-sdk",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Official SDK for building bots on the Nova platform",
   "main": "dist/index.js",
   "module": "dist/index.mjs",