nocobase/packages/plugins/@nocobase/plugin-workflow/src/server/instructions/index.ts

import { Transactionable } from '@nocobase/database';

import type Plugin from '../Plugin';
import type Processor from '../Processor';

import type { FlowNodeModel } from '../types';

export interface IJob {
  status: number;
  result?: unknown;
  [key: string]: unknown;
}

export type InstructionResult = IJob | Promise<IJob> | null;

export type Runner = (node: FlowNodeModel, input: any, processor: Processor) => InstructionResult;

// what should a instruction do?
// - base on input and context, do any calculations or system call (io), and produce a result or pending.
export abstract class Instruction {
  constructor(public workflow: Plugin) {}

  abstract run(node: FlowNodeModel, input: any, processor: Processor): InstructionResult;

  resume?(node: FlowNodeModel, input: any, processor: Processor): InstructionResult;

  getScope?(node: FlowNodeModel, data: any, processor: Processor): any;

  duplicateConfig?(node: FlowNodeModel, options: Transactionable): object | Promise<object>;
}

export default Instruction;