#API 레퍼런스

#서버 사이드

서버 사이드 패키지 구조에서 사용할 수 있는 API는 다음 코드와 같습니다:

import PluginWorkflowServer, {
  Trigger,
  Instruction,
  EXECUTION_STATUS,
  JOB_STATUS,
} from '@nocobase/plugin-workflow';

#PluginWorkflowServer

워크플로우 플러그인 클래스입니다.

일반적으로 애플리케이션 런타임 중에 app 인스턴스를 가져올 수 있는 모든 곳에서 app.pm.get<PluginWorkflowServer>(PluginWorkflowServer)를 호출하여 워크플로우 플러그인 인스턴스(이하 plugin으로 지칭)를 가져올 수 있습니다.

#registerTrigger()

새로운 트리거 유형을 확장하고 등록합니다.

시그니처

registerTrigger(type: string, trigger: typeof Trigger | Trigger })

매개변수

예시

import PluginWorkflowServer, { Trigger } from '@nocobase/plugin-workflow';

function handler(this: MyTrigger, workflow: WorkflowModel, message: string) {
  // 워크플로우를 트리거합니다.
  this.workflow.trigger(workflow, { data: message.data });
}

class MyTrigger extends Trigger {
  messageHandlers: Map<number, WorkflowModel> = new Map();
  on(workflow: WorkflowModel) {
    const messageHandler = handler.bind(this, workflow);
    // 워크플로우를 트리거하기 위해 특정 이벤트를 수신합니다.
    process.on(
      'message',
      this.messageHandlers.set(workflow.id, messageHandler),
    );
  }

  off(workflow: WorkflowModel) {
    const messageHandler = this.messageHandlers.get(workflow.id);
    // 리스너를 제거합니다.
    process.off('message', messageHandler);
  }
}

export default class MyPlugin extends Plugin {
  load() {
    // 워크플로우 플러그인 인스턴스를 가져옵니다.
    const workflowPlugin =
      this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // 트리거를 등록합니다.
    workflowPlugin.registerTrigger('myTrigger', MyTrigger);
  }
}

#registerInstruction()

새로운 노드 유형을 확장하고 등록합니다.

시그니처

registerInstruction(type: string, instruction: typeof Instruction | Instruction })

매개변수

예시

import PluginWorkflowServer, { Instruction, JOB_STATUS } from '@nocobase/plugin-workflow';

class LogInstruction extends Instruction {
  run(node, input, processor) {
    console.log('my instruction runs!');
    return {
      status: JOB_STATUS.RESOVLED,
    };
  },
};

export default class MyPlugin extends Plugin {
  load() {
    // 워크플로우 플러그인 인스턴스를 가져옵니다.
    const workflowPlugin = this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // 명령어를 등록합니다.
    workflowPlugin.registerInstruction('log', LogInstruction);
  }
}

#trigger()

특정 워크플로우를 트리거합니다. 주로 사용자 정의 트리거에서 특정 사용자 정의 이벤트가 수신될 때 해당 워크플로우를 트리거하는 데 사용됩니다.

시그니처

trigger(workflow: Workflow, context: any)

매개변수

예시

import { Trigger } from '@nocobase/plugin-workflow';

class MyTrigger extends Trigger {
  timer: NodeJS.Timeout;

  on(workflow) {
    // 이벤트를 등록합니다.
    this.timer = setInterval(() => {
      // 워크플로우를 트리거합니다.
      this.plugin.trigger(workflow, { date: new Date() });
    }, workflow.config.interval ?? 60000);
  }
}

#resume()

특정 노드 작업을 통해 대기 중인 워크플로우의 실행을 재개합니다.

• 대기 상태(EXECUTION_STATUS.STARTED)에 있는 워크플로우만 실행을 재개할 수 있습니다.
• 대기 상태(JOB_STATUS.PENDING)에 있는 노드 작업만 실행을 재개할 수 있습니다.

시그니처

resume(job: JobModel)

매개변수

예시

자세한 내용은 소스 코드를 참조하십시오.

#Trigger

사용자 정의 트리거 유형을 확장하는 데 사용되는 트리거 기본 클래스입니다.

on/off는 워크플로우가 활성화/비활성화될 때 이벤트 리스너를 등록/등록 해제하는 데 사용됩니다. 전달되는 매개변수는 해당 트리거의 워크플로우 인스턴스이며, 관련 설정에 따라 처리할 수 있습니다. 일부 트리거 유형이 이미 전역적으로 이벤트를 수신하고 있는 경우, 이 두 메서드를 구현할 필요가 없을 수도 있습니다. 예를 들어, 타이머 트리거에서는 on에서 타이머를 등록하고 off에서 타이머를 등록 해제할 수 있습니다.

#Instruction

사용자 정의 명령어 유형을 확장하는 데 사용되는 명령어 기본 클래스입니다.

관련 타입

export type Job =
  | {
      status: JOB_STATUS[keyof JOB_STATUS];
      result?: unknown;
      [key: string]: unknown;
    }
  | JobModel
  | null;

export type InstructionResult = Job | Promise<Job>;

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

export class Instruction {
  run: Runner;
  resume?: Runner;
}

getScope는 브랜치의 지역 변수 내용을 제공하는 데 사용되며, 루프 노드의 구현을 참조할 수 있습니다.

#EXECUTION_STATUS

워크플로우 실행 계획 상태에 대한 상수 테이블로, 해당 실행 계획의 현재 상태를 식별하는 데 사용됩니다.

처음 세 가지를 제외하고는 모두 실패 상태를 나타내지만, 다양한 실패 원인을 설명하는 데 사용될 수 있습니다.

#JOB_STATUS

워크플로우 노드 작업 상태에 대한 상수 테이블로, 해당 노드 작업의 현재 상태를 식별하는 데 사용됩니다. 노드에서 생성된 상태는 전체 실행 계획의 상태에도 영향을 미칩니다.

#클라이언트 사이드

클라이언트 사이드 패키지 구조에서 사용할 수 있는 API는 다음 코드와 같습니다:

import PluginWorkflowClient, {
  Trigger,
  Instruction,
} from '@nocobase/plugin-workflow/client';

#PluginWorkflowClient

#registerTrigger()

트리거 유형에 해당하는 설정 패널을 등록합니다.

시그니처

registerTrigger(type: string, trigger: typeof Trigger | Trigger): void

매개변수

#registerInstruction()

노드 유형에 해당하는 설정 패널을 등록합니다.

시그니처

registerInstruction(type: string, instruction: typeof Instruction | Instruction): void

매개변수

#registerInstructionGroup()

노드 유형 그룹을 등록합니다. NocoBase는 기본적으로 4가지 노드 유형 그룹을 제공합니다:

• 'control': 제어
• 'collection': 컬렉션 작업
• 'manual': 수동 처리
• 'extended': 기타 확장

다른 그룹을 확장해야 하는 경우 이 메서드를 사용하여 등록할 수 있습니다.

시그니처

registerInstructionGroup(type: string, group: { label: string }): void

매개변수

예시

export default class YourPluginClient extends Plugin {
  load() {
    const pluginWorkflow = this.app.pm.get(PluginWorkflowClient);

    pluginWorkflow.registerInstructionGroup('ai', { label: `{{t("AI", { ns: "${NAMESPACE}" })}}` });
  }
}

#Trigger

사용자 정의 트리거 유형을 확장하는 데 사용되는 트리거 기본 클래스입니다.

• useVariables가 설정되지 않은 경우, 해당 트리거 유형은 값 검색 기능을 제공하지 않으며, 워크플로우 노드에서 트리거의 컨텍스트 데이터를 선택할 수 없습니다.

#Instruction

사용자 정의 노드 유형을 확장하는 데 사용되는 명령어 기본 클래스입니다.

관련 타입

export type NodeAvailableContext = {
  workflow: object;
  upstream: object;
  branchIndex: number;
};

• useVariables가 설정되지 않은 경우, 해당 노드 유형은 값 검색 기능을 제공하지 않으며, 워크플로우 노드에서 해당 유형 노드의 결과 데이터를 선택할 수 없습니다. 결과 값이 단일(선택 불가능)한 경우, 해당 정보를 표현하는 정적 콘텐츠를 반환하면 됩니다(참조: 연산 노드 소스 코드). 객체의 특정 속성과 같이 선택 가능해야 하는 경우, 해당 선택 컴포넌트 출력을 사용자 정의할 수 있습니다(참조: 데이터 추가 노드 소스 코드).
• Component는 노드 사용자 정의 렌더링 컴포넌트입니다. 기본 노드 렌더링이 충분하지 않을 때 완전히 대체하여 사용자 정의 노드 뷰를 렌더링하는 데 사용할 수 있습니다. 예를 들어, 브랜치 유형의 시작 노드에 더 많은 작업 버튼이나 다른 상호 작용을 제공해야 하는 경우 이 메서드를 사용해야 합니다(참조: 병렬 브랜치 소스 코드).
• useInitializers는 초기화 블록을 제공하는 데 사용됩니다. 예를 들어, 수동 노드에서 상위 노드를 기반으로 관련 사용자 블록을 초기화할 수 있습니다. 이 메서드가 제공되면 수동 노드 인터페이스 설정에서 블록을 초기화할 때 사용할 수 있습니다(참조: 데이터 추가 노드 소스 코드).
• isAvailable은 주로 노드가 현재 환경에서 사용(추가)될 수 있는지 여부를 판단하는 데 사용됩니다. 현재 환경에는 현재 워크플로우, 상위 노드 및 현재 브랜치 인덱스 등이 포함됩니다.