mqtt-crypto-client 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -7
- package/dist/index.browser.js +9 -0
- package/dist/index.browser.js.map +7 -0
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -33,7 +33,7 @@ const { createClient } = require('mqtt-crypto-client');
|
|
|
33
33
|
不经过 bundler，直接用 `<script>` 引入。构建产物暴露全局 `MqttCryptoClient`，包含 `createClient`、加解密工具、信封/topic 工具等全部公开导出。
|
|
34
34
|
|
|
35
35
|
```html
|
|
36
|
-
<script src="https://unpkg.com/mqtt-crypto-client@0.2.
|
|
36
|
+
<script src="https://unpkg.com/mqtt-crypto-client@0.2.2/dist/index.iife.js"></script>
|
|
37
37
|
<script>
|
|
38
38
|
const { createClient, encryptPayload, decryptPayload, buildTopic } = MqttCryptoClient;
|
|
39
39
|
|
|
@@ -53,19 +53,44 @@ const { createClient } = require('mqtt-crypto-client');
|
|
|
53
53
|
|
|
54
54
|
CDN 地址模板（`unpkg` / `jsdelivr` 字段均指向 IIFE）：
|
|
55
55
|
|
|
56
|
-
- `https://unpkg.com/mqtt-crypto-client@0.2.
|
|
57
|
-
- `https://cdn.jsdelivr.net/npm/mqtt-crypto-client@0.2.
|
|
56
|
+
- `https://unpkg.com/mqtt-crypto-client@0.2.2/dist/index.iife.js`
|
|
57
|
+
- `https://cdn.jsdelivr.net/npm/mqtt-crypto-client@0.2.2/dist/index.iife.js`
|
|
58
58
|
- 省略版本号会取 latest：`https://unpkg.com/mqtt-crypto-client`、`https://cdn.jsdelivr.net/npm/mqtt-crypto-client`
|
|
59
59
|
|
|
60
60
|
说明：
|
|
61
61
|
|
|
62
62
|
- 浏览器端使用 **crypto-js** 做同步 AES，格式与 Node 端、原 CryptoJS 实现逐字节一致（`Salted__` + 8 字节 salt + AES-256-CBC + `EVP_BytesToKey(MD5,1)` + PKCS#7 + base64）；Node 端仍用 `node:crypto`，行为不变。
|
|
63
|
-
-
|
|
63
|
+
- 浏览器产物构建期会把 `process.env.*`、`global` 静态替换掉；无法静态消除的裸 `process` 由内联最小 shim 兜底（不污染 `window.process`）。构建后会做 **AST 级扫描**（覆盖 `process.nextTick`、`process.on`、`typeof process`、`process` 传参、`Buffer`、`global` 等全部形式），并在无 `process`/`Buffer` 的 vm 沙箱中加载验证，失败即构建失败。
|
|
64
64
|
- 浏览器下 `encryptPayload` 的 `salt` 参数接受 `Uint8Array` 或 crypto-js `WordArray`；`deriveKeyAndIv` 返回 `Uint8Array`。
|
|
65
|
-
-
|
|
65
|
+
- 浏览器产物内含 mqtt 浏览器构建与 crypto-js，体积较大；Node 用户不需要这些产物。
|
|
66
66
|
- 该加密格式没有 MAC/AEAD，不能防篡改，详见下方安全说明。
|
|
67
67
|
- 本地演示：先 `npm run build`，再打开 [`examples/script-tag.html`](./examples/script-tag.html)。
|
|
68
68
|
|
|
69
|
+
## 浏览器 bundler 引入（Vite / webpack / Rollup）
|
|
70
|
+
|
|
71
|
+
浏览器环境通过包描述里的 `browser` 条件解析到 `dist/index.browser.js`（`browser` 字段作为兜底），因此不需要为这个库配置 `process` / `crypto` / `events` / `stream` 的 Node polyfill：
|
|
72
|
+
|
|
73
|
+
```js
|
|
74
|
+
import { createClient } from 'mqtt-crypto-client';
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
```js
|
|
78
|
+
// package.json（本包）
|
|
79
|
+
"browser": "./dist/index.browser.js",
|
|
80
|
+
"exports": {
|
|
81
|
+
".": {
|
|
82
|
+
"types": "./types/index.d.ts",
|
|
83
|
+
"browser": "./dist/index.browser.js", // 浏览器优先命中
|
|
84
|
+
"import": "./src/index.js", // Node ESM：使用 node:crypto
|
|
85
|
+
"require": "./dist/index.cjs" // Node CJS
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
- Node 侧行为不变：`import` 仍解析到 `src/index.js`，`require` 仍解析到 `dist/index.cjs`。
|
|
91
|
+
- 浏览器产物已内联 crypto-js（CryptoJS 兼容格式）、本地 EventEmitter 与 mqtt 浏览器构建，既不含 `node:*` 内置模块，也不含裸 `process`/`Buffer`/`global`。
|
|
92
|
+
- 若升级后仍报 `process is not defined`，通常是 bundler 缓存了旧预打包结果：Vite 清理 `node_modules/.vite` 后重启；webpack 关闭 `cache` 或删除 `node_modules/.cache`。确认实际加载的文件可检查产物里是否包含 `const SALT_HEADER` 等浏览器实现特征，或直接 `grep -c "node:crypto" node_modules/mqtt-crypto-client/dist/index.browser.js`（应为 0）。
|
|
93
|
+
|
|
69
94
|
## 快速开始
|
|
70
95
|
|
|
71
96
|
```js
|
|
@@ -239,9 +264,9 @@ CryptoJS -> node: OK
|
|
|
239
264
|
|
|
240
265
|
```bash
|
|
241
266
|
npm install
|
|
242
|
-
npm test # node:test，
|
|
267
|
+
npm test # node:test，49 个用例（含浏览器/Node 互通、IIFE 冒烟、浏览器 ESM 入口）
|
|
243
268
|
npm run typecheck # tsc checkJs
|
|
244
|
-
npm run build # dist/index.cjs + 浏览器 IIFE
|
|
269
|
+
npm run build # dist/index.cjs + 浏览器 ESM/IIFE（dist/index.browser.js、dist/index.iife.js）
|
|
245
270
|
npm pack --dry-run
|
|
246
271
|
```
|
|
247
272
|
|