@pisell/private-materials 6.8.27 → 6.8.29

package/lib/plus/webPosLogin/types.d.ts

@@ -0,0 +1,286 @@
+/**
+ * WebPosLogin 组件类型定义
+ * @description WebPOS 登录流程组件，包含登录、店铺选择、设备选择三个步骤
+ */
+/// <reference types="react" />
+/**
+ * 店铺数据结构
+ * @description 从租户列表接口返回的店铺信息
+ */
+export interface StoreItem {
+    /** 店铺ID */
+    id: number;
+    /** 租户ID */
+    tenant_id: number;
+    /** 账户ID */
+    account_id: number;
+    /** 类型 */
+    type: string;
+    /** 昵称 */
+    nickname: string;
+    /** 状态 */
+    status: string;
+    /** 创建时间 */
+    created_at?: string;
+    /** 更新时间 */
+    updated_at?: string;
+    /** 租户详情 */
+    tenant: {
+        /** 租户ID */
+        id: number;
+        /** 父租户ID */
+        tenant_id?: number;
+        /** 账户ID */
+        account_id?: number;
+        /** 类型 */
+        type?: string;
+        /** 名称（多语言） */
+        name: {
+            en?: string | null;
+            'zh-CN'?: string | null;
+            'zh-HK'?: string | null;
+            original: string;
+        };
+        /** Logo图片 */
+        logo?: string;
+        /** 图标 */
+        icon?: string;
+        /** Favicon */
+        favicon?: string;
+        /** 默认域名 */
+        default_domain: string;
+        /** 私有域名 */
+        private_domain?: string | null;
+        /** 货币代码 */
+        currency_code?: string | null;
+        /** 国家代码 */
+        country_code?: string | null;
+        /** 语言 */
+        locale?: string;
+        /** 时区 */
+        timezone?: string;
+        /** 状态 */
+        status?: string;
+    };
+}
+/**
+ * 设备客户端信息
+ * @description 设备绑定的客户端详情
+ */
+export interface DeviceClient {
+    /** 客户端ID */
+    id: number;
+    /** 店铺ID */
+    shop_id: number;
+    /** 设备ID */
+    device_id: number;
+    /** 客户端编号 */
+    number: string;
+    /** 客户端名称 */
+    name: string;
+    /** 客户端类型 */
+    type: string;
+    /** 设备型号 */
+    model?: string;
+    /** 系统版本 */
+    version?: string;
+    /** 设备详细数据 */
+    data?: {
+        battery?: {
+            is_charging?: boolean;
+            visible_percent?: string;
+        };
+        hardware?: {
+            country?: string;
+            datetime?: string;
+            language?: string;
+            timezone?: string;
+        };
+        application?: {
+            name?: string;
+            type?: string;
+            version?: string;
+            language?: string;
+            bundle_id?: string;
+        };
+        connectivity?: {
+            ip?: string;
+            type?: string;
+            wifi_details?: any[];
+        };
+    };
+    /** 最后刷新时间 */
+    refreshed_at?: string;
+    /** 创建时间 */
+    created_at?: string;
+    /** 更新时间 */
+    updated_at?: string;
+}
+/**
+ * 设备数据结构
+ * @description 从设备列表接口返回的设备信息
+ */
+export interface DeviceItem {
+    /** 设备ID */
+    id: number;
+    /** 店铺ID */
+    shop_id: number;
+    /** 设备类型 */
+    type: string;
+    /** 设备编号 */
+    number: string;
+    /** 设备名称 */
+    name: string;
+    /** 设备描述 */
+    description?: string;
+    /** 设备设置 */
+    setting?: any[];
+    /** 创建时间 */
+    created_at?: string;
+    /** 更新时间 */
+    updated_at?: string;
+    /** 绑定的客户端信息（null 表示未被使用） */
+    client?: DeviceClient | null;
+}
+/**
+ * 用户信息
+ * @description 当前登录用户的基本信息
+ */
+export interface UserInfo {
+    /** 用户名称 */
+    name: string;
+    /** 用户头像 */
+    avatar?: string;
+}
+/**
+ * 品牌区轮播项
+ * @description 左侧品牌区的轮播内容配置
+ */
+export interface CarouselItem {
+    /** 内容类型：图片或视频 */
+    type: 'image' | 'video';
+    /** 资源URL */
+    url: string;
+}
+/**
+ * 品牌区配置
+ * @description 左侧品牌展示区域的配置
+ */
+export interface BrandConfig {
+    /** 轮播内容列表（图片/视频） */
+    carouselItems?: CarouselItem[];
+    /** 默认Logo（当无轮播时显示） */
+    logo?: string;
+    /** 品牌标语 */
+    slogan?: string;
+}
+/**
+ * 登录流程步骤
+ */
+export declare type LoginStep = 'login' | 'store' | 'device';
+/**
+ * 支持的语言类型
+ */
+export declare type LocaleType = 'en' | 'zh-CN' | 'zh-HK';
+/**
+ * WebPosLogin 主组件 Props
+ * @description WebPOS 登录组件的所有配置项
+ */
+export interface WebPosLoginCptProps {
+    /** 自定义类名 */
+    className?: string;
+    /** 自定义样式 */
+    style?: React.CSSProperties;
+    /** 背景图片URL */
+    backgroundImage?: string;
+    /** 品牌区配置 */
+    brandConfig?: BrandConfig;
+    /** 当前步骤：login-登录 | store-店铺选择 | device-设备选择 */
+    step?: LoginStep;
+    /** 是否显示返回按钮（默认 true） */
+    showBackButton?: boolean;
+    /** 店铺列表数据 */
+    storeList?: StoreItem[];
+    /** 设备列表数据 */
+    deviceList?: DeviceItem[];
+    /** 当前用户信息 */
+    userInfo?: UserInfo;
+    /** 当前选中的店铺 */
+    selectedStore?: StoreItem;
+    /** 上次使用的店铺ID（用于显示 Last used 标签） */
+    lastUsedStoreId?: number;
+    /** 上次使用的设备ID（用于显示 Last used 标签） */
+    lastUsedDeviceId?: number;
+    /** 语言设置 */
+    locale?: LocaleType;
+    /** 加载状态 */
+    loading?: boolean;
+    /** 登录配置 */
+    loginConfig?: any;
+    /** 店铺选择回调 */
+    onStoreSelect?: (store: StoreItem) => void;
+    /** 设备选择回调 */
+    onDeviceSelect?: (device: DeviceItem) => void;
+    /** 切换账号回调 */
+    onChangeAccount?: () => void;
+    /** 切换店铺回调 */
+    onChangeStore?: () => void;
+    /** 返回上一步回调 */
+    onBack?: () => void;
+    /** 登录成功回调 */
+    onLoginSuccess?: (data: any) => void;
+}
+/**
+ * BrandPanel 品牌区组件 Props
+ */
+export interface BrandPanelProps {
+    /** 品牌配置 */
+    config?: BrandConfig;
+    /** 自定义类名 */
+    className?: string;
+}
+/**
+ * SelectStore 店铺选择组件 Props
+ */
+export interface SelectStoreProps {
+    /** 店铺列表 */
+    storeList?: StoreItem[];
+    /** 语言 */
+    locale?: LocaleType;
+    /** 加载状态 */
+    loading?: boolean;
+    /** 上次使用的店铺ID */
+    lastUsedStoreId?: number;
+    /** 选择店铺回调 */
+    onSelect?: (store: StoreItem) => void;
+}
+/**
+ * SelectDevice 设备选择组件 Props
+ */
+export interface SelectDeviceProps {
+    /** 设备列表 */
+    deviceList?: DeviceItem[];
+    /** 语言 */
+    locale?: LocaleType;
+    /** 加载状态 */
+    loading?: boolean;
+    /** 选择设备回调 */
+    onSelect?: (device: DeviceItem) => void;
+}
+/**
+ * UserFooter 底部用户信息组件 Props
+ */
+export interface UserFooterProps {
+    /** 用户信息 */
+    userInfo?: UserInfo;
+    /** 当前选中的店铺 */
+    selectedStore?: StoreItem;
+    /** 当前步骤 */
+    step?: LoginStep;
+    /** 语言 */
+    locale?: LocaleType;
+    /** 切换账号回调 */
+    onChangeAccount?: () => void;
+    /** 切换店铺回调 */
+    onChangeStore?: () => void;
+}

package/lib/pro/Login2.0/components/LegalTerms.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { LegalTermsConfig } from '../shared/types';
+import './LegalTerms.less';
+interface LegalTermsProps {
+    config: LegalTermsConfig;
+}
+declare const LegalTerms: React.FC<LegalTermsProps>;
+export default LegalTerms;

package/lib/pro/Login2.0/components/PhoneInput.d.ts

@@ -0,0 +1,53 @@
+import React from 'react';
+import './PhoneInput.less';
+/** 国家/地区配置（后端返回格式） */
+export interface CountryOption {
+    /** 国家/地区名称 */
+    name: string;
+    /** 国家/地区代码 */
+    code: string;
+    /** 区号（不带+号） */
+    calling_code: string;
+    /** 货币代码 */
+    currency_code: string;
+}
+/** 手机号对象格式 */
+export interface PhoneValueObject {
+    /** 手机号（不含区号） */
+    phone: string;
+    /** 国家区号（不带+号） */
+    country_calling_code: string;
+}
+/** 值格式类型 */
+export declare type ValueFormat = 'string' | 'object';
+/** 手机号输入组件属性 */
+export interface PhoneInputProps {
+    /** 完整的手机号值（包含区号），格式：+86138****，或 +1555****（字符串模式） */
+    value?: string | PhoneValueObject;
+    /** 值变化回调 */
+    onChange?: (value: string | PhoneValueObject) => void;
+    /** Placeholder */
+    placeholder?: string;
+    /** 大小 */
+    size?: 'large' | 'middle' | 'small';
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 自定义类名 */
+    className?: string;
+    /** 可用的国家/地区列表 */
+    countries?: CountryOption[];
+    /** 默认国家/地区代码 */
+    defaultCountry?: string;
+    /** 值格式：'string' 返回 "+8613800138000"，'object' 返回 { phone: "13800138000", country_calling_code: "86" } */
+    valueFormat?: ValueFormat;
+    /** 键盘按键事件回调 */
+    onKeyDown?: (e: React.KeyboardEvent<HTMLInputElement>) => void;
+}
+/**
+ * 手机号输入组件
+ *
+ * 支持国际区号选择和手机号输入
+ * 值格式：+区号+手机号，例如：+8613800138000 或 +15551234567
+ */
+declare function PhoneInput({ value, onChange, placeholder, onKeyDown, size, disabled, className, countries, defaultCountry, valueFormat, }: PhoneInputProps): JSX.Element;
+export default PhoneInput;

package/lib/pro/Login2.0/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { useRegisterFlow } from './useRegisterFlow';
+export type { UseRegisterFlowOptions, UseRegisterFlowReturn } from './useRegisterFlow';

package/lib/pro/Login2.0/hooks/useRegisterFlow.d.ts

@@ -0,0 +1,39 @@
+import { RegisterStep, RegisterFlowData, RegisterFlowConfig, getStepDefinition } from '../shared/registerFlow';
+import type { AuthMethodType } from '../shared/types';
+export interface UseRegisterFlowOptions {
+    /** 账号类型 */
+    accountType: AuthMethodType;
+    /** 邮箱配置 */
+    emailConfig?: {
+        enable_email?: boolean;
+        require_email_verification?: boolean;
+    };
+    /** 手机配置 */
+    phoneConfig?: {
+        enable_phone_number?: boolean;
+        require_phone_verification?: boolean;
+    };
+    /** 初始账号 */
+    initialAccount?: string;
+    /** 步骤变化回调 */
+    onStepChange?: (step: RegisterStep, data: RegisterFlowData) => void;
+    /** 完成回调 */
+    onComplete?: (data: RegisterFlowData) => void;
+}
+export interface UseRegisterFlowReturn {
+    /** 当前流程数据 */
+    flowData: RegisterFlowData;
+    /** 当前步骤定义 */
+    currentStepDef: ReturnType<typeof getStepDefinition>;
+    /** 流程配置 */
+    flowConfig: RegisterFlowConfig;
+    /** 跳转到指定步骤 */
+    goToStep: (step: RegisterStep, updates?: Partial<RegisterFlowData>) => void;
+    /** 更新流程数据 */
+    updateFlowData: (updates: Partial<RegisterFlowData>) => void;
+    /** 重置流程 */
+    resetFlow: () => void;
+    /** 处理错误 */
+    handleError: (code: string, message: string, targetStep?: RegisterStep) => void;
+}
+export declare function useRegisterFlow(options: UseRegisterFlowOptions): UseRegisterFlowReturn;

package/lib/pro/Login2.0/hooks/useRegistrationMethods.d.ts

@@ -0,0 +1,9 @@
+import { AuthMethodType } from '../shared/types';
+/**
+ * 注册方式相关的逻辑hook
+ */
+export declare function useRegistrationMethods(isRegistrationMethodEnabled: (type: AuthMethodType) => boolean): {
+    enabledMethods: AuthMethodType[];
+    shouldShowDivider: boolean;
+    hasEmailAndPhone: boolean;
+};

package/lib/pro/Login2.0/shared/Header.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { UIConfig } from './types';
+interface HeaderProps {
+    ui?: UIConfig;
+}
+/**
+ * 共享的头部组件
+ * 包含 Logo、标题、副标题、描述
+ */
+declare const Header: React.FC<HeaderProps>;
+export default Header;

package/lib/pro/Login2.0/shared/types.d.ts

@@ -0,0 +1,232 @@
+/**
+ * 登录注册 2.0 共享类型定义
+ */
+/** 验证方式枚举 */
+export declare type VerificationMethod = 'verification_code' | 'password';
+/** 邮箱注册验证方式 */
+export declare type EmailRegistrationVerification = 'verification_link' | 'verification_code' | 'none';
+/** 手机注册验证方式 */
+export declare type PhoneRegistrationVerification = 'verification_code';
+/** 认证方式类型 */
+export declare type AuthMethodType = 'email' | 'phone' | 'google' | 'facebook' | 'apple' | 'guest';
+/** 登录方式项类型 */
+export declare type LoginMethodType = 'email' | 'phone' | 'google' | 'facebook' | 'apple' | 'guest';
+export interface PhoneValueObject {
+    phone: string;
+    country_calling_code: string;
+}
+/** 邮箱登录方式项 */
+export interface EmailLoginMethod {
+    type: 'email';
+    /** 启用的验证方式（按顺序），第一个为默认方式 */
+    verificationMethods: Array<'password' | 'verification_code'>;
+    /** 密码登录是否分步骤填写（先输入邮箱，再输入密码） */
+    stepByStep?: boolean;
+}
+/** 手机登录方式项 */
+export interface PhoneLoginMethod {
+    type: 'phone';
+    /** 启用的验证方式（按顺序），第一个为默认方式 */
+    verificationMethods: Array<'password' | 'verification_code'>;
+    /** 密码登录是否分步骤填写（先输入手机号，再输入密码） */
+    stepByStep?: boolean;
+}
+/** Google 登录方式项 */
+export interface GoogleLoginMethod {
+    type: 'google';
+    /** Google Client ID */
+    clientId?: string;
+}
+/** Facebook 登录方式项 */
+export interface FacebookLoginMethod {
+    type: 'facebook';
+    /** Facebook App ID */
+    appId?: string;
+}
+/** Apple 登录方式项 */
+export interface AppleLoginMethod {
+    type: 'apple';
+    /** Apple Client ID */
+    clientId?: string;
+}
+/** Guest 登录方式项 */
+export interface GuestLoginMethod {
+    type: 'guest';
+}
+/** 注册方式类型 */
+export declare type RegistrationMethodType = 'email' | 'phone' | 'google' | 'facebook' | 'apple';
+/** 邮箱注册方式项 */
+export interface EmailRegistrationMethod {
+    type: 'email';
+    /** 注册验证方式（邮箱支持验证链接/验证码/无需验证） */
+    verificationMethod: 'verification_link' | 'verification_code' | 'none';
+}
+/** 手机注册方式项 */
+export interface PhoneRegistrationMethod {
+    type: 'phone';
+    /** 注册验证方式（手机仅支持验证码） */
+    verificationMethod: 'verification_code';
+}
+/** Google 注册方式项 */
+export interface GoogleRegistrationMethod {
+    type: 'google';
+    /** Google Client ID */
+    clientId?: string;
+}
+/** Facebook 注册方式项 */
+export interface FacebookRegistrationMethod {
+    type: 'facebook';
+    /** Facebook App ID */
+    appId?: string;
+}
+/** Apple 注册方式项 */
+export interface AppleRegistrationMethod {
+    type: 'apple';
+    /** Apple Client ID */
+    clientId?: string;
+}
+/** 注册方式项联合类型 */
+export declare type RegistrationMethodItem = EmailRegistrationMethod | PhoneRegistrationMethod | GoogleRegistrationMethod | FacebookRegistrationMethod | AppleRegistrationMethod;
+/** 法律条款项 */
+export interface LegalTermItem {
+    /** 条款名称 - 支持国际化对象或简单字符串 */
+    name: string | {
+        en?: string;
+        'zh-CN'?: string;
+        'zh-HK'?: string;
+        original?: string;
+    };
+    /** 条款链接 */
+    url: string;
+}
+/** 法律条款配置 */
+export interface LegalTermsConfig {
+    /** 是否显示法律条款区域 */
+    enabled?: boolean;
+    /** 法律条款列表 */
+    terms?: LegalTermItem[];
+    /** 条款文本模板 */
+    textTemplate?: string;
+    /** 当前模式：login 或 register */
+    mode?: 'login' | 'register';
+}
+/** 登录方式项联合类型 */
+export declare type LoginMethodItem = EmailLoginMethod | PhoneLoginMethod | GoogleLoginMethod | FacebookLoginMethod | AppleLoginMethod | GuestLoginMethod;
+/** 邮箱认证配置 */
+export interface EmailAuthConfig {
+    /** 是否启用邮箱认证 */
+    enable_email: boolean;
+    /** 注册验证方式 */
+    registration_verification?: EmailRegistrationVerification;
+    /** 登录验证方式列表 */
+    login_verification_methods?: VerificationMethod[];
+}
+/** 手机认证配置 */
+export interface PhoneAuthConfig {
+    /** 是否启用手机认证 */
+    enable_phone_number: boolean;
+    /** 注册验证方式 */
+    registration_verification?: PhoneRegistrationVerification;
+    /** 登录验证方式列表 */
+    login_verification_methods?: VerificationMethod[];
+}
+/** 三方 OAuth 配置 */
+export interface OAuthConfig {
+    /** Google 登录 */
+    google?: {
+        enabled: boolean;
+        client_id?: string;
+    };
+    /** Facebook 登录 */
+    facebook?: {
+        enabled: boolean;
+        app_id?: string;
+    };
+    /** Apple 登录 */
+    apple?: {
+        enabled: boolean;
+        client_id?: string;
+    };
+}
+/** UI 配置 */
+export interface UIConfig {
+    /** Logo 配置 */
+    logo?: {
+        show: boolean;
+        url?: string;
+        position?: 'left' | 'center' | 'right';
+        size?: {
+            width: number;
+            height: number;
+        };
+    };
+    /** 标题配置 */
+    title?: {
+        show: boolean;
+        text?: string;
+        align?: 'left' | 'center' | 'right';
+    };
+    /** 副标题配置 */
+    subtitle?: {
+        show: boolean;
+        text?: string;
+        align?: 'left' | 'center' | 'right';
+    };
+    /** 描述配置 */
+    desc?: {
+        show: boolean;
+        text?: string;
+        align?: 'left' | 'center' | 'right';
+    };
+    /** 表单标签配置 */
+    formLabels?: {
+        /** 邮箱标签配置 */
+        email?: {
+            show: boolean;
+            text?: string;
+        };
+        /** 手机标签配置 */
+        phone?: {
+            show: boolean;
+            text?: string;
+        };
+        /** 密码标签配置 */
+        password?: {
+            show: boolean;
+            text?: string;
+        };
+        /** 验证码标签配置 */
+        verificationCode?: {
+            show: boolean;
+            text?: string;
+        };
+    };
+    /** 密码规则 */
+    passwordRules?: any;
+    /** 主题色 */
+    themeColor?: string;
+}
+/** 登录表单数据 */
+export interface LoginFormData {
+    /** 邮箱或手机号 */
+    account: string | PhoneValueObject;
+    /** 密码 */
+    password?: string;
+    /** 验证码 */
+    verification_code?: string;
+    /** 记住我 */
+    remember_me?: boolean;
+}
+/** 注册表单数据 */
+export interface RegisterFormData {
+    /** 邮箱或手机号 */
+    account: string;
+    /** 密码 */
+    password?: string;
+    /** 确认密码 */
+    confirm_password?: string;
+    /** 验证码 */
+    verification_code?: string;
+    /** 验证链接 token */
+    verification_token?: string;
+}

package/lib/pro/Login2.0/steps/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 注册流程步骤组件导出
+ */
+export { default as WaitEmailLink } from './WaitEmailLink';
+export { default as EmailAlreadyRegistered } from './EmailAlreadyRegistered';
+export { default as CodeInput } from './CodeInput';
+export { default as VerificationSuccess } from './VerificationSuccess';
+export { default as SetPassword } from './SetPassword';
+export { default as VerifyingEmailLink } from './VerifyingEmailLink';
+export { default as EmailLinkExpired } from './EmailLinkExpired';
+export { default as EmailLinkAlreadyUsed } from './EmailLinkAlreadyUsed';
+export type { WaitEmailLinkProps } from './WaitEmailLink';
+export type { EmailAlreadyRegisteredProps } from './EmailAlreadyRegistered';
+export type { CodeInputProps } from './CodeInput';
+export type { VerificationSuccessProps } from './VerificationSuccess';
+export type { SetPasswordProps } from './SetPassword';
+export type { VerifyingEmailLinkProps } from './VerifyingEmailLink';
+export type { EmailLinkExpiredProps } from './EmailLinkExpired';
+export type { EmailLinkAlreadyUsedProps } from './EmailLinkAlreadyUsed';