#Référence de l'API

#Côté serveur

Les API disponibles dans la structure du package côté serveur sont présentées dans le code suivant :

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

#PluginWorkflowServer

Classe de plugin de flux de travail.

Généralement, pendant l'exécution de l'application, vous pouvez appeler app.pm.get<PluginWorkflowServer>(PluginWorkflowServer) partout où vous pouvez obtenir l'instance d'application app pour récupérer l'instance du plugin de flux de travail (désignée ci-après par plugin).

#registerTrigger()

Permet d'étendre et d'enregistrer un nouveau type de déclencheur.

Signature

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

Paramètres

Exemple

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()

Permet d'étendre et d'enregistrer un nouveau type de nœud.

Signature

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

Paramètres

Exemple

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()

Déclenche un flux de travail spécifique. Cette méthode est principalement utilisée dans les déclencheurs personnalisés pour activer le flux de travail correspondant lorsqu'un événement personnalisé spécifique est détecté.

Signature

trigger(workflow: Workflow, context: any)

Paramètres

Exemple

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()

Reprend l'exécution d'un flux de travail en attente à partir d'une tâche de nœud spécifique.

• Seuls les flux de travail en état d'attente (EXECUTION_STATUS.STARTED) peuvent être repris.
• Seules les tâches de nœud en état d'attente (JOB_STATUS.PENDING) peuvent être reprises.

Signature

resume(job: JobModel)

Paramètres

Exemple

Pour plus de détails, consultez le code source.

#Trigger

Classe de base pour les déclencheurs, utilisée pour étendre les types de déclencheurs personnalisés.

on/off sont utilisés pour enregistrer/désenregistrer des écouteurs d'événements lors de l'activation/désactivation d'un flux de travail. Le paramètre passé est l'instance du flux de travail correspondant au déclencheur, qui peut être traitée selon la configuration. Certains types de déclencheurs qui écoutent déjà des événements globalement n'ont pas besoin d'implémenter ces deux méthodes. Par exemple, dans un déclencheur programmé, vous pouvez enregistrer un minuteur dans on et le désenregistrer dans off.

#Instruction

Classe de base pour les types d'instructions, utilisée pour étendre les types d'instructions personnalisés.

Types associés

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

Pour getScope, vous pouvez vous référer à l'implémentation du nœud de boucle, qui est utilisée pour fournir le contenu des variables locales pour les branches.

#EXECUTION_STATUS

Tableau de constantes pour les statuts des plans d'exécution de flux de travail, utilisé pour identifier l'état actuel du plan d'exécution correspondant.

À l'exception des trois premiers, tous les autres représentent un état d'échec, mais peuvent être utilisés pour décrire différentes raisons d'échec.

#JOB_STATUS

Tableau de constantes pour les statuts des tâches de nœud de flux de travail, utilisé pour identifier l'état actuel de la tâche de nœud correspondante. Le statut généré par le nœud affecte également le statut de l'ensemble du plan d'exécution.

#Côté client

Les API disponibles dans la structure du package côté client sont présentées dans le code suivant :

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

#PluginWorkflowClient

#registerTrigger()

Enregistre le panneau de configuration correspondant au type de déclencheur.

Signature

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

Paramètres

#registerInstruction()

Enregistre le panneau de configuration correspondant au type de nœud.

Signature

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

Paramètres

#registerInstructionGroup()

Enregistre un groupe de types de nœuds. NocoBase propose par défaut 4 groupes de types de nœuds :

• 'control' : Contrôle
• 'collection' : Opérations sur les collections
• 'manual' : Traitement manuel
• 'extended' : Autres extensions

Si vous avez besoin d'étendre d'autres groupes, vous pouvez utiliser cette méthode pour les enregistrer.

Signature

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

Paramètres

Exemple

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

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

#Trigger

Classe de base pour les déclencheurs, utilisée pour étendre les types de déclencheurs personnalisés.

• Si useVariables n'est pas défini, cela signifie que ce type de déclencheur ne fournit pas de fonction de récupération de valeur, et les données de contexte du déclencheur ne peuvent pas être sélectionnées dans les nœuds du flux de travail.

#Instruction

Classe de base pour les instructions, utilisée pour étendre les types de nœuds personnalisés.

Types associés

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

• Si useVariables n'est pas défini, cela signifie que ce type de nœud ne fournit pas de fonction de récupération de valeur, et les données de résultat de ce type de nœud ne peuvent pas être sélectionnées dans les nœuds du flux de travail. Si la valeur de résultat est unique (non sélectionnable), vous pouvez simplement retourner un contenu statique qui exprime l'information correspondante (voir : code source du nœud de calcul). Si elle doit être sélectionnable (par exemple, une propriété d'un objet), vous pouvez personnaliser la sortie du composant de sélection correspondant (voir : code source du nœud de création de données).
• Component est un composant de rendu personnalisé pour le nœud. Lorsque le rendu par défaut du nœud n'est pas suffisant, il peut être entièrement remplacé pour un rendu de vue de nœud personnalisé. Par exemple, si vous devez fournir plus de boutons d'action ou d'autres interactions pour le nœud de début d'un type de branche, vous devrez utiliser cette méthode (voir : code source de la branche parallèle).
• useInitializers est utilisé pour fournir une méthode d'initialisation des blocs. Par exemple, dans un nœud manuel, vous pouvez initialiser des blocs utilisateur pertinents en fonction des nœuds en amont. Si cette méthode est fournie, elle sera disponible lors de l'initialisation des blocs dans la configuration de l'interface du nœud manuel (voir : code source du nœud de création de données).
• isAvailable est principalement utilisé pour déterminer si un nœud peut être utilisé (ajouté) dans l'environnement actuel. L'environnement actuel comprend le flux de travail en cours, les nœuds en amont et l'index de la branche actuelle.