@nocobase/client-v2 2.1.0-alpha.3 → 2.1.0-alpha.30

package/src/flow-compat/fieldValidationConstants.ts

@@ -0,0 +1,305 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+export const REQUIRED_RULE_KEY = 'required';
+export const DEFAULT_VALIDATION_RULES = [
+  {
+    key: REQUIRED_RULE_KEY,
+    label: 'Required',
+    hasValue: false,
+    params: [],
+  },
+];
+
+export const FIELDS_VALIDATION_OPTIONS = {
+  string: [
+    ...DEFAULT_VALIDATION_RULES,
+    {
+      key: 'max',
+      label: 'Max length',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'min',
+      label: 'Min length',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'pattern',
+      label: 'Pattern',
+      hasValue: true,
+      params: [{ key: 'regex', label: 'Regular Expression', componentType: 'text', required: true }],
+    },
+    {
+      key: 'email',
+      label: 'Email',
+      hasValue: true,
+      params: [
+        {
+          key: 'allowFullyQualified',
+          label: 'Domains ending with a . character are permitted',
+          componentType: 'checkbox',
+        },
+        {
+          key: 'allowUnicode',
+          label: 'Unicode characters are permitted',
+          componentType: 'checkbox',
+        },
+        {
+          key: 'ignoreLength',
+          label: 'Ignore invalid email length errors',
+          componentType: 'checkbox',
+        },
+        {
+          key: 'minDomainSegments',
+          label: 'Min Domain Segments',
+          componentType: 'inputNumber',
+          defaultValue: 2,
+        },
+        {
+          key: 'maxDomainSegments',
+          label: 'Max Domain Segments',
+          componentType: 'inputNumber',
+        },
+        {
+          key: 'tlds',
+          label: 'tlds',
+          componentType: 'radio',
+          defaultValue: 'iana',
+          options: [
+            {
+              label: 'IANA registry',
+              value: 'iana',
+            },
+            {
+              label: 'Disable validation',
+              value: 'disable',
+            },
+            {
+              label: 'Allow list',
+              value: 'allow',
+              componentType: 'text',
+            },
+            {
+              label: 'Deny list',
+              value: 'deny',
+              componentType: 'text',
+            },
+          ],
+        },
+      ],
+      paramsType: 'object',
+    },
+    {
+      key: 'uuid',
+      label: 'UUID',
+      hasValue: true,
+      params: [
+        {
+          key: 'version',
+          label: 'Version',
+          componentType: 'multipleSelect',
+          options: [
+            { label: 'uuidv1', value: 'uuidv1' },
+            { label: 'uuidv2', value: 'uuidv2' },
+            { label: 'uuidv3', value: 'uuidv3' },
+            { label: 'uuidv4', value: 'uuidv4' },
+            { label: 'uuidv5', value: 'uuidv5' },
+            { label: 'uuidv6', value: 'uuidv6' },
+            { label: 'uuidv7', value: 'uuidv7' },
+            { label: 'uuidv8', value: 'uuidv8' },
+          ],
+        },
+        {
+          key: 'separator',
+          label: 'Separator',
+          componentType: 'singleSelect',
+          options: [
+            { label: 'Must use `-` and `:`', value: true },
+            { label: 'No allow `-` and `:`', value: false },
+            { label: 'Only use `-`', value: '-' },
+            { label: 'Only use `_`', value: '_' },
+            { label: 'Only use `.`', value: '.' },
+          ],
+        },
+      ],
+      paramsType: 'object',
+    },
+    {
+      key: 'hex',
+      label: 'Hex',
+      hasValue: true,
+      params: [
+        {
+          key: 'prefix',
+          label: 'Prefix',
+          componentType: 'singleSelect',
+          options: [
+            { label: 'Must use prefix', value: true },
+            { label: 'No use prefix', value: false },
+            { label: 'Optional prefix', value: 'optional' },
+          ],
+        },
+        {
+          key: 'byteAligned',
+          label: 'Byte Aligned',
+          componentType: 'checkbox',
+        },
+      ],
+    },
+    {
+      key: 'length',
+      label: 'Length',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'uri',
+      label: 'URI',
+      hasValue: true,
+      params: [
+        {
+          key: 'scheme',
+          label: 'Scheme',
+          componentType: 'multipleSelect',
+          options: [
+            { label: 'http', value: 'http' },
+            { label: 'https', value: 'https' },
+            { label: 'ftp', value: 'ftp' },
+            { label: 'file', value: 'file' },
+            { label: 'ws', value: 'ws' },
+            { label: 'wss', value: 'wss' },
+          ],
+        },
+        {
+          key: 'allowRelative',
+          label: 'Allow relative URIs',
+          componentType: 'checkbox',
+        },
+        {
+          key: 'relativeOnly',
+          label: 'Restrict only relative URIs',
+          componentType: 'checkbox',
+        },
+        {
+          key: 'allowQuerySquareBrackets',
+          label: 'Allows unencoded square brackets inside the query string',
+          componentType: 'checkbox',
+        },
+        {
+          key: 'encodeUri',
+          label: 'Attempts to encode the URI using encodeURI before validating it again',
+          componentType: 'checkbox',
+        },
+      ],
+      paramsType: 'object',
+    },
+  ],
+  number: [
+    ...DEFAULT_VALIDATION_RULES,
+    {
+      key: 'greater',
+      label: 'Greater than',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'less',
+      label: 'Less than',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'max',
+      label: 'Max value',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'min',
+      label: 'Min value',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'multiple',
+      label: 'Multiple',
+      hasValue: true,
+      params: [{ key: 'base', label: 'Base', componentType: 'inputNumber', required: true }],
+    },
+    { key: 'integer', label: 'Integer', hasValue: false, params: [] },
+    {
+      key: 'precision',
+      label: 'Precision',
+      hasValue: true,
+      params: [{ key: 'limit', label: 'Limit', componentType: 'inputNumber', required: true }],
+    },
+    {
+      key: 'unsafe',
+      label: 'Unsafe integer',
+      hasValue: false,
+      params: [],
+    },
+  ],
+  date: [
+    ...DEFAULT_VALIDATION_RULES,
+    {
+      key: 'greater',
+      label: 'Greater than',
+      hasValue: true,
+      params: [{ key: 'date', label: 'Date', componentType: 'datePicker', required: true }],
+    },
+    {
+      key: 'less',
+      label: 'Less than',
+      hasValue: true,
+      params: [{ key: 'date', label: 'Date', componentType: 'datePicker', required: true }],
+    },
+    {
+      key: 'max',
+      label: 'Max value',
+      hasValue: true,
+      params: [{ key: 'date', label: 'Date', componentType: 'datePicker', required: true }],
+    },
+    {
+      key: 'min',
+      label: 'Min value',
+      hasValue: true,
+      params: [{ key: 'date', label: 'Date', componentType: 'datePicker', required: true }],
+    },
+    {
+      key: 'timestamp',
+      label: 'Timestamp',
+      hasValue: true,
+      params: [
+        {
+          key: 'type',
+          label: 'Type',
+          componentType: 'singleSelect',
+          options: [
+            { label: 'JavaScript', value: 'javascript' },
+            { label: 'Unix', value: 'unix' },
+          ],
+          defaultValue: 'javascript',
+        },
+      ],
+    },
+  ],
+  object: [...DEFAULT_VALIDATION_RULES],
+} as const;
+
+export type ValidationKeysByType = {
+  [K in keyof typeof FIELDS_VALIDATION_OPTIONS]: (typeof FIELDS_VALIDATION_OPTIONS)[K][number]['key'];
+};
+
+export type ValidationType = keyof typeof FIELDS_VALIDATION_OPTIONS;
+
+export type AvailableValidationOption<T extends ValidationType = ValidationType> = ValidationKeysByType[T];

package/src/flow-compat/index.ts

@@ -0,0 +1,28 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+export { Plugin } from '../Plugin';
+export { useApp } from '../hooks/useApp';
+export { usePlugin } from '../hooks/usePlugin';
+export { ColorPicker } from './ColorPicker';
+export { DEFAULT_DATA_SOURCE_KEY, isTitleField } from './data';
+export { FieldValidation } from './FieldValidation';
+export { HighPerformanceSpin } from './HighPerformanceSpin';
+export { Icon, hasIcon, icons, registerIcon, registerIcons } from './Icon';
+export { IconPicker } from './IconPicker';
+export { getDateRanges, inferPickerType } from './date';
+export { LAZY_COMPONENT_KEY, lazy, useLazy } from './lazy';
+export { operators } from './operators';
+export { Password } from './Password';
+export { ICON_POPUP_Z_INDEX, StablePopover } from './Popover';
+export { getZIndex, useZIndexContext, zIndexContext } from './zIndexContext';
+export { useFullscreenOverlay } from './useFullscreenOverlay';
+export type { CollectionFieldOptions } from './data';
+export { NocoBaseDesktopRouteType } from './routeTypes';
+export type { AdminLayoutModel, NocoBaseDesktopRoute } from './routeTypes';

package/src/flow-compat/lazy.tsx

@@ -0,0 +1,110 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import React, { lazy as ReactLazy } from 'react';
+import { Spin } from 'antd';
+import { get } from 'lodash';
+
+export const LAZY_COMPONENT_KEY = Symbol('LAZY_COMPONENT_KEY');
+
+type ModuleImportor<TModule extends Record<string, any> = Record<string, any>> = () => Promise<TModule>;
+
+type LazyCacheRecord<TModule extends Record<string, any> = Record<string, any>> = {
+  error?: unknown;
+  module?: TModule;
+  promise?: Promise<TModule>;
+};
+
+const useLazyCache = new Map<string, LazyCacheRecord>();
+
+type LazyComponentType<M extends Record<string, any>, K extends keyof M> = {
+  [P in K]: M[P];
+};
+
+export function lazy<M extends Record<'default', any>>(factory: () => Promise<M>): M['default'];
+
+export function lazy<M extends Record<string, any>, K extends keyof M = keyof M>(
+  factory: () => Promise<M>,
+  ...componentNames: K[]
+): LazyComponentType<M, K>;
+
+export function lazy<M extends Record<string, any>, K extends keyof M>(
+  factory: () => Promise<M>,
+  ...componentNames: K[]
+) {
+  if (componentNames.length === 0) {
+    const LazyComponent = ReactLazy(() =>
+      factory().then((module) => {
+        const ret = module.default;
+        Component[LAZY_COMPONENT_KEY] = ret;
+        return {
+          default: ret,
+        };
+      }),
+    );
+    const Component = (props) => (
+      <React.Suspense fallback={<Spin />}>
+        <LazyComponent {...props} />
+      </React.Suspense>
+    );
+    return Component;
+  }
+
+  return componentNames.reduce(
+    (acc, name) => {
+      const LazyComponent = ReactLazy(() =>
+        factory().then((module) => {
+          const component = get(module, name);
+          acc[name][LAZY_COMPONENT_KEY] = component;
+          return {
+            default: component,
+          };
+        }),
+      );
+      acc[name] = ((props) => (
+        <React.Suspense fallback={<Spin />}>
+          <LazyComponent {...props} />
+        </React.Suspense>
+      )) as M[K];
+      return acc;
+    },
+    {} as LazyComponentType<M, K>,
+  );
+}
+
+export function useLazy<T = () => any>(importor: ModuleImportor, picker: string | ((module: any) => T)): T {
+  const exportPicker = typeof picker === 'function' ? picker : (module) => module[picker];
+  const cacheKey = importor.toString();
+  const cached = useLazyCache.get(cacheKey);
+
+  if (cached?.error) {
+    throw cached.error;
+  }
+
+  if (cached?.module) {
+    return exportPicker(cached.module) as T;
+  }
+
+  if (!cached?.promise) {
+    const record: LazyCacheRecord = cached || {};
+    record.promise = importor()
+      .then((module) => {
+        record.module = module;
+        return module;
+      })
+      .catch((error) => {
+        record.error = error;
+        throw error;
+      });
+    useLazyCache.set(cacheKey, record);
+    throw record.promise;
+  }
+
+  throw cached.promise;
+}