#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);

    // Instructionを登録
    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 は、ワークフローの有効化/無効化時にイベントリスナーを登録/登録解除するために使用されます。渡されるパラメーターは、対応するトリガーのワークフローインスタンスであり、関連する設定に基づいて処理できます。一部のトリガータイプでは、すでにグローバルにイベントをリッスンしている場合、これらの2つのメソッドを実装する必要はありません。例えば、タイマートリガーでは、on でタイマーを登録し、off でタイマーを登録解除できます。

#Instruction

カスタムInstructionタイプを拡張するための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

ワークフロー実行プランのステータス定数テーブルで、対応する実行プランの現在のステータスを識別するために使用されます。

最初の3つを除き、その他はすべて失敗状態を表しますが、異なる失敗理由を表現するために使用できます。

#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

カスタムノードタイプを拡張するためのInstruction基底クラスです。

関連タイプ

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

• useVariables が設定されていない場合、このノードタイプは値取得機能を提供せず、ワークフローのノードでこのタイプのノードの結果データを選択することはできません。結果値が単一（選択不可）の場合、対応する情報を表現する静的なコンテンツを返せば十分です（参照：計算ノードのソースコード）。選択可能にする必要がある場合（例：オブジェクト内の特定のプロパティ）、対応する選択コンポーネントの出力をカスタマイズできます（参照：データ追加ノードのソースコード）。
• Component はノードのカスタムレンダリングコンポーネントです。デフォルトのノードレンダリングでは不十分な場合、完全に上書きしてカスタムノードビューのレンダリングに使用できます。例えば、ブランチタイプの開始ノードに対して、より多くの操作ボタンやその他のインタラクションを提供したい場合は、このメソッドを使用する必要があります（参照：並列ブランチのソースコード）。
• useInitializers は、初期化ブロックを提供するためのメソッドです。例えば、手動ノードでは、上流ノードに基づいて関連するユーザーブロックを初期化できます。このメソッドが提供されている場合、手動ノードのインターフェース設定でブロックを初期化する際に利用可能になります（参照：データ追加ノードのソースコード）。
• isAvailable は、ノードが現在の環境で使用（追加）できるかどうかを判断するために主に使用されます。現在の環境には、現在のワークフロー、上流ノード、現在のブランチインデックスなどが含まれます。