@deppon/deppon-router 2.2.1 → 2.2.2

package/LICENSE

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2024 Deppon
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+MIT License
+
+Copyright (c) 2024 Deppon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/es/composable.js

@@ -36,24 +36,24 @@ function createRouteProxy(routeRef, router) {
   });
 }
 
-/**
- * Composition API: useRouter
- * 在 Vue 3 Composition API 中使用 router
- *
- * @example
- * import { useRouter } from '@deppon/deppon-router'
- *
- * export default {
- *     setup() {
- *         const router = useRouter()
- *
- *         const handleClick = () => {
- *             router.push('/home')
- *         }
- *
- *         return { handleClick }
- *     }
- * }
+/**
+ * Composition API: useRouter
+ * 在 Vue 3 Composition API 中使用 router
+ *
+ * @example
+ * import { useRouter } from '@deppon/deppon-router'
+ *
+ * export default {
+ *     setup() {
+ *         const router = useRouter()
+ *
+ *         const handleClick = () => {
+ *             router.push('/home')
+ *         }
+ *
+ *         return { handleClick }
+ *     }
+ * }
  */
 function useRouter() {
   // 优先从 provide 获取增强的 router
@@ -78,28 +78,28 @@ function useRouter() {
   return routerFromProvide;
 }
 
-/**
- * Composition API: useRoute
- * 在 Vue 3 Composition API 中使用当前路由
- *
- * @example
- * import { useRoute } from '@deppon/deppon-router'
- *
- * export default {
- *     setup() {
- *         const route = useRoute()
- *
- *         console.log(route.path)
- *         console.log(route.params)
- *         console.log(route.query)
- *
- *         // 使用 getQueryByRoute 获取参数（自动适配 iframe 环境）
- *         const allParams = route.getQueryByRoute();
- *         const sourceType = route.getQueryByRoute('sourceType');
- *
- *         return {}
- *     }
- * }
+/**
+ * Composition API: useRoute
+ * 在 Vue 3 Composition API 中使用当前路由
+ *
+ * @example
+ * import { useRoute } from '@deppon/deppon-router'
+ *
+ * export default {
+ *     setup() {
+ *         const route = useRoute()
+ *
+ *         console.log(route.path)
+ *         console.log(route.params)
+ *         console.log(route.query)
+ *
+ *         // 使用 getQueryByRoute 获取参数（自动适配 iframe 环境）
+ *         const allParams = route.getQueryByRoute();
+ *         const sourceType = route.getQueryByRoute('sourceType');
+ *
+ *         return {}
+ *     }
+ * }
  */
 function useRoute() {
   try {

package/es/guards.d.ts

@@ -1,8 +1,8 @@
-/**
- * 设置路由守卫
- * @param {Object} router - Vue Router 实例
- * @param {Object} guards - 守卫配置
- * @param {Object} log - 日志实例
- * @param {Function} onRouteChange - 路由变化回调
- */
-export function setupGuards(router: Object, guards: Object | undefined, log: Object, onRouteChange: Function): void;
+/**
+ * 设置路由守卫
+ * @param {Object} router - Vue Router 实例
+ * @param {Object} guards - 守卫配置
+ * @param {Object} log - 日志实例
+ * @param {Function} onRouteChange - 路由变化回调
+ */
+export function setupGuards(router: Object, guards: Object | undefined, log: Object, onRouteChange: Function): void;

package/es/guards.js

@@ -1,11 +1,11 @@
 import './_virtual/_rollup-plugin-inject-process-env.js';
 
-/**
- * 设置路由守卫
- * @param {Object} router - Vue Router 实例
- * @param {Object} guards - 守卫配置
- * @param {Object} log - 日志实例
- * @param {Function} onRouteChange - 路由变化回调
+/**
+ * 设置路由守卫
+ * @param {Object} router - Vue Router 实例
+ * @param {Object} guards - 守卫配置
+ * @param {Object} log - 日志实例
+ * @param {Function} onRouteChange - 路由变化回调
  */
 function setupGuards(router) {
   var guards = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};

package/es/types.d.ts

@@ -1,4 +1,4 @@
-/**
- * 重新导出 vue-router 的类型（供其他包使用）
- */
-export type { RouterView, Router, RouteRecordRaw, NavigationGuardNext, RouteLocationNormalized } from 'vue-router';
+/**
+ * 重新导出 vue-router 的类型（供其他包使用）
+ */
+export type { RouterView, Router, RouteRecordRaw, NavigationGuardNext, RouteLocationNormalized } from 'vue-router';

package/es/utils.d.ts

@@ -1,142 +1,142 @@
-export function createRouterUtils(router: any, defaultViewTab?: null): {
-    /**
-     * 包装后的 push 方法，自动应用默认的 _viewTab 配置
-     * @param {Object|String} location - 路由位置
-     * @param {Function} onComplete - 成功回调
-     * @param {Function} onAbort - 失败回调
-     */
-    push(location: Object | string, onComplete: Function, onAbort: Function): Promise<any>;
-    /**
-     * 安全的路由跳转（带错误处理）
-     * @param {Object|String} location - 路由位置
-     * @param {Function} onComplete - 成功回调
-     * @param {Function} onAbort - 失败回调
-     */
-    safePush(location: Object | string, onComplete: Function, onAbort: Function): any;
-    /**
-     * 安全的路由替换（带错误处理）
-     * @param {Object|String} location - 路由位置
-     * @param {Function} onComplete - 成功回调
-     * @param {Function} onAbort - 失败回调
-     */
-    safeReplace(location: Object | string, onComplete: Function, onAbort: Function): any;
-    /**
-     * 根据路由名称跳转
-     * @param {String} name - 路由名称
-     * @param {Object} params - 路由参数
-     * @param {Object} query - 查询参数
-     */
-    pushByName(name: string, params?: Object, query?: Object): any;
-    /**
-     * 根据路由路径跳转
-     * @param {String} path - 路由路径
-     * @param {Object} query - 查询参数
-     */
-    pushByPath(path: string, query?: Object): any;
-    /**
-     * 返回上一页
-     * @param {Number} delta - 返回的步数，默认为 1
-     */
-    goBack(delta?: number): void;
-    /**
-     * 关闭当前标签页
-     * @param {string} [url] - 标签页 URL（默认使用当前页面的 location.href）
-     * @param {string} [type='IFRAME'] - 标签页类型（默认：'IFRAME'）
-     */
-    closeCurrentTab(url?: string | undefined, type?: string | undefined): void;
-    /**
-     * 检查路由是否存在（包括动态添加的路由）
-     * @param {String} name - 路由名称
-     * @returns {Boolean}
-     */
-    hasRoute(name: string): boolean;
-    /**
-     * 获取路由配置（包括动态添加的路由）
-     * @param {String} name - 路由名称
-     * @returns {Object|null}
-     */
-    getRouteConfig(name: string): Object | null;
-    /**
-     * 智能获取路由参数：在 iframe 环境中优先从父级获取，否则从当前路由 query 获取
-     * 与 depponPush 的参数获取逻辑保持一致
-     * @param {String} [key] - 参数键名，如果不提供则返回所有参数对象
-     * @returns {any} 参数值（如果提供了 key）或参数对象（如果未提供 key）
-     *
-     * @example
-     * // 获取所有参数
-     * const params = router.getQueryByRoute();
-     *
-     * // 获取指定参数
-     * const sourceType = router.getQueryByRoute('sourceType');
-     */
-    getQueryByRoute(key?: string | undefined): any;
-    /**
-     * 智能路由跳转：在 iframe 环境中自动使用 viewTab，否则使用 router.push
-     * 参数传递方式与 router.push 完全一致，在 iframe 环境中会自动适配 viewTab
-     * @param {Object|String} location - 路由位置（与 router.push 一致）
-     *   - 如果是字符串：路径字符串，如 '/home' 或 '/home?id=1'
-     *   - 如果是对象，可以包含以下属性：
-     *     - path: 路径
-     *     - name: 路由名称
-     *     - params: 路由参数（在 iframe 环境中会传递给 viewTab 的 params）
-     *     - query: 查询参数（会转换为 URL 的 query string）
-     *     - _viewTab: viewTab 选项对象（可选，仅在 iframe 环境中生效）
-     *       - title: 标签页标题（默认使用路由 meta.title 或 '新页面'）
-     *       - uumsFunction: UUMS 功能配置
-     *         - functionCode: 功能代码
-     *         - sourceSystem: 来源系统
-     *       - closeCurrentTab: 是否关闭当前标签页（默认 false）
-     * @param {Function} [onComplete] - 成功回调（与 router.push 一致）
-     * @param {Function} [onAbort] - 失败回调（与 router.push 一致）
-     * @returns {Promise} 跳转 Promise
-     *
-     * @example
-     * // 基本用法（与 router.push 完全一致，在 iframe 环境中自动使用 viewTab）
-     * router.depponPush('/home');
-     * router.depponPush({ path: '/home', query: { id: 1 } });
-     * router.depponPush({ name: 'Home', params: { id: 1 } });
-     *
-     * // 在 iframe 环境中自定义 viewTab 选项
-     * router.depponPush({
-     *   path: '/preferInfo',
-     *   query: { sourceType: 'insert' },
-     *   params: { custNumber: '701265308', preferId: '1312' },
-     *   _viewTab: {
-     *     title: 'CMC-产品折扣新增',
-     *     uumsFunction: {
-     *       functionCode: 'CMC_FUNCTION_00002',
-     *       sourceSystem: 'CMC',
-     *     },
-     *     closeCurrentTab: true,
-     *   },
-     * });
-     *
-     * // 替换原有代码示例：
-     * // 原代码：
-     * // if (top.viewTab) {
-     * //   let params = { sourceType: 'insert' };
-     * //   let url = location.origin + '/#/preferInfo?sourceType=insert';
-     * //   let tabUrl = top.Ext.urlAppend(url, 'isUap=true');
-     * //   top.closeTab(tabUrl, 'IFRAME');
-     * //   top.viewTab('CMC-产品折扣新增', url, 'iframe', params, { ... });
-     * // } else {
-     * //   this.$router.push({ path: '/preferInfo', query: { sourceType: 'insert' } });
-     * // }
-     * //
-     * // 新代码（自动适配）：
-     * router.depponPush({
-     *   path: '/preferInfo',
-     *   query: { sourceType: 'insert' },
-     *   params: { sourceType: 'insert' },
-     *   _viewTab: {
-     *     title: 'CMC-产品折扣新增',
-     *     uumsFunction: {
-     *       functionCode: 'CMC_FUNCTION_00002',
-     *       sourceSystem: 'CMC',
-     *     },
-     *     closeCurrentTab: true,
-     *   },
-     * });
-     */
-    depponPush(location: Object | string, onComplete?: Function | undefined, onAbort?: Function | undefined): Promise<any>;
-};
+export function createRouterUtils(router: any, defaultViewTab?: null): {
+    /**
+     * 包装后的 push 方法，自动应用默认的 _viewTab 配置
+     * @param {Object|String} location - 路由位置
+     * @param {Function} onComplete - 成功回调
+     * @param {Function} onAbort - 失败回调
+     */
+    push(location: Object | string, onComplete: Function, onAbort: Function): Promise<any>;
+    /**
+     * 安全的路由跳转（带错误处理）
+     * @param {Object|String} location - 路由位置
+     * @param {Function} onComplete - 成功回调
+     * @param {Function} onAbort - 失败回调
+     */
+    safePush(location: Object | string, onComplete: Function, onAbort: Function): any;
+    /**
+     * 安全的路由替换（带错误处理）
+     * @param {Object|String} location - 路由位置
+     * @param {Function} onComplete - 成功回调
+     * @param {Function} onAbort - 失败回调
+     */
+    safeReplace(location: Object | string, onComplete: Function, onAbort: Function): any;
+    /**
+     * 根据路由名称跳转
+     * @param {String} name - 路由名称
+     * @param {Object} params - 路由参数
+     * @param {Object} query - 查询参数
+     */
+    pushByName(name: string, params?: Object, query?: Object): any;
+    /**
+     * 根据路由路径跳转
+     * @param {String} path - 路由路径
+     * @param {Object} query - 查询参数
+     */
+    pushByPath(path: string, query?: Object): any;
+    /**
+     * 返回上一页
+     * @param {Number} delta - 返回的步数，默认为 1
+     */
+    goBack(delta?: number): void;
+    /**
+     * 关闭当前标签页
+     * @param {string} [url] - 标签页 URL（默认使用当前页面的 location.href）
+     * @param {string} [type='IFRAME'] - 标签页类型（默认：'IFRAME'）
+     */
+    closeCurrentTab(url?: string | undefined, type?: string | undefined): void;
+    /**
+     * 检查路由是否存在（包括动态添加的路由）
+     * @param {String} name - 路由名称
+     * @returns {Boolean}
+     */
+    hasRoute(name: string): boolean;
+    /**
+     * 获取路由配置（包括动态添加的路由）
+     * @param {String} name - 路由名称
+     * @returns {Object|null}
+     */
+    getRouteConfig(name: string): Object | null;
+    /**
+     * 智能获取路由参数：在 iframe 环境中优先从父级获取，否则从当前路由 query 获取
+     * 与 depponPush 的参数获取逻辑保持一致
+     * @param {String} [key] - 参数键名，如果不提供则返回所有参数对象
+     * @returns {any} 参数值（如果提供了 key）或参数对象（如果未提供 key）
+     *
+     * @example
+     * // 获取所有参数
+     * const params = router.getQueryByRoute();
+     *
+     * // 获取指定参数
+     * const sourceType = router.getQueryByRoute('sourceType');
+     */
+    getQueryByRoute(key?: string | undefined): any;
+    /**
+     * 智能路由跳转：在 iframe 环境中自动使用 viewTab，否则使用 router.push
+     * 参数传递方式与 router.push 完全一致，在 iframe 环境中会自动适配 viewTab
+     * @param {Object|String} location - 路由位置（与 router.push 一致）
+     *   - 如果是字符串：路径字符串，如 '/home' 或 '/home?id=1'
+     *   - 如果是对象，可以包含以下属性：
+     *     - path: 路径
+     *     - name: 路由名称
+     *     - params: 路由参数（在 iframe 环境中会传递给 viewTab 的 params）
+     *     - query: 查询参数（会转换为 URL 的 query string）
+     *     - _viewTab: viewTab 选项对象（可选，仅在 iframe 环境中生效）
+     *       - title: 标签页标题（默认使用路由 meta.title 或 '新页面'）
+     *       - uumsFunction: UUMS 功能配置
+     *         - functionCode: 功能代码
+     *         - sourceSystem: 来源系统
+     *       - closeCurrentTab: 是否关闭当前标签页（默认 false）
+     * @param {Function} [onComplete] - 成功回调（与 router.push 一致）
+     * @param {Function} [onAbort] - 失败回调（与 router.push 一致）
+     * @returns {Promise} 跳转 Promise
+     *
+     * @example
+     * // 基本用法（与 router.push 完全一致，在 iframe 环境中自动使用 viewTab）
+     * router.depponPush('/home');
+     * router.depponPush({ path: '/home', query: { id: 1 } });
+     * router.depponPush({ name: 'Home', params: { id: 1 } });
+     *
+     * // 在 iframe 环境中自定义 viewTab 选项
+     * router.depponPush({
+     *   path: '/preferInfo',
+     *   query: { sourceType: 'insert' },
+     *   params: { custNumber: '701265308', preferId: '1312' },
+     *   _viewTab: {
+     *     title: 'CMC-产品折扣新增',
+     *     uumsFunction: {
+     *       functionCode: 'CMC_FUNCTION_00002',
+     *       sourceSystem: 'CMC',
+     *     },
+     *     closeCurrentTab: true,
+     *   },
+     * });
+     *
+     * // 替换原有代码示例：
+     * // 原代码：
+     * // if (top.viewTab) {
+     * //   let params = { sourceType: 'insert' };
+     * //   let url = location.origin + '/#/preferInfo?sourceType=insert';
+     * //   let tabUrl = top.Ext.urlAppend(url, 'isUap=true');
+     * //   top.closeTab(tabUrl, 'IFRAME');
+     * //   top.viewTab('CMC-产品折扣新增', url, 'iframe', params, { ... });
+     * // } else {
+     * //   this.$router.push({ path: '/preferInfo', query: { sourceType: 'insert' } });
+     * // }
+     * //
+     * // 新代码（自动适配）：
+     * router.depponPush({
+     *   path: '/preferInfo',
+     *   query: { sourceType: 'insert' },
+     *   params: { sourceType: 'insert' },
+     *   _viewTab: {
+     *     title: 'CMC-产品折扣新增',
+     *     uumsFunction: {
+     *       functionCode: 'CMC_FUNCTION_00002',
+     *       sourceSystem: 'CMC',
+     *     },
+     *     closeCurrentTab: true,
+     *   },
+     * });
+     */
+    depponPush(location: Object | string, onComplete?: Function | undefined, onAbort?: Function | undefined): Promise<any>;
+};

package/es/vue.d.ts

@@ -1,16 +1,16 @@
-declare namespace _default {
-    export { install };
-}
-export default _default;
-/**
- * Vue 插件安装函数
- * @param {Object} app - Vue 应用实例
- * @param {Object|Array} options - 配置选项或路由配置数组
- * @param {Object} options.router - 已创建的 router 实例（如果提供，将直接使用）
- * @param {Array} options.routes - 路由配置数组
- * @param {Object} options.routerOptions - Vue Router 原始配置选项
- * @param {Object} options.guards - 路由守卫配置
- * @param {Object} options.log - 日志实例（可选，用于路由追踪）
- * @param {Function} options.onRouteChange - 路由变化回调（可选）
- */
-declare function install(app: Object, options?: Object | any[]): void;
+declare namespace _default {
+    export { install };
+}
+export default _default;
+/**
+ * Vue 插件安装函数
+ * @param {Object} app - Vue 应用实例
+ * @param {Object|Array} options - 配置选项或路由配置数组
+ * @param {Object} options.router - 已创建的 router 实例（如果提供，将直接使用）
+ * @param {Array} options.routes - 路由配置数组
+ * @param {Object} options.routerOptions - Vue Router 原始配置选项
+ * @param {Object} options.guards - 路由守卫配置
+ * @param {Object} options.log - 日志实例（可选，用于路由追踪）
+ * @param {Function} options.onRouteChange - 路由变化回调（可选）
+ */
+declare function install(app: Object, options?: Object | any[]): void;

package/es/vue.js

@@ -1,16 +1,16 @@
 import './_virtual/_rollup-plugin-inject-process-env.js';
 import { createDepponRouter } from './index.js';
 
-/**
- * Vue 插件安装函数
- * @param {Object} app - Vue 应用实例
- * @param {Object|Array} options - 配置选项或路由配置数组
- * @param {Object} options.router - 已创建的 router 实例（如果提供，将直接使用）
- * @param {Array} options.routes - 路由配置数组
- * @param {Object} options.routerOptions - Vue Router 原始配置选项
- * @param {Object} options.guards - 路由守卫配置
- * @param {Object} options.log - 日志实例（可选，用于路由追踪）
- * @param {Function} options.onRouteChange - 路由变化回调（可选）
+/**
+ * Vue 插件安装函数
+ * @param {Object} app - Vue 应用实例
+ * @param {Object|Array} options - 配置选项或路由配置数组
+ * @param {Object} options.router - 已创建的 router 实例（如果提供，将直接使用）
+ * @param {Array} options.routes - 路由配置数组
+ * @param {Object} options.routerOptions - Vue Router 原始配置选项
+ * @param {Object} options.guards - 路由守卫配置
+ * @param {Object} options.log - 日志实例（可选，用于路由追踪）
+ * @param {Function} options.onRouteChange - 路由变化回调（可选）
  */
 function install(app) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deppon/deppon-router",
-    "version": "2.2.1",
+    "version": "2.2.2",
     "description": "Vue Router 4 wrapper package",
     "license": "MIT",
     "homepage": "",