@pisell/materials 1.8.23 → 1.8.24

package/lib/components/PisellProcedure/PisellProcedure.stories.d.ts

@@ -0,0 +1,163 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import PisellProcedure from './PisellProcedure';
+/**
+ * PisellProcedure 流程容器组件
+ *
+ * 用于管理多步骤流程的复合容器组件，基于 PisellLayout 实现三段式布局
+ * 包含头部区域（步骤条）、主体区域（内容区+信息区）、底部区域（操作按钮）
+ */
+declare const meta: Meta<typeof PisellProcedure>;
+export default meta;
+declare type Story = StoryObj<typeof PisellProcedure>;
+/**
+ * 基础用法
+ * @description 默认流程容器，包含头部、主体、底部三个区域
+ */
+export declare const Default: Story;
+/**
+ * 页面模式
+ * @description 默认模式，支持响应式和移动端适配
+ */
+export declare const PageMode: Story;
+/**
+ * 弹窗模式
+ * @description 用于弹窗场景，不应用移动端适配
+ */
+export declare const ModalMode: Story;
+/**
+ * 步骤控制
+ * @description 使用 onStepsChange 监听步骤变化
+ */
+export declare const StepControl: Story;
+/**
+ * 步骤拦截
+ * @description 通过 onNext/onPrev 返回 false 阻止步骤切换
+ */
+export declare const StepIntercept: Story;
+/**
+ * 无侧边栏
+ */
+export declare const WithoutSidebar: Story;
+/**
+ * 无头部
+ */
+export declare const WithoutHeader: Story;
+/**
+ * 无底部
+ */
+export declare const WithoutFooter: Story;
+/**
+ * 最小配置
+ * @description 仅显示主体内容
+ */
+export declare const MinimalConfig: Story;
+/**
+ * 头部插槽顺序 - 默认
+ * @description left 在左，right 在右
+ */
+export declare const HeaderSlotDefault: Story;
+/**
+ * 头部插槽顺序 - 反转
+ * @description left 在右，right 在左
+ */
+export declare const HeaderSlotReverse: Story;
+/**
+ * 隐藏步骤条
+ * @description 仅显示头部插槽，不显示步骤条
+ */
+export declare const HideSteps: Story;
+/**
+ * 第一步显示返回按钮
+ * @description 通过 showBackOnFirstStep 控制
+ */
+export declare const ShowBackOnFirstStep: Story;
+/**
+ * 返回确认弹窗
+ * @description 点击返回时弹出确认弹窗
+ */
+export declare const BackConfirmModal: Story;
+/**
+ * 关闭确认弹窗
+ * @description 点击关闭时弹出确认弹窗
+ */
+export declare const CloseConfirmModal: Story;
+/**
+ * 主体布局 - 比例布局
+ * @description 使用比例分配内容区和侧边栏宽度
+ */
+export declare const BodyRatioLayout: Story;
+/**
+ * 主体布局 - 固定宽度
+ * @description 侧边栏使用固定宽度
+ */
+export declare const BodyFixedLayout: Story;
+/**
+ * 主体布局 - 垂直布局
+ * @description 内容区和侧边栏上下排列
+ */
+export declare const BodyVerticalLayout: Story;
+/**
+ * 主体布局 - 内容顺序反转
+ * @description 侧边栏在左/上，内容区在右/下
+ */
+export declare const BodyContentOrderReverse: Story;
+/**
+ * 底部位置 - 悬浮在侧边栏
+ * @description 默认位置，底部悬浮在侧边栏区域
+ */
+export declare const FooterFloatSidebar: Story;
+/**
+ * 底部位置 - 固定在整体底部
+ */
+export declare const FooterFixedBottom: Story;
+/**
+ * 底部位置 - 悬浮在整体区域
+ * @description 移动端默认使用此模式
+ */
+export declare const FooterFloatAll: Story;
+/**
+ * 底部位置 - 悬浮在内容区
+ */
+export declare const FooterFloatContent: Story;
+/**
+ * 底部位置 - 内嵌在内容区底部
+ */
+export declare const FooterFixedContentBottom: Story;
+/**
+ * 底部位置 - 内嵌在侧边栏底部
+ */
+export declare const FooterFixedSidebarBottom: Story;
+/**
+ * 移动端总结按钮
+ * @description 移动端显示总结按钮，点击可查看侧边栏内容
+ */
+export declare const MobileSummaryButton: Story;
+/**
+ * 溢出收纳功能
+ * @description 当宽度不足时，按钮会被收纳到 More 菜单中
+ */
+export declare const OverflowActions: Story;
+/**
+ * 禁用溢出收纳
+ * @description 不启用溢出收纳，按钮会换行显示
+ */
+export declare const DisableOverflow: Story;
+/**
+ * 完整示例 - 购物流程
+ * @description 模拟真实的购物流程
+ */
+export declare const ShoppingFlow: Story;
+/**
+ * 完整示例 - 注册流程
+ * @description 模拟用户注册流程
+ */
+export declare const RegistrationFlow: Story;
+/**
+ * 完整示例 - 表单向导
+ * @description 多步表单向导
+ */
+export declare const FormWizard: Story;
+/**
+ * 交互测试 - 组件渲染
+ */
+export declare const InteractionTest: Story;

package/lib/components/PisellTabbar/PisellTabbar.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+import './PisellTabbar.less';
+import { PisellTabbarProps } from './types';
+/**
+ * PisellTabbar - 多层级 Tabbar 组件
+ *
+ * 支持最多 3 层级的 Tab 导航，每层级可独立展开/收起
+ *
+ * @component
+ * @example
+ * ```tsx
+ * <PisellTabbar
+ *   dataSource={categoryData}
+ *   value={[1, 10, 100]}
+ *   onChange={(value) => console.log('当前选中:', value)}
+ * />
+ * ```
+ */
+declare const PisellTabbar: React.FC<PisellTabbarProps>;
+export default PisellTabbar;

package/lib/components/PisellTabbar/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * PisellTabbar 组件导出文件
+ * @module PisellTabbar
+ */
+import PisellTabbar from './PisellTabbar';
+import PisellTabbarTemplate1 from './template/Template1';
+export type { PisellTabbarProps, TabbarDataSource, LevelType } from './types';
+export { PisellTabbarTemplate1 };
+export default PisellTabbar;

package/lib/components/PisellTabbar/template/Template1/PisellTabbar.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import '../../PisellTabbar.less';
+import { PisellTabbarProps } from '../../types';
+declare const _default: React.ForwardRefExoticComponent<PisellTabbarProps & React.RefAttributes<unknown>>;
+export default _default;

package/lib/components/PisellTabbar/template/Template1/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * PisellTabbar 组件导出文件
+ * @module PisellTabbar
+ */
+import PisellTabbar from './PisellTabbar';
+export default PisellTabbar;

package/lib/components/appVersionControl/index.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { AppVersionControlProps } from './types';
+import './index.less';
+declare const AppVersionControl: (props: AppVersionControlProps) => JSX.Element;
+export default AppVersionControl;

package/lib/components/cardMetricItem/index.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import './index.less';
+/**
+ * CardMetricItem 组件 Props
+ */
+export interface PisellStatisticProps {
+    title: string;
+    number: string | number;
+    hint?: React.ReactNode;
+    tags?: React.ReactNode;
+    showCurrencySymbol?: boolean;
+    style?: any;
+}
+declare const CardMetricItem: (props: PisellStatisticProps) => JSX.Element;
+export default CardMetricItem;

package/lib/components/dataSourceComponents/dataSourceForm/BaseForm.d.ts

@@ -0,0 +1,3 @@
+import './index.less';
+declare const _default: any;
+export default _default;

package/lib/components/dataSourceComponents/dataSourceForm/formItem.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="react" />
 declare const FormItem: (props: any) => JSX.Element;
 export default FormItem;

package/lib/components/dataSourceComponents/dataSourceForm/serve.d.ts

@@ -0,0 +1,178 @@
+export interface DataSourceType {
+    key: string;
+    displayName: string;
+    status: string;
+    type: string;
+    isDBInstance: boolean;
+    collections: Collection[];
+}
+export declare type ActionsItem = {
+    method: string;
+    path: string;
+    params: {
+        name: string;
+        value: string;
+    }[];
+    headers: {
+        name: string;
+        value: string;
+    }[];
+    body: Record<string, any>;
+};
+export interface Collection {
+    name: string;
+    title: string;
+    tableName: string;
+    timestamps: boolean;
+    autoGenId: boolean;
+    filterTargetKey: string;
+    fields: Field[];
+    introspected: boolean;
+    unavailableActions: any[];
+    actions: {
+        get: ActionsItem;
+        update: ActionsItem;
+        create: ActionsItem;
+        delete: ActionsItem;
+        list: ActionsItem;
+    };
+}
+interface Field {
+    name: string;
+    type: string;
+    allowNull: boolean;
+    primaryKey: boolean;
+    unique: boolean;
+    autoIncrement: boolean;
+    description?: (null | string)[];
+    possibleTypes?: string[];
+    rawType: string;
+    interface: string;
+    uiSchema: UiSchema;
+    key?: string;
+    collectionName?: string;
+    collectionKey?: any;
+    dataSourceKey?: string;
+    defaultValue?: any;
+}
+interface UiSchema {
+    type?: string;
+    'x-component': string;
+    'x-component-props'?: Xcomponentprops;
+    'x-validator'?: string;
+    title: string;
+    default?: any;
+    enum?: any[];
+}
+interface Xcomponentprops {
+    style?: Style;
+    autoSize?: AutoSize;
+    stringMode?: boolean;
+    step?: string;
+    dateFormat?: string;
+    showTime?: boolean;
+}
+interface AutoSize {
+    minRows: number;
+}
+interface Style {
+    width: string;
+}
+/**
+ * 获取nocobase自定义数据源
+ */
+export declare const getNocobaseDataSource: () => Promise<DataSourceType[]>;
+/**
+ * 获取nocobase主数据源
+ */
+export declare const getNocobaseMainDataSource: () => Promise<any>;
+/**
+ * 获取nocobase数据源设置
+ */
+export declare const getNocobaseDataSourceOptions: () => Promise<any>;
+/**
+ * 创建nocobase数据
+ */
+export declare const createNocobaseData: (params: {
+    key: string;
+    data: any;
+    headers?: any;
+}) => Promise<any>;
+/**
+ * nocobase get数据
+ */
+export declare const getNocobaseData: (params: {
+    key: string;
+    query: Record<string, any>;
+    headers?: any;
+}) => Promise<any>;
+/**
+ * 自定义api接口
+ */
+export declare const customApi: (url: string, data: Record<string, any>, options: {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    baseUrl?: string | undefined;
+    headers?: {
+        name: string;
+        value: any;
+    }[] | undefined;
+    params?: {
+        name: string;
+        value: any;
+    }[] | undefined;
+    body?: Record<string, any> | undefined;
+    dataSourceKey?: string | undefined;
+}) => Promise<any>;
+/**
+ * 更新nocobase数据
+ */
+export declare const updateNocobaseData: (params: {
+    key: string;
+    data: any;
+    headers?: any;
+    query?: Record<string, any> | undefined;
+}) => Promise<any>;
+/**
+ * 获取nocobase数据列表
+ */
+export declare const getNocobaseDataList: (allParams: {
+    key: string;
+    params: {
+        page: number;
+        pageSize: number;
+    };
+    headers?: any;
+}) => Promise<any>;
+/**
+ * 删除nocobase数据
+ */
+export declare const deleteNocobaseData: (key: string, id: string, headers?: any) => Promise<any>;
+/**
+ * 获取formSettingMeta数据
+ * @param params 请求参数
+ * @param params.sectionCodes 配置段代码数组，如 ['payment']
+ * @param params.businessCode 业务代码
+ * @param params.channelCode 渠道代码
+ * @param params.isBoard 是否包含board_code参数
+ * @returns Promise<any> 返回设置元数据
+ */
+export declare const getFormSettingMetaData: (params: {
+    sectionCodes: string[];
+    scope: string;
+    target?: string | undefined;
+}) => Promise<any>;
+/**
+ * 更新租户设置数据
+ * @param params 请求参数
+ * @param params.businessCode 业务代码
+ * @param params.channelCode 渠道代码
+ * @param params.boardCode 板块代码
+ * @param params.data 要更新的数据对象，如 {"order.prefix":"","order.suffix":"","payment.number":""}
+ * @returns Promise<any> 返回更新结果
+ */
+export declare const updateTenantSetting: (params: {
+    scope: string;
+    target?: string | undefined;
+    data: Record<string, any>;
+}) => Promise<any>;
+export {};

package/lib/components/dataSourceComponents/dataSourceForm/submitButton/index.d.ts

@@ -0,0 +1,39 @@
+import React from 'react';
+import { ButtonProps } from 'antd';
+import './index.less';
+export interface SubmitButtonProps extends ButtonProps {
+    status: 'normal' | 'disabled' | 'hidden';
+    children: React.ReactNode;
+    childrenString?: string;
+    confirmConfig?: {
+        enable: boolean;
+        title: string;
+        content: string;
+        icon: React.ReactNode;
+        okText: string;
+        cancelText: string;
+    };
+    toastConfig?: {
+        enable: boolean;
+        icon: React.ReactNode;
+        title: string;
+        showAfterSubmit?: boolean;
+    };
+    refreshData?: boolean;
+    afterSubmitType?: 'none' | 'close' | 'showModal' | 'showNotification';
+    afterSubmitModalConfig?: {
+        title: string;
+        content: string;
+        okText: string;
+        onOk?: () => void;
+    };
+    afterSubmitNotificationConfig?: {
+        title: string;
+        content: string;
+        icon: React.ReactNode;
+        duration: number;
+        placement: 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight';
+    };
+}
+declare const SubmitButton: (props: SubmitButtonProps) => JSX.Element | null;
+export default SubmitButton;

package/lib/components/dataSourceComponents/dataSourceForm/utils.d.ts

@@ -0,0 +1,57 @@
+import React from 'react';
+import { FormInstance } from 'antd';
+import { ModeType } from './type';
+import './style.less';
+export interface WithModeProps {
+    renderMode?: ModeType;
+    value?: any;
+    onChange?: (value: any) => void;
+    [key: string]: any;
+}
+/**
+ * @title: 增加renderMode属性
+ * @description: 基于renderMode属性控制渲染模式
+ * @return: *
+ * @Author: shengjie.zuo
+ * @Date: 2024-11-23 17:13:18
+ */
+export declare const withMode: <P extends object>(FieldComponent: React.ComponentType<P>, ReadPrettyComponent?: React.ComponentType<P & {
+    renderMode: ModeType;
+}> | undefined, transformProps?: ((props: P, renderMode: ModeType) => P) | undefined) => React.FC<P & WithModeProps>;
+export interface WithFormItemProps {
+    name: string;
+    label?: string;
+    mode?: ModeType;
+    [key: string]: any;
+}
+export declare const formItemNameReplace: (name: string) => string;
+export declare const formItemNameReverse: (name: string) => string;
+export declare const isValidDomain: (value: string) => boolean;
+/**
+ * @title: 追加formItem层
+ * @description:
+ * @return: *
+ * @Author: shengjie.zuo
+ * @Date: 2024-11-23 17:14:25
+ */
+export declare const withFormItem: <P extends object>(WrappedComponent: React.ComponentType<P>, overlayProps?: {
+    otherFormItemProps?: Record<string, any> | ((props: Record<string, any>, others?: Record<string, any>) => Record<string, any>) | undefined;
+    innerProps?: Record<string, any> | undefined;
+} | undefined) => React.FC<P & WithFormItemProps>;
+export declare const withDataSource: <P extends unknown>(WrappedComponent: React.ComponentType<P>) => (props: P & {
+    dataSource?: any;
+    extraParams?: Record<string, any> | undefined;
+}) => JSX.Element;
+export declare const withOptions: <P extends unknown>(WrappedComponent: React.ComponentType<P>) => (props: P & {
+    options?: any;
+    optionSourceType?: "default" | "custom" | "api" | undefined;
+    labelField: string;
+    valueField: string;
+    extraParams?: Record<string, any> | undefined;
+}) => JSX.Element;
+export declare const getNestedValue: (obj: Record<string, any>, path: string) => Record<string, any>;
+export declare const renderValueWithMap: (value: any, valueMap?: Record<string, string>, renderMode?: ModeType) => JSX.Element | null;
+export declare function toArr(str: string | number | (string | number)[]): (string | number)[];
+export declare const filterSystemFields: (params: Record<string, any>) => Record<string, any>;
+export declare const transformFormObjToArrayWithUntouched: (obj: Record<string, any>) => any[];
+export declare const setFormFieldsUntouched: (form: FormInstance) => void;

package/lib/components/dataSourceComponents/dataSourceShow/dataSourceImage/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const DataSourceImage: (props: import("../utils").ParsedProps) => JSX.Element;
+export default DataSourceImage;

package/lib/components/dataSourceComponents/dataSourceSubForm/index.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { DataSourceSubFormProps } from './types';
+/**
+ * @title DataSourceSubForm 子表单组件
+ * @description
+ * 独立的子表单组件，专注于渲染一组表单字段。支持两种使用方式：
+ * 1. 传入 children：使用低代码引擎渲染的子组件（优先）
+ * 2. 传入 xRecordSchema：通过配置自动生成表单字段（fallback）
+ *
+ * 值结构: { field1: v1, field2: v2 }
+ */
+declare const DataSourceSubForm: React.FC<DataSourceSubFormProps>;
+export default DataSourceSubForm;

package/lib/components/dataSourceComponents/dataSourceSubForm/types.d.ts

@@ -0,0 +1,117 @@
+import React from 'react';
+import { ModeType } from '../dataSourceForm/type';
+/**
+ * @title 字段选项接口
+ * @description 用于下拉框、单选框等组件的选项配置
+ */
+export interface DataSourceSubFormOption {
+    label?: React.ReactNode;
+    value: string | number;
+}
+/**
+ * @title 字段 Schema 接口
+ * @description 定义表单字段的结构和配置
+ */
+export interface DataSourceSubFormFieldSchema {
+    /** 字段名称（必填） */
+    name: string;
+    /** 字段标签 */
+    label?: React.ReactNode;
+    /** 组件类型（兼容多种命名方式） */
+    component?: string;
+    componentName?: string;
+    /** 字段数据类型 */
+    type?: string;
+    /** 接口类型，用于映射到具体组件（如 Select、Input 等） */
+    interface?: string;
+    /** 字段选项列表（用于 Select、Radio 等） */
+    options?: DataSourceSubFormOption[];
+    /** 组件额外配置 */
+    props?: Record<string, any>;
+    /** 子字段（用于嵌套结构，如 Input.JSON） */
+    children?: DataSourceSubFormFieldSchema[];
+    _children?: DataSourceSubFormFieldSchema[];
+    /** 字段 Schema 配置 */
+    schema?: Record<string, any>;
+    /** UI Schema 配置（支持低代码平台的各种配置项） */
+    uiSchema?: {
+        title?: React.ReactNode;
+        enum?: DataSourceSubFormOption[];
+        'x-component'?: string;
+        'x-component-props'?: Record<string, any>;
+        'x-read-pretty'?: boolean;
+        'x-validator'?: string;
+        'x-display'?: 'visible' | 'hidden' | 'none';
+        'x-pattern'?: 'editable' | 'disabled' | 'readPretty';
+        'x-data-source'?: {
+            type?: string;
+            options?: Array<{
+                id?: string;
+                label: string | Record<string, any>;
+                value: string;
+                color?: string;
+            }>;
+            labelField?: string;
+            valueField?: string;
+            dataSource?: any;
+            extraParams?: Record<string, any>;
+        };
+        'x-record-schema'?: DataSourceSubFormSchema | DataSourceSubFormFieldSchema[] | string;
+        default?: any;
+        type?: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
+    };
+}
+/**
+ * @title Schema 接口
+ * @description 表单字段集合的结构定义
+ */
+export interface DataSourceSubFormSchema {
+    /** 字段列表 */
+    fields?: DataSourceSubFormFieldSchema[];
+    /** 属性映射（key-value 形式） */
+    properties?: Record<string, any>;
+    /** 子字段列表 */
+    children?: DataSourceSubFormFieldSchema[];
+}
+/**
+ * @title DataSourceSubForm 组件 Props
+ * @description
+ * 独立的子表单组件，用于渲染一组表单字段。
+ * 支持通过 xRecordSchema 配置字段，或直接传入 children 低代码子组件。
+ */
+export interface DataSourceSubFormProps {
+    /** 渲染模式：edit（编辑）、disabled（禁用）、preview（预览） */
+    renderMode?: ModeType;
+    /**
+     * 表单值对象
+     * @example { "fieldName1": "value1", "fieldName2": "value2" }
+     */
+    value?: Record<string, any>;
+    /**
+     * 值变化回调
+     * @param value 更新后的表单值对象
+     */
+    onChange?: (value: Record<string, any>) => void;
+    /**
+     * xRecordSchema：定义表单字段结构
+     * 支持三种格式：
+     * 1. JSON 字符串
+     * 2. Schema 对象（包含 fields/properties/children）
+     * 3. 字段数组
+     */
+    xRecordSchema?: string | DataSourceSubFormSchema | DataSourceSubFormFieldSchema[];
+    /**
+     * 容器 children：低代码引擎渲染的子组件节点
+     * 优先使用 children，如果没有则回退到 xRecordSchema 渲染
+     */
+    children?: React.ReactNode;
+    /** 低代码设计模式标识 */
+    __designMode?: string;
+    /** 表单布局方式 */
+    layout?: 'horizontal' | 'vertical' | 'inline';
+    /** 自定义类名 */
+    className?: string;
+    /** 自定义样式 */
+    style?: React.CSSProperties;
+    [key: string]: any;
+}

package/lib/components/dataSourceComponents/dataSourceTable/filter/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import './index.less';
 interface BaseFilterItem {
     name?: string;

package/lib/components/dataSourceComponents/dataSourceTable/filter/utils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { FilterItemProps } from '../../../filter/types';
 import { DataSourceType, Field } from '../../provider/dataSource/DataSourceContext';
 export declare const genGetField: (dataSource?: DataSourceType) => (key: string) => Field;

package/lib/components/dataSourceComponents/dataSourceTable/hooks/useDataSourceKey.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="react" />
 declare const useDataSourceKey: () => {
-    dataSourceKey: string | import("../../provider/dataSource/DataSourceContext").DataSourceType | undefined;
-    dataSourceKeyRef: import("react").MutableRefObject<string | import("../../provider/dataSource/DataSourceContext").DataSourceType | undefined>;
+    dataSourceKey: string | undefined;
+    dataSourceKeyRef: import("react").MutableRefObject<string | undefined>;
 };
 export default useDataSourceKey;

package/lib/components/dataSourceComponents/dataSourceTable/hooks/useDrawerState.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+declare const useDrawerState: (operationContent?: {
+    [key: string]: import("react").ReactNode;
+} | undefined) => any;
+export default useDrawerState;