@bluecopa/core 0.1.68 → 0.1.69

package/dist/api/process/deleteProcessTrigger.d.ts

@@ -0,0 +1,10 @@
+export interface DeleteProcessTriggerResponse {
+    deleted: boolean;
+}
+/**
+ * Deletes a process trigger by entity id.
+ * @param id - Required: the trigger entity id
+ * @returns Promise<DeleteProcessTriggerResponse>
+ * @throws { message, status } on failure
+ */
+export declare function deleteProcessTrigger(id: string): Promise<DeleteProcessTriggerResponse>;

package/dist/api/process/getTriggersBySheet.d.ts

@@ -0,0 +1,8 @@
+import { ProcessTrigger } from './triggerTypes';
+/**
+ * Fetches every process trigger attached to a given process sheet.
+ * @param sheetId - Required: the process_sheet_id
+ * @returns Promise<ProcessTrigger[]>
+ * @throws { message, status } on failure
+ */
+export declare function getTriggersBySheet(sheetId: string): Promise<ProcessTrigger[]>;

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

@@ -1,2 +1,6 @@
 export * from './markTaskDone';
 export * from './reassignTask';
+export * from './triggerTypes';
+export * from './getTriggersBySheet';
+export * from './registerProcessTrigger';
+export * from './deleteProcessTrigger';

package/dist/api/process/registerProcessTrigger.d.ts

@@ -0,0 +1,10 @@
+import { ProcessTrigger } from './triggerTypes';
+/**
+ * Creates or updates a process trigger.
+ * Pass `id` and `entityVersion` on the payload to update an existing one;
+ * omit them to create a new trigger.
+ * @param payload - The full ProcessTrigger payload
+ * @returns Promise<ProcessTrigger> The persisted trigger (with new entityVersion)
+ * @throws { message, status } on failure
+ */
+export declare function registerProcessTrigger(payload: ProcessTrigger): Promise<ProcessTrigger>;

package/dist/api/process/triggerTypes.d.ts

@@ -0,0 +1,49 @@
+export type TriggerComponent = "DATASET" | "FILEBOX" | "FORM" | "HTTP" | "SCHEDULE" | "MANUAL" | "EXTERNAL_EVENT" | "PROCESS_TASK" | "PROCESS_WORKFLOW_EVENT";
+export type TriggerEventType = "CREATED" | "UPDATED" | "DELETED" | "DRAFTED" | "SUBMITTED" | "PUBLISHED" | "SCHEDULED" | "TRIGGERED" | "REASSIGNED";
+export type WorkflowType = "SRC_BRONZE_SILVER" | "SRC_TO_BRONZE" | "BRONZE_TO_SILVER" | "TRANSFORMATION" | "EXPORT" | "EXPORT_AS_EXCEL" | "EXPORT_AS_DATASET" | "RECON" | "DRIVE_PROCESSING" | "DATA_PIPELINE" | "ROBOT_WORKFLOW" | "DATASET_PUBLISH" | "SYSTEM_DATASET_PUBLISH" | "STATEMENT_VIEW" | "LEDGER_WORKFLOW" | "INVALIDATE_CACHE_WORKFLOW" | "ALLOCATION_WORKFLOW" | "PROCESS" | "PROCESS_TREE" | "PROCESS_ACTION_WORKFLOW" | "EXTERNAL_DATASET" | "TEMPLATED_PIPELINE" | "DRIVE_PENDING_FILE_PROCESSING" | "DATABOX" | "FILEBOX" | "ROUTE_FILES" | "PROCESS_ACTION_TRACKER" | "ALERT" | "NOTIFICATION";
+export interface ExcludeScheduleCronTriggerInfo {
+    type: "CRON";
+    cron: string;
+    timezone: string;
+}
+export interface ExcludeScheduleHolidayDatasetTriggerInfo {
+    type: "HOLIDAY";
+    datasetId: string;
+    dateColumn: string;
+}
+export type ExcludeScheduleTriggerInfo = ExcludeScheduleCronTriggerInfo | ExcludeScheduleHolidayDatasetTriggerInfo;
+export interface ScheduledTriggerMetadata {
+    type: "ScheduledTriggerMetadata";
+    scheduleName: string;
+    workflowName: string;
+    schedule: string;
+    timezone: string;
+    concurrencyPolicy: "Allow" | "Replace" | "Forbid";
+    startingDeadlineSeconds: number;
+    successfulJobsHistoryLimit: number;
+    failedJobsHistoryLimit: number;
+    body?: Record<string, any>;
+    excludeScheduleTriggerInfo?: ExcludeScheduleTriggerInfo;
+    skipScheduledTimes?: string[];
+}
+export interface ProcessTrigger {
+    trigger_id: string;
+    component_id: string;
+    process_sheet_id: string;
+    trigger_component: TriggerComponent;
+    event_type: TriggerEventType;
+    workflowType: WorkflowType;
+    sourceMetadata?: ScheduledTriggerMetadata[];
+    name?: string;
+    id?: string;
+    entityVersion?: number;
+    metadata?: Record<string, any>;
+    solutionId?: string;
+    solutionBranch?: string;
+    workspaceId?: string;
+    createdBy?: string;
+    createdDate?: string;
+    lastModifiedBy?: string;
+    lastModifiedDate?: string;
+    auditTrailEntitySubType?: string;
+}

package/dist/index.d.ts

@@ -16,6 +16,8 @@ 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 { ProcessTrigger, ScheduledTriggerMetadata, ExcludeScheduleTriggerInfo, ExcludeScheduleCronTriggerInfo, ExcludeScheduleHolidayDatasetTriggerInfo, TriggerComponent, TriggerEventType, WorkflowType, } from './api/process/triggerTypes';
+export type { DeleteProcessTriggerResponse, } from './api/process/deleteProcessTrigger';
 export type { FileUploadRequest, FileUploadResponse, } from './api/file/fileUpload';
 export type { FileDownloadRequest } from './api/file/fileDownload';
 export type { GetFileUrlRequest, GetFileUrlResponse, } from './api/file/getFileUrlByFileId';