@nocobase/client-v2 2.1.0-alpha.22 → 2.1.0-alpha.24

package/es/collection-manager/interfaces/snowflake-id.d.ts

@@ -0,0 +1,117 @@
+/**
+ * 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 { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class SnowflakeIdFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    primaryKeyDescription: string;
+    hidden: boolean;
+    sortable: boolean;
+    default: {
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                stringMode: boolean;
+                separator: string;
+                step: string;
+            };
+            'x-validator': string;
+        };
+    };
+    availableTypes: string[];
+    properties: {
+        layout: {
+            type: string;
+            title: string;
+            'x-component': string;
+            'x-decorator': string;
+            'x-decorator-props': {
+                style: {
+                    marginBottom: string;
+                };
+            };
+            properties: {
+                primaryKey: {
+                    type: string;
+                    'x-content': string;
+                    'x-decorator': string;
+                    'x-component': string;
+                    'x-disabled': string;
+                    'x-reactions': {
+                        dependencies: string[];
+                        when: string;
+                        fulfill: {
+                            state: {
+                                value: boolean;
+                            };
+                        };
+                    }[];
+                };
+                unique: {
+                    type: string;
+                    'x-content': string;
+                    'x-decorator': string;
+                    'x-component': string;
+                    'x-disabled': string;
+                    'x-reactions': {
+                        dependencies: string[];
+                        when: string;
+                        fulfill: {
+                            state: {
+                                value: boolean;
+                            };
+                        };
+                    }[];
+                };
+            };
+        };
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+        })[];
+    };
+    description: string;
+    titleUsable: boolean;
+}

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

@@ -0,0 +1,172 @@
+/**
+ * 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 { ISchema } from '@formily/react';
+import { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class SubTableFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    isAssociation: boolean;
+    default: {
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {};
+        };
+    };
+    availableTypes: string[];
+    schemaInitialize(schema: ISchema, { field, readPretty }: {
+        field: any;
+        readPretty: any;
+    }): void;
+    initialize: (values: any) => void;
+    properties: {
+        subtable: {
+            type: string;
+            'x-component': string;
+            properties: {
+                actions: {
+                    type: string;
+                    'x-component': string;
+                    'x-component-props': {};
+                    properties: {
+                        delete: {
+                            type: string;
+                            title: string;
+                            'x-component': string;
+                            'x-component-props': {
+                                useAction: string;
+                                confirm: {
+                                    title: string;
+                                    content: string;
+                                };
+                            };
+                        };
+                        create: {
+                            type: string;
+                            title: string;
+                            'x-component': string;
+                            'x-component-props': {
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                children: {
+                    type: string;
+                    title: string;
+                    'x-decorator': string;
+                    'x-component': string;
+                    'x-component-props': {
+                        pagination: boolean;
+                        expandable: {
+                            childrenColumnName: string;
+                        };
+                        rowKey: string;
+                        rowSelection: {
+                            type: string;
+                        };
+                        useSelectedRowKeys: string;
+                        useDataSource: string;
+                    };
+                    properties: {
+                        column1: {
+                            type: string;
+                            title: string;
+                            'x-component': string;
+                            properties: {
+                                'uiSchema.title': {
+                                    type: string;
+                                    'x-component': string;
+                                    'x-read-pretty': boolean;
+                                };
+                            };
+                        };
+                        column2: {
+                            type: string;
+                            title: string;
+                            'x-component': string;
+                            properties: {
+                                name: {
+                                    'x-component': string;
+                                    'x-read-pretty': boolean;
+                                };
+                            };
+                        };
+                        column3: {
+                            type: string;
+                            title: string;
+                            'x-component': string;
+                            properties: {
+                                interface: {
+                                    'x-component': string;
+                                    'x-read-pretty': boolean;
+                                };
+                            };
+                        };
+                        column4: {
+                            type: string;
+                            title: string;
+                            'x-component': string;
+                            properties: {
+                                actions: {
+                                    type: string;
+                                    'x-component': string;
+                                    'x-component-props': {
+                                        split: string;
+                                    };
+                                    properties: {
+                                        update: {
+                                            type: string;
+                                            title: string;
+                                            'x-component': string;
+                                            'x-component-props': {};
+                                        };
+                                        delete: {
+                                            type: string;
+                                            title: string;
+                                            'x-component': string;
+                                            'x-component-props': {
+                                                useAction: string;
+                                                confirm: {
+                                                    title: string;
+                                                    content: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+}

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

@@ -0,0 +1,59 @@
+/**
+ * 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 { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class TableoidFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    sortable: boolean;
+    default: {
+        name: string;
+        type: string;
+        uiSchema: {
+            type: string;
+            title: string;
+            'x-component': string;
+            'x-component-props': {
+                isTableOid: boolean;
+            };
+            'x-read-pretty': boolean;
+        };
+    };
+    properties: {
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+    };
+    filterable: {
+        operators: {
+            label: string;
+            value: string;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    mode: string;
+                };
+            };
+        }[];
+    };
+}

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

@@ -0,0 +1,107 @@
+/**
+ * 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 { ISchema } from '@formily/react';
+import { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class TextareaFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    default: {
+        interface: string;
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    availableTypes: string[];
+    validationType: string;
+    availableValidationOptions: string[];
+    hasDefaultValue: boolean;
+    titleUsable: boolean;
+    properties: {
+        trim: {
+            type: string;
+            'x-content': string;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+    schemaInitialize(schema: ISchema, { block }: {
+        block: any;
+    }): void;
+    validateSchema: (fieldSchema: any) => {
+        max: {
+            type: string;
+            title: string;
+            minimum: number;
+            'x-decorator': string;
+            'x-component': string;
+            'x-component-props': {
+                precision: number;
+            };
+            'x-reactions': string;
+        };
+        min: {
+            type: string;
+            title: string;
+            minimum: number;
+            'x-decorator': string;
+            'x-component': string;
+            'x-component-props': {
+                precision: number;
+            };
+            'x-reactions': {
+                dependencies: string[];
+                fulfill: {
+                    state: {
+                        selfErrors: string;
+                    };
+                };
+            };
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+        })[];
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class TimeFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    sortable: boolean;
+    default: {
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    availableTypes: string[];
+    hasDefaultValue: boolean;
+    properties: {
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+        })[];
+    };
+    titleUsable: boolean;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 { ISchema } from '@formily/react';
+interface IDefault {
+    type: string;
+    uiSchema?: ISchema;
+    [key: string]: any;
+}
+export interface IField extends ISchema {
+    group?: string;
+    order?: number;
+    default?: IDefault;
+    operators?: any[];
+    /**
+     * - 如果该值为空，则在 Filter 组件中该字段会被过滤掉
+     * - 如果该值为空，则不会在变量列表中看到该字段
+     */
+    filterable?: {
+        /**
+         * 字段所支持的操作符，会在 Filter 组件中显示，比如设置 `数据范围` 的时候可以看见
+         */
+        operators?: any[];
+        /**
+         * 为当前字段添加子选项，这个子选项会在 Filter 组件中显示，比如设置 `数据范围` 的时候可以看见
+         */
+        children?: any[];
+        [key: string]: any;
+    };
+    titleUsable?: boolean;
+    [key: string]: any;
+}
+export {};

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

@@ -0,0 +1,124 @@
+/**
+ * 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 { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class UnixTimestampFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    sortable: boolean;
+    default: {
+        type: string;
+        accuracy: string;
+        timezone: boolean;
+        defaultToCurrentTime: boolean;
+        onUpdateToCurrentTime: boolean;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                showTime: boolean;
+            };
+        };
+    };
+    availableTypes: string[];
+    hasDefaultValue: boolean;
+    validationType: string;
+    availableValidationOptions: string[];
+    properties: {
+        accuracy: {
+            type: string;
+            title: string;
+            'x-component': string;
+            'x-decorator': string;
+            default: string;
+            enum: {
+                value: string;
+                label: string;
+            }[];
+        };
+        defaultToCurrentTime: {
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-content': string;
+        };
+        onUpdateToCurrentTime: {
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-content': string;
+        };
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    isRange: boolean;
+                };
+            };
+            onlyFilterAction: boolean;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    isRange: boolean;
+                };
+            };
+            onlyFilterAction: boolean;
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    isRange: boolean;
+                };
+            };
+            selected?: undefined;
+            onlyFilterAction?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+            schema?: undefined;
+            onlyFilterAction?: undefined;
+        })[];
+    };
+    titleUsable: boolean;
+}