@digisglobal/omnivox-sdk 0.5.0 → 0.6.1

package/dist/index.cjs

@@ -24,14 +24,19 @@ __export(index_exports, {
   buildPageParams: () => buildPageParams,
   createAgentsModule: () => createAgentsModule,
   createApiKeyTokenProvider: () => createApiKeyTokenProvider,
+  createAttachmentsModule: () => createAttachmentsModule,
   createAuthMeModule: () => createAuthMeModule,
+  createCannedResponsesModule: () => createCannedResponsesModule,
   createChannelsModule: () => createChannelsModule,
   createContactsModule: () => createContactsModule,
   createConversationsModule: () => createConversationsModule,
   createMessagesModule: () => createMessagesModule,
   createOmnivoxClient: () => createOmnivoxClient,
   createSessionTokenProvider: () => createSessionTokenProvider,
+  createTemplatesModule: () => createTemplatesModule,
   createTenantsModule: () => createTenantsModule,
+  createWhatsAppBusinessAccountsModule: () => createWhatsAppBusinessAccountsModule,
+  createWsClient: () => createWsClient,
   iteratePages: () => iteratePages
 });
 module.exports = __toCommonJS(index_exports);
@@ -64,6 +69,11 @@ async function parseResponse(res) {
   }
   return text ? JSON.parse(text) : void 0;
 }
+async function parseEnvelopedResponse(res) {
+  if (NO_BODY_STATUSES.includes(res.status)) return void 0;
+  const envelope = await parseResponse(res);
+  return envelope.data;
+}
 
 // src/auth/auth-me.ts
 function createAuthMeModule(options) {
@@ -163,6 +173,9 @@ var getConversationsControllerListLobbyUrl = (params) => {
 var getConversationsControllerPickupLobbyEntryUrl = (entryId) => {
   return `/api/v1/conversations/lobby/${entryId}/pickup`;
 };
+var getConversationsControllerGetWhatsAppRecoveryOptionsUrl = (id) => {
+  return `/api/v1/conversations/${id}/whatsapp-recovery-options`;
+};
 var getConversationsControllerFindOneUrl = (id) => {
   return `/api/v1/conversations/${id}`;
 };
@@ -179,6 +192,9 @@ var getMessagesControllerListUrl = (params) => {
   const stringifiedParams = normalizedParams.toString();
   return stringifiedParams.length > 0 ? `/api/v1/messages?${stringifiedParams}` : `/api/v1/messages`;
 };
+var getMessagesControllerSendTemplateUrl = () => {
+  return `/api/v1/messages/send-template`;
+};
 var getMessagesControllerGetByIdUrl = (id, params) => {
   const normalizedParams = new URLSearchParams();
   Object.entries(params || {}).forEach(([key, value]) => {
@@ -207,6 +223,12 @@ var getChannelsControllerUpdateUrl = (id, channelId) => {
 var getChannelsControllerVerifyUrl = (id, channelId) => {
   return `/api/v1/tenants/${id}/channels/${channelId}/verify`;
 };
+var getWhatsAppBusinessAccountsControllerListUrl = (id) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts`;
+};
+var getWhatsAppBusinessAccountsControllerFindOneUrl = (id, wabaRowId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaRowId}`;
+};
 var getAgentsControllerCreateUrl = () => {
   return `/api/v1/agents`;
 };
@@ -223,6 +245,68 @@ var getAgentsControllerListUrl = (params) => {
 var getAgentsControllerFindOneUrl = (id) => {
   return `/api/v1/agents/${id}`;
 };
+var getTemplatesControllerAuthorDraftUrl = (id, wabaId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates`;
+};
+var getTemplatesControllerImportApprovedUrl = (id, wabaId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/import`;
+};
+var getTemplatesControllerForkDraftUrl = (id, wabaId, templateId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/${templateId}`;
+};
+var getTemplatesControllerGetHistoryUrl = (id, wabaId, templateId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/${templateId}/history`;
+};
+var getTemplatesControllerSubmitUrl = (id, wabaId, templateId) => {
+  return `/api/v1/tenants/${id}/whatsapp-business-accounts/${wabaId}/templates/${templateId}/submit`;
+};
+var getEmailTemplatesControllerCreateUrl = () => {
+  return `/api/v1/templates/email`;
+};
+var getEmailTemplatesControllerListUrl = (params) => {
+  const normalizedParams = new URLSearchParams();
+  Object.entries(params || {}).forEach(([key, value]) => {
+    if (value !== void 0) {
+      normalizedParams.append(key, value === null ? "null" : String(value));
+    }
+  });
+  const stringifiedParams = normalizedParams.toString();
+  return stringifiedParams.length > 0 ? `/api/v1/templates/email?${stringifiedParams}` : `/api/v1/templates/email`;
+};
+var getEmailTemplatesControllerGetByIdUrl = (id) => {
+  return `/api/v1/templates/email/${id}`;
+};
+var getEmailTemplatesControllerPatchUrl = (id) => {
+  return `/api/v1/templates/email/${id}`;
+};
+var getEmailTemplatesControllerDeleteUrl = (id) => {
+  return `/api/v1/templates/email/${id}`;
+};
+var getCannedResponsesControllerCreateUrl = () => {
+  return `/api/v1/canned-responses`;
+};
+var getCannedResponsesControllerListUrl = (params) => {
+  const normalizedParams = new URLSearchParams();
+  Object.entries(params || {}).forEach(([key, value]) => {
+    if (value !== void 0) {
+      normalizedParams.append(key, value === null ? "null" : String(value));
+    }
+  });
+  const stringifiedParams = normalizedParams.toString();
+  return stringifiedParams.length > 0 ? `/api/v1/canned-responses?${stringifiedParams}` : `/api/v1/canned-responses`;
+};
+var getCannedResponsesControllerPatchUrl = (id) => {
+  return `/api/v1/canned-responses/${id}`;
+};
+var getCannedResponsesControllerDeleteUrl = (id) => {
+  return `/api/v1/canned-responses/${id}`;
+};
+var getAttachmentsControllerUploadUrl = () => {
+  return `/api/v1/attachments`;
+};
+var getAttachmentsControllerGetDownloadUrlUrl = (id) => {
+  return `/api/v1/attachments/${id}/url`;
+};
 
 // src/pagination/pagination.ts
 var MAX_PAGE_SIZE = 100;
@@ -623,6 +707,18 @@ function createConversationsModule(options) {
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("POST", input));
       return parseResponse(res);
+    },
+    /**
+     * List APPROVED + SENDABLE WhatsApp templates eligible to re-open an
+     * expired 24-hour customer-service window for the given conversation.
+     * Returns an empty array when the channel is not WhatsApp or has no linked WABA.
+     * Calls GET /api/v1/conversations/:id/whatsapp-recovery-options.
+     */
+    async whatsappRecoveryOptions(id) {
+      const path = getConversationsControllerGetWhatsAppRecoveryOptionsUrl(id);
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("GET"));
+      return parseResponse(res);
     }
   };
 }
@@ -689,6 +785,415 @@ function createMessagesModule(options) {
       const url = `${baseUrl}${path}`;
       const res = await fetch(url, buildInit("DELETE"));
       await parseResponse(res);
+    },
+    /**
+     * Send a template message in a conversation (WhatsApp or Email).
+     * Branches on the conversation channel type — WhatsApp uses positional
+     * `variables`; Email uses named `emailVariables`.
+     * Calls POST /api/v1/messages/send-template.
+     */
+    async sendTemplate(input) {
+      const path = getMessagesControllerSendTemplateUrl();
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("POST", input));
+      return parseResponse(res);
+    }
+  };
+}
+
+// src/templates/templates.ts
+function createTemplatesModule(options) {
+  const baseUrl = options.baseUrl;
+  function buildInit(method, body) {
+    return {
+      method,
+      credentials: options.getCredentials(),
+      headers: {
+        "Content-Type": "application/json",
+        ...options.getHeaders()
+      },
+      ...body !== void 0 ? { body: JSON.stringify(body) } : {}
+    };
+  }
+  return {
+    /**
+     * WhatsApp template submodule — WABA-scoped operations.
+     */
+    whatsapp: {
+      /**
+       * Author a new DRAFT template (version 1) under a WhatsApp Business Account.
+       * Calls POST /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates.
+       */
+      async authorDraft(tenantId, wabaId, input) {
+        const path = getTemplatesControllerAuthorDraftUrl(tenantId, wabaId);
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("POST", input));
+        return parseEnvelopedResponse(res);
+      },
+      /**
+       * Import all APPROVED templates from the WABA into the system (immediately sendable).
+       * Calls POST /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/import.
+       */
+      async importApproved(tenantId, wabaId) {
+        const path = getTemplatesControllerImportApprovedUrl(tenantId, wabaId);
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("POST"));
+        return parseEnvelopedResponse(res);
+      },
+      /**
+       * Fork a new DRAFT version from the latest version of a template (update).
+       * Calls PATCH /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId.
+       */
+      async update(tenantId, wabaId, templateId, input) {
+        const path = getTemplatesControllerForkDraftUrl(
+          tenantId,
+          wabaId,
+          templateId
+        );
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("PATCH", input));
+        return parseEnvelopedResponse(res);
+      },
+      /**
+       * List all versions and status events for a template in chronological order.
+       * Calls GET /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId/history.
+       */
+      async history(tenantId, wabaId, templateId) {
+        const path = getTemplatesControllerGetHistoryUrl(
+          tenantId,
+          wabaId,
+          templateId
+        );
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("GET"));
+        return parseEnvelopedResponse(res);
+      },
+      /**
+       * Submit a DRAFT template version to Meta for review and approval (DRAFT → PENDING_APPROVAL).
+       * Calls POST /api/v1/tenants/:id/whatsapp-business-accounts/:wabaId/templates/:templateId/submit.
+       */
+      async submit(tenantId, wabaId, templateId) {
+        const path = getTemplatesControllerSubmitUrl(
+          tenantId,
+          wabaId,
+          templateId
+        );
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("POST"));
+        return parseEnvelopedResponse(res);
+      }
+    },
+    /**
+     * Email template submodule — tenant-scoped operations.
+     */
+    email: {
+      /**
+       * Create an Email template for the authenticated tenant.
+       * Calls POST /api/v1/templates/email.
+       */
+      async create(input) {
+        const path = getEmailTemplatesControllerCreateUrl();
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("POST", input));
+        return parseEnvelopedResponse(res);
+      },
+      /**
+       * List Email templates for the authenticated tenant (paginated).
+       * Calls GET /api/v1/templates/email.
+       */
+      async list(opts) {
+        const { page, pageSize } = buildPageParams(opts);
+        const path = getEmailTemplatesControllerListUrl({ page, pageSize });
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("GET"));
+        return parseResponse(res);
+      },
+      /**
+       * Get an Email template by id.
+       * Calls GET /api/v1/templates/email/:id.
+       */
+      async getById(id) {
+        const path = getEmailTemplatesControllerGetByIdUrl(id);
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("GET"));
+        return parseEnvelopedResponse(res);
+      },
+      /**
+       * Partially update an Email template — name, subject, htmlBody, textBody, and/or variableSchema; omitted fields unchanged.
+       * Calls PATCH /api/v1/templates/email/:id.
+       */
+      async patch(id, input) {
+        const path = getEmailTemplatesControllerPatchUrl(id);
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("PATCH", input));
+        return parseEnvelopedResponse(res);
+      },
+      /**
+       * Delete an Email template.
+       * Calls DELETE /api/v1/templates/email/:id.
+       */
+      async delete(id) {
+        const path = getEmailTemplatesControllerDeleteUrl(id);
+        const url = `${baseUrl}${path}`;
+        const res = await fetch(url, buildInit("DELETE"));
+        if (!res.ok) {
+          return parseResponse(res);
+        }
+      }
+    }
+  };
+}
+
+// src/canned-responses/canned-responses.ts
+function createCannedResponsesModule(options) {
+  const baseUrl = options.baseUrl;
+  function buildInit(method, body) {
+    return {
+      method,
+      credentials: options.getCredentials(),
+      headers: {
+        "Content-Type": "application/json",
+        ...options.getHeaders()
+      },
+      ...body !== void 0 ? { body: JSON.stringify(body) } : {}
+    };
+  }
+  return {
+    /**
+     * List canned responses (paginated, no search filter).
+     * pageSize is clamped to 100 per the API contract.
+     * Calls GET /api/v1/canned-responses.
+     */
+    async list(opts) {
+      const { page, pageSize } = buildPageParams(opts);
+      const path = getCannedResponsesControllerListUrl({ page, pageSize });
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("GET"));
+      return parseResponse(res);
+    },
+    /**
+     * Search canned responses by title substring or keyword prefix.
+     * pageSize is clamped to 100 per the API contract.
+     * Calls GET /api/v1/canned-responses?q=<term>.
+     */
+    async search(opts) {
+      const { page, pageSize } = buildPageParams(opts);
+      const path = getCannedResponsesControllerListUrl({
+        page,
+        pageSize,
+        q: opts.q
+      });
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("GET"));
+      return parseResponse(res);
+    },
+    /**
+     * Create a canned response.
+     * Calls POST /api/v1/canned-responses.
+     */
+    async create(input) {
+      const path = getCannedResponsesControllerCreateUrl();
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("POST", input));
+      return parseResponse(res);
+    },
+    /**
+     * Partially update a canned response — title, body, and/or keywords.
+     * Calls PATCH /api/v1/canned-responses/:id.
+     */
+    async update(id, input) {
+      const path = getCannedResponsesControllerPatchUrl(id);
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("PATCH", input));
+      return parseResponse(res);
+    },
+    /**
+     * Delete a canned response by id.
+     * Calls DELETE /api/v1/canned-responses/:id.
+     */
+    async delete(id) {
+      const path = getCannedResponsesControllerDeleteUrl(id);
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("DELETE"));
+      if (!res.ok) {
+        return parseResponse(res);
+      }
+    }
+  };
+}
+
+// src/attachments/attachments.ts
+function createAttachmentsModule(options) {
+  const baseUrl = options.baseUrl;
+  return {
+    /**
+     * Upload a file as a draft attachment.
+     *
+     * Accepts a Blob or File (browser) or a Uint8Array wrapped in a Blob (Node 22+).
+     * Content-Type is intentionally omitted from headers so that fetch (both
+     * Node 22 built-in and browser) can set the multipart/form-data boundary.
+     *
+     * Calls POST /api/v1/attachments.
+     */
+    async upload(file, _opts) {
+      const form = new FormData();
+      const blob = file instanceof Uint8Array ? new Blob([file]) : file;
+      form.append("file", blob);
+      const path = getAttachmentsControllerUploadUrl();
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, {
+        method: "POST",
+        credentials: options.getCredentials(),
+        headers: {
+          // No Content-Type — let fetch set multipart boundary.
+          ...options.getHeaders()
+        },
+        body: form
+      });
+      return parseResponse(res);
+    },
+    /**
+     * Get a short-lived presigned download URL for a stored attachment.
+     * The URL is valid for ≤ 15 minutes (NF-09).
+     *
+     * Calls GET /api/v1/attachments/:id/url.
+     */
+    async url(id) {
+      const path = getAttachmentsControllerGetDownloadUrlUrl(id);
+      const fullUrl = `${baseUrl}${path}`;
+      const res = await fetch(fullUrl, {
+        method: "GET",
+        credentials: options.getCredentials(),
+        headers: {
+          ...options.getHeaders()
+        }
+      });
+      return parseResponse(res);
+    }
+  };
+}
+
+// src/whatsapp-business-accounts/whatsapp-business-accounts.ts
+function createWhatsAppBusinessAccountsModule(options) {
+  const baseUrl = options.baseUrl;
+  function buildInit(method) {
+    return {
+      method,
+      credentials: options.getCredentials(),
+      headers: {
+        "Content-Type": "application/json",
+        ...options.getHeaders()
+      }
+    };
+  }
+  return {
+    /**
+     * List all WhatsApp Business Accounts for the tenant.
+     * Returns a non-secret view — no secretRef is exposed.
+     * Calls GET /api/v1/tenants/:id/whatsapp-business-accounts.
+     *
+     * @example
+     * const wabas = await sdk.whatsappBusinessAccounts.list('ten_acmecorp')
+     * // pick wabas[0].id as the wabaId for sdk.templates.whatsapp.*
+     */
+    async list(tenantId) {
+      const path = getWhatsAppBusinessAccountsControllerListUrl(tenantId);
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("GET"));
+      return parseEnvelopedResponse(res);
+    },
+    /**
+     * Get a single WhatsApp Business Account by its row id.
+     * Returns a non-secret view — no secretRef is exposed.
+     * Calls GET /api/v1/tenants/:id/whatsapp-business-accounts/:wabaRowId.
+     *
+     * @example
+     * const waba = await sdk.whatsappBusinessAccounts.get('ten_acmecorp', 'waba_row_001')
+     */
+    async get(tenantId, wabaRowId) {
+      const path = getWhatsAppBusinessAccountsControllerFindOneUrl(
+        tenantId,
+        wabaRowId
+      );
+      const url = `${baseUrl}${path}`;
+      const res = await fetch(url, buildInit("GET"));
+      return parseEnvelopedResponse(res);
+    }
+  };
+}
+
+// src/ws/ws-client.ts
+var import_socket = require("socket.io-client");
+function createWsClient(options) {
+  const handshakeAuth = options.auth === void 0 ? void 0 : "apiKey" in options.auth ? { apiKey: options.auth.apiKey } : { token: options.auth.token };
+  const ioOptions = {
+    reconnection: true,
+    reconnectionAttempts: Infinity,
+    reconnectionDelay: 1e3,
+    reconnectionDelayMax: 3e4,
+    randomizationFactor: 0.5,
+    withCredentials: options.withCredentials ?? false
+  };
+  if (handshakeAuth !== void 0) {
+    ioOptions.auth = handshakeAuth;
+  }
+  const socket = (0, import_socket.io)(`${options.baseUrl}/ws/chat`, ioOptions);
+  let currentState = "connecting";
+  const stateListeners = /* @__PURE__ */ new Set();
+  function setState(next) {
+    if (next === currentState) return;
+    currentState = next;
+    for (const listener of stateListeners) {
+      listener(next);
+    }
+  }
+  socket.on("connect", () => {
+    setState("connected");
+  });
+  socket.on("disconnect", () => {
+    setState("disconnected");
+  });
+  socket.on("reconnect_attempt", () => {
+    setState("reconnecting");
+  });
+  socket.on("reconnect", () => {
+    setState("connected");
+  });
+  return {
+    get state() {
+      return currentState;
+    },
+    onStateChange(listener) {
+      stateListeners.add(listener);
+      return () => {
+        stateListeners.delete(listener);
+      };
+    },
+    on(event, handler) {
+      const rawHandler = handler;
+      socket.on(event, rawHandler);
+      return () => {
+        ;
+        socket.off(event, rawHandler);
+      };
+    },
+    joinConversation(conversationId) {
+      socket.emit("conversation:join", { conversationId });
+    },
+    leaveConversation(conversationId) {
+      socket.emit("conversation:leave", { conversationId });
+    },
+    typingStart(conversationId) {
+      socket.emit("typing:start", { conversationId });
+    },
+    typingStop(conversationId) {
+      socket.emit("typing:stop", { conversationId });
+    },
+    markRead(conversationId, lastReadMessageId) {
+      socket.emit("message:read", { conversationId, lastReadMessageId });
+    },
+    disconnect() {
+      socket.disconnect();
     }
   };
 }
@@ -707,7 +1212,35 @@ function createOmnivoxClient(options) {
     channels: createChannelsModule(moduleOptions),
     contacts: createContactsModule(moduleOptions),
     conversations: createConversationsModule(moduleOptions),
-    messages: createMessagesModule(moduleOptions)
+    messages: createMessagesModule(moduleOptions),
+    templates: createTemplatesModule(moduleOptions),
+    cannedResponses: createCannedResponsesModule(moduleOptions),
+    attachments: createAttachmentsModule(moduleOptions),
+    whatsappBusinessAccounts: createWhatsAppBusinessAccountsModule(moduleOptions),
+    /**
+     * Creates a WebSocket client connected to the `/ws/chat` namespace.
+     *
+     * Call this factory once and reuse the returned client. Reconnection with
+     * exponential backoff + jitter (cap 30 s) is fully automatic.
+     *
+     * For API-key or token auth, pass the credential explicitly:
+     * @example
+     * const ws = client.connect({ apiKey: 'ovx_live_abc' })
+     * ws.on('message:new', (msg) => console.log(msg))
+     * ws.joinConversation('conv_001')
+     *
+     * For session/cookie auth (Console), call with no argument — the token
+     * provider's `getCredentials() === 'include'` signals cookie mode and
+     * `withCredentials` is set automatically:
+     * @example
+     * const ws = client.connect()
+     * ws.on('message:new', (msg) => console.log(msg))
+     */
+    connect: (auth) => createWsClient({
+      baseUrl: options.baseUrl,
+      ...auth !== void 0 ? { auth } : {},
+      withCredentials: options.tokenProvider.getCredentials() === "include"
+    })
   };
 }
 
@@ -738,13 +1271,18 @@ function createSessionTokenProvider() {
   buildPageParams,
   createAgentsModule,
   createApiKeyTokenProvider,
+  createAttachmentsModule,
   createAuthMeModule,
+  createCannedResponsesModule,
   createChannelsModule,
   createContactsModule,
   createConversationsModule,
   createMessagesModule,
   createOmnivoxClient,
   createSessionTokenProvider,
+  createTemplatesModule,
   createTenantsModule,
+  createWhatsAppBusinessAccountsModule,
+  createWsClient,
   iteratePages
 });