@nocobase/plugin-kanban 2.1.0-beta.2 → 2.1.0-beta.20

package/dist/client/models/KanbanBlockModel.d.ts

@@ -0,0 +1,121 @@
+/**
+ * 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 { CollectionBlockModel } from '@nocobase/client';
+import { MultiRecordResource } from '@nocobase/flow-engine';
+import React from 'react';
+import { type KanbanGroupOption } from './utils';
+declare class KanbanBlockResource extends MultiRecordResource {
+    refresh(): Promise<void>;
+}
+export declare class KanbanBlockModel extends CollectionBlockModel<{
+    subModels: {
+        item: any;
+        actions?: any[];
+        cardViewAction?: any;
+        quickCreateAction?: any;
+    };
+}> {
+    static scene: any;
+    isManualRefresh: boolean;
+    defaultProps: {
+        dragEnabled: boolean;
+        quickCreateEnabled: boolean;
+        styleVariant: string;
+    };
+    _defaultCustomModelClasses: {
+        CollectionActionGroupModel: string;
+        RecordActionGroupModel: string;
+        TableColumnModel: string;
+        TableAssociationFieldGroupModel: string;
+        TableCustomColumnModel: string;
+    };
+    static filterCollection(collection: any): boolean;
+    get resource(): MultiRecordResource<any>;
+    getGroupFieldCandidates(): any;
+    getSortFieldCandidates(groupFieldOrName?: any): any;
+    getDefaultGroupFieldName(): any;
+    getGroupField(): import("@nocobase/flow-engine").CollectionField;
+    getInlineGroupOptions(field?: import("@nocobase/flow-engine").CollectionField): KanbanGroupOption[];
+    getConfiguredGroupOptions(): KanbanGroupOption[];
+    getGroupTitleFieldName(field?: import("@nocobase/flow-engine").CollectionField): string | undefined;
+    getGroupColorFieldName(field?: import("@nocobase/flow-engine").CollectionField): string | undefined;
+    getRelationOptionFieldCandidates(field?: import("@nocobase/flow-engine").CollectionField): Array<{
+        label: string;
+        value: string;
+    }>;
+    loadRelationGroupOptions(field?: import("@nocobase/flow-engine").CollectionField, options?: {
+        titleFieldName?: string;
+        colorFieldName?: string;
+        savedOptions?: Array<Partial<KanbanGroupOption>>;
+    }): Promise<KanbanGroupOption[]>;
+    getPageSize(): any;
+    getColumnWidth(): any;
+    getConfiguredSortFieldName(): string;
+    getConfiguredGlobalSort(): any;
+    getConfiguredDragSortFieldName(): string;
+    getCompatibleSortFieldName(sortFieldName?: string, groupFieldOrName?: any): any;
+    getSortFieldName(groupFieldOrName?: any): any;
+    getDragSortFieldName(groupFieldOrName?: any): any;
+    getEffectiveSortFieldName(groupFieldOrName?: any): any;
+    getDragEnabled(): boolean;
+    getCardOpenMode(): "dialog" | "embed" | "drawer";
+    getCardPopupSize(): "large" | "medium" | "small";
+    getCardPopupTemplateUid(): string;
+    getCardPopupPageModelClass(): any;
+    getQuickCreateEnabled(): boolean;
+    getPopupMode(): "dialog" | "embed" | "drawer";
+    getPopupSize(): "large" | "medium" | "small";
+    getPopupTemplateUid(): string;
+    getPopupPageModelClass(): any;
+    getPopupTargetUid(): string;
+    getCardPopupTargetUid(): string;
+    getStyleVariant(): "default" | "filled";
+    isCardClickable(): boolean;
+    canDragSort(): boolean;
+    canCrossColumnDrag(): boolean;
+    getDataLoadingMode(): 'auto' | 'manual';
+    createResource(): KanbanBlockResource;
+    onActive(forceRefresh?: boolean): void;
+    renderConfigureActions(): React.JSX.Element;
+    renderActions(): React.JSX.Element;
+    getPopupActionUid(): string;
+    getQuickCreateActionUid(): string;
+    syncPopupAction(action: any, options: {
+        mode: string;
+        size: string;
+        popupTemplateUid?: string;
+        uid?: string;
+        pageModelClass?: string;
+    }): Promise<void>;
+    syncCardViewAction(action: any): Promise<void>;
+    ensureCardViewAction(): Promise<any>;
+    getQuickCreateAction(): any;
+    ensureQuickCreateAction(): Promise<any>;
+    syncQuickCreateAction(action: any): Promise<void>;
+    openEmptyPopupShell(options: {
+        mode?: string;
+        size?: string;
+        title?: string;
+    }): Promise<boolean>;
+    buildQuickCreateFormData(column?: {
+        value?: string;
+        isUnknown?: boolean;
+    }): {
+        [x: number]: string | {
+            [x: number]: string;
+        };
+    };
+    openQuickCreate(column?: {
+        value?: string;
+        isUnknown?: boolean;
+    }): Promise<void>;
+    openCard(record: any): Promise<void>;
+    renderComponent(): React.JSX.Element;
+}
+export {};

package/dist/client/models/KanbanCardItemModel.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 { DetailsGridModel } from '@nocobase/client';
+import { FlowModel } from '@nocobase/flow-engine';
+import React from 'react';
+type KanbanCardItemStructure = {
+    subModels: {
+        grid: DetailsGridModel;
+    };
+};
+export declare class KanbanCardItemModel extends FlowModel<KanbanCardItemStructure> {
+    render(): React.JSX.Element;
+}
+export {};

package/dist/client/models/KanbanCollectionActionGroupModel.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 { ActionGroupModel } from '@nocobase/client';
+import { type FlowModelContext } from '@nocobase/flow-engine';
+export declare class KanbanCollectionActionGroupModel extends ActionGroupModel {
+    static defineChildren(ctx: FlowModelContext): Promise<any[]>;
+}

package/dist/client/models/actions/KanbanPopupModels.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { AddNewActionModel, ViewActionModel } from '@nocobase/client';
+export declare const createKanbanQuickCreateActionOptions: (uid?: string) => {
+    uid: string;
+    use: string;
+};
+export declare const createKanbanCardViewActionOptions: (uid?: string) => {
+    uid: string;
+    use: string;
+};
+export declare class KanbanQuickCreateActionModel extends AddNewActionModel {
+    defaultPopupTitle: string;
+}
+export declare class KanbanCardViewActionModel extends ViewActionModel {
+    defaultPopupTitle: string;
+}

package/dist/client/models/components/KanbanBlock.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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';
+import type { KanbanBlockModel } from '../KanbanBlockModel';
+export declare const KanbanBlockView: React.MemoExoticComponent<import("@formily/reactive-react").ReactFC<{
+    model: KanbanBlockModel;
+}>>;

package/dist/client/models/components/KanbanCreateSortFieldSelect.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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';
+type SortFieldOption = {
+    label: string;
+    value: string;
+    scopeKey?: string;
+    uiSchema?: {
+        title?: string;
+    };
+};
+type CollectionFieldMetadata = {
+    name: string;
+    interface?: string;
+    foreignKey?: string;
+    scopeKey?: string;
+    uiSchema?: {
+        title?: string;
+    };
+};
+type GroupFieldOption = {
+    label: string;
+    value: string;
+};
+export declare const upsertKanbanCollectionFieldOptions: (fields?: Record<string, any>[], fieldData?: Record<string, any>) => Record<string, any>[];
+export declare const KanbanCreateSortFieldSelect: (props: {
+    [key: string]: any;
+    sortFields?: SortFieldOption[];
+    collectionFields?: CollectionFieldMetadata[];
+    groupField?: GroupFieldOption;
+    collectionName?: string;
+    dataSource?: string;
+}) => React.JSX.Element;
+export {};

package/dist/client/models/components/KanbanGroupOptionsTable.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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';
+import type { KanbanBlockModel } from '../KanbanBlockModel';
+import { type KanbanGroupOption } from '../utils';
+type GroupOptionsValue = KanbanGroupOption[];
+export declare const KanbanGroupOptionsTable: React.MemoExoticComponent<import("@formily/react").ReactFC<{
+    value?: GroupOptionsValue;
+    onChange?: (value: GroupOptionsValue) => void;
+    groupFieldName?: string;
+    model?: KanbanBlockModel;
+    collection?: any;
+    dataSourceKey?: string;
+}>>;
+export {};

package/dist/client/models/components/KanbanGroupingSelector.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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';
+import type { KanbanBlockModel } from '../KanbanBlockModel';
+import { type KanbanGroupOption, type KanbanGroupingValue } from '../utils';
+export declare const KanbanGroupingSelector: React.MemoExoticComponent<import("@formily/react").ReactFC<{
+    value?: KanbanGroupOption[] | KanbanGroupingValue;
+    onChange?: (value: KanbanGroupOption[]) => void;
+    model?: KanbanBlockModel;
+    collection?: any;
+    dataSourceKey?: string;
+}>>;

package/dist/client/models/components/kanban-block/CardRenderer.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';
+import type { KanbanBlockModel } from '../../KanbanBlockModel';
+import { type KanbanRuntimeRecord } from './shared';
+export declare const CardPlaceholder: () => React.JSX.Element;
+type LazyCardRendererProps = {
+    model: KanbanBlockModel;
+    record: any;
+    index: number;
+    columnKey: string;
+    enableDesignSettings?: boolean;
+};
+export declare const LazyCardRenderer: React.MemoExoticComponent<({ model, record, index, columnKey, enableDesignSettings }: LazyCardRendererProps) => React.JSX.Element>;
+type DraggableKanbanCardProps = {
+    model: KanbanBlockModel;
+    record: KanbanRuntimeRecord;
+    index: number;
+    columnKey: string;
+    dragEnabled: boolean;
+    dragInteractionEnabled: boolean;
+    enableDesignSettings?: boolean;
+};
+export declare const DraggableKanbanCard: React.MemoExoticComponent<({ model, record, index, columnKey, dragEnabled, dragInteractionEnabled, enableDesignSettings, }: DraggableKanbanCardProps) => React.JSX.Element>;
+export {};

package/dist/client/models/components/kanban-block/ColumnPanel.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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';
+import type { KanbanBlockModel } from '../../KanbanBlockModel';
+import { type ColumnRefreshMeta, type ColumnState, type KanbanDesignSettingsHost, type KanbanRuntimeRecord, type RuntimeColumn } from './shared';
+type ColumnPanelProps = {
+    model: KanbanBlockModel;
+    column: RuntimeColumn;
+    state: ColumnState | undefined;
+    displayItems: KanbanRuntimeRecord[];
+    setState: React.Dispatch<React.SetStateAction<Record<string, ColumnState>>>;
+    refreshMeta?: ColumnRefreshMeta;
+    designSettingsHost?: KanbanDesignSettingsHost | null;
+    fixedHeight: boolean;
+    dragEnabled: boolean;
+    dragInteractionEnabled: boolean;
+    hidden?: boolean;
+};
+export declare const ColumnPanel: React.MemoExoticComponent<({ model, column, state, displayItems, setState, refreshMeta, designSettingsHost, fixedHeight, dragEnabled, dragInteractionEnabled, hidden, }: ColumnPanelProps) => React.JSX.Element>;
+export {};

package/dist/client/models/components/kanban-block/shared.d.ts

@@ -0,0 +1,127 @@
+/**
+ * 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 { MultiRecordResource } from '@nocobase/flow-engine';
+import type { KanbanBlockModel } from '../../KanbanBlockModel';
+export type DropResult = {
+    source: {
+        droppableId: string;
+        index: number;
+    };
+    destination?: {
+        droppableId: string;
+        index: number;
+    } | null;
+};
+export type ColumnState = {
+    items: any[];
+    page: number;
+    hasNext: boolean;
+    count?: number;
+    loading: boolean;
+    error?: string;
+    loadedRefreshToken: number;
+};
+export type RuntimeColumn = {
+    key: string;
+    value: string;
+    label: string;
+    color: string;
+    isUnknown?: boolean;
+};
+export type KanbanDesignSettingsHost = {
+    columnKey: string;
+    recordKey?: string;
+    index: number;
+};
+export type ColumnRefreshMeta = {
+    token: number;
+    reason: 'global' | 'drag';
+    activeRecordKey?: string;
+};
+export type KanbanRuntimeRecord = {
+    id?: string | number;
+    __kanbanRecordKey?: string;
+    __kanbanRecordKeyValue?: any;
+    __kanbanColumnKey?: string;
+    [key: string]: any;
+};
+export declare const createInitialColumnState: (loading?: boolean) => ColumnState;
+export declare const getRuntimeRecordKey: (record: KanbanRuntimeRecord, collection?: {
+    filterTargetKey?: string | string[];
+    getFilterByTK?: (record: any) => any;
+}) => string;
+export declare const normalizeKanbanRuntimeRecord: (record: any, collection?: {
+    filterTargetKey?: string | string[];
+    getFilterByTK?: (record: any) => any;
+}) => KanbanRuntimeRecord;
+export declare const dedupeColumnItemsByRecordKey: (items: KanbanRuntimeRecord[], collection?: {
+    filterTargetKey?: string | string[];
+    getFilterByTK?: (record: any) => any;
+}) => KanbanRuntimeRecord[];
+export declare const getKanbanCardRenderKey: (options: {
+    columnKey: string;
+    record: any;
+    index: number;
+}) => string;
+export declare const getKanbanDesignSettingsHost: (options: {
+    enabled: boolean;
+    columns: RuntimeColumn[];
+    itemsByColumn: Record<string, KanbanRuntimeRecord[]>;
+    collection?: {
+        filterTargetKey?: string | string[];
+        getFilterByTK?: (record: any) => any;
+    };
+}) => KanbanDesignSettingsHost | null;
+export declare const shouldMountUnknownColumn: (options: {
+    state?: ColumnState;
+    refreshMeta?: ColumnRefreshMeta;
+    displayItems?: KanbanRuntimeRecord[];
+}) => boolean;
+export declare const shouldHideUnknownColumn: (options: {
+    state?: ColumnState;
+    refreshMeta?: ColumnRefreshMeta;
+    displayItems?: KanbanRuntimeRecord[];
+}) => boolean;
+export declare const isKanbanDesignSettingsHost: (options: {
+    host: KanbanDesignSettingsHost | null | undefined;
+    columnKey: string;
+    record: KanbanRuntimeRecord;
+    index: number;
+    collection?: {
+        filterTargetKey?: string | string[];
+        getFilterByTK?: (record: any) => any;
+    };
+}) => boolean;
+export declare const removeKanbanColumnOverride: (record: KanbanRuntimeRecord) => KanbanRuntimeRecord;
+export declare const applyKanbanColumnOverride: (options: {
+    record: KanbanRuntimeRecord;
+    sourceColumnKey: string;
+    targetColumnKey: string;
+}) => KanbanRuntimeRecord;
+export declare const moveKanbanRecordByCoordinates: (options: {
+    itemsByColumn: Record<string, KanbanRuntimeRecord[]>;
+    sourceColumnKey: string;
+    sourceIndex: number;
+    targetColumnKey: string;
+    targetIndex: number;
+}) => Record<string, KanbanRuntimeRecord[]>;
+export declare const areKanbanRecordListsEqual: (left?: KanbanRuntimeRecord[], right?: KanbanRuntimeRecord[], collection?: {
+    filterTargetKey?: string | string[];
+    getFilterByTK?: (record: any) => any;
+}) => boolean;
+export declare const reuseKanbanRecordReferences: (options: {
+    previousItems?: KanbanRuntimeRecord[];
+    nextItems?: KanbanRuntimeRecord[];
+    collection?: {
+        filterTargetKey?: string | string[];
+        getFilterByTK?: (record: any) => any;
+    };
+    skipRecordKeys?: Array<string | undefined>;
+}) => KanbanRuntimeRecord[];
+export declare const createColumnResource: (model: KanbanBlockModel, column: RuntimeColumn, page: number, pageSize?: number) => MultiRecordResource<unknown>;

package/dist/client/models/index.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.
+ */
+export * from './utils';
+export * from './KanbanBlockModel';
+export * from './KanbanCardItemModel';
+export * from './KanbanCollectionActionGroupModel';
+export * from './actions/KanbanPopupModels';
+export * from './components/KanbanGroupingSelector';
+export * from './components/KanbanGroupOptionsTable';
+export * from './components/KanbanCreateSortFieldSelect';

package/dist/client/models/popupSettings.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 const normalizeKanbanPopupTargetUid: (value?: string) => string;
+export declare const normalizeKanbanPopupTemplateUid: (value?: string) => string;
+export declare const resolveKanbanOpenViewDefaultParams: (ctx: any) => Promise<any>;