@msom/vue-query-preserve-v3 1.0.0

package/dist/index.js

@@ -0,0 +1,48 @@
+function createQueryPreservePlugin(options = {}) {
+  const { preserveKeys = [], beforeNavigate } = options;
+  return {
+    install(app) {
+      const router = app.config.globalProperties.$router;
+      if (!router) {
+        console.error(
+          "[vue-query-preserve] Router instance not found. Please ensure app.use(router) is called before."
+        );
+        return;
+      }
+      router.beforeEach((to, from) => {
+        if (beforeNavigate) {
+          const result = beforeNavigate(to, from);
+          if (result === false) {
+            return false;
+          }
+        }
+        const preserved = {};
+        if (preserveKeys.length > 0 && from.query) {
+          preserveKeys.forEach((key) => {
+            if (from.query[key] !== void 0) {
+              preserved[key] = from.query[key];
+            }
+          });
+        }
+        if (Object.keys(preserved).length > 0) {
+          const hasPreservedParams = preserveKeys.some(
+            (key) => to.query[key] === void 0
+          );
+          if (hasPreservedParams) {
+            return {
+              ...to,
+              query: {
+                ...preserved,
+                ...to.query
+              }
+            };
+          }
+        }
+      });
+    }
+  };
+}
+export {
+  createQueryPreservePlugin as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * Vue 3 版本插件 - 路由查询参数保留插件\n * 适配 Vue 3.x + vue-router@4\n */\nimport type { Plugin, App } from \"vue\";\nimport type { Router } from \"vue-router\";\n\nexport interface QueryPreserveOptions {\n  /**\n   * 需要保留的查询参数键名白名单\n   */\n  preserveKeys?: string[];\n  /**\n   * 跳转前的自定义钩子函数\n   * @param to 目标路由对象\n   * @param from 来源路由对象\n   * @returns 返回 false 可阻止跳转\n   */\n  beforeNavigate?: (to: any, from: any) => boolean | void;\n}\n\n/**\n * Vue 3 版本的路由查询参数保留插件\n * @param options 插件配置选项\n */\nfunction createQueryPreservePlugin(options: QueryPreserveOptions = {}): Plugin {\n  const { preserveKeys = [], beforeNavigate } = options;\n\n  return {\n    install(app: App) {\n      const router: Router = app.config.globalProperties.$router;\n\n      if (!router) {\n        console.error(\n          \"[vue-query-preserve] Router instance not found. Please ensure app.use(router) is called before.\",\n        );\n        return;\n      }\n\n      router.beforeEach((to, from) => {\n        // 如果配置了 beforeNavigate 钩子，执行它\n        if (beforeNavigate) {\n          const result = beforeNavigate(to, from);\n          if (result === false) {\n            return false;\n          }\n        }\n\n        // 从来源路由中提取需要保留的参数\n        const preserved: Record<string, string> = {};\n        if (preserveKeys.length > 0 && from.query) {\n          preserveKeys.forEach((key) => {\n            if (from.query[key] !== undefined) {\n              preserved[key] = from.query[key] as string;\n            }\n          });\n        }\n\n        // 如果有需要保留的参数，且目标路由没有这些参数，则合并\n        if (Object.keys(preserved).length > 0) {\n          const hasPreservedParams = preserveKeys.some(\n            (key) => to.query[key] === undefined,\n          );\n          if (hasPreservedParams) {\n            return {\n              ...to,\n              query: {\n                ...preserved,\n                ...to.query,\n              },\n            };\n          }\n        }\n      });\n    },\n  };\n}\n\nexport default createQueryPreservePlugin;\n"],"names":[],"mappings":"AAyBA,SAAS,0BAA0B,UAAgC,IAAY;AAC7E,QAAM,EAAE,eAAe,IAAI,mBAAmB;AAE9C,SAAO;AAAA,IACL,QAAQ,KAAU;AAChB,YAAM,SAAiB,IAAI,OAAO,iBAAiB;AAEnD,UAAI,CAAC,QAAQ;AACX,gBAAQ;AAAA,UACN;AAAA,QAAA;AAEF;AAAA,MACF;AAEA,aAAO,WAAW,CAAC,IAAI,SAAS;AAE9B,YAAI,gBAAgB;AAClB,gBAAM,SAAS,eAAe,IAAI,IAAI;AACtC,cAAI,WAAW,OAAO;AACpB,mBAAO;AAAA,UACT;AAAA,QACF;AAGA,cAAM,YAAoC,CAAA;AAC1C,YAAI,aAAa,SAAS,KAAK,KAAK,OAAO;AACzC,uBAAa,QAAQ,CAAC,QAAQ;AAC5B,gBAAI,KAAK,MAAM,GAAG,MAAM,QAAW;AACjC,wBAAU,GAAG,IAAI,KAAK,MAAM,GAAG;AAAA,YACjC;AAAA,UACF,CAAC;AAAA,QACH;AAGA,YAAI,OAAO,KAAK,SAAS,EAAE,SAAS,GAAG;AACrC,gBAAM,qBAAqB,aAAa;AAAA,YACtC,CAAC,QAAQ,GAAG,MAAM,GAAG,MAAM;AAAA,UAAA;AAE7B,cAAI,oBAAoB;AACtB,mBAAO;AAAA,cACL,GAAG;AAAA,cACH,OAAO;AAAA,gBACL,GAAG;AAAA,gBACH,GAAG,GAAG;AAAA,cAAA;AAAA,YACR;AAAA,UAEJ;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EAAA;AAEJ;"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json.schemastore.org/package",
+  "name": "@msom/vue-query-preserve-v3",
+  "version": "1.0.0",
+  "description": "Vue 3 插件，在路由跳转时自动保留指定的查询参数",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "vue",
+    "vue-router",
+    "vue3",
+    "query",
+    "preserve",
+    "plugin"
+  ],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "peerDependencies": {
+    "vue": "^3.x",
+    "vue-router": "^4.x"
+  },
+  "devDependencies": {
+    "vite": "^5.0.0",
+    "vue": "^3.5.0",
+    "vue-router": "^4.5.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "tsc --noEmit && vite build --config ../../vite.config.ts",
+    "release": "pnpm run build && pnpm publish --git-checks=false"
+  }
+}