nocobase/packages/plugin-ui-schema-storage/src/__tests__/ui-schema.test.ts

import { ISchema } from '@formily/json-schema';
import { mockServer, MockServer } from '@nocobase/test';
import { Collection, Database } from '@nocobase/database';
import PluginUiSchema, { UiSchemaRepository } from '..';

describe('ui-schema', () => {
  let app: MockServer;
  let db: Database;

  let uiSchemaRepository: UiSchemaRepository;

  afterEach(async () => {
    await app.destroy();
  });

  beforeEach(async () => {
    app = mockServer({
      registerActions: true,
    });

    db = app.db;

    await db.sequelize.getQueryInterface().dropAllTables();

    app.plugin(PluginUiSchema);

    await app.load();
    uiSchemaRepository = db.getCollection('ui_schemas').repository as UiSchemaRepository;
  });

  type SchemaProperties = Record<string, ISchema>;
  // properties、patternProperties、definitions 都是这种类型的
  describe('SchemaProperties', () => {
    it('properties is plain object', () => {
      const items = [
        {
          properties: {}, // 有效
        },
        {
          properties: null, // 跳过
        },
        {
          properties: 'aaa', // 无效，跳过并警告
        },
        {
          properties: [], // 无效，跳过并警告
        },
        {
          properties: 1, // 无效，跳过并警告
        },
        {
          properties: true, // 无效，跳过并警告
        },
      ];
    });
    it('properties node is plain object', () => {
      const schema = {
        properties: {
          a: {}, // 有效 {name: 'a'}
          b: null, // 跳过，不警告
          c: 'aaa', // 无效，跳过并警告
          d: true, // 无效，跳过并警告
          e: 1, // 无效，跳过并警告
          f: [], // 无效，跳过并警告
        },
      };
    });
    it('nested', () => {
      const schema = {
        properties: {
          a: {
            properties: {
              b: {},
            },
          },
        },
      };
    });
  });

  type SchemaItems = ISchema | ISchema[];

  describe('items', () => {
    it('should insert items node', async () => {
      const schema = {
        type: 'object',
        properties: {
          string_array: {
            type: 'array',
            'x-component': 'ArrayCards',
            maxItems: 3,
            'x-decorator': 'FormItem',
            'x-component-props': {
              title: 'String array',
            },
            items: {
              type: 'void',
              properties: {
                index: {
                  type: 'void',
                  'x-component': 'ArrayCards.Index',
                },
                input: {
                  type: 'string',
                  'x-decorator': 'FormItem',
                  title: 'Input',
                  required: true,
                  'x-component': 'Input',
                },
                remove: {
                  type: 'void',
                  'x-component': 'ArrayCards.Remove',
                },
                moveUp: {
                  type: 'void',
                  'x-component': 'ArrayCards.MoveUp',
                },
                moveDown: {
                  type: 'void',
                  'x-component': 'ArrayCards.MoveDown',
                },
              },
            },
            properties: {
              addition: {
                type: 'void',
                title: 'Add entry',
                'x-component': 'ArrayCards.Addition',
              },
            },
          },
          array: {
            type: 'array',
            'x-component': 'ArrayCards',
            maxItems: 3,
            'x-decorator': 'FormItem',
            'x-component-props': {
              title: 'Object array',
            },
            items: {
              type: 'object',
              properties: {
                index: {
                  type: 'void',
                  'x-component': 'ArrayCards.Index',
                },
                input: {
                  type: 'string',
                  'x-decorator': 'FormItem',
                  title: 'Input',
                  required: true,
                  'x-component': 'Input',
                },
                remove: {
                  type: 'void',
                  'x-component': 'ArrayCards.Remove',
                },
                moveUp: {
                  type: 'void',
                  'x-component': 'ArrayCards.MoveUp',
                },
                moveDown: {
                  type: 'void',
                  'x-component': 'ArrayCards.MoveDown',
                },
              },
            },
            properties: {
              addition: {
                type: 'void',
                title: 'Add entry',
                'x-component': 'ArrayCards.Addition',
              },
            },
          },
        },
      };

      const result = await uiSchemaRepository.insert(schema);
      console.log(JSON.stringify(result, null, 2));
    });

    it('items is array or plain object', () => {
      const examples = [
        {
          items: {}, // 有效，等同于 [{}]
        },
        {
          items: [{}], // 有效
        },
        {
          items: [], // 有效，但无节点
        },
        {
          items: 'str', // 无效，跳过并警告
        },
      ];
    });
    it('items node is plain object', () => {
      const schema = {
        items: [
          {},
          [], // 无效，跳过并警告
          null, // 无效，跳过并警告
          'aa', // 无效，跳过并警告
        ],
      };
    });
  });
  describe('additionalProperties & additionalItems', () => {
    it('additionalProperties and additionalItems are plain object', () => {
      const schema = {
        additionalProperties: {},
        additionalItems: {
          properties: {},
        },
      };
    });
    it('null', () => {
      const schema = {
        additionalProperties: null,
        additionalItems: null,
      };
    });
    it('null', () => {
      const schema = {
        additionalProperties: 1, // 跳过并警告
        additionalItems: 'str', // 跳过并警告
      };
    });
  });

  it('all props', () => {
    const schema = {
      definitions: {
        address: {
          type: 'object',
          properties: {
            street_address: {
              type: 'string',
            },
            city: {
              type: 'string',
            },
            state: {
              type: 'string',
            },
          },
          required: ['street_address', 'city', 'state'],
        },
      },
      type: 'object',
      title: 'title',
      description: 'description',
      patternProperties: {
        '^[a-zA-Z0-9]*$': {
          properties: {
            model: { type: 'string' },
            made: { type: 'string' },
            year: { type: 'string' },
          },
        },
      },
      additionalProperties: {
        type: 'string',
      },
      properties: {
        string: {
          type: 'string',
          default: 'default',
          required: true,
          'x-component': 'Input',
          'x-component-props': {
            placeholder: 'placeholder',
          },
          'x-decorator': 'FormItem',
          'x-decorator-props': {
            labelCol: 3,
          },
          'x-disabled': true,
          'x-display': 'visible',
          'x-editable': false,
          'x-hidden': false,
          'x-pattern': 'readPretty',
          'x-read-only': true,
          'x-validator': ['phone'],
          'x-reactions': [
            {
              target: 'xxx',
              when: '{{aa > bb}}',
            },
          ],
        },
        boolean: {
          type: 'boolean',
          default: false,
        },
        number: {
          type: 'number',
          default: 100,
        },
        date: {
          type: 'date',
          default: '2020-12-23',
        },
        datetime: {
          type: 'datetime',
          default: '2020-12-23 23:00:00',
        },
        array: {
          type: 'array',
          items: {
            type: 'string',
          },
          additionalItems: {
            type: 'number',
          },
        },
        array2: {
          type: 'array',
          items: [
            {
              type: 'string',
            },
            {
              type: 'object',
            },
          ],
        },
        void: {
          type: 'void',
        },
      },
    };
  });
});