@flowgram.ai/form-materials 0.1.0-alpha.8

package/src/components/variable-selector/use-variable-tree.tsx

@@ -0,0 +1,101 @@
+import React, { useCallback } from 'react';
+
+import { useScopeAvailable, ASTMatch, BaseVariableField } from '@flowgram.ai/editor';
+import { TreeNodeData } from '@douyinfe/semi-ui/lib/es/tree';
+import { Icon } from '@douyinfe/semi-ui';
+
+import { ArrayIcons, VariableTypeIcons } from '../type-selector/constants';
+import { JsonSchemaUtils } from '../../utils/json-schema';
+import { IJsonSchema } from '../../typings/json-schema';
+
+type VariableField = BaseVariableField<{ icon?: string | JSX.Element; title?: string }>;
+
+export function useVariableTree(params: {
+  includeSchema?: IJsonSchema | IJsonSchema[];
+  excludeSchema?: IJsonSchema | IJsonSchema[];
+}): TreeNodeData[] {
+  const { includeSchema, excludeSchema } = params;
+
+  const available = useScopeAvailable();
+
+  const getVariableTypeIcon = useCallback((variable: VariableField) => {
+    if (variable.meta?.icon) {
+      if (typeof variable.meta.icon === 'string') {
+        return <img style={{ marginRight: 8 }} width={12} height={12} src={variable.meta.icon} />;
+      }
+
+      return variable.meta.icon;
+    }
+
+    const _type = variable.type;
+
+    if (ASTMatch.isArray(_type)) {
+      return (
+        <Icon
+          size="small"
+          svg={ArrayIcons[_type.items?.kind.toLowerCase()] || VariableTypeIcons.array}
+        />
+      );
+    }
+
+    if (ASTMatch.isCustomType(_type)) {
+      return <Icon size="small" svg={VariableTypeIcons[_type.typeName.toLowerCase()]} />;
+    }
+
+    return <Icon size="small" svg={VariableTypeIcons[variable.type?.kind.toLowerCase()]} />;
+  }, []);
+
+  const renderVariable = (
+    variable: VariableField,
+    parentFields: VariableField[] = []
+  ): TreeNodeData | null => {
+    let type = variable?.type;
+
+    if (!type) {
+      return null;
+    }
+
+    let children: TreeNodeData[] | undefined;
+
+    if (ASTMatch.isObject(type)) {
+      children = (type.properties || [])
+        .map((_property) => renderVariable(_property as VariableField, [...parentFields, variable]))
+        .filter(Boolean) as TreeNodeData[];
+
+      if (!children?.length) {
+        return null;
+      }
+    }
+
+    const keyPath = [...parentFields.map((_field) => _field.key), variable.key];
+    const key = keyPath.join('.');
+
+    const isSchemaInclude = includeSchema
+      ? JsonSchemaUtils.isASTMatchSchema(type, includeSchema)
+      : true;
+    const isSchemaExclude = excludeSchema
+      ? JsonSchemaUtils.isASTMatchSchema(type, excludeSchema)
+      : false;
+    const isSchemaMatch = isSchemaInclude && !isSchemaExclude;
+
+    // If not match, and no children, return null
+    if (!isSchemaMatch && !children?.length) {
+      return null;
+    }
+
+    return {
+      key: key,
+      label: variable.meta?.title || variable.key,
+      value: key,
+      keyPath,
+      icon: getVariableTypeIcon(variable),
+      children,
+      disabled: !isSchemaMatch,
+      rootMeta: parentFields[0]?.meta,
+    };
+  };
+
+  return [...available.variables.slice(0).reverse()]
+    .map((_variable) => renderVariable(_variable as VariableField))
+    .filter(Boolean) as TreeNodeData[];
+}

package/src/effects/auto-rename-ref/config.json

@@ -0,0 +1,5 @@
+{
+  "name": "auto-rename-ref",
+  "depMaterials": ["flow-value"],
+  "depPackages": ["lodash"]
+}

package/src/effects/auto-rename-ref/index.ts

@@ -0,0 +1,104 @@
+import { isArray, isObject } from 'lodash';
+import {
+  DataEvent,
+  Effect,
+  EffectOptions,
+  VariableFieldKeyRenameService,
+} from '@flowgram.ai/editor';
+
+import { IFlowRefValue } from '../../typings';
+
+/**
+ * Auto rename ref when form item's key is renamed
+ *
+ * Example:
+ *
+ * formMeta: {
+ *  effects: {
+ *    "inputsValues": autoRenameRefEffect,
+ *  }
+ * }
+ */
+export const autoRenameRefEffect: EffectOptions[] = [
+  {
+    event: DataEvent.onValueInit,
+    effect: ((params) => {
+      const { context, form, name } = params;
+
+      const renameService = context.node.getService(VariableFieldKeyRenameService);
+
+      const disposable = renameService.onRename(({ before, after }) => {
+        const beforeKeyPath = [
+          ...before.parentFields.map((_field) => _field.key).reverse(),
+          before.key,
+        ];
+        const afterKeyPath = [
+          ...after.parentFields.map((_field) => _field.key).reverse(),
+          after.key,
+        ];
+
+        // traverse rename refs inside form item 'name'
+        traverseRef(name, form.getValueIn(name), (_drilldownName, _v) => {
+          if (isRefMatch(_v, beforeKeyPath)) {
+            _v.content = [...afterKeyPath, ...(_v.content || [])?.slice(beforeKeyPath.length)];
+            form.setValueIn(_drilldownName, _v);
+          }
+        });
+      });
+
+      return () => {
+        disposable.dispose();
+      };
+    }) as Effect,
+  },
+];
+
+/**
+ * If ref value's keyPath is the under as targetKeyPath
+ * @param value
+ * @param targetKeyPath
+ * @returns
+ */
+function isRefMatch(value: IFlowRefValue, targetKeyPath: string[]) {
+  return targetKeyPath.every((_key, index) => _key === value.content?.[index]);
+}
+
+/**
+ * If value is ref
+ * @param value
+ * @returns
+ */
+function isRef(value: any): value is IFlowRefValue {
+  return (
+    value?.type === 'ref' && Array.isArray(value?.content) && typeof value?.content[0] === 'string'
+  );
+}
+
+/**
+ * Traverse value to find ref
+ * @param value
+ * @param options
+ * @returns
+ */
+function traverseRef(name: string, value: any, cb: (name: string, _v: IFlowRefValue) => void) {
+  if (isObject(value)) {
+    if (isRef(value)) {
+      cb(name, value);
+      return;
+    }
+
+    Object.entries(value).forEach(([_key, _value]) => {
+      traverseRef(`${name}.${_key}`, _value, cb);
+    });
+    return;
+  }
+
+  if (isArray(value)) {
+    value.forEach((_value, idx) => {
+      traverseRef(`${name}[${idx}]`, _value, cb);
+    });
+    return;
+  }
+
+  return;
+}

package/src/effects/index.ts

@@ -0,0 +1,3 @@
+export * from './provide-batch-input';
+export * from './provide-batch-outputs';
+export * from './auto-rename-ref';

package/src/effects/provide-batch-input/config.json

@@ -0,0 +1,5 @@
+{
+  "name": "provide-batch-input",
+  "depMaterials": ["flow-value"],
+  "depPackages": []
+}

package/src/effects/provide-batch-input/index.ts

@@ -0,0 +1,38 @@
+import {
+  ASTFactory,
+  EffectOptions,
+  FlowNodeRegistry,
+  createEffectFromVariableProvider,
+  getNodeForm,
+} from '@flowgram.ai/editor';
+
+import { IFlowRefValue } from '../../typings';
+
+export const provideBatchInputEffect: EffectOptions[] = createEffectFromVariableProvider({
+  private: true,
+  parse: (value: IFlowRefValue, ctx) => [
+    ASTFactory.createVariableDeclaration({
+      key: `${ctx.node.id}_locals`,
+      meta: {
+        title: getNodeForm(ctx.node)?.getValueIn('title'),
+        icon: ctx.node.getNodeRegistry<FlowNodeRegistry>().info?.icon,
+      },
+      type: ASTFactory.createObject({
+        properties: [
+          ASTFactory.createProperty({
+            key: 'item',
+            initializer: ASTFactory.createEnumerateExpression({
+              enumerateFor: ASTFactory.createKeyPathExpression({
+                keyPath: value.content || [],
+              }),
+            }),
+          }),
+          ASTFactory.createProperty({
+            key: 'index',
+            type: ASTFactory.createNumber(),
+          }),
+        ],
+      }),
+    }),
+  ],
+});

package/src/effects/provide-batch-outputs/config.json

@@ -0,0 +1,5 @@
+{
+  "name": "provide-batch-outputs",
+  "depMaterials": ["flow-value"],
+  "depPackages": []
+}

package/src/effects/provide-batch-outputs/index.ts

@@ -0,0 +1,34 @@
+import {
+  ASTFactory,
+  EffectOptions,
+  FlowNodeRegistry,
+  createEffectFromVariableProvider,
+  getNodeForm,
+} from '@flowgram.ai/editor';
+
+import { IFlowRefValue } from '../../typings';
+
+export const provideBatchOutputsEffect: EffectOptions[] = createEffectFromVariableProvider({
+  private: true,
+  parse: (value: Record<string, IFlowRefValue>, ctx) => [
+    ASTFactory.createVariableDeclaration({
+      key: `${ctx.node.id}`,
+      meta: {
+        title: getNodeForm(ctx.node)?.getValueIn('title'),
+        icon: ctx.node.getNodeRegistry<FlowNodeRegistry>().info?.icon,
+      },
+      type: ASTFactory.createObject({
+        properties: Object.entries(value).map(([_key, value]) =>
+          ASTFactory.createProperty({
+            key: _key,
+            initializer: ASTFactory.createWrapArrayExpression({
+              wrapFor: ASTFactory.createKeyPathExpression({
+                keyPath: value.content || [],
+              }),
+            }),
+          })
+        ),
+      }),
+    }),
+  ],
+});

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './components';
+export * from './effects';
+export * from './utils';
+export * from './typings';

package/src/typings/flow-value/config.json

@@ -0,0 +1,5 @@
+{
+  "name": "flow-value",
+  "depMaterials": [],
+  "depPackages": []
+}

package/src/typings/flow-value/index.ts

@@ -0,0 +1,27 @@
+export interface IFlowConstantValue {
+  type: 'constant';
+  content?: string | number | boolean;
+}
+
+export interface IFlowRefValue {
+  type: 'ref';
+  content?: string[];
+}
+
+export interface IFlowExpressionValue {
+  type: 'expression';
+  content?: string;
+}
+
+export interface IFlowTemplateValue {
+  type: 'template';
+  content?: string;
+}
+
+export type IFlowValue =
+  | IFlowConstantValue
+  | IFlowRefValue
+  | IFlowExpressionValue
+  | IFlowTemplateValue;
+
+export type IFlowConstantRefValue = IFlowConstantValue | IFlowRefValue;

package/src/typings/index.ts

@@ -0,0 +1,2 @@
+export * from './flow-value';
+export * from './json-schema';

package/src/typings/json-schema/config.json

@@ -0,0 +1,5 @@
+{
+  "name": "json-schema",
+  "depMaterials": [],
+  "depPackages": []
+}

package/src/typings/json-schema/index.ts

@@ -0,0 +1,31 @@
+export type JsonSchemaBasicType =
+  | 'boolean'
+  | 'string'
+  | 'integer'
+  | 'number'
+  | 'object'
+  | 'array'
+  | 'map';
+
+export interface IJsonSchema<T = string> {
+  type?: T;
+  default?: any;
+  title?: string;
+  description?: string;
+  enum?: (string | number)[];
+  properties?: Record<string, IJsonSchema<T>>;
+  additionalProperties?: IJsonSchema<T>;
+  items?: IJsonSchema<T>;
+  required?: string[];
+  $ref?: string;
+  extra?: {
+    index?: number;
+    // Used in BaseType.isEqualWithJSONSchema, the type comparison will be weak
+    weak?: boolean;
+    // Set the render component
+    formComponent?: string;
+    [key: string]: any;
+  };
+}
+
+export type IBasicJsonSchema = IJsonSchema<JsonSchemaBasicType>;

package/src/utils/format-legacy-refs/config.json

@@ -0,0 +1,5 @@
+{
+  "name": "format-legacy-ref",
+  "depMaterials": [],
+  "depPackages": []
+}

package/src/utils/format-legacy-refs/index.ts

@@ -0,0 +1,153 @@
+import { isObject } from 'lodash';
+
+interface LegacyFlowRefValueSchema {
+  type: 'ref';
+  content: string;
+}
+
+interface NewFlowRefValueSchema {
+  type: 'ref';
+  content: string[];
+}
+
+/**
+ * In flowgram 0.2.0, for introducing Loop variable functionality,
+ * the FlowRefValueSchema type definition is updated:
+ *
+ * interface LegacyFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string;
+ * }
+ *
+ * interface NewFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string[];
+ * }
+ *
+ *
+ * For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData
+ *
+ * How to use:
+ *
+ * 1. Call formatLegacyRefOnSubmit on the formData before submitting
+ * 2. Call formatLegacyRefOnInit on the formData after submitting
+ *
+ * Example:
+ * import { formatLegacyRefOnSubmit, formatLegacyRefOnInit } from '@flowgram.ai/form-materials';
+ * formMeta: {
+ *  formatOnSubmit: (data) => formatLegacyRefOnSubmit(data),
+ *  formatOnInit: (data) => formatLegacyRefOnInit(data),
+ * }
+ */
+export function formatLegacyRefOnSubmit(value: any): any {
+  if (isObject(value)) {
+    if (isLegacyFlowRefValueSchema(value)) {
+      return formatLegacyRefToNewRef(value);
+    }
+
+    return Object.fromEntries(
+      Object.entries(value).map(([key, value]: [string, any]) => [
+        key,
+        formatLegacyRefOnSubmit(value),
+      ])
+    );
+  }
+
+  if (Array.isArray(value)) {
+    return value.map(formatLegacyRefOnSubmit);
+  }
+
+  return value;
+}
+
+/**
+ * In flowgram 0.2.0, for introducing Loop variable functionality,
+ * the FlowRefValueSchema type definition is updated:
+ *
+ * interface LegacyFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string;
+ * }
+ *
+ * interface NewFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string[];
+ * }
+ *
+ *
+ * For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData
+ *
+ * How to use:
+ *
+ * 1. Call formatLegacyRefOnSubmit on the formData before submitting
+ * 2. Call formatLegacyRefOnInit on the formData after submitting
+ *
+ * Example:
+ * import { formatLegacyRefOnSubmit, formatLegacyRefOnInit } from '@flowgram.ai/form-materials';
+ *
+ * formMeta: {
+ *  formatOnSubmit: (data) => formatLegacyRefOnSubmit(data),
+ *  formatOnInit: (data) => formatLegacyRefOnInit(data),
+ * }
+ */
+export function formatLegacyRefOnInit(value: any): any {
+  if (isObject(value)) {
+    if (isNewFlowRefValueSchema(value)) {
+      return formatNewRefToLegacyRef(value);
+    }
+
+    return Object.fromEntries(
+      Object.entries(value).map(([key, value]: [string, any]) => [
+        key,
+        formatLegacyRefOnInit(value),
+      ])
+    );
+  }
+
+  if (Array.isArray(value)) {
+    return value.map(formatLegacyRefOnInit);
+  }
+
+  return value;
+}
+
+export function isLegacyFlowRefValueSchema(value: any): value is LegacyFlowRefValueSchema {
+  return (
+    isObject(value) &&
+    Object.keys(value).length === 2 &&
+    (value as any).type === 'ref' &&
+    typeof (value as any).content === 'string'
+  );
+}
+
+export function isNewFlowRefValueSchema(value: any): value is NewFlowRefValueSchema {
+  return (
+    isObject(value) &&
+    Object.keys(value).length === 2 &&
+    (value as any).type === 'ref' &&
+    Array.isArray((value as any).content)
+  );
+}
+
+export function formatLegacyRefToNewRef(value: LegacyFlowRefValueSchema) {
+  const keyPath = value.content.split('.');
+
+  if (keyPath[1] === 'outputs') {
+    return {
+      type: 'ref',
+      content: [`${keyPath[0]}.${keyPath[1]}`, ...(keyPath.length > 2 ? keyPath.slice(2) : [])],
+    };
+  }
+
+  return {
+    type: 'ref',
+    content: keyPath,
+  };
+}
+
+export function formatNewRefToLegacyRef(value: NewFlowRefValueSchema) {
+  return {
+    type: 'ref',
+    content: value.content.join('.'),
+  };
+}

package/src/utils/format-legacy-refs/readme.md

@@ -0,0 +1,38 @@
+# Notice
+
+In `@flowgram.ai/form-materials@0.2.0`, for introducing loop-related materials,
+
+The FlowRefValueSchema type definition is updated:
+
+```typescript
+interface LegacyFlowRefValueSchema {
+  type: 'ref';
+  content: string;
+}
+
+interface NewFlowRefValueSchema {
+  type: 'ref';
+  content: string[];
+}
+```
+
+
+
+For making sure backend json will not be changed in your application, we provide `format-legacy-ref` utils for upgrading
+
+
+How to use:
+
+1. Call formatLegacyRefOnSubmit on the formData before submitting
+2. Call formatLegacyRefOnInit on the formData after submitting
+
+Example:
+
+```typescript
+import { formatLegacyRefOnSubmit, formatLegacyRefOnInit } from '@flowgram.ai/form-materials';
+
+formMeta: {
+  formatOnSubmit: (data) => formatLegacyRefOnSubmit(data),
+  formatOnInit: (data) => formatLegacyRefOnInit(data),
+}
+```

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './format-legacy-refs';
+export * from './json-schema';

package/src/utils/json-schema/config.json

@@ -0,0 +1,5 @@
+{
+  "name": "json-schema",
+  "depMaterials": ["typings/json-schema"],
+  "depPackages": ["lodash"]
+}