@transai/connector-runner-api 0.8.1 → 0.9.1

package/libs/types/src/lib/management-api/workflow/parameter-mapper.interface.d.ts

@@ -0,0 +1,26 @@
+export interface ValueMapper {
+    selector: string;
+    type: 'string' | 'number' | 'boolean';
+    required?: boolean;
+}
+export interface ArrayMapper {
+    selector: string;
+    type: 'array';
+    required?: boolean;
+    items: MessageMapper;
+}
+export type MessageMapper = {
+    [key: string]: ValueMapper | ArrayMapper;
+};
+export interface ConditionMapper {
+    selector: string;
+    [key: string]: string | {
+        id: string;
+        value: string;
+    };
+}
+export interface ValidationMapper {
+    selector: string;
+    custom_failure_message?: string;
+}
+export type NodeMapper = MessageMapper | ConditionMapper | ValidationMapper | {};

package/libs/types/src/lib/management-api/workflow/workflow-definition.interface.d.ts

@@ -1,47 +1,45 @@
-import { TriggerType } from './trigger-types.interface';
-import { NodeTypes, WorkflowDrawing } from './workflow.drawing';
-export interface ValueMapper {
-    selector: string;
-    type: 'string' | 'number' | 'boolean';
-    required?: boolean;
-}
-export interface ArrayMapper {
-    selector: string;
-    type: 'array';
-    required?: boolean;
-    items: MessageMapper;
-}
-export type MessageMapper = {
-    [key: string]: ValueMapper | ArrayMapper;
-};
-export interface ConditionMapper {
-    selector: string;
-    [key: string]: string | {
-        id: string;
-        value: string;
-    };
+import { NodeTypes, TriggerType } from './enums';
+import { ConditionMapper, MessageMapper, NodeMapper, ValidationMapper } from './parameter-mapper.interface';
+import { WorkflowDrawing } from './workflow-drawing.interface';
+export interface StoredInterface {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
 }
-export type NodeMapper = MessageMapper | ConditionMapper;
 export interface TriggerInterface {
     name: string;
     type: TriggerType;
     identifier: string;
     expression?: string;
 }
-export interface CreateWorkflowDefinitionStep {
+export interface WorkflowDefinitionStepBase {
     name: string;
     identifier: string;
     requires: Array<string>;
-    type: NodeTypes;
     operationIdentifier: string;
     operationVersion?: string;
+    type: NodeTypes;
     with: NodeMapper;
 }
-export interface WorkflowDefinitionStep extends CreateWorkflowDefinitionStep {
-    id: string;
-    createdAt: Date;
-    updatedAt: Date;
+export type BaseWorkflowDefinitionStep = WorkflowDefinitionStepBase & StoredInterface;
+export interface ActionStep extends WorkflowDefinitionStepBase {
+    type: NodeTypes.ACTION;
+    with: MessageMapper;
+    operationVersion: string;
+}
+export interface ConditionalStep extends WorkflowDefinitionStepBase {
+    type: NodeTypes.CONDITIONAL;
+    with: ConditionMapper;
+}
+export interface ValidationStep extends WorkflowDefinitionStepBase {
+    type: NodeTypes.VALIDATION;
+    with: ValidationMapper;
+}
+export interface PlaceholderStep extends WorkflowDefinitionStepBase {
+    type: NodeTypes.PLACEHOLDER;
+    with: {};
 }
+export type WorkflowDefinitionStep = ActionStep | ConditionalStep | ValidationStep | PlaceholderStep;
 export interface CreateWorkflowDefinition {
     identifier: string;
     name: string;
@@ -50,15 +48,19 @@ export interface CreateWorkflowDefinition {
     triggerType: TriggerType;
     triggerIdentifier: string;
     semanticIdentifier: string;
-    steps: Array<CreateWorkflowDefinitionStep>;
+    steps: Array<WorkflowDefinitionStepBase>;
     enabled: boolean;
     workflowDrawing?: WorkflowDrawing;
     trigger?: TriggerInterface;
 }
-export interface WorkflowDefinition extends CreateWorkflowDefinition {
-    steps: Array<WorkflowDefinitionStep>;
-    id: string;
-    createdAt: Date;
-    updatedAt: Date;
+export interface WorkflowDefinition extends CreateWorkflowDefinition, StoredInterface {
+    steps: Array<WorkflowDefinitionStepBase>;
     tenantIdentifier: string;
 }
+/**
+ * TODO: set this later as WorkflowDefinition
+ * However if i do that right now, compilation fails
+ */
+export interface BetterWorkflowDefinition extends WorkflowDefinition {
+    steps: Array<WorkflowDefinitionStep & StoredInterface>;
+}

package/libs/types/src/lib/management-api/workflow/{workflow.drawing.d.ts → workflow-drawing.interface.d.ts}

@@ -1,19 +1,5 @@
-import { TriggerType } from './trigger-types.interface';
-import { ConditionMapper, MessageMapper } from './workflow-definition.interface';
-export declare enum NodeTypes {
-    TRIGGER = "TRIGGER",
-    ACTION = "ACTION",
-    CONDITIONAL = "CONDITIONAL",
-    VALIDATION = "VALIDATION",
-    ANNOTATION = "ANNOTATION",
-    PLACEHOLDER = "PLACEHOLDER",
-    INVISIBLE = "INVISIBLE",
-    END = "END"
-}
-export declare enum ConditionalTypes {
-    TRUE_FALSE = "TRUE_FALSE",
-    CASE = "CASE"
-}
+import { ConditionalTypes, NodeTypes, TriggerType } from './enums';
+import { ConditionMapper, MessageMapper, ValidationMapper } from './parameter-mapper.interface';
 export interface Conditional {
     type: ConditionalTypes;
 }
@@ -50,7 +36,7 @@ export interface ConditionalNode extends Node {
 }
 export interface ValidationNode extends Node {
     type: NodeTypes.VALIDATION;
-    with: ConditionMapper;
+    with: ValidationMapper;
 }
 export interface AnnotationNode extends Node {
     type: NodeTypes.ANNOTATION;
@@ -60,6 +46,7 @@ export interface EndNode extends Node {
 }
 export interface PlaceholderNode extends Node {
     type: NodeTypes.PLACEHOLDER;
+    with: {};
 }
 export interface InvisibleNode extends Node {
     type: NodeTypes.INVISIBLE;

package/libs/types/src/lib/management-api/workflow/{workflow-run.d.ts → workflow-run.interface.d.ts}

@@ -1,37 +1,9 @@
 import { EventInterface } from '../event-origin.interface';
-import { ConditionMapper, MessageMapper, NodeMapper, WorkflowDefinition, WorkflowDefinitionStep } from './workflow-definition.interface';
-import { NodeTypes, WorkflowDrawing } from './workflow.drawing';
-export declare enum WorkflowRunStatusStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    SUCCESS = "SUCCESS",
-    FAILED = "FAILED"
-}
-export declare enum WorkflowJobStatusStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    SUCCESS = "SUCCESS",
-    SKIPPED = "SKIPPED",
-    BAD_REQUEST = "BAD_REQUEST",// input validation errors
-    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
-    ABORTED = "ABORTED"
-}
-export interface WorkflowRunInterface {
-    id: string;
-    tenantIdentifier: string;
-    semanticIdentifier: string;
-    status: WorkflowRunStatusStatus;
-    ttl: number;
-    workflow: WorkflowDefinition;
-    drawing?: WorkflowDrawing;
-    trigger: EventInterface;
-    jobs: Array<ActionJob | ConditionalJob | ValidationJob>;
-    createdAt: Date;
-    updatedAt: Date;
-    testRun?: boolean;
-    restartOf?: string;
-}
-export interface WorkflowJobInterface {
+import { WorkflowDefinition, WorkflowDefinitionStep } from './workflow-definition.interface';
+import { WorkflowDrawing } from './workflow-drawing.interface';
+import { ConditionMapper, MessageMapper, NodeMapper, ValidationMapper } from './parameter-mapper.interface';
+import { WorkflowRunStatusStatus, WorkflowJobStatusStatus, NodeTypes } from './enums';
+export interface BaseWorkflowJobInterface {
     id: string;
     identifier: string;
     run: WorkflowRunInterface;
@@ -41,26 +13,45 @@ export interface WorkflowJobInterface {
     payload?: Record<string, unknown> | undefined;
     log?: string;
     result?: unknown;
-    type: NodeTypes;
-    with: NodeMapper;
     requires: Array<string>;
     step: WorkflowDefinitionStep;
     testRun?: boolean;
     createdAt: Date;
     updatedAt: Date;
+    type: NodeTypes;
+    with: NodeMapper;
 }
-export interface ActionJob extends WorkflowJobInterface {
+export interface ActionJob extends BaseWorkflowJobInterface {
     type: NodeTypes.ACTION;
     with: MessageMapper;
+    operationIdentifier: string;
+    operationVersion: string;
 }
-export interface ConditionalJob extends WorkflowJobInterface {
+export interface ConditionalJob extends BaseWorkflowJobInterface {
     type: NodeTypes.CONDITIONAL;
     with: ConditionMapper;
 }
-export interface ValidationJob extends WorkflowJobInterface {
+export interface ValidationJob extends BaseWorkflowJobInterface {
     type: NodeTypes.VALIDATION;
-    with: ConditionMapper;
+    with: ValidationMapper;
 }
-export interface PlaceholderJob extends WorkflowJobInterface {
+export interface PlaceholderJob extends BaseWorkflowJobInterface {
     type: NodeTypes.PLACEHOLDER;
+    with: {};
+}
+export type WorkflowJobInterface = ActionJob | ConditionalJob | ValidationJob | PlaceholderJob;
+export interface WorkflowRunInterface {
+    id: string;
+    tenantIdentifier: string;
+    semanticIdentifier: string;
+    status: WorkflowRunStatusStatus;
+    ttl: number;
+    workflow: WorkflowDefinition;
+    drawing?: WorkflowDrawing;
+    trigger: EventInterface;
+    jobs: Array<WorkflowJobInterface>;
+    createdAt: Date;
+    updatedAt: Date;
+    testRun?: boolean;
+    restartOf?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transai/connector-runner-api",
-  "version": "0.8.1",
+  "version": "0.9.1",
   "publishConfig": {
     "access": "public"
   },
@@ -11,6 +11,6 @@
     "url": "https://transai.com"
   },
   "type": "commonjs",
-  "main": "./index.js",
+  "main": "./index.cjs",
   "typings": "./index.d.ts"
 }