mp-weixin-back 0.0.2 → 0.0.4

package/build.config.ts

@@ -0,0 +1,12 @@
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  entries: ['src/index'],
+  declaration: true,
+  clean: true,
+  rollup: {
+    emitCJS: true,
+  },
+  failOnWarn: false,
+  externals: ['vite', 'vue']
+})

package/dist/index.cjs

@@ -0,0 +1,231 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const JSON5 = require('json5');
+const generate = require('@babel/generator');
+const compilerSfc = require('@vue/compiler-sfc');
+const astKit = require('ast-kit');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const path__default = /*#__PURE__*/_interopDefaultCompat(path);
+const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+const JSON5__default = /*#__PURE__*/_interopDefaultCompat(JSON5);
+const generate__default = /*#__PURE__*/_interopDefaultCompat(generate);
+
+const virtualFileId = "mp-weixin-back-helper";
+
+function isArrowFunction(func) {
+  if (typeof func !== "function")
+    return false;
+  return !func.hasOwnProperty("prototype") && func.toString().includes("=>");
+}
+async function parseSFC(code) {
+  try {
+    return compilerSfc.parse(code).descriptor;
+  } catch (error) {
+    throw new Error(`\u89E3\u6790vue\u6587\u4EF6\u5931\u8D25\uFF0C\u8BF7\u68C0\u67E5\u6587\u4EF6\u662F\u5426\u6B63\u786E`);
+  }
+}
+async function transformVueFile(code, id) {
+  if (code.includes("<page-container")) {
+    return code;
+  }
+  if (!code.includes("<template")) {
+    return code;
+  }
+  const componentStr = '<page-container :show="__MP_BACK_SHOW_PAGE_CONTAINER__" :overlay="false" @beforeleave="onBeforeLeave" :z-index="1" :duration="false"></page-container>';
+  const sfc = await parseSFC(code);
+  const setupCode = sfc.scriptSetup?.loc.source;
+  const setupAst = astKit.babelParse(setupCode || "", sfc.scriptSetup?.lang);
+  let pageBackConfig = this.config;
+  let hasPageBack = false, hasImportRef = false, pageBackFnName = "onPageBack", callbackCode = ``;
+  if (setupAst) {
+    astKit.walkAST(setupAst, {
+      enter(node) {
+        if (node.type == "ImportDeclaration" && node.source.value.includes(virtualFileId)) {
+          const importSpecifier = node.specifiers[0];
+          hasPageBack = true;
+          pageBackFnName = importSpecifier.local.name;
+        }
+        if (node.type == "ImportDeclaration" && node.source.value === "vue") {
+          const importSpecifiers = node.specifiers;
+          for (let i = 0; i < importSpecifiers.length; i++) {
+            const element = importSpecifiers[i];
+            if (element.local.name == "ref") {
+              hasImportRef = true;
+              break;
+            }
+          }
+        }
+        if (node.type == "ExpressionStatement" && node.expression.type == "CallExpression" && node.expression.callee.loc?.identifierName == pageBackFnName) {
+          const callback = node.expression.arguments[0];
+          const backArguments = node.expression.arguments[1];
+          if (backArguments && backArguments.type == "ObjectExpression") {
+            const config = new Function(`return (${generate__default(backArguments).code});`)();
+            pageBackConfig = { ...pageBackConfig, ...config };
+          }
+          if (callback && (callback.type === "ArrowFunctionExpression" || callback.type === "FunctionExpression")) {
+            const body = callback.body;
+            if (body.type === "BlockStatement") {
+              body.body.forEach((statement) => {
+                callbackCode += generate__default(statement).code;
+              });
+            }
+          }
+        }
+      }
+    });
+  }
+  if (!hasPageBack)
+    return;
+  if (!pageBackConfig.preventDefault) {
+    callbackCode += `uni.navigateBack({ delta: 1 });`;
+  }
+  const configBack = (() => {
+    if (!pageBackConfig.onPageBack)
+      return "";
+    if (typeof pageBackConfig.onPageBack !== "function") {
+      throw new Error("`onPageBack` must be a function");
+    }
+    const params = JSON.stringify({
+      page: this.getPageById(id)
+    });
+    const hasFunction = pageBackConfig.onPageBack.toString().includes("function");
+    if (isArrowFunction(pageBackConfig.onPageBack) || hasFunction) {
+      return `(${pageBackConfig.onPageBack})(${params});`;
+    }
+    return `(function ${pageBackConfig.onPageBack})()`;
+  })();
+  const beforeLeaveStr = `
+    ${!hasImportRef ? "import { ref } from 'vue'" : ""}
+    let __MP_BACK_FREQUENCY__ = 1
+    const __MP_BACK_SHOW_PAGE_CONTAINER__ = ref(true);
+    const onBeforeLeave = () => {
+      console.log("__MP_BACK_FREQUENCY__", __MP_BACK_FREQUENCY__, ${pageBackConfig.frequency})
+      if (__MP_BACK_FREQUENCY__ < ${pageBackConfig.frequency}) {
+        __MP_BACK_SHOW_PAGE_CONTAINER__.value = false
+        setTimeout(() => {
+          __MP_BACK_SHOW_PAGE_CONTAINER__.value = true
+        }, 0);
+        __MP_BACK_FREQUENCY__++
+      }
+      // \u8FD0\u884C\u914D\u7F6E\u7684\u533F\u540D\u51FD\u6570
+      ${configBack}
+      ${callbackCode}
+    };
+  `;
+  const result = code.replace(
+    /(<template.*?>)([\s\S]*?)(<\/template>)([\s\S]*?)(<script\s+(?:lang="ts"\s+)?setup.*?>|$)/,
+    (match, templateStart, templateContent, templateEnd, middleContent, scriptSetup) => {
+      const hasScriptSetup = Boolean(scriptSetup);
+      const scriptStartTag = hasScriptSetup ? scriptSetup : "<script setup>";
+      const scriptEndTag = hasScriptSetup ? "" : "<\/script>";
+      const injectedTemplate = `${templateStart}${templateContent}
+ ${componentStr}
+${templateEnd}`;
+      const injectedScript = `
+${middleContent}${scriptStartTag}
+${beforeLeaveStr}
+${scriptEndTag}`;
+      return injectedTemplate + injectedScript;
+    }
+  );
+  return result;
+}
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class pageContext {
+  constructor(config) {
+    __publicField(this, "config");
+    __publicField(this, "pages", []);
+    this.config = config;
+  }
+  getPagesJsonPath() {
+    const pagesJsonPath = path__default.join(this.config.root, "src/pages.json");
+    return pagesJsonPath;
+  }
+  // 获取页面配置详情
+  async getPagesJsonInfo() {
+    const hasPagesJson = fs__default.existsSync(this.getPagesJsonPath());
+    if (!hasPagesJson)
+      return;
+    try {
+      const content = await fs__default.promises.readFile(this.getPagesJsonPath(), "utf-8");
+      const pagesContent = JSON5__default.parse(content);
+      const { pages, subpackages } = pagesContent;
+      if (pages) {
+        const mainPages = pages.reduce((acc, current) => {
+          acc.push(current.path);
+          return acc;
+        }, []);
+        this.pages.push(...mainPages);
+      }
+      if (subpackages) {
+        const root = subpackages.root;
+        const subPages = subpackages.pages.reduce((acc, current) => {
+          acc.push(`${root}/${current.path}`.replace("//", "/"));
+          return acc;
+        }, []);
+        this.pages.push(...subPages);
+      }
+    } catch (error) {
+      throw new Error("\u8BF7\u6B63\u786E\u914D\u7F6E\u9879\u76EE\u7684pages.json\u6587\u4EF6");
+    }
+  }
+  // 获取指定id的page
+  getPageById(id) {
+    const path2 = (id.split("src/")[1] || "").replace(".vue", "");
+    return this.pages.find((i) => i === path2) || null;
+  }
+  async transform(code, id) {
+    const result = await transformVueFile.call(this, code, id);
+    return result;
+  }
+}
+
+function MpBackPlugin(userOptions = {}) {
+  let context;
+  const defaultOptions = {
+    preventDefault: false,
+    frequency: 1
+  };
+  const options = { ...defaultOptions, ...userOptions };
+  return {
+    name: "vite-plugin-mp-weixin-back",
+    enforce: "pre",
+    configResolved(config) {
+      context = new pageContext({ ...options, mode: config.mode, root: config.root });
+    },
+    buildStart() {
+      context.getPagesJsonInfo();
+    },
+    resolveId(id) {
+      if (id === virtualFileId) {
+        return virtualFileId;
+      }
+    },
+    load(id) {
+      if (id.includes("node_modules")) {
+        return;
+      }
+      if (id === virtualFileId) {
+        return `export default function onPageBack() {}`;
+      }
+    },
+    async transform(code, id) {
+      if (id.includes("node_modules") || !id.includes(".vue")) {
+        return;
+      }
+      return context.transform(code, id);
+    }
+  };
+}
+
+module.exports = MpBackPlugin;

package/dist/index.d.cts

@@ -0,0 +1,27 @@
+import { Plugin } from 'vite';
+
+type UserOptions = Partial<Config>;
+type Config = {
+    /**
+     * 是否阻止默认的回退事件，默认为 false
+     */
+    preventDefault: boolean;
+    /**
+     * 阻止次数，默认是 `1`
+     */
+    frequency: number;
+    /**
+     * 页面回退时触发
+     */
+    onPageBack?: (params: BackParams) => void;
+};
+type BackParams = {
+    /**
+     * 当前页面路径
+     */
+    page: string;
+};
+
+declare function MpBackPlugin(userOptions?: UserOptions): Plugin;
+
+export { MpBackPlugin as default };