chore(plugin-workflow): adjust types (#2206)

* chore(plugin-workflow): adjust types

* fix(plugin-workflow): fix types

packages/plugins/workflow/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@nocobase/plugin-workflow",
-  "displayName": "workflow",
+  "displayName": "Workflow",
   "displayName.zh-CN": "工作流",
-  "description": " a powerful workflow plugin designed to support business process management and automation. .",
+  "description": "A powerful workflow plugin designed to support business process management and automation.",
   "description.zh-CN": "工作流插件，为业务流程管理和自动化提供支持。",
   "version": "0.10.1-alpha.1",
   "license": "AGPL-3.0",
@@ -25,7 +25,8 @@
     "cron-parser": "4.4.0",
     "lru-cache": "8.0.5",
     "moment": "^2.29.2",
-    "react-js-cron": "^3.1.0"
+    "react-js-cron": "^3.1.0",
+    "sequelize": "^6.26.0"
   },
   "devDependencies": {
     "react": "18.x",

packages/plugins/workflow/src/client/index.tsx

@@ -2,6 +2,7 @@ export * from './Branch';
 export * from './FlowContext';
 export * from './nodes';
 export { triggers } from './triggers';
+export { useWorkflowVariableOptions } from './variable';
 
 import { Plugin, useCollectionDataSource } from '@nocobase/client';
 import React from 'react';

packages/plugins/workflow/src/server/Plugin.ts

@@ -11,14 +11,13 @@ import initFields from './fields';
 import initActions from './actions';
 import { EXECUTION_STATUS } from './constants';
 import initInstructions, { Instruction } from './instructions';
-import ExecutionModel from './models/Execution';
-import JobModel from './models/Job';
-import WorkflowModel from './models/Workflow';
 import Processor from './Processor';
 import initTriggers, { Trigger } from './triggers';
 import initFunctions, { CustomFunction } from './functions';
 import { createLogger, Logger, LoggerOptions, getLoggerLevel, getLoggerFilePath } from '@nocobase/logger';
 
+import type { WorkflowModel, ExecutionModel, JobModel } from './types';
+
 type Pending = [ExecutionModel, JobModel?];
 
 type ID = number | string;

packages/plugins/workflow/src/server/Processor.ts

@@ -5,9 +5,7 @@ import { parse } from '@nocobase/utils';
 import Plugin from '.';
 import { EXECUTION_STATUS, JOB_STATUS } from './constants';
 import { Runner } from './instructions';
-import ExecutionModel from './models/Execution';
+import type { ExecutionModel, FlowNodeModel, JobModel } from './types';
-import FlowNodeModel from './models/FlowNode';
-import JobModel from './models/Job';
 
 export interface ProcessorOptions extends Transactionable {
   plugin: Plugin;

packages/plugins/workflow/src/server/__tests__/index.ts

@@ -4,7 +4,7 @@ import { lodash } from '@nocobase/utils';
 import path from 'path';
 import Plugin from '..';
 import { JOB_STATUS } from '../constants';
-import FlowNodeModel from '../models/FlowNode';
+import type { FlowNodeModel } from '../types';
 
 export function sleep(ms: number) {
   return new Promise((resolve) => {

packages/plugins/workflow/src/server/__tests__/instructions/update.test.ts

@@ -1,14 +1,14 @@
 import { Application } from '@nocobase/server';
 import Database from '@nocobase/database';
 import { getApp, sleep } from '..';
-import DefinedWorkflowModel from '../../models/Workflow';
+import type { WorkflowModel as WorkflowModelType } from '../../types';
 
 describe('workflow > instructions > update', () => {
   let app: Application;
   let db: Database;
   let PostRepo;
   let WorkflowModel;
-  let workflow: DefinedWorkflowModel;
+  let workflow: WorkflowModelType;
 
   beforeEach(async () => {
     app = await getApp();

packages/plugins/workflow/src/server/actions/nodes.ts

@@ -1,6 +1,6 @@
 import { Context, utils } from '@nocobase/actions';
 import { MultipleRelationRepository, Op } from '@nocobase/database';
-import WorkflowModel from '../models/Workflow';
+import type { WorkflowModel } from '../types';
 
 export async function create(context: Context, next) {
   const { db } = context;

packages/plugins/workflow/src/server/functions/index.ts

@@ -1,6 +1,5 @@
 import Plugin from '..';
-import ExecutionModel from '../models/Execution';
+import type { ExecutionModel, FlowNodeModel } from '../types';
-import FlowNodeModel from '../models/FlowNode';
 
 export type CustomFunction = (this: { execution: ExecutionModel; node?: FlowNodeModel }) => any;
 

packages/plugins/workflow/src/server/index.ts

@@ -3,3 +3,4 @@ export * from './constants';
 export { Trigger } from './triggers';
 export { default as Processor } from './Processor';
 export { default } from './Plugin';
+export * from './types';

packages/plugins/workflow/src/server/instructions/aggregate.ts

@@ -1,7 +1,8 @@
 import { BelongsToManyRepository, DataTypes, HasManyRepository } from '@nocobase/database';
-import { JOB_STATUS } from '../constants';
+
-import FlowNodeModel from '../models/FlowNode';
 import Processor from '../Processor';
+import { JOB_STATUS } from '../constants';
+import type { FlowNodeModel } from '../types';
 
 const aggregators = {
   count: 'count',

packages/plugins/workflow/src/server/instructions/calculation.ts

@@ -3,7 +3,7 @@ import { parse } from '@nocobase/utils';
 import { Instruction } from '.';
 import { Processor } from '..';
 import { JOB_STATUS } from '../constants';
-import FlowNodeModel from '../models/FlowNode';
+import type { FlowNodeModel } from '../types';
 
 interface CalculationConfig {
   dynamic?: boolean | string;

packages/plugins/workflow/src/server/instructions/condition.ts

@@ -3,9 +3,11 @@ import { Registry } from '@nocobase/utils';
 import { Instruction } from '.';
 import { Processor } from '..';
 import { JOB_STATUS } from '../constants';
-import FlowNodeModel from '../models/FlowNode';
+import type { FlowNodeModel } from '../types';
 
-export const calculators = new Registry<Function>();
+type Comparer = (a: any, b: any) => boolean;
+
+export const calculators = new Registry<Comparer>();
 
 // built-in functions
 function equal(a, b) {
@@ -92,7 +94,9 @@ type CalculationGroup = {
 type Calculation = CalculationItem | CalculationGroup;
 
 function calculate(calculation: CalculationItem = {}) {
-  let fn: Function;
+  type NewType = Comparer;
+
+  let fn: NewType;
   if (!(calculation.calculator && (fn = calculators.get(calculation.calculator)))) {
     throw new Error(`no calculator function registered for "${calculation.calculator}"`);
   }

packages/plugins/workflow/src/server/instructions/create.ts

@@ -1,5 +1,5 @@
 import { JOB_STATUS } from '../constants';
-import FlowNodeModel from '../models/FlowNode';
+import type { FlowNodeModel } from '../types';
 
 export default {
   async run(node: FlowNodeModel, input, processor) {

packages/plugins/workflow/src/server/instructions/delay.ts

@@ -1,9 +1,8 @@
 import Plugin from '..';
 import { EXECUTION_STATUS, JOB_STATUS } from '../constants';
-import ExecutionModel from '../models/Execution';
-import JobModel from '../models/Job';
 import Processor from '../Processor';
 import { Instruction } from '.';
+import type { ExecutionModel, JobModel } from '../types';
 
 type ValueOf<T> = T[keyof T];
 

packages/plugins/workflow/src/server/instructions/destroy.ts

@@ -1,5 +1,5 @@
 import { JOB_STATUS } from '../constants';
-import FlowNodeModel from '../models/FlowNode';
+import type { FlowNodeModel } from '../types';
 
 export default {
   async run(node: FlowNodeModel, input, processor) {

packages/plugins/workflow/src/server/instructions/index.ts

@@ -2,11 +2,11 @@ import path from 'path';
 
 import { requireModule } from '@nocobase/utils';
 
-import FlowNodeModel from '../models/FlowNode';
-
 import Plugin from '..';
 import Processor from '../Processor';
 
+import type { FlowNodeModel } from '../types';
+
 export type Job = {
   status: number;
   result?: unknown;

packages/plugins/workflow/src/server/instructions/loop.ts

@@ -1,7 +1,6 @@
-import FlowNodeModel from '../models/FlowNode';
-import JobModel from '../models/Job';
 import Processor from '../Processor';
 import { JOB_STATUS } from '../constants';
+import type { FlowNodeModel, JobModel } from '../types';
 
 function getTargetLength(target) {
   let length = 0;

packages/plugins/workflow/src/server/instructions/manual/forms/index.ts

@@ -6,7 +6,7 @@ import update from './update';
 
 export type FormHandler = (this: ManualInstruction, instance, formConfig, processor: Processor) => Promise<void>;
 
-export default function({ formTypes }) {
+export default function ({ formTypes }) {
   formTypes.register('create', create);
   formTypes.register('update', update);
 }

packages/plugins/workflow/src/server/instructions/parallel.ts

@@ -1,7 +1,6 @@
-import FlowNodeModel from '../models/FlowNode';
-import JobModel from '../models/Job';
 import Processor from '../Processor';
 import { JOB_STATUS } from '../constants';
+import type { FlowNodeModel, JobModel } from '../types';
 
 export const PARALLEL_MODE = {
   ALL: 'all',

packages/plugins/workflow/src/server/instructions/query.ts

@@ -1,6 +1,6 @@
-import FlowNodeModel from '../models/FlowNode';
 import Processor from '../Processor';
 import { JOB_STATUS } from '../constants';
+import type { FlowNodeModel } from '../types';
 
 export default {
   async run(node: FlowNodeModel, input, processor: Processor) {

packages/plugins/workflow/src/server/instructions/request.ts

@@ -3,7 +3,7 @@ import axios, { AxiosRequestConfig } from 'axios';
 import { Instruction } from './index';
 import { JOB_STATUS } from '../constants';
 import Processor from '../Processor';
-import FlowNodeModel from '../models/FlowNode';
+import type { FlowNodeModel } from '../types';
 
 export interface Header {
   name: string;
@@ -53,6 +53,7 @@ export default class implements Instruction {
 
     const config = processor.getParsedValue(node.config, node) as RequestConfig;
 
+    // eslint-disable-next-line promise/catch-or-return
     request(config)
       .then((response) => {
         job.set({

packages/plugins/workflow/src/server/instructions/update.ts

@@ -1,6 +1,6 @@
-import FlowNodeModel from '../models/FlowNode';
 import Processor from '../Processor';
 import { JOB_STATUS } from '../constants';
+import type { FlowNodeModel } from '../types';
 
 export default {
   async run(node: FlowNodeModel, input, processor: Processor) {

packages/plugins/workflow/src/server/triggers/collection.ts

@@ -1,6 +1,6 @@
 import { Collection, Model } from '@nocobase/database';
 import { Trigger } from '..';
-import WorkflowModel from '../models/Workflow';
+import type { WorkflowModel } from '../types';
 
 export interface CollectionChangeTriggerConfig {
   collection: string;

packages/plugins/workflow/src/server/triggers/index.ts

@@ -2,7 +2,7 @@ import path from 'path';
 import { requireModule } from '@nocobase/utils';
 
 import Plugin from '..';
-import WorkflowModel from '../models/Workflow';
+import type { WorkflowModel } from '../types';
 
 export abstract class Trigger {
   constructor(public readonly plugin: Plugin) {}

packages/plugins/workflow/src/server/triggers/schedule.ts

@@ -1,7 +1,7 @@
 import { fn, literal, Op, where } from '@nocobase/database';
 import parser from 'cron-parser';
 import Plugin, { Trigger } from '..';
-import WorkflowModel from '../models/Workflow';
+import type { WorkflowModel } from '../types';
 
 export type ScheduleOnField =
   | string

packages/plugins/workflow/src/server/types/index.ts

@@ -0,0 +1,4 @@
+export type { default as WorkflowModel } from './Workflow';
+export type { default as FlowNodeModel } from './FlowNode';
+export type { default as ExecutionModel } from './Execution';
+export type { default as JobModel } from './Job';