@ethora/sdk-backend 25.1.1

package/dist/config/secrets.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Configuration and secrets management for Ethora SDK
+ *
+ * @format
+ */
+/**
+ * Secrets configuration interface
+ */
+export interface Secrets {
+    /** Base URL for the Ethora chat API */
+    chatApiUrl: string;
+    /** Application ID for the Ethora chat service */
+    chatAppId: string;
+    /** Secret key for JWT token generation */
+    chatAppSecret: string;
+    /** Chatbot JID (optional) */
+    chatBotJid?: string;
+}
+/**
+ * Default timeout configuration
+ */
+export interface TimeoutConfig {
+    /** Total request timeout in milliseconds */
+    total: number;
+    /** Connection timeout in milliseconds */
+    connect: number;
+}
+/**
+ * Default timeout values
+ */
+export declare const DEFAULT_TIMEOUT: TimeoutConfig;
+/**
+ * JID domain for Ethora chat rooms
+ */
+export declare const ETHORA_JID_DOMAIN = "@conference.xmpp.ethoradev.com";
+/**
+ * Gets secrets configuration
+ *
+ * In a real implementation, this would read from environment variables,
+ * a secrets manager, or a configuration file.
+ *
+ * @returns Secrets configuration object
+ * @throws Error if required secrets are not configured
+ */
+export declare function getSecretsSync(): Secrets;
+/**
+ * Gets or creates a singleton instance of secrets
+ *
+ * @returns Secrets configuration object
+ */
+export declare function getSecrets(): Secrets;
+//# sourceMappingURL=secrets.d.ts.map

package/dist/config/secrets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secrets.d.ts","sourceRoot":"","sources":["../../src/config/secrets.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,aAG7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,mCAAmC,CAAC;AAElE;;;;;;;;GAQG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAoBxC;AAOD;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAKpC"}

package/dist/config/secrets.js

@@ -0,0 +1,63 @@
+"use strict";
+/**
+ * Configuration and secrets management for Ethora SDK
+ *
+ * @format
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ETHORA_JID_DOMAIN = exports.DEFAULT_TIMEOUT = void 0;
+exports.getSecretsSync = getSecretsSync;
+exports.getSecrets = getSecrets;
+/**
+ * Default timeout values
+ */
+exports.DEFAULT_TIMEOUT = {
+    total: 30000, // 30 seconds
+    connect: 5000, // 5 seconds
+};
+/**
+ * JID domain for Ethora chat rooms
+ */
+exports.ETHORA_JID_DOMAIN = "@conference.xmpp.ethoradev.com";
+/**
+ * Gets secrets configuration
+ *
+ * In a real implementation, this would read from environment variables,
+ * a secrets manager, or a configuration file.
+ *
+ * @returns Secrets configuration object
+ * @throws Error if required secrets are not configured
+ */
+function getSecretsSync() {
+    const chatApiUrl = process.env.ETHORA_CHAT_API_URL;
+    const chatAppId = process.env.ETHORA_CHAT_APP_ID;
+    const chatAppSecret = process.env.ETHORA_CHAT_APP_SECRET;
+    if (!chatApiUrl || !chatAppId || !chatAppSecret) {
+        throw new Error("Missing required Ethora configuration. Please set the following environment variables:\n" +
+            "- ETHORA_CHAT_API_URL\n" +
+            "- ETHORA_CHAT_APP_ID\n" +
+            "- ETHORA_CHAT_APP_SECRET");
+    }
+    return {
+        chatApiUrl,
+        chatAppId,
+        chatAppSecret,
+        chatBotJid: process.env.ETHORA_CHAT_BOT_JID,
+    };
+}
+/**
+ * Singleton instance of secrets
+ */
+let secretsInstance = null;
+/**
+ * Gets or creates a singleton instance of secrets
+ *
+ * @returns Secrets configuration object
+ */
+function getSecrets() {
+    if (!secretsInstance) {
+        secretsInstance = getSecretsSync();
+    }
+    return secretsInstance;
+}
+//# sourceMappingURL=secrets.js.map

package/dist/config/secrets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secrets.js","sourceRoot":"","sources":["../../src/config/secrets.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAgDH,wCAoBC;AAYD,gCAKC;AA3DD;;GAEG;AACU,QAAA,eAAe,GAAkB;IAC5C,KAAK,EAAE,KAAK,EAAE,aAAa;IAC3B,OAAO,EAAE,IAAI,EAAE,YAAY;CAC5B,CAAC;AAEF;;GAEG;AACU,QAAA,iBAAiB,GAAG,gCAAgC,CAAC;AAElE;;;;;;;;GAQG;AACH,SAAgB,cAAc;IAC5B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IACjD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;IAEzD,IAAI,CAAC,UAAU,IAAI,CAAC,SAAS,IAAI,CAAC,aAAa,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CACb,0FAA0F;YACxF,yBAAyB;YACzB,wBAAwB;YACxB,0BAA0B,CAC7B,CAAC;IACJ,CAAC;IAED,OAAO;QACL,UAAU;QACV,SAAS;QACT,aAAa;QACb,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB;KAC5C,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,IAAI,eAAe,GAAmB,IAAI,CAAC;AAE3C;;;;GAIG;AACH,SAAgB,UAAU;IACxB,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,eAAe,GAAG,cAAc,EAAE,CAAC;IACrC,CAAC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Ethora SDK - Main entry point
+ *
+ * This SDK provides a TypeScript/Node.js implementation for integrating
+ * with the Ethora chat service backend API.
+ *
+ * @format
+ */
+export * from "./types";
+export * from "./config/secrets";
+export * from "./utils/logger";
+export * from "./utils/jwt";
+export { EthoraSDKService, getEthoraSDKService, } from "./repositories/EthoraSDKService";
+export type { ChatRepository } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,cAAc,SAAS,CAAC;AAGxB,cAAc,kBAAkB,CAAC;AAGjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAG5B,OAAO,EACL,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * Ethora SDK - Main entry point
+ *
+ * This SDK provides a TypeScript/Node.js implementation for integrating
+ * with the Ethora chat service backend API.
+ *
+ * @format
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEthoraSDKService = exports.EthoraSDKService = void 0;
+// Export types
+__exportStar(require("./types"), exports);
+// Export configuration
+__exportStar(require("./config/secrets"), exports);
+// Export utilities
+__exportStar(require("./utils/logger"), exports);
+__exportStar(require("./utils/jwt"), exports);
+// Export repositories
+var EthoraSDKService_1 = require("./repositories/EthoraSDKService");
+Object.defineProperty(exports, "EthoraSDKService", { enumerable: true, get: function () { return EthoraSDKService_1.EthoraSDKService; } });
+Object.defineProperty(exports, "getEthoraSDKService", { enumerable: true, get: function () { return EthoraSDKService_1.getEthoraSDKService; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;;;;;;;;;;;;;AAEH,eAAe;AACf,0CAAwB;AAExB,uBAAuB;AACvB,mDAAiC;AAEjC,mBAAmB;AACnB,iDAA+B;AAC/B,8CAA4B;AAE5B,sBAAsB;AACtB,oEAGyC;AAFvC,oHAAA,gBAAgB,OAAA;AAChB,uHAAA,mBAAmB,OAAA"}

package/dist/repositories/EthoraSDKService.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Concrete implementation of the ChatRepository using the Ethora API
+ *
+ * This class handles chat operations in the Ethora chat service. It manages
+ * JWT authentication tokens for server-to-server communication and uses
+ * HTTP clients to make asynchronous API calls.
+ *
+ * @format
+ */
+import type { UUID, ChatRepository, ApiResponse, UpdateUserData, GetUsersQueryParams } from "../types";
+/**
+ * EthoraSDKService - Concrete implementation of ChatRepository
+ */
+export declare class EthoraSDKService implements ChatRepository {
+    private readonly baseEthoraUrl;
+    private readonly secrets;
+    private readonly httpClient;
+    constructor();
+    /**
+     * Generates a fully-qualified chat room JID from a workspace ID
+     *
+     * The JID is constructed in the format `<appId>_<workspace_id>@conference.xmpp.ethoradev.com`.
+     * This method uses a static JID domain to provide a unique identifier for a chat room.
+     *
+     * @param workspaceId - The unique identifier of the workspace
+     * @param full - Whether to include the full JID domain
+     * @returns The fully-qualified JID string for the chat room
+     */
+    createChatName(workspaceId: UUID, full?: boolean): string;
+    /**
+     * Creates a client-side JWT token for a specific user ID
+     *
+     * This method generates a JWT token for a user that can be used for client-side
+     * authentication with the chat service. The token payload includes the
+     * user's ID and the app ID.
+     *
+     * @param userId - The unique identifier of the user
+     * @returns The encoded JWT token for client-side authentication
+     */
+    createChatUserJwtToken(userId: UUID): string;
+    /**
+     * Creates the necessary headers for an API call with a JWT token
+     *
+     * @returns The headers dictionary containing the `x-custom-token` field
+     */
+    private getHeaders;
+    /**
+     * Makes an HTTP request with error handling
+     *
+     * @param config - Axios request configuration
+     * @returns The API response
+     */
+    private makeRequest;
+    /**
+     * Creates a user in the chat service
+     *
+     * Uses the batch API endpoint to create a single user. The API expects:
+     * - bypassEmailConfirmation: true
+     * - usersList: array with user objects containing email, firstName, lastName, password, uuid
+     *
+     * @param userId - The unique identifier of the user (used as uuid)
+     * @param userData - Additional user data (optional) - can include email, firstName, lastName, password, etc.
+     * @returns The API response
+     */
+    createUser(userId: UUID, userData?: Record<string, unknown>): Promise<ApiResponse>;
+    /**
+     * Creates a chat room for a workspace
+     *
+     * @param workspaceId - The unique identifier of the workspace
+     * @param roomData - Additional room data (optional)
+     * @returns The API response
+     */
+    createChatRoom(workspaceId: UUID, roomData?: Record<string, unknown>): Promise<ApiResponse>;
+    /**
+     * Grants a user access to a chat room
+     *
+     * Uses plain userIds without prefixing (matching how users are created)
+     *
+     * @param workspaceId - The unique identifier of the workspace
+     * @param userId - The unique identifier of the user (or array of user IDs)
+     * @returns The API response
+     */
+    grantUserAccessToChatRoom(workspaceId: UUID, userId: UUID | UUID[]): Promise<ApiResponse>;
+    /**
+     * Grants chatbot access to a chat room
+     *
+     * @param workspaceId - The unique identifier of the workspace
+     * @returns The API response
+     */
+    grantChatbotAccessToChatRoom(workspaceId: UUID): Promise<ApiResponse>;
+    /**
+     * Deletes users from the chat service
+     *
+     * @param userIds - Array of user IDs to delete
+     * @returns The API response
+     */
+    deleteUsers(userIds: UUID[]): Promise<ApiResponse>;
+    /**
+     * Deletes a chat room from the chat service by its workspace ID
+     *
+     * This method sends a DELETE request to the Ethora API using the workspace ID
+     * to construct the chat name. It gracefully handles the case where the chat room
+     * is already non-existent (422 Not Found).
+     *
+     * @param workspaceId - The unique identifier of the workspace associated with the chat room
+     * @returns The JSON response from the chat service upon successful deletion or a success status if not found
+     */
+    deleteChatRoom(workspaceId: UUID): Promise<ApiResponse>;
+    /**
+     * Updates multiple users in the chat service
+     *
+     * This method sends a PATCH request to update multiple users at once.
+     * The endpoint accepts an array of user objects with userId and optional
+     * fields. Only provided fields will be updated.
+     *
+     * Limits: 1-100 users per request
+     * Response contains results array with status for each user:
+     * - updated: user was successfully updated (includes updated user data)
+     * - not-found: user was not found
+     * - skipped: user update was skipped
+     *
+     * @param users - Array of user data to update (1-100 users)
+     * @returns The API response with results array containing status for each user
+     */
+    updateUsers(users: UpdateUserData[]): Promise<ApiResponse>;
+    /**
+     * Gets users from the chat service
+     *
+     * This method supports multiple query modes:
+     * - No parameters: returns all users of the app
+     * - chatName parameter: returns all users of the chat
+     *   - For group chats: use appId_uuId format
+     *   - For 1-on-1 chats: use xmppUsernameA-xmppUsernameB format
+     * - xmppUsername parameter: returns a specific user by XMPP username
+     *
+     * @param params - Query parameters for filtering users (optional)
+     * @returns The API response
+     */
+    getUsers(params?: GetUsersQueryParams): Promise<ApiResponse>;
+}
+export declare function getEthoraSDKService(): EthoraSDKService;
+//# sourceMappingURL=EthoraSDKService.d.ts.map

package/dist/repositories/EthoraSDKService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EthoraSDKService.d.ts","sourceRoot":"","sources":["../../src/repositories/EthoraSDKService.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,KAAK,EACV,IAAI,EACJ,cAAc,EACd,WAAW,EAIX,cAAc,EAEd,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAWlB;;GAEG;AACH,qBAAa,gBAAiB,YAAW,cAAc;IACrD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;;IAgB3C;;;;;;;;;OASG;IACH,cAAc,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,GAAE,OAAc,GAAG,MAAM;IAa/D;;;;;;;;;OASG;IACH,sBAAsB,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM;IAK5C;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAOlB;;;;;OAKG;YACW,WAAW;IA4BzB;;;;;;;;;;OAUG;IACG,UAAU,CACd,MAAM,EAAE,IAAI,EACZ,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,OAAO,CAAC,WAAW,CAAC;IA0EvB;;;;;;OAMG;IACG,cAAc,CAClB,WAAW,EAAE,IAAI,EACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,OAAO,CAAC,WAAW,CAAC;IAwBvB;;;;;;;;OAQG;IACG,yBAAyB,CAC7B,WAAW,EAAE,IAAI,EACjB,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,GACpB,OAAO,CAAC,WAAW,CAAC;IA8CvB;;;;;OAKG;IACG,4BAA4B,CAAC,WAAW,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IAoB3E;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;IAkCxD;;;;;;;;;OASG;IACG,cAAc,CAAC,WAAW,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IAgD7D;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;IAkChE;;;;;;;;;;;;OAYG;IACG,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;CA6BnE;AAaD,wBAAgB,mBAAmB,IAAI,gBAAgB,CAMtD"}