yswk-ui 0.1.0 → 0.1.2

package/dist/wkc-ui/utils/libraryManager.d.ts

@@ -0,0 +1,154 @@
+import { App } from 'vue';
+import { ComponentListItem } from '../types/component';
+/**
+ * 初始化配置选项
+ */
+export interface InitOptions {
+    isEditing?: boolean;
+    isWrapper?: boolean;
+    isPreview?: boolean;
+    baseUrl?: string;
+    apiToken?: string;
+}
+/**
+ * 初始化组件库环境
+ * @param options 初始化配置选项
+ * @description
+ * 该函数用于设置组件库运行所需的环境标识，包括：
+ * - 编辑器环境标识（isEditing）
+ * - 组件包裹标识（isWrapper）
+ *
+ * 使用场景：
+ * 1. 编辑器环境：在 MobileRender 组件挂载时调用
+ * 2. 第三方使用：在应用入口处调用，根据实际场景传入配置
+ *
+ * @example
+ * initComponentLibrary({ isEditing: true, isWrapper: true })
+ */
+export declare function initComponentLibrary(options?: InitOptions): void;
+/**
+ * 设置外部必需的 Session 数据
+ * @param params 外部 Session 数据配置
+ * @description
+ * 该函数用于设置组件库运行所需的外部数据，这些数据通常由宿主应用提供。
+ * 包括页面路由参数、位置信息、用户信息、零售户信息等。
+ *
+ * @example
+ * ```typescript
+ * import { LibraryHelper } from 'yswk-ui'
+ *
+ * LibraryHelper.setRequiredSessionKey({
+ *   routeQuery: '',
+ *   locationInfo: 'loactionInfo',
+ * })
+ * ```
+ */
+export interface RequiredSessionParams {
+    /** 页面路由查询参数 */
+    routeQuery?: string;
+    /** 地理位置信息 */
+    locationInfo?: string;
+}
+export declare function setRequiredSessionKey(params: RequiredSessionParams): void;
+/**
+ * 清除组件库环境标识
+ * @description
+ * 用于清理组件库设置的所有环境标识，通常在组件卸载或应用退出时调用
+ *
+ * @example
+ * // 在组件卸载时清理
+ * onUnmounted(() => {
+ *   clearComponentLibrary()
+ * })
+ */
+export declare function clearComponentLibrary(): void;
+/**
+ * 全局注册所有组件
+ * @param app Vue应用实例
+ * @description
+ * 使用 config 中的 id 作为组件名进行全局注册
+ * 注册后可以使用 <component :is="componentId"> 动态渲染
+ *
+ * @example
+ * ```typescript
+ * import { createApp } from 'vue'
+ * import { registerComponents } from 'yswk-ui'
+ * import App from './App.vue'
+ *
+ * const app = createApp(App)
+ * registerComponents(app)
+ * app.mount('#app')
+ * ```
+ *
+ * @example
+ * ```vue
+ * <template>
+ *   <!-- 使用 config 中的 id 动态渲染 -->
+ *   <component :is="'BtnLink'" />
+ * </template>
+ * ```
+ */
+export declare function registerComponents(app: App): void;
+/**
+ * 获取组件配置
+ * @param componentId 组件ID（如 'BtnLink', 'RotatePlate'）
+ * @returns 组件配置对象
+ *
+ * @example
+ * ```typescript
+ * import { getComponentConfig } from 'yswk-ui'
+ *
+ * const config = getComponentConfig('BtnLink')
+ * console.log(config.styleSchema)
+ * ```
+ */
+export declare function getComponentConfig(componentId: string): any;
+/**
+ * 获取组件实例
+ * @param componentId 组件ID（如 'BtnLink', 'RotatePlate'）
+ * @returns 组件实例
+ *
+ * @example
+ * ```typescript
+ * import { getComponent } from 'yswk-ui'
+ *
+ * const BtnLinkComponent = getComponent('BtnLink')
+ * ```
+ */
+export declare function getComponent(componentId: string): any;
+/**
+ * 获取当前组件列表
+ */
+export declare function getComponentList(): ComponentListItem[];
+/**
+ * 获取按分组组织的组件列表
+ * @returns 按分组组织的组件列表，每个分组包含 label、value 和 children
+ *
+ * @example
+ * ```typescript
+ * const groupedList = getComponentListByGroup()
+ * // 返回格式:
+ * // [
+ * //   {
+ * //     label: '基础组件',
+ * //     value: 'base',
+ * //     children: [
+ * //       { id: 'btn-link', name: '链接按钮', ... },
+ * //       { id: 'btn-rule', name: '规则按钮', ... }
+ * //     ]
+ * //   },
+ * //   {
+ * //     label: '抽奖组件',
+ * //     value: 'lucky',
+ * //     children: [
+ * //       { id: 'rotate-plate', name: '转盘抽奖', ... }
+ * //     ]
+ * //   }
+ * // ]
+ * ```
+ */
+export declare function getComponentListByGroup(): {
+    label: string;
+    value: string;
+    children: ComponentListItem[];
+}[];

package/dist/wkc-ui/utils/request.d.ts

@@ -0,0 +1,29 @@
+import { IApiConfig } from '../types/component';
+/**
+ * 延迟函数，用于模拟请求等待时间
+ * @param ms - 延迟的毫秒数
+ * @returns Promise<void>
+ */
+export declare const delay: (ms: number) => Promise<void>;
+declare const service: import('axios').AxiosInstance;
+/**
+ * 通用接口使用封装
+ * @param obj - 请求配置对象
+ * @param obj.key - 接口标识符，用于在 previewConfig 中查找对应的接口配置
+ * @param obj.previewConfig - 接口配置数组，包含多个接口的配置信息（如 URL、请求方法等）
+ * @param obj.preUrl - 预设的服务地址前缀，当 sessionStorage 中没有配置时使用
+ * @param obj.data - 可选的请求体数据，用于 POST/PUT 等请求
+ * @param obj.params - 可选的 URL 查询参数，用于 GET 请求
+ * @param obj.headers - 可选的自定义请求头，会覆盖默认的请求头
+ * @returns Promise<any> - 返回接口请求的 Promise 对象
+ */
+export declare const getRequestByKey: (obj: {
+    key: string;
+    previewConfig: Record<string, IApiConfig>;
+    preUrl?: string;
+    data?: any;
+    params?: any;
+    headers?: Record<string, string>;
+    resetParams?: any;
+}) => Promise<any>;
+export default service;

package/dist/wkc-ui/utils/sessionHelper.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 组件辅助工具函数 从session中取值
+ * 独立的工具函数，避免循环依赖
+ */
+/**
+ * 组件外层是否有一层包裹组件 仅项目内使用
+ */
+export declare function isWrappedByEditor(): boolean;
+/**
+ * 组件是否处于编辑状态 仅项目内使用
+ */
+export declare function getIsEditing(): boolean;
+export declare function getComBaseApiUrl(): string;
+export declare function getComIsPreview(): number;
+export declare function getRouteCacheParams(): any;
+export declare function getScanRouteParams(): {
+    qrCode: string;
+    tobaCode: string;
+};
+export declare function getLocationInfo(): {
+    lat: number;
+    lng: number;
+};

package/dist/wkc-ui/utils/styleHelper.d.ts

@@ -0,0 +1,44 @@
+/**
+ * px 转 vw 工具函数 不需被导出，仅组件库非编辑环境使用
+ * @param px - px 值
+ * @param viewportWidth - 设计稿宽度，默认 375
+ * @returns vw 值 小于5将不转换
+ */
+export declare const px2vw: (px: number, viewportWidth?: number) => string;
+/**
+ * 转换 style 对象中的 px 值为 vw
+ * @param styleObj - 样式对象
+ * @param viewportWidth - 设计稿宽度，默认 375
+ * @returns 转换后的样式对象
+ *
+ * @example
+ * const style = { width: '100px', height: '200px', margin: '10px 20px' }
+ * const vwStyle = convertPxToVw(style)
+ * // { width: '26.66667vw', height: '53.33333vw', margin: '2.66667vw 5.33333vw' }
+ */
+export declare const convertPxToVw: (styleObj: Record<string, any>, viewportWidth?: number) => Record<string, any>;
+export declare const getBgImg: (bgUrl?: string) => string;
+export declare const getBorderRadius: (radius?: string | number) => string;
+export declare const setHCenterByMargin: (styleObj: any, marginLeft: number, isCenter: boolean) => void;
+/**
+ * 应用旋转和缩放变换
+ * @param transform - transform 配置对象
+ * @param centerHorizontal - 是否水平居中
+ * @param isEdit - 是否编辑模式
+ * @returns transform 字符串
+ */
+export declare const applyTransform: (obj: {
+    transform?: {
+        rotate?: {
+            angle: number;
+        };
+        scale?: {
+            value: number;
+        };
+    };
+    centerHorizontal?: boolean;
+    isEdit: boolean;
+}) => {
+    transformStr: string;
+    animationStr: string;
+};

package/dist/wkc-ui/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yswk-ui",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "H5活动组件库 - 核心组件",
   "type": "module",
   "main": "./dist/index.es.js",