@nocobase/client 1.9.0-beta.8 → 1.9.0

package/es/block-provider/hooks/index.d.ts

@@ -6,6 +6,7 @@
  * 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 { Form } from '@formily/core';
 import { ChangeEvent } from 'react';
 import { NavigateFunction } from 'react-router-dom';
 import { CollectionOptions } from '../../collection-manager';
@@ -26,7 +27,7 @@ export declare function getFormValues({ filterByTk, field, form, fieldNames, get
     resource: any;
     actionFields: any[];
 }): any;
-export declare function useCollectValuesToSubmit(): () => Promise<any>;
+export declare function useCollectValuesToSubmit(f?: Form): () => Promise<any>;
 export declare const useCreateActionProps: () => {
     onClick(): Promise<void>;
 };
@@ -80,6 +81,32 @@ export declare const useBulkDestroyActionProps: () => {
 export declare const useRefreshActionProps: () => {
     onClick(): Promise<void>;
 };
+export interface ColumnInfo {
+    key: string;
+    title: string;
+    dataIndex: string;
+    visible: boolean;
+    fixed?: 'left' | 'right' | false;
+    width?: number;
+    order?: number;
+}
+/**
+ * Get table columns from schema
+ */
+export declare const useTableColumns: () => ColumnInfo[];
+export declare const useEditTableActionProps: () => {
+    columns: (ColumnInfo | {
+        visible: any;
+        order: any;
+        width: any;
+        fixed: any;
+        key: string;
+        title: string;
+        dataIndex: string;
+    })[];
+    onSubmit: (values: any) => void;
+    onReset: () => void;
+};
 export declare const useDetailsPaginationProps: () => {
     simple: boolean;
     current: any;

package/es/collection-manager/Configuration/components/FieldValidation.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 from 'react';
+interface ValidationRule {
+    key: string;
+    name: string;
+    args?: {
+        [key: string]: any;
+    };
+    paramsType?: string;
+}
+interface ValidationData {
+    type: string;
+    rules: ValidationRule[];
+}
+interface FieldValidationProps {
+    value?: ValidationData;
+    onChange?: (value: ValidationData) => void;
+    type?: string;
+    availableValidationOptions?: string[];
+    excludeValidationOptions?: string[];
+    isAssociation?: boolean;
+}
+export declare const FieldValidation: React.MemoExoticComponent<import("@formily/react").ReactFC<FieldValidationProps>>;
+export {};

package/es/collection-manager/Configuration/components/index.d.ts

@@ -15,3 +15,4 @@ export declare const SourceKey: React.MemoExoticComponent<import("@formily/react
 export declare const TargetKey: React.MemoExoticComponent<import("@formily/react").ReactFC<Omit<any, "ref">>>;
 export declare const ForeignKey: React.MemoExoticComponent<import("@formily/react").ReactFC<Omit<any, "ref">>>;
 export declare const ThroughCollection: React.MemoExoticComponent<import("@formily/react").ReactFC<Omit<any, "ref">>>;
+export { FieldValidation } from './FieldValidation';

package/es/collection-manager/constants.d.ts

@@ -0,0 +1,383 @@
+/**
+ * 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 declare const REQUIRED_RULE_KEY = "required";
+export declare const DEFAULT_VALIDATION_RULES: {
+    key: string;
+    label: string;
+    hasValue: boolean;
+    params: any[];
+}[];
+export declare const FIELDS_VALIDATION_OPTIONS: {
+    readonly string: readonly [...{
+        key: string;
+        label: string;
+        hasValue: boolean;
+        params: any[];
+    }[], {
+        readonly key: "max";
+        readonly label: "Max length";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "min";
+        readonly label: "Min length";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "pattern";
+        readonly label: "Pattern";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "regex";
+            readonly label: "Regular Expression";
+            readonly componentType: "text";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "email";
+        readonly label: "Email";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "allowFullyQualified";
+            readonly label: "Domains ending with a . character are permitted";
+            readonly componentType: "checkbox";
+        }, {
+            readonly key: "allowUnicode";
+            readonly label: "Unicode characters are permitted";
+            readonly componentType: "checkbox";
+        }, {
+            readonly key: "ignoreLength";
+            readonly label: "Ignore invalid email length errors";
+            readonly componentType: "checkbox";
+        }, {
+            readonly key: "minDomainSegments";
+            readonly label: "Min Domain Segments";
+            readonly componentType: "inputNumber";
+            readonly defaultValue: 2;
+        }, {
+            readonly key: "maxDomainSegments";
+            readonly label: "Max Domain Segments";
+            readonly componentType: "inputNumber";
+        }, {
+            readonly key: "tlds";
+            readonly label: "tlds";
+            readonly componentType: "radio";
+            readonly defaultValue: "iana";
+            readonly options: readonly [{
+                readonly label: "IANA registry";
+                readonly value: "iana";
+            }, {
+                readonly label: "Disable validation";
+                readonly value: "disable";
+            }, {
+                readonly label: "Allow list";
+                readonly value: "allow";
+                readonly componentType: "text";
+            }, {
+                readonly label: "Deny list";
+                readonly value: "deny";
+                readonly componentType: "text";
+            }];
+        }];
+        readonly paramsType: "object";
+    }, {
+        readonly key: "uuid";
+        readonly label: "UUID";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "version";
+            readonly label: "Version";
+            readonly componentType: "multipleSelect";
+            readonly options: readonly [{
+                readonly label: "uuidv1";
+                readonly value: "uuidv1";
+            }, {
+                readonly label: "uuidv2";
+                readonly value: "uuidv2";
+            }, {
+                readonly label: "uuidv3";
+                readonly value: "uuidv3";
+            }, {
+                readonly label: "uuidv4";
+                readonly value: "uuidv4";
+            }, {
+                readonly label: "uuidv5";
+                readonly value: "uuidv5";
+            }, {
+                readonly label: "uuidv6";
+                readonly value: "uuidv6";
+            }, {
+                readonly label: "uuidv7";
+                readonly value: "uuidv7";
+            }, {
+                readonly label: "uuidv8";
+                readonly value: "uuidv8";
+            }];
+        }, {
+            readonly key: "separator";
+            readonly label: "Separator";
+            readonly componentType: "singleSelect";
+            readonly options: readonly [{
+                readonly label: "Must use `-` and `:`";
+                readonly value: true;
+            }, {
+                readonly label: "No allow `-` and `:`";
+                readonly value: false;
+            }, {
+                readonly label: "Only use `-`";
+                readonly value: "-";
+            }, {
+                readonly label: "Only use `_`";
+                readonly value: "_";
+            }, {
+                readonly label: "Only use `.`";
+                readonly value: ".";
+            }];
+        }];
+        readonly paramsType: "object";
+    }, {
+        readonly key: "hex";
+        readonly label: "Hex";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "prefix";
+            readonly label: "Prefix";
+            readonly componentType: "singleSelect";
+            readonly options: readonly [{
+                readonly label: "Must use prefix";
+                readonly value: true;
+            }, {
+                readonly label: "No use prefix";
+                readonly value: false;
+            }, {
+                readonly label: "Optional prefix";
+                readonly value: "optional";
+            }];
+        }, {
+            readonly key: "byteAligned";
+            readonly label: "Byte Aligned";
+            readonly componentType: "checkbox";
+        }];
+    }, {
+        readonly key: "length";
+        readonly label: "Length";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "uri";
+        readonly label: "URI";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "scheme";
+            readonly label: "Scheme";
+            readonly componentType: "multipleSelect";
+            readonly options: readonly [{
+                readonly label: "http";
+                readonly value: "http";
+            }, {
+                readonly label: "https";
+                readonly value: "https";
+            }, {
+                readonly label: "ftp";
+                readonly value: "ftp";
+            }, {
+                readonly label: "file";
+                readonly value: "file";
+            }, {
+                readonly label: "ws";
+                readonly value: "ws";
+            }, {
+                readonly label: "wss";
+                readonly value: "wss";
+            }];
+        }, {
+            readonly key: "allowRelative";
+            readonly label: "Allow relative URIs";
+            readonly componentType: "checkbox";
+        }, {
+            readonly key: "relativeOnly";
+            readonly label: "Restrict only relative URIs";
+            readonly componentType: "checkbox";
+        }, {
+            readonly key: "allowQuerySquareBrackets";
+            readonly label: "Allows unencoded square brackets inside the query string";
+            readonly componentType: "checkbox";
+        }, {
+            readonly key: "encodeUri";
+            readonly label: "Attempts to encode the URI using encodeURI before validating it again";
+            readonly componentType: "checkbox";
+        }];
+        readonly paramsType: "object";
+    }];
+    readonly number: readonly [...{
+        key: string;
+        label: string;
+        hasValue: boolean;
+        params: any[];
+    }[], {
+        readonly key: "greater";
+        readonly label: "Greater than";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "less";
+        readonly label: "Less than";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "max";
+        readonly label: "Max value";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "min";
+        readonly label: "Min value";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "multiple";
+        readonly label: "Multiple";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "base";
+            readonly label: "Base";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "integer";
+        readonly label: "Integer";
+        readonly hasValue: false;
+        readonly params: readonly [];
+    }, {
+        readonly key: "precision";
+        readonly label: "Precision";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "limit";
+            readonly label: "Limit";
+            readonly componentType: "inputNumber";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "unsafe";
+        readonly label: "Unsafe integer";
+        readonly hasValue: false;
+        readonly params: readonly [];
+    }];
+    readonly date: readonly [...{
+        key: string;
+        label: string;
+        hasValue: boolean;
+        params: any[];
+    }[], {
+        readonly key: "greater";
+        readonly label: "Greater than";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "date";
+            readonly label: "Date";
+            readonly componentType: "datePicker";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "less";
+        readonly label: "Less than";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "date";
+            readonly label: "Date";
+            readonly componentType: "datePicker";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "max";
+        readonly label: "Max value";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "date";
+            readonly label: "Date";
+            readonly componentType: "datePicker";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "min";
+        readonly label: "Min value";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "date";
+            readonly label: "Date";
+            readonly componentType: "datePicker";
+            readonly required: true;
+        }];
+    }, {
+        readonly key: "timestamp";
+        readonly label: "Timestamp";
+        readonly hasValue: true;
+        readonly params: readonly [{
+            readonly key: "type";
+            readonly label: "Type";
+            readonly componentType: "singleSelect";
+            readonly options: readonly [{
+                readonly label: "JavaScript";
+                readonly value: "javascript";
+            }, {
+                readonly label: "Unix";
+                readonly value: "unix";
+            }];
+            readonly defaultValue: "javascript";
+        }];
+    }];
+    readonly object: readonly {
+        key: string;
+        label: string;
+        hasValue: boolean;
+        params: any[];
+    }[];
+};
+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/es/collection-manager/interfaces/dateOnly.d.ts

@@ -27,6 +27,7 @@ export declare class DateFieldInterface extends CollectionFieldInterface {
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
     properties: {
         'uiSchema.x-component-props.showTime': {
             type: string;

package/es/collection-manager/interfaces/datetime.d.ts

@@ -30,6 +30,7 @@ export declare class DatetimeFieldInterface extends CollectionFieldInterface {
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
     properties: {
         defaultToCurrentTime: {
             type: string;

package/es/collection-manager/interfaces/datetimeNoTz.d.ts

@@ -30,6 +30,7 @@ export declare class DatetimeNoTzFieldInterface extends CollectionFieldInterface
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
     properties: {
         defaultToCurrentTime: {
             type: string;

package/es/collection-manager/interfaces/email.d.ts

@@ -25,6 +25,8 @@ export declare class EmailFieldInterface extends CollectionFieldInterface {
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
+    availableValidationOptions: string[];
     properties: {
         unique: {
             type: string;

package/es/collection-manager/interfaces/input.d.ts

@@ -25,6 +25,8 @@ export declare class InputFieldInterface extends CollectionFieldInterface {
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
+    availableValidationOptions: string[];
     properties: {
         trim: {
             type: string;

package/es/collection-manager/interfaces/integer.d.ts

@@ -28,6 +28,8 @@ export declare class IntegerFieldInterface extends CollectionFieldInterface {
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
+    excludeValidationOptions: string[];
     properties: {
         layout: {
             type: string;

package/es/collection-manager/interfaces/m2m.d.ts

@@ -36,6 +36,7 @@ export declare class M2MFieldInterface extends CollectionFieldInterface {
         };
     };
     availableTypes: string[];
+    validationType: string;
     schemaInitialize(schema: ISchema, { field, readPretty, block, targetCollection }: {
         field: any;
         readPretty: any;

package/es/collection-manager/interfaces/m2o.d.ts

@@ -16,6 +16,7 @@ export declare class M2OFieldInterface extends CollectionFieldInterface {
     title: string;
     description: string;
     isAssociation: boolean;
+    validationType: string;
     default: {
         type: string;
         uiSchema: {

package/es/collection-manager/interfaces/number.d.ts

@@ -27,6 +27,8 @@ export declare class NumberFieldInterface extends CollectionFieldInterface {
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
+    excludeValidationOptions: string[];
     properties: {
         unique: {
             type: string;

package/es/collection-manager/interfaces/o2m.d.ts

@@ -16,6 +16,7 @@ export declare class O2MFieldInterface extends CollectionFieldInterface {
     title: string;
     description: string;
     isAssociation: boolean;
+    validationType: string;
     default: {
         type: string;
         uiSchema: {

package/es/collection-manager/interfaces/o2o.d.ts

@@ -16,6 +16,7 @@ export declare class O2OFieldInterface extends CollectionFieldInterface {
     title: string;
     description: string;
     isAssociation: boolean;
+    validationType: string;
     default: {
         type: string;
         uiSchema: {
@@ -215,6 +216,7 @@ export declare class OHOFieldInterface extends CollectionFieldInterface {
     title: string;
     description: string;
     isAssociation: boolean;
+    validationType: string;
     default: {
         type: string;
         uiSchema: {
@@ -419,6 +421,7 @@ export declare class OBOFieldInterface extends CollectionFieldInterface {
     title: string;
     description: string;
     isAssociation: boolean;
+    validationType: string;
     default: {
         type: string;
         uiSchema: {

package/es/collection-manager/interfaces/password.d.ts

@@ -23,6 +23,8 @@ export declare class PasswordFieldInterface extends CollectionFieldInterface {
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
+    availableValidationOptions: string[];
     properties: {
         unique: {
             type: string;

package/es/collection-manager/interfaces/percent.d.ts

@@ -35,6 +35,8 @@ export declare class PercentFieldInterface extends CollectionFieldInterface {
     }): void;
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
+    excludeValidationOptions: string[];
     properties: {
         unique: {
             type: string;

package/es/collection-manager/interfaces/phone.d.ts

@@ -25,6 +25,8 @@ export declare class PhoneFieldInterface extends CollectionFieldInterface {
         };
     };
     availableTypes: string[];
+    validationType: string;
+    availableValidationOptions: string[];
     hasDefaultValue: boolean;
     properties: {
         unique: {

package/es/collection-manager/interfaces/textarea.d.ts

@@ -23,6 +23,8 @@ export declare class TextareaFieldInterface extends CollectionFieldInterface {
         };
     };
     availableTypes: string[];
+    validationType: string;
+    availableValidationOptions: string[];
     hasDefaultValue: boolean;
     titleUsable: boolean;
     properties: {

package/es/collection-manager/interfaces/unixTimestamp.d.ts

@@ -30,6 +30,8 @@ export declare class UnixTimestampFieldInterface extends CollectionFieldInterfac
     };
     availableTypes: string[];
     hasDefaultValue: boolean;
+    validationType: string;
+    availableValidationOptions: string[];
     properties: {
         accuracy: {
             type: string;

package/es/collection-manager/interfaces/url.d.ts

@@ -29,6 +29,8 @@ export declare class UrlFieldInterface extends CollectionFieldInterface {
     schemaInitialize(schema: ISchema, { block }: {
         block: any;
     }): void;
+    validationType: string;
+    availableValidationOptions: string[];
     properties: {
         'uiSchema.title': {
             type: string;

package/es/collection-manager/interfaces/uuid.d.ts

@@ -24,6 +24,8 @@ export declare class UUIDFieldInterface extends CollectionFieldInterface {
         };
     };
     availableTypes: string[];
+    validationType: string;
+    availableValidationOptions: string[];
     properties: {
         'uiSchema.title': {
             type: string;

package/es/data-source/collection-field-interface/CollectionFieldInterface.d.ts

@@ -38,6 +38,9 @@ export declare abstract class CollectionFieldInterface {
     isAssociation?: boolean;
     operators?: any[];
     properties?: any;
+    validationType?: string;
+    availableValidationOptions: string[];
+    excludeValidationOptions?: string[];
     /**
      * - 如果该值为空，则在 Filter 组件中该字段会被过滤掉
      * - 如果该值为空，则不会在变量列表中看到该字段
@@ -59,7 +62,7 @@ export declare abstract class CollectionFieldInterface {
     schemaInitialize?(schema: ISchema, data: any): void;
     hidden?: boolean;
     addComponentOption(componentOption: CollectionFieldInterfaceComponentOption): void;
-    getConfigureFormProperties(): any;
+    getConfigureFormProperties(collectionInfo?: any): Record<string, ISchema>;
     getDefaultValueProperty(): {
         defaultValue: any;
     };