@in.pulse-crm/sdk 1.3.2 → 1.3.4

package/dist/file.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { AxiosInstance } from "axios";
 interface UploadFileOptions {
     /**

package/dist/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/socket-server.d.ts

@@ -44,9 +44,15 @@ export type ReportStatusData = {
     id: number;
     type: string;
     progress: number;
-    isCompleted: boolean;
-    isFailed: boolean;
-    error?: string;
+    isCompleted: true;
+    isFailed: false;
+    fileId: number;
+} | {
+    id: number;
+    type: string;
+    isCompleted: false;
+    isFailed: true;
+    error: string;
 };
 /**
  * String representando um QR Code.
@@ -64,6 +70,69 @@ export type SectorId = number;
  * Nome de uma instância.
  */
 export type InstanceName = string;
+/**
+ * Represents a function type for emitting events to specific rooms in a socket server.
+ * This function type supports multiple overloads, each corresponding to a specific
+ * combination of room type, event type, and value type.
+ *
+ * @typedef EmitFunction
+ *
+ * @overload
+ * Emits a `NEW_CHAT` event to a chat or monitor room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, either a `SocketChatRoom` or `SocketMonitorRoom`.
+ * @param event - The event type, `SocketEventType.NEW_CHAT`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `CHAT_FINISHED` event to a chat or monitor room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, either a `SocketChatRoom` or `SocketMonitorRoom`.
+ * @param event - The event type, `SocketEventType.CHAT_FINISHED`.
+ * @param value - The ID of the finished chat.
+ *
+ * @overload
+ * Emits a `QR_CODE` event to an admin room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketAdminRoom`.
+ * @param event - The event type, `SocketEventType.QR_CODE`.
+ * @param value - The QR code data.
+ *
+ * @overload
+ * Emits a `MESSAGE` event to a chat room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketChatRoom`.
+ * @param event - The event type, `SocketEventType.MESSAGE`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `NOTIFICATION` event to an admin room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketAdminRoom`.
+ * @param event - The event type, `SocketEventType.NOTIFICATION`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `MESSAGE_EDIT` event to a chat room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketChatRoom`.
+ * @param event - The event type, `SocketEventType.MESSAGE_EDIT`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `MESSAGE_STATUS` event to a chat room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketChatRoom`.
+ * @param event - The event type, `SocketEventType.MESSAGE_STATUS`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `REPORT_STATUS` event to an admin room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketAdminRoom`.
+ * @param event - The event type, `SocketEventType.REPORT_STATUS`.
+ * @param value - The report status data.
+ */
 export type EmitFunction = {
     (instanceName: string, room: SocketChatRoom | SocketMonitorRoom, event: SocketEventType.NEW_CHAT, value: NotImplemented): void;
     (instanceName: string, room: SocketChatRoom | SocketMonitorRoom, event: SocketEventType.CHAT_FINISHED, value: ChatId): void;
@@ -72,7 +141,7 @@ export type EmitFunction = {
     (instanceName: string, room: SocketAdminRoom, event: SocketEventType.NOTIFICATION, value: NotImplemented): void;
     (instanceName: string, room: SocketChatRoom, event: SocketEventType.MESSAGE_EDIT, value: NotImplemented): void;
     (instanceName: string, room: SocketChatRoom, event: SocketEventType.MESSAGE_STATUS, value: NotImplemented): void;
-    (instanceName: string, room: SocketAdminRoom, event: SocketEventType.REPORT_STATUS, value: ReportStatusData): void;
+    (instanceName: string, room: SocketReportsRoom, event: SocketEventType.REPORT_STATUS, value: ReportStatusData): void;
 };
 /**
  * Classe para manipulação de eventos de socket.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@in.pulse-crm/sdk",
-	"version": "1.3.2",
+	"version": "1.3.4",
 	"description": "SDKs for abstraction of api consumption of in.pulse-crm application",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",

package/src/socket-server.ts

@@ -52,10 +52,16 @@ export type ReportStatusData = {
     id: number;
     type: string;
     progress: number;
-    isCompleted: boolean;
-    isFailed: boolean;
-    error?: string;
-};
+    isCompleted: true;
+    isFailed: false;
+    fileId: number;
+} | {
+    id: number;
+    type: string;
+    isCompleted: false;
+    isFailed: true;
+    error: string;
+}
 
 /**
  * String representando um QR Code.
@@ -77,6 +83,69 @@ export type SectorId = number;
  */
 export type InstanceName = string;
 
+/**
+ * Represents a function type for emitting events to specific rooms in a socket server.
+ * This function type supports multiple overloads, each corresponding to a specific
+ * combination of room type, event type, and value type.
+ *
+ * @typedef EmitFunction
+ *
+ * @overload
+ * Emits a `NEW_CHAT` event to a chat or monitor room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, either a `SocketChatRoom` or `SocketMonitorRoom`.
+ * @param event - The event type, `SocketEventType.NEW_CHAT`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `CHAT_FINISHED` event to a chat or monitor room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, either a `SocketChatRoom` or `SocketMonitorRoom`.
+ * @param event - The event type, `SocketEventType.CHAT_FINISHED`.
+ * @param value - The ID of the finished chat.
+ *
+ * @overload
+ * Emits a `QR_CODE` event to an admin room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketAdminRoom`.
+ * @param event - The event type, `SocketEventType.QR_CODE`.
+ * @param value - The QR code data.
+ *
+ * @overload
+ * Emits a `MESSAGE` event to a chat room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketChatRoom`.
+ * @param event - The event type, `SocketEventType.MESSAGE`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `NOTIFICATION` event to an admin room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketAdminRoom`.
+ * @param event - The event type, `SocketEventType.NOTIFICATION`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `MESSAGE_EDIT` event to a chat room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketChatRoom`.
+ * @param event - The event type, `SocketEventType.MESSAGE_EDIT`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `MESSAGE_STATUS` event to a chat room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketChatRoom`.
+ * @param event - The event type, `SocketEventType.MESSAGE_STATUS`.
+ * @param value - The value associated with the event (type not yet implemented).
+ *
+ * @overload
+ * Emits a `REPORT_STATUS` event to an admin room.
+ * @param instanceName - The name of the instance emitting the event.
+ * @param room - The target room, a `SocketAdminRoom`.
+ * @param event - The event type, `SocketEventType.REPORT_STATUS`.
+ * @param value - The report status data.
+ */
 export type EmitFunction = {
     (
         instanceName: string,
@@ -122,7 +191,7 @@ export type EmitFunction = {
     ): void;
     (
         instanceName: string,
-        room: SocketAdminRoom,
+        room: SocketReportsRoom,
         event: SocketEventType.REPORT_STATUS,
         value: ReportStatusData
     ): void;