tachybase_todo/packages/plugins/@nocobase/plugin-workflow/src/client/variable.tsx

325 lines
9.6 KiB
TypeScript

import { useCompile } from '@nocobase/client';
import { useFlowContext } from './FlowContext';
import { NAMESPACE, lang } from './locale';
import { instructions, useAvailableUpstreams, useNodeContext, useUpstreamScopes } from './nodes';
import { triggers } from './triggers';
export type VariableOption = {
key?: string;
value?: string;
label?: string;
children?: VariableOptions;
[key: string]: any;
};
export type VariableOptions = VariableOption[] | null;
export type VariableDataType =
| string
| {
type: string;
options?: { entity?: boolean; collection?: string };
}
| ((field: any, appends?: string[]) => boolean);
export type OptionsOfUseVariableOptions = {
types?: VariableDataType[];
fieldNames?: {
label?: string;
value?: string;
children?: string;
};
};
export const defaultFieldNames = { label: 'label', value: 'value', children: 'children' } as const;
export const nodesOptions = {
label: `{{t("Node result", { ns: "${NAMESPACE}" })}}`,
value: '$jobsMapByNodeId',
useOptions(options: OptionsOfUseVariableOptions) {
const current = useNodeContext();
const upstreams = useAvailableUpstreams(current);
const result: VariableOption[] = [];
upstreams.forEach((node) => {
const instruction = instructions.get(node.type);
const subOption = instruction.useVariables?.(node, options);
if (subOption) {
result.push(subOption);
}
});
return result;
},
};
export const triggerOptions = {
label: `{{t("Trigger variables", { ns: "${NAMESPACE}" })}}`,
value: '$context',
useOptions(options: OptionsOfUseVariableOptions) {
const { workflow } = useFlowContext();
const trigger = triggers.get(workflow.type);
return trigger?.useVariables?.(workflow.config, options) ?? null;
},
};
export const scopeOptions = {
label: `{{t("Scope variables", { ns: "${NAMESPACE}" })}}`,
value: '$scopes',
useOptions(options: OptionsOfUseVariableOptions) {
const { fieldNames = defaultFieldNames } = options;
const current = useNodeContext();
const scopes = useUpstreamScopes(current);
const result: VariableOption[] = [];
scopes.forEach((node) => {
const instruction = instructions.get(node.type);
const subOptions = instruction.useScopeVariables?.(node, options);
if (subOptions) {
result.push({
key: node.id.toString(),
[fieldNames.value]: node.id.toString(),
[fieldNames.label]: node.title ?? `#${node.id}`,
[fieldNames.children]: subOptions,
});
}
});
return result;
},
};
export const systemOptions = {
label: `{{t("System variables", { ns: "${NAMESPACE}" })}}`,
value: '$system',
useOptions({ types, fieldNames = defaultFieldNames }: OptionsOfUseVariableOptions) {
return [
...(!types || types.includes('date')
? [
{
key: 'now',
[fieldNames.label]: lang('System time'),
[fieldNames.value]: 'now',
},
]
: []),
];
},
};
export const BaseTypeSets = {
boolean: new Set(['checkbox']),
number: new Set(['integer', 'number', 'percent']),
string: new Set([
'input',
'password',
'email',
'phone',
'select',
'radioGroup',
'text',
'markdown',
'richText',
'expression',
'time',
]),
date: new Set(['date', 'createdAt', 'updatedAt']),
};
// { type: 'reference', options: { collection: 'users', multiple: false } }
// { type: 'reference', options: { collection: 'attachments', multiple: false } }
// { type: 'reference', options: { collection: 'myExpressions', entity: false } }
function matchFieldType(field, type, appends?: string[]): boolean {
const inputType = typeof type;
if (inputType === 'string') {
return BaseTypeSets[type]?.has(field.interface);
}
if (inputType === 'object' && type.type === 'reference') {
if (isAssociationField(field)) {
return (
type.options?.entity && (field.collectionName === type.options?.collection || type.options?.collection === '*')
);
} else if (field.isForeignKey) {
return (
(field.collectionName === type.options?.collection && field.name === 'id') ||
field.target === type.options?.collection
);
} else {
return false;
}
}
if (inputType === 'function') {
return type(field, appends);
}
return false;
}
function isAssociationField(field): boolean {
return ['belongsTo', 'hasOne', 'hasMany', 'belongsToMany'].includes(field.type);
}
function getNextAppends(field, appends: string[]) {
const fieldPrefix = `${field.name}.`;
return appends.filter((item) => item.startsWith(fieldPrefix)).map((item) => item.replace(fieldPrefix, ''));
}
function filterTypedFields({ fields, types, appends, compile, getCollectionFields }) {
return fields.filter((field) => {
if (types?.length) {
return types.some((type) => matchFieldType(field, type, appends));
}
if (isAssociationField(field)) {
const nextAppends = getNextAppends(field, appends);
const included = appends.includes(field.name);
return (
(nextAppends.length || included) &&
filterTypedFields({
fields: getNormalizedFields(field.target, { compile, getCollectionFields }),
types,
// depth: depth - 1,
appends: nextAppends,
compile,
getCollectionFields,
}).length
);
}
return true;
});
}
export function useWorkflowVariableOptions(options: OptionsOfUseVariableOptions = {}) {
const fieldNames = Object.assign({}, defaultFieldNames, options.fieldNames ?? {});
const opts = Object.assign(options, { fieldNames });
const compile = useCompile();
const result = [scopeOptions, nodesOptions, triggerOptions, systemOptions].map((item: any) => {
const children = item.useOptions?.(opts)?.filter(Boolean);
return {
[fieldNames.label]: compile(item.label),
[fieldNames.value]: item.value,
key: item[fieldNames.value],
[fieldNames.children]: children,
disabled: !children || !children.length,
};
});
return result;
}
function getNormalizedFields(collectionName, { compile, getCollectionFields }) {
const fields = getCollectionFields(collectionName);
const foreignKeyFields: any[] = [];
const otherFields: any[] = [];
fields.forEach((field) => {
if (field.isForeignKey) {
foreignKeyFields.push(field);
} else {
otherFields.push(field);
}
});
for (let i = otherFields.length - 1; i >= 0; i--) {
const field = otherFields[i];
if (field.type === 'belongsTo') {
const foreignKeyField = foreignKeyFields.find((f) => f.name === field.foreignKey);
if (foreignKeyField) {
otherFields.splice(i, 0, {
...field,
...foreignKeyField,
uiSchema: {
...field.uiSchema,
title: field.uiSchema?.title ? `${compile(field.uiSchema?.title)} ID` : foreignKeyField.name,
},
});
} else {
otherFields.splice(i, 0, {
...field,
name: field.foreignKey,
type: 'bigInt',
isForeignKey: true,
interface: field.interface,
uiSchema: {
...field.uiSchema,
title: field.uiSchema?.title ? `${compile(field.uiSchema?.title)} ID` : field.name,
},
});
}
} else if (field.type === 'context' && field.collectionName === 'users') {
const belongsToField =
otherFields.find((f) => f.type === 'belongsTo' && f.target === 'users' && f.foreignKey === field.name) ?? {};
otherFields.splice(i, 0, {
...field,
type: field.dataType,
interface: belongsToField.interface,
uiSchema: {
...belongsToField.uiSchema,
title: belongsToField.uiSchema?.title ? `${compile(belongsToField.uiSchema?.title)} ID` : field.name,
},
});
}
}
return otherFields.filter((field) => field.interface && !field.hidden);
}
function loadChildren(option) {
const appends = getNextAppends(option.field, option.appends);
const result = getCollectionFieldOptions({
collection: option.field.target,
types: option.types,
appends,
...this,
});
option.loadChildren = null;
if (result.length) {
option.children = result;
} else {
option.isLeaf = true;
const matchingType = option.types ? option.types.some((type) => matchFieldType(option.field, type, appends)) : true;
if (!matchingType) {
option.disabled = true;
}
}
}
export function getCollectionFieldOptions(options): VariableOption[] {
const {
fields,
collection,
types,
appends = [],
compile,
getCollectionFields,
fieldNames = defaultFieldNames,
} = options;
const normalizedFields = getNormalizedFields(collection, { compile, getCollectionFields });
const computedFields = fields ?? normalizedFields;
const boundLoadChildren = loadChildren.bind({ compile, getCollectionFields, fieldNames });
const result: VariableOption[] = filterTypedFields({
fields: computedFields,
types,
// depth,
appends,
compile,
getCollectionFields,
}).map((field) => {
const label = compile(field.uiSchema?.title || field.name);
// console.log('===', label, field);
const nextAppends = getNextAppends(field, appends);
// TODO: no matching fields in next appends should consider isLeaf as true
const isLeaf = !isAssociationField(field) || (!nextAppends.length && !appends.includes(field.name));
return {
[fieldNames.label]: label,
key: field.name,
[fieldNames.value]: field.name,
isLeaf,
loadChildren: isLeaf ? null : boundLoadChildren,
field,
// depth,
appends,
types,
};
});
return result;
}