@nocobase/plugin-data-source-manager 2.1.0-beta.9 → 2.2.0-alpha.1

package/dist/client-v2/pages/permissions/types.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 type { ReactNode } from 'react';
+export interface AvailableAction {
+    name: string;
+    displayName?: ReactNode;
+    onNewRecord?: boolean;
+    allowConfigureFields?: boolean;
+}
+export interface DataSourceRecord {
+    key: string;
+    displayName?: ReactNode;
+    type?: string;
+    enabled?: boolean;
+}
+export interface CollectionFieldRecord {
+    name: string;
+    interface?: string;
+    type?: string;
+    target?: string;
+    uiSchema?: {
+        title?: ReactNode;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+export interface RoleCollectionRecord {
+    type?: string;
+    name: string;
+    collectionName?: string;
+    title?: ReactNode;
+    roleName: string;
+    usingConfig?: 'strategy' | 'resourceAction';
+    exists?: boolean;
+    fields?: CollectionFieldRecord[];
+}
+export interface RoleResourceAction {
+    name: string;
+    fields?: string[];
+    scopeId?: string | number | null;
+    scope?: unknown;
+}
+export interface ScopeRecord {
+    id: string | number;
+    key?: string;
+    name?: string;
+    resourceName?: string | null;
+    scope?: Record<string, unknown>;
+}

package/dist/client-v2/plugin.d.ts

@@ -0,0 +1,243 @@
+/**
+ * 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 { Application, Plugin, type CollectionTemplateField } from '@nocobase/client-v2';
+import React, { ComponentType } from 'react';
+import { FieldInterfaceConfigureOptions } from './field-interfaces';
+import { DataSourcePermissionTabRegistry, type DataSourcePermissionTabOptionResolver, type DataSourcePermissionTabProps } from './registries';
+export interface DataSourceSettingsFormProps {
+    mode: 'create' | 'edit';
+    type: DataSourceTypeOptions;
+    initialValues?: Record<string, any>;
+    loadCollections: (key: string) => Promise<any>;
+}
+export interface DataSourceCollectionActionProps {
+    dataSourceKey: string;
+    record?: Record<string, any>;
+    selectedRowKeys?: React.Key[];
+    onSubmitted?: () => void;
+    children?: React.ReactNode;
+    isBulk?: boolean;
+}
+export interface DataSourceFieldInterfaceFilterOptions {
+    groups?: string[];
+    include?: string[];
+    exclude?: string[];
+}
+export interface DataSourceFieldInterfaceReadOnlyContext {
+    collection: Record<string, unknown>;
+    field: Record<string, unknown>;
+    fieldInterface?: {
+        name?: string;
+        group?: string;
+        isAssociation?: boolean;
+    };
+}
+export interface DataSourceTypeOptions {
+    name?: string;
+    label?: React.ReactNode;
+    defaultValues?: Record<string, any>;
+    createFieldInterfaces?: DataSourceFieldInterfaceFilterOptions | ((context: {
+        collection: Record<string, any>;
+    }) => DataSourceFieldInterfaceFilterOptions | undefined);
+    disableAddFields?: boolean;
+    disableConfigureFields?: boolean;
+    disableTestConnection?: boolean;
+    capabilities?: {
+        query?: boolean;
+        runSQL?: boolean;
+    };
+    AddCollection?: ComponentType<DataSourceCollectionActionProps>;
+    EditCollection?: ComponentType<DataSourceCollectionActionProps>;
+    DeleteCollection?: ComponentType<DataSourceCollectionActionProps>;
+    allowCollectionCreate?: boolean;
+    allowCollectionDeletion?: boolean;
+    isFieldInterfaceReadOnly?: (context: DataSourceFieldInterfaceReadOnlyContext) => boolean | undefined;
+    normalizeValues?: (values: Record<string, any>) => Record<string, any>;
+    SettingsForm?: ComponentType<DataSourceSettingsFormProps>;
+}
+export interface CollectionPresetFieldOptions {
+    name?: string;
+    order?: number;
+    field?: React.ReactNode;
+    interfaceLabel?: React.ReactNode;
+    description?: React.ReactNode;
+    defaultSelected?: boolean;
+    value: CollectionTemplateField & {
+        name: string;
+        interface?: string;
+        primaryKey?: boolean;
+        uiSchema?: Record<string, any>;
+        [key: string]: any;
+    };
+}
+export interface CollectionTemplateFormProps {
+    mode: 'create' | 'edit';
+    template: CollectionTemplateOptions;
+    form: any;
+}
+export interface CollectionTemplateConfigureItemProps extends CollectionTemplateFormProps {
+    item: CollectionTemplateConfigureItem;
+}
+export interface CollectionTemplateSyncFieldsProps {
+    collection: Record<string, any>;
+    dataSourceKey: string;
+    onSubmitted: () => void;
+}
+export interface CollectionTemplateSyncFieldsOptions {
+    Component?: ComponentType<CollectionTemplateSyncFieldsProps>;
+    visible?: boolean | ((props: {
+        collection: Record<string, any>;
+        dataSourceKey: string;
+    }) => boolean);
+}
+export interface CollectionTemplateConfigureItem {
+    name?: string;
+    label?: React.ReactNode;
+    component?: 'Input' | 'Input.TextArea' | 'Select' | 'Checkbox';
+    options?: Array<{
+        label: React.ReactNode;
+        value: string | number | boolean;
+    }>;
+    Component?: ComponentType<CollectionTemplateConfigureItemProps>;
+    componentProps?: Record<string, unknown>;
+    required?: boolean;
+    hidden?: boolean | ((props: CollectionTemplateFormProps) => boolean);
+}
+export interface CollectionTemplateOptions {
+    name?: string;
+    title: React.ReactNode;
+    description?: React.ReactNode;
+    order?: number;
+    color?: string;
+    divider?: boolean;
+    collection?: {
+        options?: Record<string, any> | (() => Record<string, any>);
+        fields?: CollectionTemplateField[] | (() => CollectionTemplateField[]);
+    };
+    capabilities?: {
+        inherits?: boolean;
+        recordUniqueKey?: boolean;
+        simplePaginate?: boolean;
+    };
+    configure?: {
+        items?: CollectionTemplateConfigureItem[];
+        Form?: ComponentType<CollectionTemplateFormProps>;
+        syncFields?: CollectionTemplateSyncFieldsOptions;
+        transformSubmitValues?: (values: Record<string, any>) => Record<string, any> | void;
+    };
+    fieldInterfaces?: {
+        include?: Array<string | {
+            interface?: string;
+            name?: string;
+            targetScope?: Record<string, unknown>;
+        }>;
+        exclude?: string[];
+        create?: {
+            include?: Array<string | {
+                interface?: string;
+                name?: string;
+                targetScope?: Record<string, unknown>;
+            }>;
+            exclude?: string[];
+        };
+    };
+    /**
+     * @deprecated Use fieldInterfaces instead.
+     */
+    availableFieldInterfaces?: {
+        include?: Array<string | {
+            interface?: string;
+            name?: string;
+            targetScope?: Record<string, unknown>;
+        }>;
+        exclude?: string[];
+        create?: {
+            include?: Array<string | {
+                interface?: string;
+                name?: string;
+                targetScope?: Record<string, unknown>;
+            }>;
+            exclude?: string[];
+        };
+    };
+    presetFields?: {
+        disabled?: boolean;
+        disabledIncludes?: string[];
+    };
+    actions?: unknown[];
+    /**
+     * @deprecated Use collection.options instead.
+     */
+    defaultValues?: Record<string, any> | (() => Record<string, any>);
+    /**
+     * @deprecated Use presetFields.disabled instead.
+     */
+    presetFieldsDisabled?: boolean;
+    /**
+     * @deprecated Use presetFields.disabledIncludes instead.
+     */
+    presetFieldsDisabledIncludes?: string[];
+    /**
+     * @deprecated Use configure.Form instead.
+     */
+    ConfigureForm?: ComponentType<CollectionTemplateFormProps>;
+    /**
+     * @deprecated Use configure.transformSubmitValues instead.
+     */
+    beforeSubmit?: (values: Record<string, any>) => void;
+}
+declare class CollectionTemplateRegistry {
+    protected templates: Map<string, CollectionTemplateOptions>;
+    register(nameOrOptions: string | CollectionTemplateOptions, options?: CollectionTemplateOptions): void;
+    get(name?: string): CollectionTemplateOptions;
+    getAll(): CollectionTemplateOptions[];
+}
+declare class CollectionPresetFieldRegistry {
+    protected fields: Map<string, CollectionPresetFieldOptions>;
+    register(options: CollectionPresetFieldOptions): void;
+    remove(name: string): void;
+    getAll(): CollectionPresetFieldOptions[];
+}
+declare class ExtensionManager {
+    protected managerActions: Array<{
+        order: number;
+        component: ComponentType;
+    }>;
+    registerManagerAction({ order, component }: {
+        order?: number;
+        component: ComponentType;
+    }): void;
+    getManagerActions(): {
+        order: number;
+        component: React.ComponentType;
+    }[];
+}
+export declare class PluginDataSourceManagerClientV2 extends Plugin<any, Application> {
+    types: Map<string, DataSourceTypeOptions>;
+    extensionManager: ExtensionManager;
+    collectionTemplateRegistry: CollectionTemplateRegistry;
+    collectionPresetFieldRegistry: CollectionPresetFieldRegistry;
+    permissionTabRegistry: DataSourcePermissionTabRegistry;
+    load(): Promise<void>;
+    registerType(name: string, options: DataSourceTypeOptions): void;
+    getType(name?: string): DataSourceTypeOptions;
+    registerFieldInterfaceConfigure(options: FieldInterfaceConfigureOptions): void;
+    registerCollectionTemplate(nameOrOptions: string | CollectionTemplateOptions, options?: CollectionTemplateOptions): void;
+    registerCollectionPresetField(options: CollectionPresetFieldOptions): void;
+    registerPermissionTab(options: DataSourcePermissionTabOptionResolver): void;
+    getPermissionTabs(props: DataSourcePermissionTabProps): import("./registries").DataSourcePermissionTabOptions[];
+    addCollectionPresetField(options: CollectionPresetFieldOptions): void;
+    removeCollectionPresetField(name: string): void;
+    getCollectionPresetFields(): CollectionPresetFieldOptions[];
+    getCollectionTemplate(name?: string): CollectionTemplateOptions;
+    getCollectionTemplates(): CollectionTemplateOptions[];
+    private registerBuiltInCollectionPresetFields;
+    private registerBuiltInCollectionTemplates;
+}
+export default PluginDataSourceManagerClientV2;

package/dist/client-v2/registries.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 type { ComponentType, ReactNode } from 'react';
+import type { AvailableAction, DataSourceRecord } from './pages/permissions/types';
+export type DataSourcePermissionT = (key: string, options?: Record<string, unknown>) => string;
+export interface DataSourcePermissionRole {
+    name: string;
+    title?: string;
+}
+export interface DataSourcePermissionTabProps {
+    activeRole?: DataSourcePermissionRole | null;
+    availableActions: AvailableAction[];
+    dataSource: DataSourceRecord;
+    t: DataSourcePermissionT;
+}
+export type ComponentLoader<Props> = () => Promise<{
+    default: ComponentType<Props>;
+}>;
+export interface DataSourcePermissionTabOptions {
+    key: string;
+    label: ReactNode;
+    componentLoader: ComponentLoader<DataSourcePermissionTabProps>;
+    sort?: number;
+}
+export type DataSourcePermissionTabOptionResolver = DataSourcePermissionTabOptions | ((props: DataSourcePermissionTabProps) => DataSourcePermissionTabOptions | null | undefined);
+export declare class DataSourcePermissionTabRegistry {
+    private readonly permissionTabs;
+    add(options: DataSourcePermissionTabOptionResolver): void;
+    getPermissionTabs(props: DataSourcePermissionTabProps): DataSourcePermissionTabOptions[];
+}

package/dist/client-v2/runtime.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { type DataSourceManager } from '@nocobase/flow-engine';
+import type React from 'react';
+export declare function syncDataSourcesToRuntime(dataSourceManager: DataSourceManager | undefined, records: Array<Record<string, any>>): void;
+export declare function removeDataSourcesFromRuntime(dataSourceManager: DataSourceManager | undefined, keys: React.Key[]): void;

package/dist/client-v2/utils/compileLegacyTemplate.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 type { ReactNode } from 'react';
+type TOptions = Record<string, unknown>;
+type TFunction = (key: string, options?: TOptions) => string;
+export declare function getLegacyTemplateKey(value: ReactNode): string;
+export declare function compileLegacyTemplate(value: ReactNode, t: TFunction): ReactNode;
+export declare function preferLegacyTemplateTitle(value: ReactNode, templateTitle?: ReactNode): ReactNode;
+export declare function compileLegacyTemplateText(value: ReactNode, t: TFunction, fallback?: string): string;
+export {};

package/dist/client-v2/utils/error.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 function isFormValidationError(error: unknown): boolean;
+export declare function getErrorMessage(error: unknown, fallback?: string): string;
+export declare function getResponseErrorMessage(response: unknown): string;

package/dist/externalVersion.js

@@ -8,30 +8,34 @@
  */
 
 module.exports = {
-  "@nocobase/client": "2.1.0-beta.9",
+  "@nocobase/client": "2.2.0-alpha.1",
   "react": "18.2.0",
-  "@nocobase/plugin-acl": "2.1.0-beta.9",
-  "@nocobase/utils": "2.1.0-beta.9",
-  "@nocobase/server": "2.1.0-beta.9",
-  "@nocobase/data-source-manager": "2.1.0-beta.9",
-  "lodash": "4.17.21",
-  "@nocobase/acl": "2.1.0-beta.9",
-  "@nocobase/database": "2.1.0-beta.9",
-  "@nocobase/actions": "2.1.0-beta.9",
-  "@nocobase/ai": "2.1.0-beta.9",
+  "@nocobase/plugin-acl": "2.2.0-alpha.1",
+  "@nocobase/utils": "2.2.0-alpha.1",
+  "@nocobase/flow-engine": "2.2.0-alpha.1",
+  "@nocobase/client-v2": "2.2.0-alpha.1",
+  "@nocobase/ai": "2.2.0-alpha.1",
+  "@nocobase/server": "2.2.0-alpha.1",
+  "@nocobase/data-source-manager": "2.2.0-alpha.1",
+  "lodash": "4.18.1",
+  "@nocobase/acl": "2.2.0-alpha.1",
+  "@nocobase/database": "2.2.0-alpha.1",
   "@ant-design/icons": "5.6.1",
   "antd": "5.24.2",
   "react-router-dom": "6.30.1",
-  "@nocobase/flow-engine": "2.1.0-beta.9",
   "@formily/shared": "2.3.7",
   "@formily/react": "2.3.7",
   "react-i18next": "11.18.6",
   "@emotion/css": "11.13.0",
+  "ahooks": "3.7.8",
+  "@nocobase/actions": "2.2.0-alpha.1",
   "sequelize": "6.35.2",
-  "@nocobase/test": "2.1.0-beta.9",
+  "@nocobase/test": "2.2.0-alpha.1",
   "@formily/antd-v5": "1.2.3",
   "@formily/core": "2.3.7",
   "@formily/reactive": "2.3.7",
   "@dnd-kit/core": "6.1.0",
-  "antd-style": "3.7.1"
+  "antd-style": "3.7.1",
+  "@dnd-kit/sortable": "7.0.2",
+  "dayjs": "1.11.13"
 };