@zxiaosi/sdk 0.1.1 → 0.1.2

package/dist/cjs/index.d.cts

@@ -1,481 +0,0 @@
-import { ConfigProviderProps } from "antd";
-import React, { ComponentType, ReactElement } from "react";
-import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, CreateAxiosDefaults } from "axios";
-import { Location, NavigateFunction, RouteObject, UIMatch } from "react-router-dom";
-import { MenuDataItem, ProLayoutProps } from "@ant-design/pro-layout";
-import { MicroApp, ObjectType, RegistrableApp } from "qiankun";
-import intl from "react-intl-universal";
-import * as zustand0 from "zustand";
-
-//#region src/components/antdConfigProvider/index.d.ts
-/**
- * Antd 配置
- * - 填充了 theme 和 locale 属性
- * - 详情参考: https://ant.design/components/config-provider-cn
- */
-declare const AntdConfigProvider: React.FC<ConfigProviderProps>;
-//#endregion
-//#region src/components/mainApp/index.d.ts
-/** 主应用的根组件 */
-declare const MainApp: React.FC;
-//#endregion
-//#region src/plugins/api/http.d.ts
-interface ApiRequestOption extends AxiosRequestConfig {
-  /** 请求唯一key(默认自动生成) */
-  requestId?: string;
-  /** 是否需要原始数据 */
-  isOriginalData?: boolean;
-  /** 是否显示错误信息 */
-  isShowFailMsg?: boolean;
-}
-//#endregion
-//#region src/plugins/api/index.d.ts
-interface ApiOptions {
-  /** Axios配置 */
-  config?: CreateAxiosDefaults;
-  /** 取消请求控制器 */
-  controllers?: Map<string, AbortController>;
-  /**
-   * 自定义请求实例
-   * - 将替代 SDK 内置的请求实例
-   * @example instance = axios.create(options)
-   */
-  instance?: AxiosInstance;
-  /**
-   * 获取用户信息
-   * {@link UserInfo}
-   * @example { data: { user: { ... }, permissions: [], roles: [], settings: {} }, code: 200 }
-   */
-  getUserInfoApi?: () => Promise<AxiosResponse<UserInfo>>;
-  /**
-   * 获取路由数据
-   * @example { data: [{path: '/', name: '首页', element: 'Home'}], code: 200 }
-   */
-  getRoutesApi?: () => Promise<AxiosResponse<RouteObject[]>>;
-}
-interface ApiResult extends Required<ApiOptions> {
-  /**
-   * 请求
-   * @param url 请求地址
-   * @param options 自定义配置项
-   */
-  readonly request: (url: string, options?: ApiRequestOption) => Promise<AxiosResponse<any, any>>;
-  /**
-   * 二次加工请求
-   * @param url 请求地址
-   * @param options 自定义配置项
-   * @returns [resp, err, cancel]
-   */
-  readonly request2: (url: string, options?: ApiRequestOption) => Promise<[AxiosResponse<any, any>, AxiosError, () => void]>;
-  /**
-   * 下载文件
-   * @param url 请求地址
-   * @param options 自定义配置项
-   * @returns [resp, err, cancel]
-   */
-  readonly download: (url: string, options?: ApiRequestOption) => Promise<[AxiosResponse<any, any>, AxiosError, () => void]>;
-}
-/**
- * 请求插件
- * - 详情参考 {@link ApiOptions} {@link ApiResult}
- * - 内置了请求, 通过 sdk.api.request 发起请求
- * - 可通过外部传入 instance 自定义请求实例
- * - 预置了获取用户信息, 获取路由, 登录接口等接口, 以便组件使用
- * @example sdk.api.request('/getTemp', { method: 'POST', ... })
- * @example sdk.api.request('/getTemp', { method: 'POST', isOriginalData: true }) // 返回原始数据
- * @example sdk.api.request('/getTemp', { method: 'POST', isShowFailMsg: false }) // 不显示错误信息
- */
-declare const SdkApiPlugin: Plugin<'api'>;
-//#endregion
-//#region src/plugins/app/index.d.ts
-interface AppOptions {
-  /** 菜单数据 */
-  menuData?: MenuDataItem[];
-  /** 所有路由信息 */
-  allRoutes?: RouteObject[];
-  /** 微应用信息 */
-  microApps?: RegistrableApp<ObjectType>[];
-  /** 微应用实例 */
-  microAppsInstance?: Map<string, MicroApp>;
-  /** 用户信息 */
-  user?: UserInfo['user'];
-  /** 用户权限 */
-  permissions?: UserInfo['permissions'];
-  /** 用户角色 */
-  roles?: UserInfo['roles'];
-  /** 用户设置 */
-  settings?: UserInfo['settings'];
-}
-interface AppResult extends Required<AppOptions> {
-  /**
-   * 跳转登录页
-   */
-  readonly pageToLogin: () => void;
-  /**
-   * 获取重定向路径
-   */
-  readonly getRedirectPath: () => string;
-}
-/**
- * 项目插件
- * - 详情参考 {@link AppOptions} {@link AppResult}
- * - 主要存储接口数据
- */
-declare const SdkAppPlugin: Plugin<'app'>;
-//#endregion
-//#region src/plugins/client/index.d.ts
-interface ClientOptions {}
-interface ClientResult extends Required<ClientOptions> {
-  /** 主应用 location */
-  location: Location;
-  /** 主应用navigate（解决子应用跳转问题） */
-  navigate: NavigateFunction;
-  /** 路由匹配（用于面包屑） */
-  matches: UIMatch[];
-}
-/**
- * 路由插件
- * - 详情参考 {@link ClientOptions} {@link ClientResult}
- * - 路由信息 sdk.client.location
- * - 路由跳转 sdk.client.navigate
- * - 面包屑信息 sdk.client.matches
- */
-declare const SdkClientPlugin: Plugin<'client'>;
-//#endregion
-//#region src/plugins/config/index.d.ts
-interface ConfigOptions {
-  /** 环境变量 */
-  env?: Record<string, any>;
-  /** 主题 */
-  theme?: ThemeProps;
-  /** 国际化 */
-  locale?: LocaleProps;
-  /**
-   * qiankun模式(切换模式后请打开新的窗口)
-   * - 'router': 基于路由模式
-   * - 'load': 手动加载模式
-   */
-  qiankunMode?: 'router' | 'load';
-  /** 登录页路由 */
-  loginPath?: string;
-  /**
-   * 登录后跳转的路由
-   * - 优先使用指定值
-   * - 其次使用重定向的值
-   * - 最后使用菜单中第一项
-   */
-  defaultPath?: string;
-  /**
-   * 自定义路由信息
-   * - 目前只支持最外层路由自定义
-   * - 会合并到 sdk.app.allRoutes 中
-   */
-  customRoutes?: RouteObject[];
-  /** Antd 配置 */
-  antdConfig?: ConfigProviderProps;
-  /** ProLayout 配置 */
-  proLayoutConfig?: ProLayoutProps;
-}
-interface ConfigResult extends Required<ConfigOptions> {}
-/**
- * 配置项插件
- * - 详情参考 {@link ConfigOptions} {@link ConfigResult}
- * - 配置 localStorage 变量名称
- * - 配置 默认主题、国际化
- * - 配置 默认登录路径、跳转路径、自定义路由
- * - 配置 Antd 配置、ProLayout 配置
- */
-declare const SdkConfigPlugin: Plugin<'config'>;
-//#endregion
-//#region src/plugins/i18n/index.d.ts
-interface I18nOptions {
-  /**
-   * React Intl Universal
-   * - 不要解构使用, const { get } = useIntl() 会报错
-   * - 如果项目不使用 React Compiler, 可以直接使用 sdk.i18n.intl
-   * - 如果使用 React Compiler, 请使用 useIntl() 方法获取
-   * @example
-   * const intl = useIntl();
-   * intl.get(key).d(defaultValue)
-   */
-  intl?: typeof intl;
-  /**
-   * React Intl Universal 配置的语言包
-   * @example
-   * {
-   *  'zh-CN': {
-   *    test: '测试国际化'
-   *  },
-   *  'en-US': {
-   *    test: 'Test Intl'
-   *  }
-   * }
-   */
-  intlConfig?: Record<string, any>;
-  /**
-   * 加载 Antd 语言包
-   * @param locale 语言包名
-   * @example
-   * import enUS from 'antd/es/locale/en_US';
-   * import zhCN from 'antd/es/locale/zh_CN';
-   * import dayjs from 'dayjs';
-   * import 'dayjs/locale/en';
-   * import 'dayjs/locale/zh';
-   *
-   * const loadLocale = (locale: string) => {
-   *   switch (locale) {
-   *     case 'en-US':
-   *       dayjs.locale('en');
-   *       return enUS;
-   *     case 'zh-CN':
-   *       dayjs.locale('zh');
-   *       return zhCN;
-   *     default:
-   *       return undefined;
-   *   }
-   * }
-   */
-  loadLocale?: (locale: string) => any;
-}
-interface I18nResult extends Required<I18nOptions> {}
-/**
- * 国际化插件
- * - 详情参考 {@link I18nOptions} {@link I18nResult}
- * - 集成 React Intl Universal 和 Antd 国际化
- * - 需要从外部引入语言包, 详见 intlConfig 和 loadLocale 配置项
- */
-declare const SdkI18nPlugin: Plugin<'i18n'>;
-//#endregion
-//#region src/plugins/storage/index.d.ts
-interface StorageOptions {
-  /** 国际化存储名称 */
-  localeKey?: string;
-  /** 主题存储名称  */
-  themeKey?: string;
-  /** Token存储名称 */
-  tokenKey?: string;
-}
-interface StorageResult extends Required<StorageOptions> {
-  /** 获取当前国际化 */
-  readonly getLocale: () => LocaleProps;
-  /** 设置/切换切换国际化 */
-  readonly setLocale: (locale: LocaleProps) => void;
-  /** 清除国际化 */
-  readonly clearLocale: () => void;
-  /** 获取当前主题 */
-  readonly getTheme: () => ThemeProps;
-  /** 设置/切换主题 */
-  readonly setTheme: (theme: ThemeProps) => void;
-  /** 清除主题 */
-  readonly clearTheme: () => void;
-  /** 获取当前 Token */
-  readonly getToken: () => string | null;
-  /** 设置 Token */
-  readonly setToken: (token: string) => void;
-  /** 清除 Token */
-  readonly clearToken: () => void;
-}
-/**
- * 本地缓存插件
- * - 详情参考 {@link StorageOptions} {@link StorageResult}
- * - 配置 localStorage 变量名称
- * - 提供 国际化、主题、Token 的 get、change、clear 方法
- * @example sdk.storage.getToken() // 获取 Token
- * @example sdk.storage.changeTheme('dark') // 切换主题
- * @example sdk.storage.clearLocale() // 清除国际化
- */
-declare const SdkStoragePlugin: Plugin<'storage'>;
-//#endregion
-//#region src/plugins/store/createAppState.d.ts
-interface AppStateStoreProps {
-  /** 子应用加载状态 */
-  microAppState: boolean;
-  /** 设置子应用加载状态 */
-  setMicroAppState: (state: boolean) => void;
-}
-/** 子应用状态切片 */
-//#endregion
-//#region src/plugins/store/createInitState.d.ts
-interface InitStateStoreProps {
-  /** 初始变量 */
-  initState: UserInfo;
-  /** 设置初始变量 */
-  setInitState: (initState: UserInfo) => void;
-}
-/** 初始变量切片 */
-//#endregion
-//#region src/plugins/store/createLocale.d.ts
-interface LocaleStoreProps {
-  /** 国际化 */
-  locale: LocaleProps;
-  /** 设置国际化 */
-  setLocale: (locale: LocaleProps) => void;
-}
-/** 国际化状态切片 */
-//#endregion
-//#region src/plugins/store/createTheme.d.ts
-interface ThemeStoreProps {
-  /** 主题 */
-  theme: ThemeProps;
-  /** 设置主题 */
-  setTheme: (theme: ThemeProps) => void;
-}
-/** 主题状态切片 */
-//#endregion
-//#region src/plugins/store/index.d.ts
-type StoreOptions = AppStateStoreProps & InitStateStoreProps & LocaleStoreProps & ThemeStoreProps;
-type StoreResult = typeof globalStore;
-/**
- * 创建 Store 切片
- * - 这里单独声明变量, 主要是为了使用返回类型 StoreResult 🤔
- */
-declare const globalStore: Omit<zustand0.StoreApi<StoreOptions>, "subscribe"> & {
-  subscribe: {
-    (listener: (selectedState: StoreOptions, previousSelectedState: StoreOptions) => void): () => void;
-    <U>(selector: (state: StoreOptions) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
-      equalityFn?: (a: U, b: U) => boolean;
-      fireImmediately?: boolean;
-    }): () => void;
-  };
-};
-/**
- * 全局状态管理插件
- * - 详情参考 {@link StoreOptions} {@link StoreResult}
- * - 此插件不会合并传入属性
- * @example const setTheme = useStore(sdk.store, (state) => state.setTheme)
- * @example const { theme, setTheme } = useStore(sdk.store, useShallow((state) => { theme: state.theme, setTheme: state.setTheme }))
- * @example const [theme, setTheme] = useStore(sdk.store, useShallow((state) => [state.theme, state.setTheme]))
- * @example sdk.store?.getState()?.setTheme('light')
- * @example sdk.store.subscribe((state) => state.theme, (theme) => { console.log('theme', theme) }, { fireImmediately: true }) // fireImmediately 立即变更
- */
-declare const SdkStorePlugin: Plugin<'store'>;
-//#endregion
-//#region src/plugins/ui/index.d.ts
-interface UIOptions {
-  /** 组件 */
-  [key: string]: ComponentType | ((name: string) => ComponentType);
-}
-interface UIResult extends Required<UIOptions> {
-  /**
-   * 获取组件
-   * @param name 组件名称
-   */
-  readonly getComponent: (name: string) => ComponentType;
-  /**
-   * 渲染组件
-   * @param name 组件名称
-   */
-  readonly renderComponent: (name: string, props?: any) => ReactElement;
-}
-/**
- * 组件插件
- * - 详情参考 {@link UIOptions} {@link UIResult}
- * - 内置了 Login、NotFound、Microapp、Layout 等组件, 可传入覆盖
- * - 组件共享
- *    - 在主应用中, 可通过 use(SdkUIPlugin, { MyComponent }) 传入组件
- *    - 在子应用中, 可通过 sdk.ui.renderComponent('MyComponent') 使用组件
- */
-declare const SdkUIPlugin: Plugin<'ui'>;
-//#endregion
-//#region src/types.d.ts
-type ThemeProps = 'light' | 'dark' | (string & {});
-type LocaleProps = 'zh-CN' | 'en-US' | (string & {});
-interface UserInfo {
-  /** 用户信息 */
-  user?: any;
-  /** 用户权限 */
-  permissions?: string[];
-  /** 用户角色 */
-  roles?: string[];
-  /** 用户设置 */
-  settings?: {
-    theme?: ThemeProps;
-    locale?: LocaleProps;
-  };
-}
-type PluginName = keyof PluginOptions;
-interface PluginOptions {
-  /** 请求插件 */
-  api?: ApiOptions;
-  /** 项目插件 */
-  app?: AppOptions;
-  /** 路由插件 */
-  client?: ClientOptions;
-  /** 配置项插件 */
-  config?: ConfigOptions;
-  /** 国际化插件 */
-  i18n?: I18nOptions;
-  /** 本地缓存插件 */
-  storage?: StorageOptions;
-  /** 状态管理插件 */
-  store?: StoreOptions;
-  /** 组件插件 */
-  ui?: UIOptions;
-}
-interface PluginResults {
-  /** 请求插件 */
-  api: ApiResult;
-  /** 项目插件 */
-  app: AppResult;
-  /** 路由插件 */
-  client: ClientResult;
-  /** 配置项插件 */
-  config: ConfigResult;
-  /** 国际化插件 */
-  i18n: I18nResult;
-  /** 本地缓存插件 */
-  storage: StorageResult;
-  /** 状态管理插件 */
-  store: StoreResult;
-  /** 组件插件 */
-  ui: UIResult;
-}
-interface Plugin<K$1 extends PluginName> {
-  /** 插件名字 */
-  name: K$1;
-  /** 插件安装方法 */
-  install: (sdk: SdkResult, options?: PluginOptions[K$1]) => void;
-  /** 插件配置项 */
-  options?: PluginOptions[K$1];
-}
-interface SdkBase {
-  /** SDK 名称 */
-  name: string;
-  /** 插件列表 */
-  _plugins: Map<string, Plugin<never>>;
-  /** 挂载sdk - Window */
-  mount: (name: string) => void;
-  /** 卸载sdk - Window */
-  unmount: () => void;
-  /** 使用插件 */
-  use: <K extends PluginName>(plugin: Plugin<K>, options?: PluginOptions[K]) => this;
-}
-type SdkResult = SdkBase & PluginResults;
-//#endregion
-//#region src/core/index.d.ts
-declare class Sdk implements SdkResult {
-  name: SdkResult['name'];
-  _plugins: SdkResult['_plugins'];
-  api: SdkResult['api'];
-  app: SdkResult['app'];
-  client: SdkResult['client'];
-  config: SdkResult['config'];
-  i18n: SdkResult['i18n'];
-  storage: SdkResult['storage'];
-  store: SdkResult['store'];
-  ui: SdkResult['ui'];
-  constructor();
-  mount(name: string): void;
-  unmount(): void;
-  use<K extends keyof PluginOptions>(plugin: Plugin<K>, options?: PluginOptions[K]): this;
-}
-/**
- * sdk 实例
- * @example sdk.use(SdkPlugin) // 使用插件
- * @example sdk.mount('SdkName') // 挂载到 window 上
- * @example sdk.unmount() // 卸载
- */
-declare const sdk: Sdk;
-//#endregion
-export { AntdConfigProvider, ApiOptions, ApiResult, AppOptions, AppResult, ClientOptions, ClientResult, ConfigOptions, ConfigResult, I18nOptions, I18nResult, MainApp, SdkApiPlugin, SdkAppPlugin, SdkClientPlugin, SdkConfigPlugin, SdkI18nPlugin, SdkStoragePlugin, SdkStorePlugin, SdkUIPlugin, StorageOptions, StorageResult, StoreOptions, StoreResult, UIOptions, UIResult, sdk };
-//# sourceMappingURL=index.d.cts.map