@nocobase/plugin-workflow-manual 1.0.0-alpha.2 → 1.0.0-alpha.3

package/src/client/instruction/forms/update.tsx

@@ -1,167 +0,0 @@
-import { useFieldSchema } from '@formily/react';
-import React, { useMemo, useState } from 'react';
-import { useTranslation } from 'react-i18next';
-import _ from 'lodash';
-
-import {
-  GeneralSchemaDesigner,
-  SchemaSettingsActionModalItem,
-  SchemaSettingsBlockTitleItem,
-  SchemaSettingsDivider,
-  SchemaSettingsLinkageRules,
-  SchemaSettingsRemove,
-  useCollection_deprecated,
-  useCollectionFilterOptions,
-  useDesignable,
-  useMenuSearch,
-} from '@nocobase/client';
-import { isValidFilter } from '@nocobase/utils/client';
-import { FilterDynamicComponent } from '@nocobase/plugin-workflow/client';
-
-import { NAMESPACE } from '../../../locale';
-import { FormBlockInitializer } from '../FormBlockInitializer';
-import { ManualFormType } from '../SchemaConfig';
-import { findSchema } from '../utils';
-
-function UpdateFormDesigner() {
-  const { name, title } = useCollection_deprecated();
-  const fieldSchema = useFieldSchema();
-  const { t } = useTranslation();
-  const { dn } = useDesignable();
-
-  return (
-    <GeneralSchemaDesigner title={title || name}>
-      <SchemaSettingsBlockTitleItem />
-      <SchemaSettingsActionModalItem
-        title={t('Filter settings', { ns: NAMESPACE })}
-        schema={{
-          name: 'filter',
-          type: 'object',
-          title: `{{t("Filter")}}`,
-          'x-component': 'Filter',
-          'x-use-component-props': () => {
-            // eslint-disable-next-line react-hooks/rules-of-hooks
-            const options = useCollectionFilterOptions(fieldSchema?.['x-decorator-props']?.collection);
-            return {
-              options,
-            };
-          },
-          'x-component-props': {
-            dynamicComponent: 'FilterDynamicComponent',
-          },
-        }}
-        initialValues={fieldSchema?.['x-decorator-props']}
-        onSubmit={({ filter }) => {
-          fieldSchema['x-decorator-props'].filter = filter;
-          dn.emit('patch', {
-            schema: {
-              // ['x-uid']: fieldSchema['x-uid'],
-              'x-decorator-props': fieldSchema['x-decorator-props'],
-            },
-          });
-          dn.refresh();
-        }}
-      />
-      <SchemaSettingsLinkageRules collectionName={name} />
-      <SchemaSettingsDivider />
-      <SchemaSettingsRemove
-        removeParentsIfNoChildren
-        breakRemoveOn={{
-          'x-component': 'Grid',
-        }}
-      />
-    </GeneralSchemaDesigner>
-  );
-}
-
-export default {
-  title: `{{t("Update record form", { ns: "${NAMESPACE}" })}}`,
-  config: {
-    useInitializer({ allCollections }) {
-      const childItems = useMemo(
-        () =>
-          allCollections.map(({ key, displayName, collections }) => ({
-            key: key,
-            name: key,
-            label: displayName,
-            type: 'subMenu',
-            children: collections.map((item) => ({
-              name: _.camelCase(`updateRecordForm-child-${item.name}`),
-              type: 'item',
-              title: item.title || item.tableName,
-              schema: {
-                collection: item.name,
-                dataSource: key,
-                title: `{{t("Update record", { ns: "${NAMESPACE}" })}}`,
-                formType: 'update',
-                'x-designer': 'UpdateFormDesigner',
-              },
-              Component: FormBlockInitializer,
-            })),
-          })),
-        [allCollections],
-      );
-      const [openMenuKeys, setOpenMenuKeys] = useState([]);
-      const searchedChildren = useMenuSearch({ data: childItems, openKeys: openMenuKeys });
-      return {
-        name: 'updateRecordForm',
-        key: 'updateRecordForm',
-        type: 'subMenu',
-        title: `{{t("Update record form", { ns: "${NAMESPACE}" })}}`,
-        componentProps: {
-          onOpenChange(keys) {
-            setOpenMenuKeys(keys);
-          },
-        },
-        children: searchedChildren,
-      } as any;
-    },
-    initializers: {
-      // AddCustomFormField
-    },
-    components: {
-      FilterDynamicComponent,
-      UpdateFormDesigner,
-    },
-    parseFormOptions(root) {
-      const forms = {};
-      const formBlocks: any[] = findSchema(
-        root,
-        (item) => item['x-decorator'] === 'FormBlockProvider' && item['x-decorator-props'].formType === 'update',
-      );
-      formBlocks.forEach((formBlock) => {
-        const [formKey] = Object.keys(formBlock.properties);
-        const formSchema = formBlock.properties[formKey];
-        //获取actionBar的schemakey
-        const actionKey =
-          Object.entries(formSchema.properties).find(([key, f]) => f['x-component'] === 'ActionBar')?.[0] || 'actions';
-        forms[formKey] = {
-          ...formBlock['x-decorator-props'],
-          type: 'update',
-          title: formBlock['x-component-props']?.title || formKey,
-          actions: findSchema(formSchema.properties[actionKey], (item) => item['x-component'] === 'Action').map(
-            (item) => ({
-              status: item['x-decorator-props'].value,
-              values: item['x-action-settings']?.assignedValues?.values,
-              key: item.name,
-            }),
-          ),
-        };
-      });
-      return forms;
-    },
-  },
-  block: {
-    scope: {
-      // useFormBlockProps
-    },
-    components: {},
-  },
-  validate({ filter }) {
-    if (!filter || !isValidFilter(filter)) {
-      return 'Please check one of your update record form, and add at least one filter condition in form settings.';
-    }
-
-    return null;
-  },
-} as ManualFormType;

package/src/client/instruction/index.tsx

@@ -1,160 +0,0 @@
-import { SchemaInitializerItemType, useCollectionManager_deprecated, useCompile, usePlugin } from '@nocobase/client';
-
-import WorkflowPlugin, {
-  defaultFieldNames,
-  getCollectionFieldOptions,
-  CollectionBlockInitializer,
-  Instruction,
-} from '@nocobase/plugin-workflow/client';
-
-import { SchemaConfig, SchemaConfigButton } from './SchemaConfig';
-import { ModeConfig } from './ModeConfig';
-import { AssigneesSelect } from './AssigneesSelect';
-import { NAMESPACE } from '../../locale';
-
-const MULTIPLE_ASSIGNED_MODE = {
-  SINGLE: Symbol('single'),
-  ALL: Symbol('all'),
-  ANY: Symbol('any'),
-  ALL_PERCENTAGE: Symbol('all percentage'),
-  ANY_PERCENTAGE: Symbol('any percentage'),
-};
-
-export default class extends Instruction {
-  title = `{{t("Manual", { ns: "${NAMESPACE}" })}}`;
-  type = 'manual';
-  group = 'manual';
-  description = `{{t("Could be used for manually submitting data, and determine whether to continue or exit. Workflow will generate a todo item for assigned user when it reaches a manual node, and continue processing after user submits the form.", { ns: "${NAMESPACE}" })}}`;
-  fieldset = {
-    assignees: {
-      type: 'array',
-      title: `{{t("Assignees", { ns: "${NAMESPACE}" })}}`,
-      'x-decorator': 'FormItem',
-      'x-component': 'AssigneesSelect',
-      'x-component-props': {
-        // multiple: true,
-      },
-      required: true,
-      default: [],
-    },
-    mode: {
-      type: 'number',
-      title: `{{t("Mode", { ns: "${NAMESPACE}" })}}`,
-      'x-decorator': 'FormItem',
-      'x-component': 'ModeConfig',
-      default: 1,
-      'x-reactions': {
-        dependencies: ['assignees'],
-        fulfill: {
-          state: {
-            visible: '{{$deps[0].length > 1}}',
-          },
-        },
-      },
-    },
-    schema: {
-      type: 'void',
-      title: `{{t("User interface", { ns: "${NAMESPACE}" })}}`,
-      'x-decorator': 'FormItem',
-      'x-component': 'SchemaConfigButton',
-      properties: {
-        schema: {
-          type: 'object',
-          'x-component': 'SchemaConfig',
-          default: null,
-        },
-      },
-    },
-    forms: {
-      type: 'object',
-      default: {},
-    },
-  };
-  components = {
-    SchemaConfigButton,
-    SchemaConfig,
-    ModeConfig,
-    AssigneesSelect,
-  };
-  useVariables({ key, title, config }, { types, fieldNames = defaultFieldNames }) {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    const compile = useCompile();
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    const { getCollectionFields } = useCollectionManager_deprecated();
-    const formKeys = Object.keys(config.forms ?? {});
-    if (!formKeys.length) {
-      return null;
-    }
-
-    const options = formKeys
-      .map((formKey) => {
-        const form = config.forms[formKey];
-
-        const fieldsOptions = getCollectionFieldOptions({
-          fields: form.collection?.fields,
-          collection: form.collection,
-          types,
-          compile,
-          getCollectionFields,
-        });
-        const label = compile(form.title) || formKey;
-        return fieldsOptions.length
-          ? {
-              key: formKey,
-              value: formKey,
-              label,
-              title: label,
-              children: fieldsOptions,
-            }
-          : null;
-      })
-      .filter(Boolean);
-
-    return options.length
-      ? {
-          [fieldNames.value]: key,
-          [fieldNames.label]: title,
-          [fieldNames.children]: options,
-        }
-      : null;
-  }
-  useInitializers(node): SchemaInitializerItemType | null {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    const { getCollection } = useCollectionManager_deprecated();
-    const formKeys = Object.keys(node.config.forms ?? {});
-    if (!formKeys.length || node.config.mode) {
-      return null;
-    }
-
-    const forms = formKeys
-      .map((formKey) => {
-        const form = node.config.forms[formKey];
-        const { fields = [] } = getCollection(form.collection);
-
-        return fields.length
-          ? ({
-              name: form.title ?? formKey,
-              type: 'item',
-              title: form.title ?? formKey,
-              Component: CollectionBlockInitializer,
-              collection: form.collection,
-              dataPath: `$jobsMapByNodeKey.${node.key}.${formKey}`,
-            } as SchemaInitializerItemType)
-          : null;
-      })
-      .filter(Boolean);
-
-    return forms.length
-      ? {
-          name: `#${node.id}`,
-          key: 'forms',
-          type: 'subMenu',
-          title: node.title,
-          children: forms,
-        }
-      : null;
-  }
-  isAvailable({ engine, workflow, upstream, branchIndex }) {
-    return !engine.isWorkflowSync(workflow);
-  }
-}

package/src/client/instruction/utils.ts

@@ -1,19 +0,0 @@
-export function findSchema(schema, filter, onlyLeaf = false) {
-  const result = [];
-
-  if (!schema) {
-    return result;
-  }
-
-  if (filter(schema) && (!onlyLeaf || !schema.properties)) {
-    result.push(schema);
-    return result;
-  }
-
-  if (schema.properties) {
-    Object.keys(schema.properties).forEach((key) => {
-      result.push(...findSchema(schema.properties[key], filter));
-    });
-  }
-  return result;
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './server';
-export { default } from './server';

package/src/locale/en-US.json

@@ -1,30 +0,0 @@
-{
-  "Manual": "Manual",
-  "Could be used for manually submitting data, and determine whether to continue or exit. Workflow will generate a todo item for assigned user when it reaches a manual node, and continue processing after user submits the form.": "Could be used for manually submitting data, and determine whether to continue or exit. Workflow will generate a todo item for assigned user when it reaches a manual node, and continue processing after user submits the form.",
-  "Values preset in this form will override user submitted ones when continue or reject.": "Values preset in this form will override user submitted ones when continue or reject.",
-  "Assignee": "Assignee",
-  "Assignees": "Assignees",
-  "User interface": "User interface",
-  "Configure user interface": "Configure user interface",
-  "View user interface": "View user interface",
-  "Separately": "Separately",
-  "Each user has own task": "Each user has own task",
-  "Collaboratively": "Collaboratively",
-  "Everyone shares one task": "Everyone shares one task",
-  "Negotiation": "Negotiation",
-  "All pass": "All pass",
-  "Everyone should pass": "Everyone should pass",
-  "Any pass": "Any pass",
-  "Anyone pass": "Anyone pass",
-  "Field name existed in form": "Field name existed in form",
-  "Continue the process": "Continue the process",
-  "Terminate the process": "Terminate the process",
-  "Save temporarily": "Save temporarily",
-  "Custom form": "Custom form",
-  "Data record": "Data record",
-  "Create record form": "Create record form",
-  "Update record form": "Update record form",
-  "Filter settings": "Filter settings",
-  "Workflow todos": "Workflow todos",
-  "Task": "Task"
-}

package/src/locale/index.ts

@@ -1,14 +0,0 @@
-import { useTranslation } from 'react-i18next';
-
-export const NAMESPACE = 'workflow-manual';
-
-export function useLang(key: string, options = {}) {
-  const { t } = usePluginTranslation(options);
-  return t(key);
-}
-
-export const lang = useLang;
-
-export function usePluginTranslation(options?) {
-  return useTranslation(NAMESPACE, options);
-}

package/src/locale/ko_KR.json

@@ -1,32 +0,0 @@
-{
-  "Manual": "수동",
-  "Could be used for manually submitting data, and determine whether to continue or exit. Workflow will generate a todo item for assigned user when it reaches a manual node, and continue processing after user submits the form.":
-    "수동으로 데이터를 제출하고 계속 진행할지 종료할지를 결정하는 데 사용될 수 있습니다. 워크플로우가 수동 노드에 도달하면 지정된 사용자에 대해 할 일 항목을 생성하고 사용자가 양식을 제출한 후 처리를 계속합니다.",
-  "Values preset in this form will override user submitted ones when continue or reject.": 
-    "이 양식에 사전 설정된 값은 계속 또는 거부될 때 사용자가 제출한 값이 덮어씁니다.",
-  "Assignee": "담당자",
-  "Assignees": "담당자",
-  "User interface": "사용자 인터페이스",
-  "Configure user interface": "사용자 인터페이스 구성",
-  "View user interface": "사용자 인터페이스 보기",
-  "Separately": "별도로",
-  "Each user has own task": "각 사용자는 고유한 작업을 갖습니다.",
-  "Collaboratively": "협력하여",
-  "Everyone shares one task": "모두가 하나의 작업을 공유합니다.",
-  "Negotiation": "협상",
-  "All pass": "모두 통과",
-  "Everyone should pass": "모든 사람이 통과해야 합니다.",
-  "Any pass": "어떤 통과",
-  "Anyone pass": "누구든 통과하면 됩니다.",
-  "Field name existed in form": "양식에 이미 존재하는 필드 이름",
-  "Continue the process": "프로세스 계속 진행",
-  "Terminate the process": "프로세스 종료",
-  "Save temporarily": "임시로 저장",
-  "Custom form": "사용자 정의 양식",
-  "Data record": "데이터 레코드",
-  "Create record form": "레코드 생성 양식",
-  "Update record form": "레코드 업데이트 양식",
-  "Filter settings": "필터 설정",
-  "Workflow todos": "워크플로우 할 일",
-  "Task node": "작업 노드"
-}

package/src/locale/zh-CN.json

@@ -1,32 +0,0 @@
-{
-  "Manual": "人工处理",
-  "Could be used for manually submitting data, and determine whether to continue or exit. Workflow will generate a todo item for assigned user when it reaches a manual node, and continue processing after user submits the form.": "可用于人工提交数据，并决定是否继续或退出流程。工作流在执行到人工节点时会为被指派的用户生成待办事项，直到用户提交对应表单后继续处理该流程。",
-  "Values preset in this form will override user submitted ones when continue or reject.": "表单中预设的字段值会在用户提交继续或拒绝时覆盖相应字段的值。",
-  "Assignee": "负责人",
-  "Assignees": "负责人",
-  "User interface": "操作界面",
-  "Configure user interface": "配置界面",
-  "View user interface": "查看界面",
-  "Separately": "分别处理",
-  "Each user has own task": "每个人处理各自的任务",
-  "Collaboratively": "协作处理",
-  "Everyone shares one task": "所有人共享同一个任务",
-  "Negotiation": "协商机制",
-  "All pass": "全部通过",
-  "Everyone should pass": "每个人通过才通过",
-  "Any pass": "任意通过",
-  "Anyone pass": "任何一人通过即通过",
-  "Field name existed in form": "表单中已有对应标识的字段",
-  "Continue the process": "继续流程",
-  "Terminate the process": "终止流程",
-  "Save temporarily": "暂存",
-  "Custom form": "自定义表单",
-  "Data record": "数据记录",
-  "Create record form": "新增数据表单",
-  "Update record form": "更新数据表单",
-  "Filter settings": "筛选设置",
-  "Workflow todos": "工作流待办",
-  "Task node": "任务节点",
-  "Unprocessed": "未处理",
-  "Please check one of your update record form, and add at least one filter condition in form settings.": "请检查您的其中的更新数据表单，并在表单设置中至少添加一个筛选条件。"
-}

package/src/server/ManualInstruction.ts

@@ -1,157 +0,0 @@
-import { Registry } from '@nocobase/utils';
-import WorkflowPlugin, { Processor, JOB_STATUS, Instruction } from '@nocobase/plugin-workflow';
-
-import initFormTypes, { FormHandler } from './forms';
-
-type FormType = {
-  type: 'custom' | 'create' | 'update';
-  actions: number[];
-  options: {
-    [key: string]: any;
-  };
-};
-
-export interface ManualConfig {
-  schema: { [key: string]: any };
-  forms: { [key: string]: FormType };
-  assignees?: (number | string)[];
-  mode?: number;
-}
-
-const MULTIPLE_ASSIGNED_MODE = {
-  SINGLE: Symbol('single'),
-  ALL: Symbol('all'),
-  ANY: Symbol('any'),
-  ALL_PERCENTAGE: Symbol('all percentage'),
-  ANY_PERCENTAGE: Symbol('any percentage'),
-};
-
-const Modes = {
-  [MULTIPLE_ASSIGNED_MODE.SINGLE]: {
-    getStatus(distribution, assignees) {
-      const done = distribution.find((item) => item.status !== JOB_STATUS.PENDING && item.count > 0);
-      return done ? done.status : null;
-    },
-  },
-  [MULTIPLE_ASSIGNED_MODE.ALL]: {
-    getStatus(distribution, assignees) {
-      const resolved = distribution.find((item) => item.status === JOB_STATUS.RESOLVED);
-      if (resolved && resolved.count === assignees.length) {
-        return JOB_STATUS.RESOLVED;
-      }
-      const rejected = distribution.find((item) => item.status < JOB_STATUS.PENDING);
-      if (rejected && rejected.count) {
-        return rejected.status;
-      }
-
-      return null;
-    },
-  },
-  [MULTIPLE_ASSIGNED_MODE.ANY]: {
-    getStatus(distribution, assignees) {
-      const resolved = distribution.find((item) => item.status === JOB_STATUS.RESOLVED);
-      if (resolved && resolved.count) {
-        return JOB_STATUS.RESOLVED;
-      }
-      const rejectedCount = distribution.reduce(
-        (count, item) => (item.status < JOB_STATUS.PENDING ? count + item.count : count),
-        0,
-      );
-      // NOTE: all failures are considered as rejected for now
-      if (rejectedCount === assignees.length) {
-        return JOB_STATUS.REJECTED;
-      }
-
-      return null;
-    },
-  },
-};
-
-function getMode(mode) {
-  switch (true) {
-    case mode === 1:
-      return Modes[MULTIPLE_ASSIGNED_MODE.ALL];
-    case mode === -1:
-      return Modes[MULTIPLE_ASSIGNED_MODE.ANY];
-    case mode > 0:
-      return Modes[MULTIPLE_ASSIGNED_MODE.ALL_PERCENTAGE];
-    case mode < 0:
-      return Modes[MULTIPLE_ASSIGNED_MODE.ANY_PERCENTAGE];
-    default:
-      return Modes[MULTIPLE_ASSIGNED_MODE.SINGLE];
-  }
-}
-
-export default class extends Instruction {
-  formTypes = new Registry<FormHandler>();
-
-  constructor(public workflow: WorkflowPlugin) {
-    super(workflow);
-
-    initFormTypes(this);
-  }
-
-  async run(node, prevJob, processor: Processor) {
-    const { mode, ...config } = node.config as ManualConfig;
-    const assignees = [...new Set(processor.getParsedValue(config.assignees, node.id).flat().filter(Boolean))];
-
-    const job = await processor.saveJob({
-      status: assignees.length ? JOB_STATUS.PENDING : JOB_STATUS.RESOLVED,
-      result: mode ? [] : null,
-      nodeId: node.id,
-      nodeKey: node.key,
-      upstreamId: prevJob?.id ?? null,
-    });
-
-    if (!assignees.length) {
-      return job;
-    }
-
-    // NOTE: batch create users jobs
-    const UserJobModel = this.workflow.app.db.getModel('users_jobs');
-    await UserJobModel.bulkCreate(
-      assignees.map((userId) => ({
-        userId,
-        jobId: job.id,
-        nodeId: node.id,
-        executionId: job.executionId,
-        workflowId: node.workflowId,
-        status: JOB_STATUS.PENDING,
-      })),
-      {
-        // transaction: processor.transaction,
-      },
-    );
-
-    return job;
-  }
-
-  async resume(node, job, processor: Processor) {
-    // NOTE: check all users jobs related if all done then continue as parallel
-    const { mode } = node.config as ManualConfig;
-    const assignees = [...new Set(processor.getParsedValue(node.config.assignees, node.id).flat().filter(Boolean))];
-
-    const UserJobModel = this.workflow.app.db.getModel('users_jobs');
-    const distribution = await UserJobModel.count({
-      where: {
-        jobId: job.id,
-      },
-      group: ['status'],
-      // transaction: processor.transaction,
-    });
-
-    const submitted = distribution.reduce(
-      (count, item) => (item.status !== JOB_STATUS.PENDING ? count + item.count : count),
-      0,
-    );
-    const status = job.status || (getMode(mode).getStatus(distribution, assignees) ?? JOB_STATUS.PENDING);
-    const result = mode ? (submitted || 0) / assignees.length : job.latestUserJob?.result ?? job.result;
-    processor.logger.debug(`manual resume job and next status: ${status}`);
-    job.set({
-      status,
-      result,
-    });
-
-    return job;
-  }
-}

package/src/server/Plugin.ts

@@ -1,43 +0,0 @@
-import { Plugin } from '@nocobase/server';
-import actions from '@nocobase/actions';
-import { HandlerType } from '@nocobase/resourcer';
-import WorkflowPlugin, { JOB_STATUS } from '@nocobase/plugin-workflow';
-
-import path from 'path';
-import { submit } from './actions';
-
-import ManualInstruction from './ManualInstruction';
-
-export default class extends Plugin {
-  async load() {
-    await this.importCollections(path.resolve(__dirname, 'collections'));
-
-    this.app.resource({
-      name: 'users_jobs',
-      actions: {
-        list: {
-          filter: {
-            $or: [
-              {
-                'workflow.enabled': true,
-              },
-              {
-                'workflow.enabled': false,
-                status: {
-                  $ne: JOB_STATUS.PENDING,
-                },
-              },
-            ],
-          },
-          handler: actions.list as HandlerType,
-        },
-        submit,
-      },
-    });
-
-    this.app.acl.allow('users_jobs', ['list', 'get', 'submit'], 'loggedIn');
-
-    const workflowPlugin = this.app.pm.get(WorkflowPlugin) as WorkflowPlugin;
-    workflowPlugin.registerInstruction('manual', ManualInstruction);
-  }
-}