#Referenční příručka API

#Na straně serveru

Níže je uveden kód, který ukazuje dostupná API ve struktuře serverového balíčku:

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

#PluginWorkflowServer

Třída pluginu pro pracovní postupy.

Během běhu aplikace můžete obvykle získat instanci pluginu pro pracovní postupy (dále jen plugin) voláním app.pm.get<PluginWorkflowServer>(PluginWorkflowServer) kdekoli, kde je dostupná instance aplikace app.

#registerTrigger()

Rozšiřuje a registruje nový typ triggeru.

Podpis

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

Parametry

Příklad

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

function handler(this: MyTrigger, workflow: WorkflowModel, message: string) {
  // trigger workflow
  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);
    // listen some event to trigger workflow
    process.on(
      'message',
      this.messageHandlers.set(workflow.id, messageHandler),
    );
  }

  off(workflow: WorkflowModel) {
    const messageHandler = this.messageHandlers.get(workflow.id);
    // remove listener
    process.off('message', messageHandler);
  }
}

export default class MyPlugin extends Plugin {
  load() {
    // get workflow plugin instance
    const workflowPlugin =
      this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // register trigger
    workflowPlugin.registerTrigger('myTrigger', MyTrigger);
  }
}

#registerInstruction()

Rozšiřuje a registruje nový typ uzlu.

Podpis

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

Parametry

Příklad

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() {
    // get workflow plugin instance
    const workflowPlugin = this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // register instruction
    workflowPlugin.registerInstruction('log', LogInstruction);
  }
}

#trigger()

Spustí konkrétní pracovní postup. Používá se především v uživatelských triggerech k spuštění odpovídajícího pracovního postupu, když je detekována specifická uživatelská událost.

Podpis

trigger(workflow: Workflow, context: any)

Parametry

Příklad

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

class MyTrigger extends Trigger {
  timer: NodeJS.Timeout;

  on(workflow) {
    // register event
    this.timer = setInterval(() => {
      // trigger workflow
      this.plugin.trigger(workflow, { date: new Date() });
    }, workflow.config.interval ?? 60000);
  }
}

#resume()

Obnoví provádění čekajícího pracovního postupu s konkrétní úlohou uzlu.

• Obnovit lze pouze pracovní postupy ve stavu spuštěno (EXECUTION_STATUS.STARTED), které čekají.
• Obnovit lze pouze úlohy uzlů v čekajícím stavu (JOB_STATUS.PENDING).

Podpis

resume(job: JobModel)

Parametry

Příklad

Podrobnosti naleznete ve zdrojovém kódu.

#Trigger

Základní třída pro triggery, sloužící k rozšíření vlastních typů triggerů.

on/off se používají k registraci/zrušení registrace posluchačů událostí při povolení/zakázání pracovního postupu. Předaný parametr je instance pracovního postupu odpovídajícího triggeru, kterou lze zpracovat podle příslušné konfigurace. Některé typy triggerů, které již mají globálně naslouchající události, nemusí tyto dvě metody implementovat. Například u časovaného triggeru můžete zaregistrovat časovač v on a zrušit jeho registraci v off.

#Instruction

Základní třída instruction, sloužící k rozšíření vlastních typů uzlů.

Související typy

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;
}

Pro getScope se můžete podívat na implementaci uzlu cyklu, která slouží k poskytování obsahu lokálních proměnných pro větve.

#EXECUTION_STATUS

Tabulka konstant pro stavy plánu provádění pracovního postupu, sloužící k identifikaci aktuálního stavu odpovídajícího plánu provádění.

Kromě prvních tří představují všechny ostatní stavy selhání, ale mohou být použity k popisu různých důvodů selhání.

#JOB_STATUS

Tabulka konstant pro stavy úloh uzlů pracovního postupu, sloužící k identifikaci aktuálního stavu odpovídající úlohy uzlu. Stav generovaný uzlem zároveň ovlivňuje stav celého plánu provádění.

#Na straně klienta

Níže je uveden kód, který ukazuje dostupná API ve struktuře klientského balíčku:

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

#PluginWorkflowClient

#registerTrigger()

Registruje konfigurační panel pro odpovídající typ triggeru.

Podpis

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

Parametry

#registerInstruction()

Registruje konfigurační panel pro odpovídající typ uzlu.

Podpis

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

Parametry

#registerInstructionGroup()

Registruje skupinu typů uzlů. NocoBase ve výchozím nastavení poskytuje 4 skupiny typů uzlů:

• 'control'：Řídicí
• 'collection'：Operace s kolekcemi
• 'manual'：Ruční zpracování
• 'extended'：Další rozšíření

Pokud potřebujete rozšířit další skupiny, můžete je zaregistrovat pomocí této metody.

Podpis

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

Parametry

Příklad

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

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

#Trigger

Základní třída pro triggery, sloužící k rozšíření vlastních typů triggerů.

• Pokud useVariables není nastaveno, znamená to, že tento typ triggeru neposkytuje funkci pro získání hodnot a kontextová data triggeru nelze vybrat v uzlech pracovního postupu.

#Instruction

Základní třída instruction, sloužící k rozšíření vlastních typů uzlů.

Související typy

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

• Pokud useVariables není nastaveno, znamená to, že tento typ uzlu neposkytuje funkci pro získání hodnot a data výsledku tohoto typu uzlu nelze vybrat v uzlech pracovního postupu. Pokud je výsledná hodnota singulární (nelze ji vybrat), můžete vrátit statický obsah, který vyjadřuje odpovídající informaci (viz: zdrojový kód uzlu pro výpočet). Pokud je potřeba, aby byla volitelná (např. vlastnost objektu), můžete přizpůsobit výstup odpovídající komponenty pro výběr (viz: zdrojový kód uzlu pro vytvoření dat).
• Component je vlastní komponenta pro vykreslování uzlu. Pokud výchozí vykreslování uzlu není dostatečné, lze ji zcela přepsat a použít pro vlastní vykreslování pohledu uzlu. Například, pokud potřebujete poskytnout více akčních tlačítek nebo jiných interakcí pro počáteční uzel typu větve, použijte tuto metodu (viz: zdrojový kód paralelní větve).
• useInitializers se používá k poskytování metody pro inicializaci bloků. Například v manuálním uzlu můžete inicializovat související uživatelské bloky na základě předchozích uzlů. Pokud je tato metoda poskytnuta, bude dostupná při inicializaci bloků v konfiguraci rozhraní manuálního uzlu (viz: zdrojový kód uzlu pro vytvoření dat).
• isAvailable se primárně používá k určení, zda lze uzel použít (přidat) v aktuálním prostředí. Aktuální prostředí zahrnuje aktuální pracovní postup, předchozí uzly a index aktuální větve.