feat: add mini-app support (#8)

Author: JounQin

.changeset/yellow-toys-add.md

@@ -0,0 +1,5 @@
+---
+"ab64": patch
+---
+
+feat: add `mini-app` support

.eslintignore

@@ -2,6 +2,7 @@ coverage
 dist
 lib
 CHANGELOG.md
+/src/mini-app.ts
 /pnpm-lock.yaml
 !/.github
 !/.*.cjs

.github/workflows/size-limit.yml

@@ -25,6 +25,9 @@ jobs:
       - name: Install Dependencies
         run: pnpm i
 
+      - name: Build MiniApp entry
+        run: pnpm mini-app
+
       - uses: andresz1/size-limit-action@v1
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -5,3 +5,4 @@ coverage
 dist
 lib
 node_modules
+/src/mini-app.ts

.prettierignore

@@ -1,3 +1,4 @@
 coverage
 dist
+/src/mini-app.ts
 /pnpm-lock.yaml

README.md

@@ -23,6 +23,7 @@ The smallest and fastest Base64 implementation in JavaScript based on `atob` and
     - [Basic](#basic)
     - [Polyfill](#polyfill)
     - [Ponyfill](#ponyfill)
+    - [MiniApp (WeChat)](#miniapp-wechat)
 - [Sponsors](#sponsors)
 - [Backers](#backers)
 - [Changelog](#changelog)
@@ -87,6 +88,16 @@ import { atob, btoa } from 'ab64/ponyfill'
 // same as browser native
 ```
 
+#### MiniApp (WeChat)
+
+Since mini app (from wechat) does not support global polyfill, so you have to use the separate `mini-app` entry instead which uses the above ponyfill inside
+
+```js
+import { decode, decodeUrl, encode, encodeUrl } from 'ab64/mini-app'
+```
+
+Or you should add an alias mapping `ab64` to `ab64/mini-app` in your `rollup`/`vite`/`webpack` configuration
+
 ## Sponsors
 
 | 1stG                                                                                                                               | RxTS                                                                                                                               | UnTS                                                                                                                               |

package.json

@@ -72,9 +72,10 @@
     "lint:es": "eslint . --cache -f friendly --max-warnings 10",
     "lint:style": "stylelint . --cache",
     "lint:tsc": "tsc --noEmit",
+    "mini-app": "tsx scripts/mini-app",
     "postversion": "pnpm i --no-frozen-lockfile",
     "prepare": "simple-git-hooks",
-    "prerelease": "pnpm build",
+    "prerelease": "pnpm mini-app && pnpm build",
     "release": "changeset publish",
     "serve": "sirv dist -s",
     "test": "run-p test:*",
@@ -109,6 +110,7 @@
     "react-router-dom": "^6.3.0",
     "sirv-cli": "^2.0.2",
     "size-limit": "^8.0.0",
+    "tsx": "^3.8.0",
     "type-coverage": "^2.22.0",
     "typescript": "4.7.4",
     "unplugin-auto-import": "^0.10.3",
@@ -124,6 +126,7 @@
         "import": "./lib/index.js",
         "require": "./lib/index.cjs"
       },
+      "./mini-app": "./lib/mini-app.js",
       "./polyfill": "./lib/polyfill.js",
       "./ponyfill": "./lib/ponyfill.js"
     },
@@ -132,11 +135,15 @@
   "size-limit": [
     {
       "path": "lib/browser.js",
-      "limit": "280B"
+      "limit": "310B"
+    },
+    {
+      "path": "lib/mini-app.js",
+      "limit": "730B"
     },
     {
       "path": "lib/ponyfill.js",
-      "limit": "520B"
+      "limit": "530B"
     }
   ],
   "typeCoverage": {

pnpm-lock.yaml

@@ -0,0 +1,9 @@
+import fs from 'node:fs/promises'
+
+await fs.writeFile(
+  'src/mini-app.ts',
+  `import { atob, btoa } from './ponyfill.js'
+
+${await fs.readFile('src/browser.ts', 'utf8')}
+`,
+)

scripts/mini-app.ts

@@ -1,14 +1,16 @@
 /* eslint-disable unicorn/prefer-code-point -- for smaller bundler and compatibility */
 
+import { slice } from './helper.js'
+
 const HEX = 16
 const CHUNK = 4
 
 export const decode = (val: string) =>
   decodeURIComponent(
-    [
+    slice(
       // eslint-disable-next-line sonar/deprecation -- it's fine on browser
-      ...atob(val),
-    ]
+      atob(val),
+    )
       .map(
         char => '%' + ('00' + char.charCodeAt(0)!.toString(HEX)).slice(-1 * 2),
       )