@scryme/chat 2.13.3 → 2.13.4

package/dist/sdk.js

@@ -57,11 +57,21 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 import axios from 'axios';
 import { setGlobalToken } from './custom-instance';
 import { getSkyrmeChatAPI } from './generated/v3-server';
+/**
+ * The primary client SDK class for accessing the Scryme Chat platform APIs.
+ * Supports automated OAuth2 Token management and provides clean, type-safe namespaces.
+ */
 var ScrymeSDK = /** @class */ (function () {
+    /**
+     * Constructs a new ScrymeSDK instance.
+     * @param options Configuration options for baseURL, tokens, and credentials.
+     */
     function ScrymeSDK(options) {
         if (options === void 0) { options = {}; }
         var _a;
+        /** The currently cached access token. */
         this.token = null;
+        /** Timestamp in milliseconds indicating when the cached token will expire. */
         this.tokenExpiresAt = null;
         this.clientId = options.clientId;
         this.clientSecret = options.clientSecret;
@@ -77,7 +87,9 @@ var ScrymeSDK = /** @class */ (function () {
             var g = globalThis;
             var env = ((_a = g.process) === null || _a === void 0 ? void 0 : _a.env) || g.__env__ || {};
             var isProd = env.NODE_ENV === 'production' ||
-                (typeof window !== 'undefined' && window.location.hostname !== 'localhost' && window.location.hostname !== '127.0.0.1');
+                (typeof window !== 'undefined' &&
+                    window.location.hostname !== 'localhost' &&
+                    window.location.hostname !== '127.0.0.1');
             url =
                 env.API_URL ||
                     env.NEXT_PUBLIC_API_URL ||
@@ -86,6 +98,10 @@ var ScrymeSDK = /** @class */ (function () {
         }
         this.baseURL = url.replace(/\/$/, '');
     }
+    /**
+     * Synchronizes the authentication token to local storage and the global configuration.
+     * @param token The token to synchronize.
+     */
     ScrymeSDK.prototype.syncToken = function (token) {
         if (!token)
             return;
@@ -97,7 +113,9 @@ var ScrymeSDK = /** @class */ (function () {
         }
     };
     /**
-     * Automatically retrieves or refreshes the M2M OAuth2 Token using client_credentials
+     * Automatically retrieves a cached token, or fetches a new one via M2M OAuth2 Client Credentials
+     * if a clientId and clientSecret are configured.
+     * @returns A promise resolving to the token string, or null if unauthenticated.
      */
     ScrymeSDK.prototype.getOrFetchToken = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -158,7 +176,8 @@ var ScrymeSDK = /** @class */ (function () {
         });
     };
     /**
-     * Gets the axios request config containing authorization and base url
+     * Generates the default request configuration containing the authorization headers and baseURL.
+     * @returns Request configuration object.
      */
     ScrymeSDK.prototype.getRequestConfig = function () {
         return __awaiter(this, void 0, void 0, function () {
@@ -230,67 +249,155 @@ var ScrymeSDK = /** @class */ (function () {
     });
     Object.defineProperty(ScrymeSDK.prototype, "workspace", {
         // --- High-level nested namespace chains for excellent DX ---
+        /**
+         * Operations for managing workspaces, including creation, updating, retrieval,
+         * members, and channels.
+         */
         get: function () {
             var _this = this;
             return {
+                /**
+                 * Lists all workspaces in the authenticated organization context.
+                 * @param options Optional request config override.
+                 * @returns List of workspaces returned exactly from the endpoint.
+                 */
                 list: function (options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.v3WorkspacesControllerGetWorkspaces(options)];
                     });
                 }); },
+                /**
+                 * Retrieves detailed information of a specific workspace by its slug.
+                 * @param slug The unique workspace slug identifier.
+                 * @param options Optional request config override.
+                 * @returns Workspace details returned exactly from the endpoint.
+                 */
                 get: function (slug, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.v3WorkspacesControllerGetWorkspaceBySlug(slug, options)];
                     });
                 }); },
+                /**
+                 * Provisions a new workspace inside the organization.
+                 * @param data Workspace creation and configuration data.
+                 * @param options Optional request config override.
+                 * @returns Provisioned workspace and bot configuration exactly from the endpoint.
+                 */
                 create: function (data, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.v3WorkspacesControllerProvisionWorkspace(data, options)];
                     });
                 }); },
+                /**
+                 * Updates the configurations and metadata of an existing workspace.
+                 * @param slug The unique workspace slug identifier.
+                 * @param data Fields to update.
+                 * @param options Optional request config override.
+                 * @returns The updated workspace details exactly from the endpoint.
+                 */
                 update: function (slug, data, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.v3WorkspacesControllerUpdateWorkspace(slug, data, options)];
                     });
                 }); },
+                /**
+                 * Permanently deletes a specific workspace by its slug.
+                 * @param slug The unique workspace slug identifier.
+                 * @param options Optional request config override.
+                 * @returns Deletion status response exactly from the endpoint.
+                 */
                 delete: function (slug, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.v3WorkspacesControllerDeleteWorkspace(slug, options)];
                     });
                 }); },
+                /**
+                 * Operations for managing workspace members, including listing, adding, role updates, and removal.
+                 */
                 members: {
+                    /**
+                     * Lists all members currently in a workspace.
+                     * @param slug The unique workspace slug identifier.
+                     * @param options Optional request config override.
+                     * @returns List of workspace members exactly from the endpoint.
+                     */
                     list: function (slug, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.v3WorkspacesControllerGetWorkspaceMembers(slug, options)];
                         });
                     }); },
+                    /**
+                     * Adds a new member to the workspace.
+                     * @param slug The unique workspace slug identifier.
+                     * @param data Input DTO containing the user's email and role.
+                     * @param options Optional request config override.
+                     * @returns Newly added member details exactly from the endpoint.
+                     */
                     add: function (slug, data, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.v3WorkspacesControllerAddWorkspaceMember(slug, data, options)];
                         });
                     }); },
+                    /**
+                     * Retrieves membership details of a specific member in a workspace.
+                     * @param slug The unique workspace slug identifier.
+                     * @param memberId Unique ID of the workspace member (user ID).
+                     * @param options Optional request config override.
+                     * @returns Workspace member details exactly from the endpoint.
+                     */
                     get: function (slug, memberId, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.v3WorkspacesControllerGetWorkspaceMember(slug, memberId, options)];
                         });
                     }); },
+                    /**
+                     * Updates the role or configuration of a workspace member.
+                     * @param slug The unique workspace slug identifier.
+                     * @param memberId Unique ID of the workspace member (user ID).
+                     * @param data Update details containing the target role.
+                     * @param options Optional request config override.
+                     * @returns The updated workspace member details exactly from the endpoint.
+                     */
                     update: function (slug, memberId, data, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.v3WorkspacesControllerUpdateWorkspaceMember(slug, memberId, data, options)];
                         });
                     }); },
+                    /**
+                     * Removes a member from the workspace.
+                     * @param slug The unique workspace slug identifier.
+                     * @param memberId Unique ID of the workspace member (user ID).
+                     * @param options Optional request config override.
+                     * @returns Workspace member deletion confirmation exactly from the endpoint.
+                     */
                     delete: function (slug, memberId, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.v3WorkspacesControllerDeleteWorkspaceMember(slug, memberId, options)];
                         });
                     }); },
                 },
+                /**
+                 * Operations for listing and creating channels inside a workspace.
+                 */
                 channels: {
+                    /**
+                     * Lists all public channels (and private channels the user has access to) in a workspace.
+                     * @param slug The unique workspace slug identifier.
+                     * @param options Optional request config override.
+                     * @returns List of channels returned exactly from the endpoint.
+                     */
                     list: function (slug, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.channelsControllerGetWorkspaceChannels(slug, options)];
                         });
                     }); },
+                    /**
+                     * Creates a new channel within a workspace.
+                     * @param slug The unique workspace slug identifier.
+                     * @param data Configuration DTO for the new channel.
+                     * @param options Optional request config override.
+                     * @returns Details of the created channel exactly from the endpoint.
+                     */
                     create: function (slug, data, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.channelsControllerCreateChannel(slug, data, options)];
@@ -303,30 +410,71 @@ var ScrymeSDK = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ScrymeSDK.prototype, "channel", {
+        /**
+         * Operations for managing specific channels and channel message actions.
+         */
         get: function () {
             var _this = this;
             return {
+                /**
+                 * Retrieves detailed information of a specific channel.
+                 * @param slug The unique workspace slug identifier.
+                 * @param channelId Unique identifier of the channel.
+                 * @param options Optional request config override.
+                 * @returns Channel details returned exactly from the endpoint.
+                 */
                 get: function (slug, channelId, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.channelsControllerGetChannel(slug, channelId, options)];
                     });
                 }); },
+                /**
+                 * Updates configuration, description, icon or status of an existing channel.
+                 * @param slug The unique workspace slug identifier.
+                 * @param channelId Unique identifier of the channel.
+                 * @param data Configuration options to update.
+                 * @param options Optional request config override.
+                 * @returns The updated channel details exactly from the endpoint.
+                 */
                 update: function (slug, channelId, data, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.channelsControllerUpdateChannel(slug, channelId, data, options)];
                     });
                 }); },
+                /**
+                 * Permanently deletes a channel from a workspace.
+                 * @param slug The unique workspace slug identifier.
+                 * @param channelId Unique identifier of the channel to delete.
+                 * @param options Optional request config override.
+                 * @returns Success status indicating that the channel was deleted exactly from the endpoint.
+                 */
                 delete: function (slug, channelId, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.channelsControllerDeleteChannel(slug, channelId, options)];
                     });
                 }); },
+                /**
+                 * Sub-namespace for managing messages inside a channel.
+                 */
                 message: {
+                    /**
+                     * Lists messages in a channel with cursor pagination support.
+                     * @param channelId Unique identifier of the channel.
+                     * @param params Query parameters for limiting, sorting, or pagination cursors.
+                     * @param options Optional request config override.
+                     * @returns Object containing the messages array and next pagination cursor exactly from the endpoint.
+                     */
                     list: function (channelId, params, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.channelsControllerGetMessages(channelId, params, options)];
                         });
                     }); },
+                    /**
+                     * Sends a new message to a channel.
+                     * @param channelId Unique identifier of the target channel.
+                     * @param options Optional request config override. Note that standard message data (like text content) can be passed inside options.data.
+                     * @returns The created message exactly from the endpoint.
+                     */
                     create: function (channelId, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.channelsControllerCreateMessage(channelId, options)];
@@ -339,24 +487,58 @@ var ScrymeSDK = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ScrymeSDK.prototype, "message", {
+        /**
+         * Operations for modifying, reacting to, or deleting existing channel messages.
+         */
         get: function () {
             var _this = this;
             return {
+                /**
+                 * Updates the content of a previously sent message.
+                 * @param channelId Unique identifier of the channel containing the message.
+                 * @param messageId Unique identifier of the message to update.
+                 * @param data The new content payload.
+                 * @param options Optional request config override.
+                 * @returns The updated message details exactly from the endpoint.
+                 */
                 update: function (channelId, messageId, data, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.channelsControllerUpdateMessage(channelId, messageId, data, options)];
                     });
                 }); },
+                /**
+                 * Permanently deletes a message.
+                 * @param channelId Unique identifier of the channel containing the message.
+                 * @param messageId Unique identifier of the message to delete.
+                 * @param options Optional request config override.
+                 * @returns Success status indicating that the message was deleted exactly from the endpoint.
+                 */
                 delete: function (channelId, messageId, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.channelsControllerDeleteMessage(channelId, messageId, options)];
                     });
                 }); },
+                /**
+                 * Adds a reaction (emoji) to a message.
+                 * @param channelId Unique identifier of the channel containing the message.
+                 * @param messageId Unique identifier of the message.
+                 * @param data Object containing the target emoji character.
+                 * @param options Optional request config override.
+                 * @returns The reaction response returned exactly from the endpoint.
+                 */
                 addReaction: function (channelId, messageId, data, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.channelsControllerAddReaction(channelId, messageId, data, options)];
                     });
                 }); },
+                /**
+                 * Removes a reaction (emoji) from a message.
+                 * @param channelId Unique identifier of the channel containing the message.
+                 * @param messageId Unique identifier of the message.
+                 * @param emoji The emoji character to remove.
+                 * @param options Optional request config override.
+                 * @returns The reaction removal response returned exactly from the endpoint.
+                 */
                 removeReaction: function (channelId, messageId, emoji, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.channelsControllerRemoveReaction(channelId, messageId, emoji, options)];
@@ -368,35 +550,77 @@ var ScrymeSDK = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ScrymeSDK.prototype, "dm", {
+        /**
+         * Operations for managing direct messages (DMs) and direct message conversations.
+         */
         get: function () {
             var _this = this;
             return {
+                /**
+                 * Lists all active direct message conversations for the authenticated user.
+                 * @param options Optional request config override.
+                 * @returns List of active DM conversations returned exactly from the endpoint.
+                 */
                 list: function (options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.dmsControllerGetDms(options)];
                     });
                 }); },
+                /**
+                 * Creates/initiates a direct message conversation with specified users.
+                 * @param data Create direct message details containing target participant IDs.
+                 * @param options Optional request config override.
+                 * @returns Details of the created DM conversation exactly from the endpoint.
+                 */
                 create: function (data, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.dmsControllerCreateDm(data, options)];
                     });
                 }); },
+                /**
+                 * Retrieves details of a specific direct message conversation.
+                 * @param dmId Unique identifier of the direct message conversation.
+                 * @param options Optional request config override.
+                 * @returns Detailed direct message conversation object exactly from the endpoint.
+                 */
                 get: function (dmId, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.dmsControllerGetDm(dmId, options)];
                     });
                 }); },
+                /**
+                 * Deletes/closes an active direct message conversation.
+                 * @param dmId Unique identifier of the direct message conversation to close.
+                 * @param options Optional request config override.
+                 * @returns Success status indicating that the DM conversation was deleted exactly from the endpoint.
+                 */
                 delete: function (dmId, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.dmsControllerDeleteDm(dmId, options)];
                     });
                 }); },
+                /**
+                 * Sub-namespace for managing direct messages in a specific DM conversation.
+                 */
                 message: {
+                    /**
+                     * Lists messages in a direct message conversation with cursor pagination.
+                     * @param dmId Unique identifier of the direct message conversation.
+                     * @param params Query parameters for pagination limits, cursors or search filters.
+                     * @param options Optional request config override.
+                     * @returns List of direct messages and next pagination cursor exactly from the endpoint.
+                     */
                     list: function (dmId, params, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.dmsControllerGetMessages(dmId, params, options)];
                         });
                     }); },
+                    /**
+                     * Sends a new message in a direct message conversation.
+                     * @param dmId Unique identifier of the direct message conversation.
+                     * @param options Optional request config override. Note that content/attachments can be passed inside options.data.
+                     * @returns The sent message exactly from the endpoint.
+                     */
                     create: function (dmId, options) { return __awaiter(_this, void 0, void 0, function () {
                         return __generator(this, function (_a) {
                             return [2 /*return*/, this.raw.dmsControllerCreateMessage(dmId, options)];
@@ -409,19 +633,40 @@ var ScrymeSDK = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ScrymeSDK.prototype, "user", {
+        /**
+         * Operations for retrieving information about the current user or other user profiles,
+         * as well as performing user searches.
+         */
         get: function () {
             var _this = this;
             return {
+                /**
+                 * Retrieves the profile details of the currently authenticated user.
+                 * @param options Optional request config override.
+                 * @returns The active user's profile returned exactly from the endpoint.
+                 */
                 me: function (options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.usersControllerGetMe(options)];
                     });
                 }); },
+                /**
+                 * Retrieves the public profile of a user by their user ID.
+                 * @param userId Unique identifier of the target user.
+                 * @param options Optional request config override.
+                 * @returns Public user profile returned exactly from the endpoint.
+                 */
                 get: function (userId, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.usersControllerGetUser(userId, options)];
                     });
                 }); },
+                /**
+                 * Searches the organization or workspace directory for user profiles matching specific queries.
+                 * @param params Object containing search filters and query string parameters.
+                 * @param options Optional request config override.
+                 * @returns List of matching user profiles returned exactly from the endpoint.
+                 */
                 search: function (params, options) { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
                         return [2 /*return*/, this.raw.usersControllerSearchUsers(params, options)];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scryme/chat",
-  "version": "2.13.3",
+  "version": "2.13.4",
   "private": false,
   "publishConfig": {
     "access": "public"