@bluecopa/core 0.1.34 → 0.1.36

package/README.md

@@ -57,13 +57,13 @@ The package uses a singleton-based configuration system to manage API settings.
 Import and set the config:
 
 ```typescript
-import { copaSetConfig, copaApi } from '@bluecopa/core';
+import { copaSetConfig, copaApi } from "@bluecopa/core";
 
 copaSetConfig({
-  apiBaseUrl: 'https://develop.bluecopa.com', // Base URL for API endpoints
-  accessToken: 'your-access-token',       // Authentication token
-  workspaceId: 'your-workspace-id',       // Current workspace identifier
-  userId: 'your-user-id'                  // User identifier for WebSocket connections
+  apiBaseUrl: "https://develop.bluecopa.com", // Base URL for API endpoints
+  accessToken: "your-access-token", // Authentication token
+  workspaceId: "your-workspace-id", // Current workspace identifier
+  userId: "your-user-id", // User identifier for WebSocket connections
 });
 ```
 
@@ -72,22 +72,22 @@ copaSetConfig({
 To automatically set the userId from the logged-in user:
 
 ```typescript
-import { copaSetConfig, copaApi } from '@bluecopa/core';
+import { copaSetConfig, copaApi } from "@bluecopa/core";
 
 // First configure basic settings
 copaSetConfig({
-  apiBaseUrl: 'https://develop.bluecopa.com',
-  accessToken: 'your-access-token',
-  workspaceId: 'your-workspace-id'
+  apiBaseUrl: "https://develop.bluecopa.com",
+  accessToken: "your-access-token",
+  workspaceId: "your-workspace-id",
 });
 
 // Get user details and set userId
 try {
   const userDetails = await copaApi.user.getLoggedInUserDetails();
   copaSetConfig({ userId: userDetails.id });
-  console.log('User ID set:', userDetails.id);
+  console.log("User ID set:", userDetails.id);
 } catch (error) {
-  console.error('Failed to get user details:', error);
+  console.error("Failed to get user details:", error);
 }
 ```
 
@@ -183,12 +183,15 @@ The core package provides WebSocket utilities for real-time communication using
 Access WebSocket functionality through the utilities:
 
 ```typescript
-import { copaUtils } from '@bluecopa/core';
+import { copaUtils } from "@bluecopa/core";
 
 // Create a WebSocket connection
-const websocket = copaUtils.websocketUtils.WebsocketContextFactory.create('centrifugo', {
-  connectionUrl: 'wss://your-centrifugo-url'
-});
+const websocket = copaUtils.websocketUtils.WebsocketContextFactory.create(
+  "centrifugo",
+  {
+    connectionUrl: "wss://your-centrifugo-url",
+  },
+);
 ```
 
 ### WebSocket Provider Interface
@@ -204,29 +207,32 @@ The `IWebsocketProvider` interface provides the following methods:
 ### WebSocket Usage Example
 
 ```typescript
-import { copaSetConfig, copaApi, copaUtils } from '@bluecopa/core';
+import { copaSetConfig, copaApi, copaUtils } from "@bluecopa/core";
 
 // Configure with userId for WebSocket connections
 copaSetConfig({
-  apiBaseUrl: 'https://develop.bluecopa.com',
-  accessToken: 'your-access-token',
-  workspaceId: 'your-workspace-id',
-  userId: 'your-user-id'
+  apiBaseUrl: "https://develop.bluecopa.com",
+  accessToken: "your-access-token",
+  workspaceId: "your-workspace-id",
+  userId: "your-user-id",
 });
 
 // Create WebSocket connection
-const websocket = copaUtils.websocketUtils.WebsocketContextFactory.create('centrifugo', {
-  connectionUrl: 'wss://centrifugo.your-domain.com/connection/websocket'
-});
+const websocket = copaUtils.websocketUtils.WebsocketContextFactory.create(
+  "centrifugo",
+  {
+    connectionUrl: "wss://centrifugo.your-domain.com/connection/websocket",
+  },
+);
 
 // Subscribe to user-specific events
-websocket.bind('notifications', 'new_message', (data) => {
-  console.log('New notification:', data);
+websocket.bind("notifications", "new_message", (data) => {
+  console.log("New notification:", data);
 });
 
 // Subscribe to global events
-websocket.bindGlobal('system_updates', (data) => {
-  console.log('System update:', data);
+websocket.bindGlobal("system_updates", (data) => {
+  console.log("System update:", data);
 });
 
 // Clean up when done
@@ -248,32 +254,35 @@ The WebSocket connection automatically uses the configured `accessToken` and `us
 Complete example showing configuration, user details retrieval, and WebSocket setup.
 
 ```typescript
-import { copaSetConfig, copaApi, copaUtils } from '@bluecopa/core';
+import { copaSetConfig, copaApi, copaUtils } from "@bluecopa/core";
 
 // Initial configuration
 copaSetConfig({
-  apiBaseUrl: 'https://develop.bluecopa.com',
-  accessToken: 'your-access-token',
-  workspaceId: 'your-workspace-id'
+  apiBaseUrl: "https://develop.bluecopa.com",
+  accessToken: "your-access-token",
+  workspaceId: "your-workspace-id",
 });
 
 // Get user details and set userId
 try {
   const userDetails = await copaApi.user.getLoggedInUserDetails();
   copaSetConfig({ userId: userDetails.id });
-  console.log('User configured:', userDetails.name, userDetails.id);
+  console.log("User configured:", userDetails.name, userDetails.id);
 } catch (error: any) {
-  console.error('Failed to get user details:', error.message, error.status);
+  console.error("Failed to get user details:", error.message, error.status);
 }
 
 // Set up WebSocket connection
-const websocket = copaUtils.websocketUtils.WebsocketContextFactory.create('centrifugo', {
-  connectionUrl: 'wss://centrifugo.develop.bluecopa.com/connection/websocket'
-});
+const websocket = copaUtils.websocketUtils.WebsocketContextFactory.create(
+  "centrifugo",
+  {
+    connectionUrl: "wss://centrifugo.develop.bluecopa.com/connection/websocket",
+  },
+);
 
 // Subscribe to notifications
-websocket.bind('notifications', 'new_message', (data) => {
-  console.log('New notification received:', data);
+websocket.bind("notifications", "new_message", (data) => {
+  console.log("New notification received:", data);
 });
 ```
 
@@ -282,14 +291,14 @@ websocket.bind('notifications', 'new_message', (data) => {
 Fetches all input tables from the API.
 
 ```typescript
-import { copaApi } from '@bluecopa/core';
+import { copaApi } from "@bluecopa/core";
 
 // Configure first
-copaSetConfig({ 
-  apiBaseUrl: 'https://api.example.com', 
-  accessToken: 'token', 
-  workspaceId: 'ws1',
-  userId: 'user123'
+copaSetConfig({
+  apiBaseUrl: "https://api.example.com",
+  accessToken: "token",
+  workspaceId: "ws1",
+  userId: "user123",
 });
 
 // Use API
@@ -302,11 +311,13 @@ const { getWorkbooksByType } = copaApi.workbook;
 Retrieves workbooks filtered by a specific type.
 
 ```typescript
-import { copaApi } from '@bluecopa/core';
+import { copaApi } from "@bluecopa/core";
 import type { Worksheet } from "$models/gen/Api";
 
 try {
-  const workbooks = await copaApi.workbook.getWorkbooksByType('dashboard' as Worksheet["type"]);
+  const workbooks = await copaApi.workbook.getWorkbooksByType(
+    "dashboard" as Worksheet["type"],
+  );
   console.log(workbooks); // Array of Worksheet
 } catch (error: any) {
   console.error(error.message, error.status);

package/dist/api/audit/getAuditLogs.d.ts

@@ -2,7 +2,7 @@ export interface GetAuditLogsRequest {
     entityType?: string;
     entitySubType?: string;
     entityId?: string;
-    source?: 'UI' | 'BACKEND';
+    source?: "UI" | "BACKEND";
     userId?: string;
     limit: number;
     startDate?: string;

package/dist/api/chat/index.d.ts

@@ -1,8 +1,8 @@
-export { createThread, type CreateThreadRequest, type CreateThreadResponse } from './createThread';
-export { getCommentsByThreadId, type GetCommentsByThreadIdResponse } from './getCommentsByThreadId';
-export { postComment, type PostCommentRequest, type PostCommentResponse } from './postComment';
-export { updateComment, type UpdateCommentRequest, type UpdateCommentResponse } from './updateComment';
+export { createThread, type CreateThreadRequest, type CreateThreadResponse, } from './createThread';
+export { getCommentsByThreadId, type GetCommentsByThreadIdResponse, } from './getCommentsByThreadId';
+export { postComment, type PostCommentRequest, type PostCommentResponse, } from './postComment';
+export { updateComment, type UpdateCommentRequest, type UpdateCommentResponse, } from './updateComment';
 export { deleteComment, type DeleteCommentResponse } from './deleteComment';
-export { subscribeUser, type SubscribeUserRequest, type SubscribeUserResponse } from './subscribeUser';
-export { unsubscribeUser, type UnsubscribeUserRequest, type UnsubscribeUserResponse } from './unsubscribeUser';
-export { checkSubscriptionStatus, type CheckSubscriptionStatusResponse } from './checkSubscriptionStatus';
+export { subscribeUser, type SubscribeUserRequest, type SubscribeUserResponse, } from './subscribeUser';
+export { unsubscribeUser, type UnsubscribeUserRequest, type UnsubscribeUserResponse, } from './unsubscribeUser';
+export { checkSubscriptionStatus, type CheckSubscriptionStatusResponse, } from './checkSubscriptionStatus';

package/dist/api/clientIp/getClientIp.d.ts

@@ -0,0 +1,9 @@
+export interface ClientIpResponse {
+    ip: string;
+}
+/**
+ * Fetches the client's IP address from the server
+ * @returns Promise<ClientIpResponse> The client's IP address
+ * @throws Error if the request fails or user is not authenticated
+ */
+export declare function getClientIp(): Promise<ClientIpResponse>;

package/dist/api/clientIp/index.d.ts

@@ -0,0 +1 @@
+export { getClientIp, type ClientIpResponse } from './getClientIp';

package/dist/api/emailEngine/createConversation.d.ts

@@ -0,0 +1,29 @@
+import { EmailConversation } from './getAllConversations';
+export interface CreateConversationRequest {
+    toEmail: string;
+    subject: string;
+    bodyText: string;
+    bodyHtml?: string;
+    accountId: string;
+    senderId: string;
+    attachments?: {
+        filename: string;
+        content: string;
+        /** snake_case to match backend API contract */
+        content_type: string;
+    }[];
+}
+/**
+ * Creates a new email conversation
+ * @param params - The conversation data
+ * @param params.toEmail - Required: Recipient email address
+ * @param params.subject - Required: Email subject
+ * @param params.bodyText - Required: Plain text body
+ * @param params.bodyHtml - Optional: HTML body
+ * @param params.accountId - Required: Account ID
+ * @param params.senderId - Required: Sender email address
+ * @param params.attachments - Optional: Array of attachments
+ * @returns Promise<EmailConversation> The created conversation
+ * @throws Error if the request fails
+ */
+export declare function createConversation(params: CreateConversationRequest): Promise<EmailConversation>;

package/dist/api/emailEngine/getAllConversations.d.ts

@@ -0,0 +1,23 @@
+export interface EmailConversation {
+    id?: string;
+    toEmail: string;
+    senderId: string;
+    subject: string;
+    bodyText?: string;
+    bodyHtml?: string;
+    status: "AWAITING_RESPONSE" | "RESPONSE_RECEIVED" | "IN_PROGRESS" | "RESOLVED" | "ESCALATED" | "CLOSED";
+    threadId?: string;
+    lastMessageAt?: string;
+    accountId: string;
+    createdBy?: string;
+    createdDate?: string;
+    lastModifiedBy?: string;
+    lastModifiedDate?: string;
+    workspaceId?: string;
+}
+/**
+ * Gets all email conversations
+ * @returns Promise<EmailConversation[]> List of all conversations
+ * @throws Error if the request fails
+ */
+export declare function getAllConversations(): Promise<EmailConversation[]>;

package/dist/api/emailEngine/getConversation.d.ts

@@ -0,0 +1,12 @@
+import { EmailConversation } from './getAllConversations';
+export interface GetConversationRequest {
+    conversationId: string;
+}
+/**
+ * Gets a single email conversation by ID
+ * @param params - The request parameters
+ * @param params.conversationId - Required: The conversation ID
+ * @returns Promise<EmailConversation> The conversation details
+ * @throws Error if the request fails
+ */
+export declare function getConversation(params: GetConversationRequest): Promise<EmailConversation>;

package/dist/api/emailEngine/index.d.ts

@@ -0,0 +1,4 @@
+export * from './getAllConversations';
+export * from './getConversation';
+export * from './createConversation';
+export * from './replyToConversation';

package/dist/api/emailEngine/replyToConversation.d.ts

@@ -0,0 +1,26 @@
+export interface ReplyToConversationRequest {
+    conversationId: string;
+    accountId: string;
+    senderId: string;
+    bodyText: string;
+    bodyHtml?: string;
+    attachments?: {
+        filename: string;
+        content: string;
+        /** snake_case to match backend API contract */
+        content_type: string;
+    }[];
+}
+/**
+ * Replies to an existing email conversation
+ * @param params - The reply parameters
+ * @param params.conversationId - Required: The conversation ID to reply to
+ * @param params.accountId - Required: Account ID
+ * @param params.senderId - Required: Sender email address
+ * @param params.bodyText - Required: Plain text body of the reply
+ * @param params.bodyHtml - Optional: HTML body of the reply
+ * @param params.attachments - Optional: Array of attachments
+ * @returns Promise<any> The reply response
+ * @throws Error if the request fails
+ */
+export declare function replyToConversation(params: ReplyToConversationRequest): Promise<any>;

package/dist/api/file/getFileUrlByFileId.d.ts

@@ -1,7 +1,7 @@
 export interface GetFileUrlRequest {
     key: string;
     contentType: string;
-    method: 'GET' | 'PUT' | 'POST';
+    method: "GET" | "PUT" | "POST";
 }
 export interface GetFileUrlResponse {
     url: string;

package/dist/api/index.d.ts

@@ -17,3 +17,6 @@ export * as audit from './audit';
 export * as templatedPipeline from './templatedPipeline';
 export * as process from './process';
 export * as inboxItems from './inboxItems';
+export * as permissions from './permissions';
+export * as clientIp from './clientIp';
+export * as emailEngine from './emailEngine';

package/dist/api/permissions/getPermissions.d.ts

@@ -0,0 +1,21 @@
+export type GetPermissionsParams = {
+    objectId: string;
+    objectType: string;
+    user: string;
+    userType: "User" | "Team";
+    relations: string[];
+};
+export type PermissionsResponse = Record<string, boolean>;
+/**
+ * Fetches permissions for a user on a given object (e.g. workbook/page).
+ * Used by external apps to gate UI or logic by Owner/Editor/Viewer/ReadOnly.
+ * All parameters are required; no defaults.
+ *
+ * @param params.objectId - Workbook/page ID
+ * @param params.objectType - e.g. 'Portal', 'Workbook', 'ExternalAppPage'
+ * @param params.user - User ID
+ * @param params.userType - 'User' | 'Team'
+ * @param params.relations - e.g. ['Owner', 'Editor', 'Viewer', 'ReadOnly']
+ * @returns Record of role to boolean (e.g. { Owner: false, Editor: true, Viewer: true })
+ */
+export declare function getPermissions(params: GetPermissionsParams): Promise<PermissionsResponse>;

package/dist/api/permissions/index.d.ts

@@ -0,0 +1 @@
+export * from './getPermissions';

package/dist/api/user/index.d.ts

@@ -1,2 +1,2 @@
-export { getLoggedInUserDetails, type UserDetails } from './getLoggedInUserDetails';
+export { getLoggedInUserDetails, type UserDetails, } from './getLoggedInUserDetails';
 export { getAllUsers, type User } from './getAllUsers';

package/dist/index.d.ts

@@ -1,25 +1,31 @@
-export { setConfig as copaSetConfig, getConfig as copaGetConfig } from './config';
+export { setConfig as copaSetConfig, getConfig as copaGetConfig, } from './config';
 export * as copaApi from './api';
 export * as copaUtils from './utils';
 export { default as copaTailwindConfig } from './tailwind/bluecopa.config';
-export type { GetAuditLogsRequest, AuditLogResponse } from './api/audit/getAuditLogs';
-export type { AuditRecord, CreateAuditLogRequest } from './api/audit/createAuditLog';
-export type { TemplatedPipelineWorkflow, GetAllTemplatedPipelinesResponse } from './api/templatedPipeline/getAllTemplatedPipelines';
+export type { GetAuditLogsRequest, AuditLogResponse, } from './api/audit/getAuditLogs';
+export type { AuditRecord, CreateAuditLogRequest, } from './api/audit/createAuditLog';
+export type { TemplatedPipelineWorkflow, GetAllTemplatedPipelinesResponse, } from './api/templatedPipeline/getAllTemplatedPipelines';
 export type { ReconWorkflow } from './api/recon/getAllReconWorkflows';
 export type { RunReconRequest, RunReconResponse } from './api/recon/runRecon';
 export type { GetFormByIdRequest, Form } from './api/form/getFormById';
-export type { CreateOrUpdateFormRequest, CreateOrUpdateFormResponse } from './api/form/createOrUpdateForm';
+export type { CreateOrUpdateFormRequest } from './api/form/createOrUpdateForm';
 export type { GetFormSchemaRequest } from './api/form/getFormSchema';
 export type { GetFormDataRequest } from './api/form/getFormData';
-export type { MarkTaskDoneRequest, MarkTaskDoneResponse, ProcessTask, CompleteTaskRequest } from './api/process/markTaskDone';
-export type { ReassignTaskRequest, ReassignTaskResponse } from './api/process/reassignTask';
-export type { FileUploadRequest, FileUploadResponse } from './api/file/fileUpload';
+export type { MarkTaskDoneRequest, MarkTaskDoneResponse, ProcessTask, CompleteTaskRequest, } from './api/process/markTaskDone';
+export type { ReassignTaskRequest, ReassignTaskResponse, } from './api/process/reassignTask';
+export type { FileUploadRequest, FileUploadResponse, } from './api/file/fileUpload';
 export type { FileDownloadRequest } from './api/file/fileDownload';
-export type { GetFileUrlRequest, GetFileUrlResponse } from './api/file/getFileUrlByFileId';
+export type { GetFileUrlRequest, GetFileUrlResponse, } from './api/file/getFileUrlByFileId';
 export type { User } from './api/user/getAllUsers';
 export type { HttpTrigger } from './api/workflow/getAllHttpTriggers';
 export type { GetRowsOptions, GetRowsResponse } from './api/inputTable/getRows';
 export type { UpdateRowOptions } from './api/inputTable/updateRow';
-export type { GetAllInboxItemsRequest, InboxItem } from './api/inboxItems/getAllInboxItems';
+export type { GetAllInboxItemsRequest, InboxItem, } from './api/inboxItems/getAllInboxItems';
 export type { MarkItemAsReadRequest } from './api/inboxItems/markItemAsRead';
 export type { MarkItemAsUnreadRequest } from './api/inboxItems/markItemAsUnread';
+export type { PermissionsResponse, GetPermissionsParams, } from './api/permissions/getPermissions';
+export type { ClientIpResponse } from './api/clientIp/getClientIp';
+export type { EmailConversation, } from './api/emailEngine/getAllConversations';
+export type { GetConversationRequest, } from './api/emailEngine/getConversation';
+export type { CreateConversationRequest, } from './api/emailEngine/createConversation';
+export type { ReplyToConversationRequest, } from './api/emailEngine/replyToConversation';