@cloudpss/ubjson 0.4.11 → 0.4.13

package/dist/stream-helper/encoder.js

@@ -1,57 +1,57 @@
-import { EncoderBase } from '../common/encoder.js';
-const BLOCK_SIZE = 1024 * 8; // 8 KiB
-const MAX_SIZE = 1024 * 1024 * 256; // 256 MiB
-/** 流式编码 UBJSON */
-export class StreamEncoderHelper extends EncoderBase {
-    constructor(value, onChunk) {
-        super(value);
-        this.onChunk = onChunk;
-    }
-    /**
-     * 确保 buffer 还有 capacity 的空闲空间
-     */
-    ensureCapacity(capacity) {
-        if (capacity > MAX_SIZE) {
-            // 超过最大尺寸限制
-            throw new Error('Buffer has exceed max size');
-        }
-        if (this.buffer == null) {
-            this.buffer = new Uint8Array(capacity);
-            this.view = new DataView(this.buffer.buffer);
-            return;
-        }
-        if (capacity < 0) {
-            // 结束流
-            this.onChunk(this.buffer.subarray(0, this.length));
-            this.buffer = new Uint8Array(0);
-            this.view = new DataView(this.buffer.buffer);
-            this.length = 0;
-            return;
-        }
-        // 无需扩容
-        if (this.buffer.byteLength >= this.length + capacity)
-            return;
-        // 提交目前的数据
-        this.onChunk(this.buffer.subarray(0, this.length));
-        // 重新分配缓冲区
-        if (capacity < BLOCK_SIZE)
-            capacity = BLOCK_SIZE;
-        this.buffer = new Uint8Array(capacity);
-        this.view = new DataView(this.buffer.buffer);
-        this.length = 0;
-    }
-    /** 获取写入结果 */
-    encode() {
-        if (typeof this.value != 'object' || this.value == null || ArrayBuffer.isView(this.value)) {
-            this.ensureCapacity(20);
-            this.write(this.value);
-            this.ensureCapacity(-1);
-        }
-        else {
-            this.ensureCapacity(BLOCK_SIZE);
-            this.write(this.value);
-            this.ensureCapacity(-1);
-        }
-    }
-}
+import { EncoderBase } from '../common/encoder.js';
+const BLOCK_SIZE = 1024 * 8; // 8 KiB
+const MAX_SIZE = 1024 * 1024 * 256; // 256 MiB
+/** 流式编码 UBJSON */
+export class StreamEncoderHelper extends EncoderBase {
+    constructor(value, onChunk) {
+        super(value);
+        this.onChunk = onChunk;
+    }
+    /**
+     * 确保 buffer 还有 capacity 的空闲空间
+     */
+    ensureCapacity(capacity) {
+        if (capacity > MAX_SIZE) {
+            // 超过最大尺寸限制
+            throw new Error('Buffer has exceed max size');
+        }
+        if (this.buffer == null) {
+            this.buffer = new Uint8Array(capacity);
+            this.view = new DataView(this.buffer.buffer);
+            return;
+        }
+        if (capacity < 0) {
+            // 结束流
+            this.onChunk(this.buffer.subarray(0, this.length));
+            this.buffer = new Uint8Array(0);
+            this.view = new DataView(this.buffer.buffer);
+            this.length = 0;
+            return;
+        }
+        // 无需扩容
+        if (this.buffer.byteLength >= this.length + capacity)
+            return;
+        // 提交目前的数据
+        this.onChunk(this.buffer.subarray(0, this.length));
+        // 重新分配缓冲区
+        if (capacity < BLOCK_SIZE)
+            capacity = BLOCK_SIZE;
+        this.buffer = new Uint8Array(capacity);
+        this.view = new DataView(this.buffer.buffer);
+        this.length = 0;
+    }
+    /** 获取写入结果 */
+    encode() {
+        if (typeof this.value != 'object' || this.value == null || ArrayBuffer.isView(this.value)) {
+            this.ensureCapacity(20);
+            this.write(this.value);
+            this.ensureCapacity(-1);
+        }
+        else {
+            this.ensureCapacity(BLOCK_SIZE);
+            this.write(this.value);
+            this.ensureCapacity(-1);
+        }
+    }
+}
 //# sourceMappingURL=encoder.js.map

package/dist/utils.d.ts

@@ -1,2 +1,2 @@
-/** 支持的数据转为 Uint8Array */
-export declare function toUint8Array(data: BinaryData): Uint8Array;
+/** 支持的数据转为 Uint8Array */
+export declare function toUint8Array(data: BinaryData): Uint8Array;

package/dist/utils.js

@@ -1,8 +1,8 @@
-/** 支持的数据转为 Uint8Array */
-export function toUint8Array(data) {
-    if (ArrayBuffer.isView(data)) {
-        return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
-    }
-    return new Uint8Array(data, 0, data.byteLength);
-}
+/** 支持的数据转为 Uint8Array */
+export function toUint8Array(data) {
+    if (ArrayBuffer.isView(data)) {
+        return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
+    }
+    return new Uint8Array(data, 0, data.byteLength);
+}
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudpss/ubjson",
-  "version": "0.4.11",
+  "version": "0.4.13",
   "author": "CloudPSS",
   "license": "MIT",
   "keywords": [
@@ -49,7 +49,8 @@
     "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest"
   },
   "devDependencies": {
-    "@msgpack/msgpack": "^3.0.0-beta2"
+    "@msgpack/msgpack": "^3.0.0-beta2",
+    "@types/lodash": "^4.14.192"
   },
   "dependencies": {
     "rxjs": "^7.8.0"

package/src/rxjs/decoder.ts

@@ -1,4 +1,4 @@
-import { Observable, OperatorFunction } from 'rxjs';
+import { Observable, type OperatorFunction } from 'rxjs';
 import { StreamDecoderHelper, UnexpectedEof } from '../stream-helper/decoder.js';
 import { toUint8Array } from '../utils.js';
 

package/src/rxjs/encoder.ts

@@ -1,4 +1,4 @@
-import { Observable, OperatorFunction } from 'rxjs';
+import { Observable, type OperatorFunction } from 'rxjs';
 import { StreamEncoderHelper } from '../stream-helper/encoder.js';
 
 /** 流式编码 UBJSON */

package/src/stream/decoder.ts

@@ -1,4 +1,4 @@
-import { Transform, TransformCallback } from 'node:stream';
+import { Transform, type TransformCallback } from 'node:stream';
 import { Subject } from 'rxjs';
 import { decode } from '../rxjs/decoder.js';
 

package/src/stream/encoder.ts

@@ -1,4 +1,4 @@
-import { Transform, TransformCallback } from 'node:stream';
+import { Transform, type TransformCallback } from 'node:stream';
 import { StreamEncoderHelper } from '../stream-helper/encoder.js';
 
 /** 流式编码 UBJSON */

package/tests/.utils.js

@@ -0,0 +1,25 @@
+/**
+ * 输入转为数字数组以便比较
+ *
+ * @param {[ArrayBuffer] | [Uint8Array] | (number | string)[]} args 输入
+ * @returns {number[]} 数字数组
+ */
+export function toArray(...args) {
+    if (args[0] instanceof ArrayBuffer) {
+        return Array.from(new Uint8Array(args[0]));
+    }
+    if (args[0] instanceof Uint8Array) {
+        return Array.from(args[0]);
+    }
+    return args.map((x) => (typeof x == 'number' ? x : /** @type {string} */ (x).charCodeAt(0)));
+}
+
+/**
+ * 将数字或字符串转换为 Uint8Array
+ *
+ * @param  {...string | number} args 数字或 char 的数组
+ * @returns {Uint8Array} Uint8Array
+ */
+export function toBuffer(...args) {
+    return Uint8Array.from(args, (x) => (typeof x == 'number' ? x : x.charCodeAt(0)));
+}

package/tests/decode.js

@@ -3,21 +3,14 @@
  */
 
 import { decode } from '../dist/index.js';
-
-/**
- * @param  {...string | number} args
- * @returns {Uint8Array}
- */
-function toBuffer(...args) {
-    return Uint8Array.from(args, (x) => (typeof x == 'number' ? x : x.charCodeAt(0)));
-}
+import { toBuffer } from './.utils.js';
 
 test('decode unsupported type', () => {
     expect(() => decode(toBuffer('!'))).toThrow();
 });
 
 test('decode undefined data', () => {
-    // @ts-expect-error
+    // @ts-expect-error 不传参数
     expect(() => decode(undefined)).toThrow();
 });
 

package/tests/e2e.js

@@ -279,7 +279,9 @@ test('encode/decode model', () => {
 });
 
 test('encode/decode complex object (no encodeInto)', () => {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const encodeInto = TextEncoder.prototype.encodeInto;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     TextEncoder.prototype.encodeInto = undefined;
     const expected = {

package/tests/encode.js

@@ -3,24 +3,14 @@
  */
 
 import { encode, decode } from '../dist/index.js';
-
-/**
- *
- * @param {[ArrayBuffer] | [Uint8Array] | (number | string)[]} args
- * @returns {number[]}
- */
-function toArray(...args) {
-    if (args[0] instanceof ArrayBuffer) {
-        return Array.from(new Uint8Array(args[0]));
-    }
-    if (args[0] instanceof Uint8Array) {
-        return Array.from(args[0]);
-    }
-    return args.map((x) => (typeof x == 'number' ? x : /** @type {string} */ (x).charCodeAt(0)));
-}
+import { toArray } from './.utils.js';
 
 test('encode function', () => {
-    expect(() => encode(function () {})).toThrow();
+    expect(() =>
+        encode(function () {
+            //noop
+        }),
+    ).toThrow();
 });
 
 test('encode bigint', () => {
@@ -96,7 +86,9 @@ test('encode string', () => {
 });
 
 test('encode string (no encodeInto)', () => {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const encodeInto = TextEncoder.prototype.encodeInto;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     TextEncoder.prototype.encodeInto = undefined;
     expect(toArray(encode('ubjson'))).toEqual(toArray('S', 'i', 6, 'u', 'b', 'j', 's', 'o', 'n'));
@@ -314,7 +306,11 @@ test('encode object (skip undefined)', () => {
 });
 
 test('encode object (function) [error]', () => {
-    const obj = { a: () => {} };
+    const obj = {
+        a: () => {
+            // noop
+        },
+    };
     expect(() => encode(obj)).toThrow(/Unsupported type \[object Function\]/);
 });
 

package/tests/rxjs/decode.js

@@ -4,9 +4,12 @@
 import { jest } from '@jest/globals';
 import { firstValueFrom, of, Subject } from 'rxjs';
 import { decode as decodePipe } from '../../dist/rxjs/index.js';
+import { toBuffer } from '../.utils.js';
 
 /**
- * @param {Uint8Array} data
+ * 包装为 promise
+ *
+ * @param {Uint8Array} data ubjson 数据
  */
 async function decode(data) {
     const readable = of(data);
@@ -14,8 +17,10 @@ async function decode(data) {
 }
 
 /**
- * @param {import("rxjs").Observable<Uint8Array>} observable
- * @param {(data: unknown) => void} onData
+ * 包装为 promise
+ *
+ * @param {import("rxjs").Observable<Uint8Array>} observable ubjson 数据流
+ * @param {(data: unknown) => void} onData 数据回调
  */
 function decodeStream(observable, onData) {
     return /** @type {Promise<void>} */ (
@@ -29,14 +34,6 @@ function decodeStream(observable, onData) {
     );
 }
 
-/**
- * @param  {...string | number} args
- * @returns {Uint8Array}
- */
-function toBuffer(...args) {
-    return Uint8Array.from(args, (x) => (typeof x == 'number' ? x : x.charCodeAt(0)));
-}
-
 test('decode unsupported type', async () => {
     await expect(() => decode(toBuffer('!'))).rejects.toThrow();
 });

package/tests/rxjs/encode.js

@@ -4,9 +4,12 @@
 import { firstValueFrom, of, reduce, Subject } from 'rxjs';
 import { encode } from '../../dist/rxjs/index.js';
 import { decode, encode as encodeRef } from '../../dist/index.js';
+import { toArray } from '../.utils.js';
 
 /**
- * @param {unknown} value
+ * 包装为 promise
+ *
+ * @param {unknown} value 要编码的值
  */
 function encodeAsync(value) {
     return firstValueFrom(
@@ -17,23 +20,12 @@ function encodeAsync(value) {
     );
 }
 
-/**
- *
- * @param {[ArrayBuffer] | [Uint8Array] | (number | string)[]} args
- * @returns {number[]}
- */
-function toArray(...args) {
-    if (args[0] instanceof ArrayBuffer) {
-        return Array.from(new Uint8Array(args[0]));
-    }
-    if (args[0] instanceof Uint8Array) {
-        return Array.from(args[0]);
-    }
-    return args.map((x) => (typeof x == 'number' ? x : /** @type {string} */ (x).charCodeAt(0)));
-}
-
 test('encode function', async () => {
-    await expect(() => encodeAsync(function () {})).rejects.toThrow();
+    await expect(() =>
+        encodeAsync(function () {
+            // noop
+        }),
+    ).rejects.toThrow();
 });
 
 test('encode bigint', async () => {
@@ -116,7 +108,9 @@ test('encode huge string', async () => {
 });
 
 test('encode string (no encodeInto)', async () => {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const encodeInto = TextEncoder.prototype.encodeInto;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     TextEncoder.prototype.encodeInto = undefined;
     expect(toArray(await encodeAsync('ubjson'))).toEqual(toArray('S', 'i', 6, 'u', 'b', 'j', 's', 'o', 'n'));
@@ -338,7 +332,11 @@ test('encode object (skip undefined)', async () => {
 });
 
 test('encode object (function) [error]', async () => {
-    const obj = { a: () => {} };
+    const obj = {
+        a: () => {
+            // noop
+        },
+    };
     await expect(() => encodeAsync(obj)).rejects.toThrow(/Unsupported type \[object Function\]/);
 });
 
@@ -408,5 +406,5 @@ test('encode stream input error [error]', async () => {
     stream.next(true);
     stream.next(false);
     stream.error(new Error('123456'));
-    expect(result).rejects.toThrow('123456');
+    await expect(result).rejects.toThrow('123456');
 });

package/tests/stream/decode.js

@@ -4,9 +4,12 @@
 import { jest } from '@jest/globals';
 import { Readable } from 'node:stream';
 import { decoder as decodeStream, decode as decodeAsync } from '../../dist/stream/index.js';
+import { toBuffer } from '../.utils.js';
 
 /**
- * @param {Uint8Array} data
+ * 包装为 promise
+ *
+ * @param {Uint8Array} data ubjson 数据
  */
 async function decode(data) {
     const readable = Readable.from([data], { objectMode: false });
@@ -14,7 +17,9 @@ async function decode(data) {
 }
 
 /**
- * @param {import("stream").Transform} stream
+ * 包装为 promise
+ *
+ * @param {import("stream").Transform} stream ubjson 流
  */
 function eos(stream) {
     return new Promise((resolve, reject) => {
@@ -23,14 +28,6 @@ function eos(stream) {
     });
 }
 
-/**
- * @param  {...string | number} args
- * @returns {Uint8Array}
- */
-function toBuffer(...args) {
-    return Uint8Array.from(args, (x) => (typeof x == 'number' ? x : x.charCodeAt(0)));
-}
-
 test('decode unsupported type', async () => {
     await expect(() => decode(toBuffer('!'))).rejects.toThrow();
 });

package/tests/stream/encode.js

@@ -4,31 +4,23 @@
 import { buffer } from 'node:stream/consumers';
 import { encode, encoder } from '../../dist/stream/index.js';
 import { decode, encode as encodeRef } from '../../dist/index.js';
+import { toArray } from '../.utils.js';
 
 /**
- * @param {unknown} value
+ * 包装为 promise
+ *
+ * @param {unknown} value 值
  */
 function encodeAsync(value) {
     return buffer(encode(value));
 }
 
-/**
- *
- * @param {[ArrayBuffer] | [Uint8Array] | (number | string)[]} args
- * @returns {number[]}
- */
-function toArray(...args) {
-    if (args[0] instanceof ArrayBuffer) {
-        return Array.from(new Uint8Array(args[0]));
-    }
-    if (args[0] instanceof Uint8Array) {
-        return Array.from(args[0]);
-    }
-    return args.map((x) => (typeof x == 'number' ? x : /** @type {string} */ (x).charCodeAt(0)));
-}
-
 test('encode function', async () => {
-    await expect(() => encodeAsync(function () {})).rejects.toThrow();
+    await expect(() =>
+        encodeAsync(function () {
+            // noop
+        }),
+    ).rejects.toThrow();
 });
 
 test('encode bigint', async () => {
@@ -111,7 +103,9 @@ test('encode huge string', async () => {
 });
 
 test('encode string (no encodeInto)', async () => {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const encodeInto = TextEncoder.prototype.encodeInto;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     TextEncoder.prototype.encodeInto = undefined;
     expect(toArray(await encodeAsync('ubjson'))).toEqual(toArray('S', 'i', 6, 'u', 'b', 'j', 's', 'o', 'n'));
@@ -333,7 +327,11 @@ test('encode object (skip undefined)', async () => {
 });
 
 test('encode object (function) [error]', async () => {
-    const obj = { a: () => {} };
+    const obj = {
+        a: () => {
+            // noop
+        },
+    };
     await expect(() => encodeAsync(obj)).rejects.toThrow(/Unsupported type \[object Function\]/);
 });
 

package/tests/string-encoding.js

@@ -2,11 +2,12 @@ import { StringEncoder } from '../dist/common/string-encoder.js';
 import { StringDecoder, decodeJs } from '../dist/common/string-decoder.js';
 
 /**
- *
- * @param {Pick<TextEncoder, 'encode'>} encoder
- * @param {Pick<TextDecoder, 'decode'>} decoder
+ * 测试编码
  */
-function testEncoding(encoder, decoder) {
+function testEncoding(
+    /** @type {Pick<TextEncoder, 'encode'>} */ encoder,
+    /** @type {Pick<TextDecoder, 'decode'>} */ decoder,
+) {
     expect(decoder.decode(encoder.encode(''))).toEqual('');
     expect(decoder.decode(encoder.encode('p4'))).toEqual('p4');
     expect(decoder.decode(encoder.encode('t0'))).toEqual('t0');
@@ -59,11 +60,7 @@ test('decode string', () => {
     testEncoding(
         new TextEncoder(),
         new (class extends StringDecoder {
-            /**
-             * @override
-             * @param {Uint8Array} buffer
-             */
-            decode(buffer) {
+            /** @override */ decode(/** @type {Uint8Array} */ buffer) {
                 return super.decode(buffer, 0, buffer.byteLength);
             }
         })(),
@@ -74,11 +71,7 @@ test('decode string js', () => {
     testEncoding(
         new TextEncoder(),
         new (class extends StringDecoder {
-            /**
-             * @override
-             * @param {Uint8Array} buffer
-             */
-            decode(buffer) {
+            /** @override */ decode(/** @type {Uint8Array} */ buffer) {
                 return decodeJs(buffer, 0, buffer.byteLength);
             }
         })(),