@bluecopa/core 0.1.77 → 0.1.78

package/README.md

@@ -11,12 +11,27 @@ The core package provides essential API utilities and functions for data managem
   - [Requirements](#requirements)
   - [Configuration](#configuration)
   - [API Reference](#api-reference)
+    - [Audit Module](#audit-module)
+    - [Chat Module](#chat-module)
+    - [ClientIp Module](#clientip-module)
     - [Dataset Module](#dataset-module)
     - [Definition Module](#definition-module)
+    - [EmailEngine Module](#emailengine-module)
     - [File Module](#file-module)
+    - [Form Module](#form-module)
+    - [InboxItems Module](#inboxitems-module)
     - [InputTable Module](#inputtable-module)
     - [Metric Module](#metric-module)
+    - [Permissions Module](#permissions-module)
+    - [Process Module](#process-module)
+    - [Recon Module](#recon-module)
+    - [Statement Module](#statement-module)
+    - [Task Module](#task-module)
+    - [TemplatedPipeline Module](#templatedpipeline-module)
+    - [Templates Module](#templates-module)
+    - [Tcn Module](#tcn-module)
     - [User Module](#user-module)
+    - [Webcron Module](#webcron-module)
     - [Workbook Module](#workbook-module)
     - [Workflow Module](#workflow-module)
     - [Worksheet Module](#worksheet-module)
@@ -120,13 +135,39 @@ export interface Config {
 
 All API functions are asynchronous and use the shared `apiClient` for HTTP requests. They handle errors by throwing objects with `message` and `status`. Access via `copaApi.moduleName.functionName()`.
 
+### Audit Module
+
+- `copaApi.audit.createAuditLog()`: Records an audit log entry
+- `copaApi.audit.getAuditLogs()`: Retrieves audit log entries
+
+See: [`audit/createAuditLog.ts`](src/api/audit/createAuditLog.ts), [`audit/getAuditLogs.ts`](src/api/audit/getAuditLogs.ts)
+
+### Chat Module
+
+- `copaApi.chat.checkSubscriptionStatus()`: Checks whether the user is subscribed to chat updates
+- `copaApi.chat.createThread()`: Creates a new chat thread
+- `copaApi.chat.getCommentsByThreadId()`: Lists comments in a thread
+- `copaApi.chat.postComment()`: Posts a comment to a thread
+- `copaApi.chat.updateComment()`: Updates an existing comment
+- `copaApi.chat.deleteComment()`: Deletes a comment
+- `copaApi.chat.subscribeUser()`: Subscribes a user to chat updates
+- `copaApi.chat.unsubscribeUser()`: Unsubscribes a user from chat updates
+
+See: [`chat/`](src/api/chat:1)
+
+### ClientIp Module
+
+- `copaApi.clientIp.getClientIp()`: Returns the caller's client IP
+
+See: [`clientIp/getClientIp.ts`](src/api/clientIp/getClientIp.ts)
+
 ### Dataset Module
 
 - `copaApi.dataset.getData()`: Retrieves specific dataset data by ID or parameters
 - `copaApi.dataset.getDatasets()`: Fetches a list of datasets
 - `copaApi.dataset.getSampleData()`: Gets sample data for datasets
 
-See: [`dataset/getData.ts`](src/api/dataset/getData.ts:1), [`dataset/getSampleData.ts`](src/api/dataset/getSampleData.ts:1), [`dataset/getDatasets.ts`](src/api/dataset/getDatasets.ts:1)
+See: [`dataset/getData.ts`](src/api/dataset/getData.ts), [`dataset/getSampleData.ts`](src/api/dataset/getSampleData.ts), [`dataset/getDatasets.ts`](src/api/dataset/getDatasets.ts)
 
 ### Definition Module
 
@@ -134,55 +175,193 @@ See: [`dataset/getData.ts`](src/api/dataset/getData.ts:1), [`dataset/getSampleDa
 - `copaApi.definition.runPublishedDefinition()`: Runs a published definition
 - `copaApi.definition.runSampleDefinition()`: Executes a sample definition for testing
 
-See: [`definition/runPublishedDefinition.ts`](src/api/definition/runPublishedDefinition.ts:1), [`definition/runSampleDefinition.ts`](src/api/definition/runSampleDefinition.ts:1), [`definition/runDefinition.ts`](src/api/definition/runDefinition.ts:1)
+See: [`definition/runPublishedDefinition.ts`](src/api/definition/runPublishedDefinition.ts), [`definition/runSampleDefinition.ts`](src/api/definition/runSampleDefinition.ts), [`definition/runDefinition.ts`](src/api/definition/runDefinition.ts)
+
+### EmailEngine Module
+
+- `copaApi.emailEngine.getAllConversations()`: Lists email conversations (paginated)
+- `copaApi.emailEngine.getConversation()`: Fetches a single conversation
+- `copaApi.emailEngine.createConversation()`: Creates a new conversation
+- `copaApi.emailEngine.replyToConversation()`: Sends a reply on a conversation
+- `copaApi.emailEngine.getMessageBySenderId()`: Retrieves messages filtered by sender id
+
+See: [`emailEngine/`](src/api/emailEngine:1)
 
 ### File Module
 
 - `copaApi.files.getFileUrlByFileId(fileId: string)`: Generates a URL for a file by its ID
+- `copaApi.files.fileUpload({ data, contentType, method, uploadType })`: Uploads data and returns a file id/path
+- `copaApi.files.fileDownload({ fileId })`: Downloads a file by id
+- `copaApi.files.getFileByFolderIdAndName({ folderId, name })`: Fetches a filebox file by its parent folder and name
+
+See: [`file/getFileUrlByFileId.ts`](src/api/file/getFileUrlByFileId.ts), [`file/fileUpload.ts`](src/api/file/fileUpload.ts), [`file/fileDownload.ts`](src/api/file/fileDownload.ts), [`file/getFileByFolderIdAndName.ts`](src/api/file/getFileByFolderIdAndName.ts)
 
-See: [`file/getFileUrlByFileId.ts`](src/api/file/getFileUrlByFileId.ts:1)
+### Form Module
+
+- `copaApi.form.getFormById()`: Fetches a form by id
+- `copaApi.form.getFormSchema()`: Retrieves a form's schema
+- `copaApi.form.getFormData()`: Retrieves submitted form data
+- `copaApi.form.createOrUpdateForm()`: Creates or updates a form definition
+
+See: [`form/`](src/api/form:1)
+
+### InboxItems Module
+
+- `copaApi.inboxItems.getAllInboxItems()`: Lists inbox items
+- `copaApi.inboxItems.createInboxItemPerUser()`: Creates an inbox item for a specific user
+- `copaApi.inboxItems.markItemAsRead()`: Marks an inbox item as read
+- `copaApi.inboxItems.markItemAsUnread()`: Marks an inbox item as unread
+
+See: [`inboxItems/`](src/api/inboxItems:1)
 
 ### InputTable Module
 
 - `copaApi.inputTable.getData()`: Retrieves data from an input table
 - `copaApi.inputTable.getInputTables()`: Fetches all input tables
 - `copaApi.inputTable.getTableById(id: string)`: Gets a specific input table by ID
+- `copaApi.inputTable.getRows(options)`: Reads rows from an input table view (filters, paging, sorting)
+- `copaApi.inputTable.insertRow(options)`: Inserts a new row
+- `copaApi.inputTable.updateRow(options)`: Updates an existing row
+- `copaApi.inputTable.deleteRow(options)`: Deletes a row
 
-See: [`inputTable/getData.ts`](src/api/inputTable/getData.ts:1), [`inputTable/getInputTables.ts`](src/api/inputTable/getInputTables.ts:1), [`inputTable/getTableById.ts`](src/api/inputTable/getTableById.ts:1)
+See: [`inputTable/getData.ts`](src/api/inputTable/getData.ts), [`inputTable/getInputTables.ts`](src/api/inputTable/getInputTables.ts), [`inputTable/getTableById.ts`](src/api/inputTable/getTableById.ts), [`inputTable/getRows.ts`](src/api/inputTable/getRows.ts), [`inputTable/insertRow.ts`](src/api/inputTable/insertRow.ts), [`inputTable/updateRow.ts`](src/api/inputTable/updateRow.ts), [`inputTable/deleteRow.ts`](src/api/inputTable/deleteRow.ts)
 
 ### Metric Module
 
 - `copaApi.metric.getData()`: Fetches metric data
 
-See: [`metric/getData.ts`](src/api/metric/getData.ts:1)
+See: [`metric/getData.ts`](src/api/metric/getData.ts)
+
+### Permissions Module
+
+- `copaApi.permissions.getPermissions()`: Retrieves permissions for the current user / context
+
+See: [`permissions/getPermissions.ts`](src/api/permissions/getPermissions.ts)
+
+### Process Module
+
+- `copaApi.process.markTaskDone()`: Marks a process task as done
+- `copaApi.process.reassignTask()`: Reassigns a process task to a different user
+- `copaApi.process.getTriggersBySheet()`: Lists triggers associated with a sheet
+- `copaApi.process.registerProcessTrigger()`: Registers a new process trigger
+- `copaApi.process.deleteProcessTrigger()`: Deletes a process trigger
+
+See: [`process/`](src/api/process:1)
+
+### Recon Module
+
+- `copaApi.recon.runRecon()`: Triggers a recon workflow run
+- `copaApi.recon.getAllReconWorkflows()`: Lists all recon workflows
+
+See: [`recon/runRecon.ts`](src/api/recon/runRecon.ts), [`recon/getAllReconWorkflows.ts`](src/api/recon/getAllReconWorkflows.ts)
+
+### Statement Module
+
+- `copaApi.statement.getData()`: Retrieves statement data
+- `copaApi.statement.getViewsBySheetId()`: Lists statement views for a sheet
+- `copaApi.statement.getViewById()`: Fetches a single statement view
+- `copaApi.statement.getRunsByViewId()`: Lists runs for a given view
+- `copaApi.statement.createNewRun()`: Creates a new statement run
+- `copaApi.statement.getRunResultById()`: Fetches the result of a given run
+
+See: [`statement/`](src/api/statement:1)
+
+### Task Module
+
+- `copaApi.task.getTaskDetails()`: Fetches detailed information about a task
+
+See: [`task/getTaskDetails.ts`](src/api/task/getTaskDetails.ts)
+
+### TemplatedPipeline Module
+
+- `copaApi.templatedPipeline.getAllTemplatedPipelines()`: Lists all templated pipelines
+
+See: [`templatedPipeline/getAllTemplatedPipelines.ts`](src/api/templatedPipeline/getAllTemplatedPipelines.ts)
+
+### Templates Module
+
+- `copaApi.templates.renderTemplate()`: Renders a template with provided variables
+
+See: [`templates/render.ts`](src/api/templates/render.ts)
+
+### Tcn Module
+
+- `copaApi.tcn.getAuthUrl()`: Returns the TCN OAuth authorization URL
+- `copaApi.tcn.exchangeCode()`: Exchanges an OAuth code for TCN tokens
+- `copaApi.tcn.refreshToken()`: Refreshes a TCN access token
+- `copaApi.tcn.getCurrentAgent()`: Fetches the currently signed-in TCN agent
+- `copaApi.tcn.getAgentSkills()`: Lists skills available to the agent
+- `copaApi.tcn.createSession()`: Creates a new TCN agent session
+- `copaApi.tcn.keepAlive()`: Pings the TCN session to keep it alive
+- `copaApi.tcn.agentGetStatus()`: Returns the current agent status
+- `copaApi.tcn.agentSetReady()`: Marks the agent as ready
+- `copaApi.tcn.agentPause()`: Pauses the agent
+- `copaApi.tcn.agentDisconnect()`: Disconnects the agent
+- `copaApi.tcn.agentGetConnectedParty()`: Returns the currently connected party for the agent
+- `copaApi.tcn.agentPutCallOnHold()`: Puts the agent's current call on hold
+- `copaApi.tcn.agentGetCallFromHold()`: Resumes the agent's held call
+- `copaApi.tcn.getHuntGroupAgentSettings()`: Fetches hunt-group settings for the agent
+- `copaApi.tcn.getCallData()`: Retrieves data for an active call
+- `copaApi.tcn.dialManualPrepare()`: Prepares a manual dial
+- `copaApi.tcn.manualDialStart()`: Starts a prepared manual dial
+- `copaApi.tcn.processManualDial()`: Processes the result of a manual dial
+
+See: [`tcn/`](src/api/tcn:1)
 
 ### User Module
 
 - `copaApi.user.getLoggedInUserDetails()`: Retrieves details of the currently logged-in user
+- `copaApi.user.getAllUsers()`: Lists all users in the workspace
+
+See: [`user/getLoggedInUserDetails.ts`](src/api/user/getLoggedInUserDetails.ts), [`user/getAllUsers.ts`](src/api/user/getAllUsers.ts)
+
+### Webcron Module
+
+Webhook CRUD + execution helpers:
+- `copaApi.webcron.listWebhooks()`, `getWebhook()`, `createWebhook()`, `updateWebhook()`, `deleteWebhook()`, `testWebhook()`, `getWebhookExecutions()`, `getWebhookSchedules()`, `createWebhookSchedule()`
+
+Schedule controls:
+- `copaApi.webcron.getSchedule()`, `updateSchedule()`, `deleteSchedule()`, `pauseSchedule()`, `resumeSchedule()`, `triggerSchedule()`
+
+Execution history:
+- `copaApi.webcron.listExecutions()`, `getExecution()`, `retryExecution()`
+
+Task lifecycle:
+- `copaApi.webcron.listTasks()`, `createTask()`, `getTask()`, `cancelTask()`, `retryTask()`, `progressTask()`, `signalTask()`
+
+Inspection bins:
+- `copaApi.webcron.listBins()`, `createBin()`, `getBin()`, `deleteBin()`, `getBinRequests()`, `clearBinRequests()`
+
+Workflow trigger:
+- `copaApi.webcron.triggerWorkflowById()`
 
-See: [`user/getLoggedInUserDetails.ts`](src/api/user/getLoggedInUserDetails.ts:1)
+See: [`webcron/`](src/api/webcron:1)
 
 ### Workbook Module
 
 - `copaApi.workbook.getPublishedWorkbookById(id: string)`: Fetches a published workbook by ID
 - `copaApi.workbook.getWorkbooksByType(type: string)`: Retrieves workbooks filtered by type
+- `copaApi.workbook.getWorkbookDetails()`: Retrieves workbook metadata/details
+- `copaApi.workbook.saveWorkbook()`: Saves a workbook draft
+- `copaApi.workbook.publishWorkbook()`: Publishes a workbook
 
-See: [`workbook/getPublishedWorkbookById.ts`](src/api/workbook/getPublishedWorkbookById.ts:1), [`workbook/getWorkbooksByType.ts`](src/api/workbook/getWorkbooksByType.ts:1)
+See: [`workbook/getPublishedWorkbookById.ts`](src/api/workbook/getPublishedWorkbookById.ts), [`workbook/getWorkbooksByType.ts`](src/api/workbook/getWorkbooksByType.ts), [`workbook/getWorkbookDetails.ts`](src/api/workbook/getWorkbookDetails.ts), [`workbook/saveWorkbook.ts`](src/api/workbook/saveWorkbook.ts), [`workbook/publishWorkbook.ts`](src/api/workbook/publishWorkbook.ts)
 
 ### Workflow Module
 
 - `copaApi.workflow.getWorkflowInstanceStatusById(id: string)`: Checks the status of a workflow instance
 - `copaApi.workflow.triggerHttpWorkflowById(id: string)`: Triggers an HTTP-based workflow
 - `copaApi.workflow.triggerWorkflowById(id: string)`: Triggers a workflow by ID
+- `copaApi.workflow.getAllHttpTriggers()`: Lists all HTTP triggers
 
-See: [`workflow/triggerHttpWorkflowById.ts`](src/api/workflow/triggerHttpWorkflowById.ts:1), [`workflow/triggerWorkflowById.ts`](src/api/workflow/triggerWorkflowById.ts:1), [`workflow/getWorkflowInstanceStatusById.ts`](src/api/workflow/getWorkflowInstanceStatusById.ts:1)
+See: [`workflow/triggerHttpWorkflowById.ts`](src/api/workflow/triggerHttpWorkflowById.ts), [`workflow/triggerWorkflowById.ts`](src/api/workflow/triggerWorkflowById.ts), [`workflow/getWorkflowInstanceStatusById.ts`](src/api/workflow/getWorkflowInstanceStatusById.ts), [`workflow/getAllHttpTriggers.ts`](src/api/workflow/getAllHttpTriggers.ts)
 
 ### Worksheet Module
 
 - `copaApi.worksheet.getWorksheets()`: Fetches all worksheets
 - `copaApi.worksheet.getWorksheetsByType(type: string)`: Retrieves worksheets by type
 
-See: [`worksheet/getWorksheets.ts`](src/api/worksheet/getWorksheets.ts:1), [`worksheet/getWorksheetsByType.ts`](src/api/worksheet/getWorksheetsByType.ts:1)
+See: [`worksheet/getWorksheets.ts`](src/api/worksheet/getWorksheets.ts), [`worksheet/getWorksheetsByType.ts`](src/api/worksheet/getWorksheetsByType.ts)
 
 ## InputTableDB — Reactive Database Client
 

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

@@ -0,0 +1,31 @@
+export interface GetFileByFolderIdAndNameRequest {
+    folderId: string;
+    name: string;
+}
+export type FileboxFileType = "CSV" | "XLSX" | "ZIP" | "RAW" | "JSON" | "PDF" | "TXT" | "SWT1" | "MSG" | "OUT" | "PNG" | "JPG" | "JPEG" | "MT940" | "XLS" | "XLSB" | "GZ" | "DOCX";
+export interface FileboxFile {
+    name: string;
+    type: FileboxFileType;
+    parentId: string;
+    status: "DRAFT" | "PUBLISHED";
+    blobFileId: string;
+    copaUploadDate?: string;
+    solutionId?: string;
+    solutionBranch?: string;
+    createdBy?: string;
+    createdDate?: string;
+    lastModifiedBy?: string;
+    lastModifiedDate?: string;
+    id?: string;
+    workspaceId?: string;
+    entityVersion?: number;
+}
+/**
+ * Gets a filebox file by its parent folder and name.
+ *
+ * @param params.folderId - The parent folder id
+ * @param params.name - The exact file name to look up
+ * @returns Promise<FileboxFile> The matching filebox file metadata
+ * @throws { message: string; status: number } if the request fails
+ */
+export declare function getFileByFolderIdAndName({ folderId, name, }: GetFileByFolderIdAndNameRequest): Promise<FileboxFile>;

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

@@ -1,3 +1,4 @@
 export * from './getFileUrlByFileId';
 export * from './fileUpload';
 export * from './fileDownload';
+export * from './getFileByFolderIdAndName';

package/dist/index.d.ts

@@ -21,6 +21,7 @@ export type { DeleteProcessTriggerResponse, } from './api/process/deleteProcessT
 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 { GetFileByFolderIdAndNameRequest, FileboxFile, FileboxFileType, } from './api/file/getFileByFolderIdAndName';
 export type { User } from './api/user/getAllUsers';
 export type { HttpTrigger } from './api/workflow/getAllHttpTriggers';
 export type { GetRowsOptions, GetRowsResponse } from './api/inputTable/getRows';

package/dist/index.es.js

@@ -330,10 +330,37 @@ async function fileDownload({
     throw { message, status };
   }
 }
+async function getFileByFolderIdAndName({
+  folderId,
+  name
+}) {
+  var _a, _b, _c, _d;
+  const normalizedFolderId = folderId == null ? void 0 : folderId.trim();
+  const normalizedName = name == null ? void 0 : name.trim();
+  if (!normalizedFolderId || !normalizedName) {
+    throw { message: "folderId and name are required", status: 400 };
+  }
+  try {
+    const response = await apiClient.get(
+      `/filebox/${encodeURIComponent(normalizedFolderId)}`,
+      { params: { fileName: normalizedName } }
+    );
+    if (!response.data) {
+      throw { message: "Failed to get filebox file", status: 500 };
+    }
+    return response.data;
+  } catch (error) {
+    const message = ((_b = (_a = error.response) == null ? void 0 : _a.data) == null ? void 0 : _b.message) || error.message || "An unexpected error occurred while getting filebox file";
+    const status = ((_c = error.response) == null ? void 0 : _c.status) ?? error.status ?? 500;
+    const data = ((_d = error.response) == null ? void 0 : _d.data) ?? error.data;
+    throw data !== void 0 ? { message, status, data } : { message, status };
+  }
+}
 const index$n = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   fileDownload,
   fileUpload,
+  getFileByFolderIdAndName,
   getFileUrlByFileId
 }, Symbol.toStringTag, { value: "Module" }));
 const runPublishedDefinition = async (props) => {