feat: taro-history

.gitignore

@@ -0,0 +1,8 @@
+//.prettierignore 
+**/*.min.js
+**/*.min.css
+
+.idea/
+node_modules/
+dist/
+.vscode

package.json

@@ -0,0 +1,14 @@
+{
+  "name": "taro-history",
+  "version": "1.0.0",
+  "main": "index.js",
+  "repository": "git@github.com:baozouai/taro-history.git",
+  "author": "baozouai <baozouai@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@tarojs/taro": "^3.4.5"
+  }
+}

src/history.ts

@@ -0,0 +1,98 @@
+import Taro from '@tarojs/taro'
+import { addPathWithPageAndIndex, getShortPath, parseSearch } from './util'
+
+interface CallbackParams {
+  short: string
+  full: string
+
+}
+type Interceptor = (url: CallbackParams) => boolean | Promise<boolean>
+type Listener = (url: CallbackParams) => void
+
+export class History {
+  private interceptors: Interceptor[] = []
+
+  private listeners: Listener[] = []
+
+  constructor() {
+    this.interceptors = []
+  }
+
+  pushBind(option: Taro.navigateTo.Option | string) {
+    return this.push.bind(this, option)
+  }
+
+  navigateBack() {
+    Taro.navigateBack()
+  }
+
+  reLaunch(option: Taro.reLaunch.Option | string) {
+    this.common(option, 'reLaunch')
+  }
+
+  private async common<T extends { url: string }>(
+    option: T | string,
+    method: 'redirectTo' | 'switchTab' | 'reLaunch' | 'navigateTo' | 'push',
+  ) {
+    if (typeof option === 'string') {
+      option = { url: option } as T
+    }
+    const origionUrl = option.url
+    option = { ...option, url: addPathWithPageAndIndex(origionUrl) }
+    const [full, search = ''] = option.url.split('?')
+    const params = {
+      short: getShortPath(full),
+      full,
+      params: parseSearch(search),
+    }
+    const isBlock = await this.canJump(params)
+    if (!isBlock) {
+      this.notifyListeners(params)
+      if (method === 'push') {
+        method = 'navigateTo'
+      }
+
+      Taro[method](option).catch(() => {
+        Taro.switchTab(option as any)
+      })
+    }
+  }
+
+  redirectTo(option: Taro.redirectTo.Option | string) {
+    this.common(option, 'redirectTo')
+  }
+
+  push(option: Taro.navigateTo.Option | Taro.switchTab.Option | string) {
+    this.common(option, 'push')
+  }
+
+  addInterceptor(interceptor: Interceptor) {
+    this.interceptors.push(interceptor)
+    return () => {
+      this.interceptors = this.interceptors.filter(
+        (item) => item !== interceptor,
+      )
+    }
+  }
+
+  addListener(listener: Listener) {
+    this.listeners.push(listener)
+    return () => {
+      this.listeners = this.listeners.filter((item) => item !== listener)
+    }
+  }
+
+  private notifyListeners(params: CallbackParams) {
+    this.listeners.forEach((listener) => listener(params))
+  }
+
+  private async canJump(params: CallbackParams) {
+    for (const interceptor of this.interceptors) {
+      const isBlock = await Promise.resolve(interceptor(params))
+      if (isBlock) return true
+    }
+    return false
+  }
+}
+
+export default History

src/index.ts

@@ -0,0 +1,6 @@
+import History from "./history"
+export * from './util'
+export { History }
+
+const history = new History()
+export default history

src/util.ts

@@ -0,0 +1,82 @@
+import {Current} from '@tarojs/taro'
+
+const PAGE_REGEXP = /^(\/?pages\/)?/
+const INDEX_REGEXP = /(\/index)?$/
+
+/**
+ * @description: 获取路径传参
+ */
+export function getParams<T = any>() {
+  return (Current?.router?.params as unknown) as T
+}
+/**
+ * @description: 获取当前路径
+ */
+export function getPath() {
+  return Current?.router?.path || ''
+}
+/**
+ * @description: 是否是当前路径
+ */
+export function isCurrentPath(path: string) {
+  return getPath() === getFullPath(path)
+}
+/**
+ * @description: 解析search为params
+ * @param {string} search
+ * @return {Record<string, unknown>} params
+ */
+export function parseSearch(search = '') {
+  const params = Object.create(null)
+  if (search === '') return params
+  const searchArr = search.split('&')
+  searchArr.forEach((item) => {
+    const [key, value] = item.split('=')
+    params[key.trim()] = value
+  })
+
+  return params
+}
+
+/**
+ * @description: 为路径加上前缀/pages/ 和后缀 /index
+ * @param {string} path
+ * @return {string} /pages/originPath/index?search
+ */
+export function addPathWithPageAndIndex(path: string) {
+  let search = ''
+  const [url, tempsearch] = path.split('?')
+  if (tempsearch) {
+    search = `?${tempsearch}`
+  }
+  // 这样就不用传/pages/和后面的/index了
+  return getFullPath(url, search)
+}
+/**
+ * @description: 为url加上前缀/pages/和后缀/index
+ * @param {string} originPath，可以是short path，如 order,也可以是full path，如 /pages/order/index?a=xxx
+ * @param {string} search
+ * @return {string} fullPath
+ * @memberof: 
+ */
+export function getFullPath(originPath: string, search = '') {
+  return originPath
+    .replace(PAGE_REGEXP, '/pages/')
+    .replace(INDEX_REGEXP, `/index${search}`)
+}
+
+/**
+ * @description: 获取短路径
+ * @param {string} originPath 长路径，如/pages/main/invite/index
+ * @return {string} 短路径，如main/invite
+ */
+export function getShortPath(originPath: string) {
+  return originPath.replace(PAGE_REGEXP, '').replace(INDEX_REGEXP, ``)
+}
+
+/**
+ * @description: 获取当前页短路径
+ */
+export function getCurrentShortPath() {
+  return getShortPath(getPath())
+}

tsconfig.json

@@ -0,0 +1,100 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es6",                                     /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}