@dcupl/common 1.9.0 → 1.9.2

package/dist/esm/types/workflow/steps/data-mapper.types.d.ts

@@ -0,0 +1,27 @@
+import { ModelDefinition } from '../../model.types';
+import { Workflow } from '../workflow.types';
+export declare namespace _WorkflowStepDataMapper {
+    type WorkflowDataMapperType = 'manual' | 'model';
+    type MappingEntry = {
+        origin: string;
+        target: string;
+    };
+    type InputOptions = {
+        data: any;
+    };
+    type OutputOptions = {
+        contextVariable: string;
+    };
+    type StepOptions = {
+        input: InputOptions;
+        output: OutputOptions;
+        mappings?: MappingEntry[];
+        model?: ModelDefinition | string;
+    };
+    type Step = Workflow.WorkflowStepBase & {
+        type: 'data-mapper';
+        options: StepOptions;
+    };
+    type StepResultValue = any[];
+    type StepResult = Workflow.StepResultValueBase<StepResultValue>;
+}

package/dist/esm/types/workflow/steps/data-mapper.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data-mapper.types.js.map

package/dist/esm/types/workflow/steps/data-mapper.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-mapper.types.js","sourceRoot":"","sources":["../../../../../src/types/workflow/steps/data-mapper.types.ts"],"names":[],"mappings":""}

package/dist/esm/types/workflow/steps/dcupl-files.types.d.ts

@@ -39,9 +39,14 @@ export declare namespace _WorkflowStepDcuplFiles {
         type: 'dcupl-files';
         options: StepOptions;
     };
-    type StepVariableResult = {
+    type StepFileResult = {
         ok: boolean;
         status: number;
         data: any;
     };
+    type StepResultValue = {
+        ok: boolean;
+        files: StepFileResult[];
+    };
+    type StepResult = Workflow.StepResultValueBase<StepResultValue>;
 }

package/dist/esm/types/workflow/steps/git-files.types.d.ts

@@ -49,9 +49,14 @@ export declare namespace _WorkflowStepGitFiles {
         type: 'git-files';
         options: StepOptions;
     };
-    type StepVariableResult = {
+    type StepFileResult = {
         ok: boolean;
         status: number;
         data: any;
     };
+    type StepResultValue = {
+        ok: boolean;
+        files: StepFileResult[];
+    };
+    type StepResult = Workflow.StepResultValueBase<StepResultValue>;
 }

package/dist/esm/types/workflow/steps/instance.types.d.ts

@@ -0,0 +1,23 @@
+import { AppLoaderConfiguration } from '../../app-loader.types';
+import { DataContainer } from '../../data.types';
+import { DcuplInitOptions } from '../../dcupl.types';
+import { ModelDefinition } from '../../model.types';
+import { Workflow } from '../workflow.types';
+export declare namespace _WorkflowStepInstance {
+    type WorkflowDataContainer = Omit<DataContainer, 'data'> & {
+        data: any;
+    };
+    type StepOptions = {
+        script: string;
+        initOptions?: DcuplInitOptions;
+        loaderFetchOptions?: AppLoaderConfiguration.FetchOptions;
+        processOptions?: AppLoaderConfiguration.ProcessOptions;
+        dataContainers?: WorkflowDataContainer[];
+        models?: ModelDefinition[] | string[];
+    };
+    type Step = Workflow.WorkflowStepBase & {
+        type: 'dcupl-instance';
+        options: StepOptions;
+    };
+    type StepResult = Workflow.StepResultContextBase;
+}

package/dist/esm/types/workflow/steps/instance.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=instance.types.js.map

package/dist/esm/types/workflow/steps/instance.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance.types.js","sourceRoot":"","sources":["../../../../../src/types/workflow/steps/instance.types.ts"],"names":[],"mappings":""}

package/dist/esm/types/workflow/steps/request.types.d.ts

@@ -0,0 +1,21 @@
+import { Workflow } from '../workflow.types';
+export declare namespace _WorkflowStepRequest {
+    type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+    type StepOptions = {
+        url: string;
+        method: RequestMethod;
+        body?: string;
+        headers?: Record<string, string>;
+        contextVariable?: string;
+    };
+    type Step = Workflow.WorkflowStepBase & {
+        type: 'request';
+        options: StepOptions;
+    };
+    type StepResultValue = {
+        ok: boolean;
+        status: number;
+        data: any;
+    };
+    type StepResult = Workflow.StepResultValueBase<StepResultValue>;
+}

package/dist/esm/types/workflow/steps/request.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=request.types.js.map

package/dist/esm/types/workflow/steps/request.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.types.js","sourceRoot":"","sources":["../../../../../src/types/workflow/steps/request.types.ts"],"names":[],"mappings":""}

package/dist/esm/types/workflow/steps/s3-files.types.d.ts

@@ -41,9 +41,14 @@ export declare namespace _WorkflowStepS3Files {
         type: 's3-files';
         options: StepOptions;
     };
-    type StepVariableResult = {
+    type StepFileResult = {
         ok: boolean;
         status: number;
         data: any;
     };
+    type StepResultValue = {
+        ok: boolean;
+        files: StepFileResult[];
+    };
+    type StepResult = Workflow.StepResultValueBase<StepResultValue>;
 }

package/dist/esm/types/workflow/steps/script.types.d.ts

@@ -0,0 +1,11 @@
+import { Workflow } from '../workflow.types';
+export declare namespace _WorkflowStepScript {
+    type StepOptions = {
+        script: string;
+    };
+    type Step = Workflow.WorkflowStepBase & {
+        type: 'script';
+        options: StepOptions;
+    };
+    type StepResult = Workflow.StepResultContextBase;
+}

package/dist/esm/types/workflow/steps/script.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=script.types.js.map

package/dist/esm/types/workflow/steps/script.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script.types.js","sourceRoot":"","sources":["../../../../../src/types/workflow/steps/script.types.ts"],"names":[],"mappings":""}

package/dist/esm/types/workflow/workflow.types.d.ts

@@ -1,10 +1,10 @@
-import { DataContainer } from '../data.types';
-import { ModelDefinition } from '../model.types';
-import { AppLoaderConfiguration } from '../app-loader.types';
-import { ListItem } from '../data.types';
 import { _WorkflowStepDcuplFiles } from './steps/dcupl-files.types';
 import { _WorkflowStepS3Files } from './steps/s3-files.types';
 import { _WorkflowStepGitFiles } from './steps/git-files.types';
+import { _WorkflowStepScript } from './steps/script.types';
+import { _WorkflowStepRequest } from './steps/request.types';
+import { _WorkflowStepInstance } from './steps/instance.types';
+import { _WorkflowStepDataMapper } from './steps/data-mapper.types';
 export declare namespace Workflow {
     type Template = {
         key: string;
@@ -27,11 +27,13 @@ export declare namespace Workflow {
     type WorkflowResponseType = 'script' | 'status' | 'debug';
     type WorkflowResponseConfigBase = {
         type: WorkflowResponseType;
-        headers?: Record<string, string>;
     };
     type WorkflowResponseScript = WorkflowResponseConfigBase & {
         type: 'script';
-        script: string;
+        options: {
+            script: string;
+            headers?: Record<string, string>;
+        };
     };
     type WorkflowResponseStatus = WorkflowResponseConfigBase & {
         type: 'status';
@@ -61,9 +63,6 @@ export declare namespace Workflow {
         type: 'request';
         path: string;
         methods: TriggerRequestMethod[];
-        scripts?: {
-            success?: string;
-        };
     };
     type TriggerManual = TriggerBase & {
         type: 'manual';
@@ -91,214 +90,24 @@ export declare namespace Workflow {
      * Step
      *
      */
-    type WorflowStepType = 'request' | 'script' | 'git-push' | 'git-pull' | 'git-files' | 'dcupl-files' | 'files-read' | 'files-write' | 's3-files' | 's3-read' | 's3-write' | 'data-mapping' | 'dcupl-instance';
+    type WorflowStepType = 'request' | 'script' | 'git-files' | 'dcupl-files' | 's3-files' | 'data-mapper' | 'dcupl-instance';
     type WorkflowStepBase = {
         key: string;
         name?: string;
         description?: string;
         skip?: boolean;
     };
-    /**
-     * Request
-     */
-    type WorkflowRequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
-    type WorkflowStepRequestOptions = {
-        url: string;
-        method: WorkflowRequestMethod;
-        body?: any;
-        headers?: Record<string, string>;
-    };
-    type WorkflowStepRequest = WorkflowStepBase & {
-        type: 'request';
-        options: WorkflowStepRequestOptions;
-        scripts?: {
-            error?: string;
-            success?: string;
-        };
-    };
-    /**
-     * Script
-     */
-    type WorkflowStepScript = WorkflowStepBase & {
-        type: 'script';
-        script: string;
-    };
     /**
      * Dcupl Instance
      */
-    type WorkflowStepDcuplInstanceDataContainer = Omit<DataContainer, 'data'> & {
-        data: string | ListItem[];
-    };
-    type WorkflowStepDcuplInstance = WorkflowStepBase & {
-        type: 'dcupl-instance';
-        apiKey: string;
-        processOptions: AppLoaderConfiguration.ProcessOptions;
-        fetchOptions?: AppLoaderConfiguration.FetchOptions;
-        dataContainers?: WorkflowStepDcuplInstanceDataContainer[];
-        models?: ModelDefinition[];
-        loaderConfig?: AppLoaderConfiguration.ProjectConfiguration;
-        scriptName?: string;
-        script?: string;
-    };
-    /**
-     * Git Push
-     */
-    type WorkflowGitPushStepFile = {
-        path: string;
-        content: string;
-        message?: string;
-    };
-    type WorkflowGitPushStepOptions = {
-        auth: {
-            user: string;
-            token: string;
-        };
-        repository: {
-            user: string;
-            repo: string;
-            /**
-             * default: main
-             */
-            branch?: string;
-        };
-        message?: string;
-        files: WorkflowGitPushStepFile[];
-    };
-    type WorkflowStepGitPush = WorkflowStepBase & {
-        type: 'git-push';
-        options: WorkflowGitPushStepOptions;
-    };
-    /**
-     * Git Pull
-     */
-    type WorkflowGitPullStepFile = {
-        key: string;
-        path: string;
-    };
-    type WorkflowGitPullStepOptions = {
-        auth: {
-            user: string;
-            token: string;
-        };
-        repository: {
-            user: string;
-            repo: string;
-            /**
-             * default: main
-             */
-            branch?: string;
-        };
-        files: WorkflowGitPullStepFile[];
-    };
-    type WorkflowStepGitPull = WorkflowStepBase & {
-        type: 'git-pull';
-        options: WorkflowGitPullStepOptions;
-    };
-    /**
-     * CDN Files Step
-     */
-    /**
-     * Files Write
-     */
-    type WorkflowFilesWriteFile = {
-        path: string;
-        content: string;
-    };
-    type WorkflowFilesWriteStepOptions = {
-        apiKey: string;
-        version: string;
-        files: WorkflowFilesWriteFile[];
-    };
-    type WorkflowStepFilesWrite = WorkflowStepBase & {
-        type: 'files-write';
-        options: WorkflowFilesWriteStepOptions;
-    };
-    /**
-     * Files Read
-     */
-    type WorkflowFilesReadFile = {
-        key: string;
-        path: string;
-    };
-    type WorkflowFilesReadStepOptions = {
-        apiKey: string;
-        version: string;
-        files: WorkflowFilesReadFile[];
-    };
-    type WorkflowStepFilesRead = WorkflowStepBase & {
-        type: 'files-read';
-        options: WorkflowFilesReadStepOptions;
-    };
-    /**
-     * S3 Read
-     */
-    type WorkflowS3ReadFile = {
-        key: string;
-        path: string;
-    };
-    type WorkflowS3StepAuth = {
-        accessKeyId: string;
-        secretAccessKey: string;
-        region: string;
-    };
-    type WorkflowS3ReadStepOptions = {
-        auth: WorkflowS3StepAuth;
-        bucket: string;
-        files: WorkflowS3ReadFile[];
-    };
-    type WorkflowStepS3Read = WorkflowStepBase & {
-        type: 's3-read';
-        options: WorkflowS3ReadStepOptions;
-    };
-    /**
-     * S3 Write
-     */
-    type WorkflowS3WriteFile = {
-        path: string;
-        content: string;
-    };
-    type WorkflowS3WriteStepOptions = {
-        auth: WorkflowS3StepAuth;
-        bucket: string;
-        files: WorkflowS3WriteFile[];
-    };
-    type WorkflowStepS3Write = WorkflowStepBase & {
-        type: 's3-write';
-        options: WorkflowS3WriteStepOptions;
-    };
-    /**
-     * Data Mapping Step
-     */
-    type WorkflowDataMappingType = 'manual' | 'model';
-    type WorkflowStepDataMappingAttributeMap = {
-        origin: string;
-        target: string;
-    };
-    type WorkflowStepDataMappingOptionBase = {
-        input: {
-            data: any[];
-        };
-        output: {
-            variable: string;
-        };
-    };
-    type WorkflowStepDataMappingManual = WorkflowStepDataMappingOptionBase & {
-        type: 'manual';
-        mappings: WorkflowStepDataMappingAttributeMap[];
-    };
-    type WorkflowStepDataMappingModel = WorkflowStepDataMappingOptionBase & {
-        type: 'model';
-        model: ModelDefinition;
-    };
-    type WorkflowStepDataMappingOptions = WorkflowStepDataMappingModel | WorkflowStepDataMappingManual;
-    type WorkflowStepDataMapping = WorkflowStepBase & {
-        type: 'data-mapping';
-        options: WorkflowStepDataMappingOptions;
-    };
     export import StepDcuplFiles = _WorkflowStepDcuplFiles;
     export import StepS3Files = _WorkflowStepS3Files;
     export import StepGitFiles = _WorkflowStepGitFiles;
-    type WorkflowStep = StepDcuplFiles.Step | StepS3Files.Step | StepGitFiles.Step | WorkflowStepRequest | WorkflowStepScript | WorkflowStepGitPush | WorkflowStepGitPull | WorkflowStepDcuplInstance | WorkflowStepFilesWrite | WorkflowStepFilesRead | WorkflowStepS3Read | WorkflowStepDataMapping | WorkflowStepS3Write;
+    export import StepScript = _WorkflowStepScript;
+    export import StepRequest = _WorkflowStepRequest;
+    export import StepInstance = _WorkflowStepInstance;
+    export import StepDataMapper = _WorkflowStepDataMapper;
+    type WorkflowStep = StepDcuplFiles.Step | StepS3Files.Step | StepGitFiles.Step | StepScript.Step | StepRequest.Step | StepInstance.Step | StepDataMapper.Step;
     /**
      * Server Config
      */
@@ -316,35 +125,53 @@ export declare namespace Workflow {
     type WorkflowRuntime = {
         workflowTimeout: number;
         scriptTimeout: number;
+        instanceScriptTimeout: number;
         requestTimeout: number;
         max_heap_size: number;
         scriptWorkers: number;
         workflowWorkers: number;
     };
-    type WorkflowStepResultStatus = 'processing' | 'success' | 'error';
-    type WorkflowStepResult = {
+    type StepResultType = 'value' | 'context';
+    type StepResultBase = {
+        error?: string;
+    };
+    type StepResultValueBase<T = any> = StepResultBase & {
+        type: 'value';
+        value?: T;
+    };
+    type StepResultContextBase = StepResultBase & {
+        type: 'context';
+        context?: RunContext;
+    };
+    type StepResult = StepResultValueBase | StepResultContextBase;
+    type WorkflowStepResultStatus = 'processing' | 'completed' | 'failed';
+    type WorkflowStepResult<Result = any> = {
         key: string;
         status: WorkflowStepResultStatus;
-        result: any;
+        result?: Result;
+        error?: any;
         start: number;
         end: number;
+        duration: number;
     };
     type WorkflowContext = {
         runContext: RunContext;
         stepResults: WorkflowStepResult[];
     };
     type SimpleRequestObject = {
-        body: any;
-        params: any;
-        query: any;
         method: string;
-        headers: any;
+        body?: any;
+        params?: any;
+        query?: any;
+        headers?: any;
     };
     type RunContext = {
-        runId: string;
+        run: {
+            id: string;
+        };
         workflow: Workflow.Workflow;
         request: SimpleRequestObject;
-        variables: Record<string, any>;
+        variables?: Record<string, any>;
         [key: string]: any;
     };
     /**
@@ -419,8 +246,9 @@ export declare namespace Workflow {
         start: number;
         end: number;
         duration: number;
-        startedAt: Date;
+        startedAt: Date | string;
         context?: Workflow.WorkflowContext;
+        result?: any;
     };
     type LogStatistics = {
         count: number;
@@ -437,7 +265,7 @@ export declare namespace Workflow {
         runId: string;
         status: WorkflowStatus;
         duration: number;
-        startedAt: Date;
+        startedAt: string | Date;
     };
     type RunLogSummary = LogStatistics & {
         runs: RunLogSummaryRun[];

package/dist/esm/types/workflow/workflow.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.types.js","sourceRoot":"","sources":["../../../../src/types/workflow/workflow.types.ts"],"names":[],"mappings":"AAQA,MAAM,KAAW,QAAQ,CA+jBxB;AA/jBD,WAAiB,QAAQ;AA+jBzB,CAAC,EA/jBgB,QAAQ,KAAR,QAAQ,QA+jBxB"}
+{"version":3,"file":"workflow.types.js","sourceRoot":"","sources":["../../../../src/types/workflow/workflow.types.ts"],"names":[],"mappings":"AAQA,MAAM,KAAW,QAAQ,CA6VxB;AA7VD,WAAiB,QAAQ;AA6VzB,CAAC,EA7VgB,QAAQ,KAAR,QAAQ,QA6VxB"}