@yume-chan/struct 0.0.9 → 0.0.13

package/src/types/number.ts

@@ -1,100 +1,115 @@
-import { StructDeserializationContext, StructFieldDefinition, StructFieldValue, StructOptions, StructSerializationContext, StructValue } from '../basic';
-
-export type DataViewGetters =
-    { [TKey in keyof DataView]: TKey extends `get${string}` ? TKey : never }[keyof DataView];
-
-export type DataViewSetters =
-    { [TKey in keyof DataView]: TKey extends `set${string}` ? TKey : never }[keyof DataView];
-
-export class NumberFieldType<TTypeScriptType extends number | bigint = number | bigint> {
-    public readonly TTypeScriptType!: TTypeScriptType;
-
-    public readonly size: number;
-
-    public readonly dataViewGetter: DataViewGetters;
-
-    public readonly dataViewSetter: DataViewSetters;
-
-    public constructor(
-        size: number,
-        dataViewGetter: DataViewGetters,
-        dataViewSetter: DataViewSetters
-    ) {
-        this.size = size;
-        this.dataViewGetter = dataViewGetter;
-        this.dataViewSetter = dataViewSetter;
-    }
-
-    public static readonly Int8 = new NumberFieldType<number>(1, 'getInt8', 'setInt8');
-
-    public static readonly Uint8 = new NumberFieldType<number>(1, 'getUint8', 'setUint8');
-
-    public static readonly Int16 = new NumberFieldType<number>(2, 'getInt16', 'setInt16');
-
-    public static readonly Uint16 = new NumberFieldType<number>(2, 'getUint16', 'setUint16');
-
-    public static readonly Int32 = new NumberFieldType<number>(4, 'getInt32', 'setInt32');
-
-    public static readonly Uint32 = new NumberFieldType<number>(4, 'getUint32', 'setUint32');
-
-    public static readonly Int64 = new NumberFieldType<bigint>(8, 'getBigInt64', 'setBigInt64');
-
-    public static readonly Uint64 = new NumberFieldType<bigint>(8, 'getBigUint64', 'setBigUint64');
-}
-
-export class NumberFieldDefinition<
-    TType extends NumberFieldType = NumberFieldType,
-    TTypeScriptType = TType['TTypeScriptType'],
-    > extends StructFieldDefinition<
-    void,
-    TTypeScriptType
-    > {
-    public readonly type: TType;
-
-    public constructor(type: TType, _typescriptType?: TTypeScriptType) {
-        super();
-        this.type = type;
-    }
-
-    public getSize(): number {
-        return this.type.size;
-    }
-
-    public create(
-        options: Readonly<StructOptions>,
-        context: StructSerializationContext,
-        struct: StructValue,
-        value: TTypeScriptType,
-    ): NumberFieldValue<this> {
-        return new NumberFieldValue(this, options, context, struct, value);
-    }
-
-    public async deserialize(
-        options: Readonly<StructOptions>,
-        context: StructDeserializationContext,
-        struct: StructValue,
-    ): Promise<NumberFieldValue<this>> {
-        const buffer = await context.read(this.getSize());
-        const view = new DataView(buffer);
-        const value = view[this.type.dataViewGetter](
-            0,
-            options.littleEndian
-        ) as any;
-        return this.create(options, context, struct, value);
-    }
-}
-
-export class NumberFieldValue<
-    TDefinition extends NumberFieldDefinition<NumberFieldType, any>,
-    > extends StructFieldValue<TDefinition> {
-    public serialize(dataView: DataView, offset: number): void {
-        // `setBigInt64` requires a `bigint` while others require `number`
-        // So `dataView[DataViewSetters]` requires `bigint & number`
-        // and that is, `never`
-        (dataView[this.definition.type.dataViewSetter] as any)(
-            offset,
-            this.value!,
-            this.options.littleEndian
-        );
-    }
-}
+// cspell: ignore syncbird
+
+import { StructFieldDefinition, StructFieldValue, StructValue, type StructAsyncDeserializeStream, type StructDeserializeStream, type StructOptions } from '../basic/index.js';
+import { Syncbird } from "../syncbird.js";
+import type { ValueOrPromise } from "../utils.js";
+
+export type DataViewGetters =
+    { [TKey in keyof DataView]: TKey extends `get${string}` ? TKey : never }[keyof DataView];
+
+export type DataViewSetters =
+    { [TKey in keyof DataView]: TKey extends `set${string}` ? TKey : never }[keyof DataView];
+
+export class NumberFieldType {
+    public readonly TTypeScriptType!: number;
+
+    public readonly size: number;
+
+    public readonly dataViewGetter: DataViewGetters;
+
+    public readonly dataViewSetter: DataViewSetters;
+
+    public constructor(
+        size: number,
+        dataViewGetter: DataViewGetters,
+        dataViewSetter: DataViewSetters
+    ) {
+        this.size = size;
+        this.dataViewGetter = dataViewGetter;
+        this.dataViewSetter = dataViewSetter;
+    }
+
+    public static readonly Int8 = new NumberFieldType(1, 'getInt8', 'setInt8');
+
+    public static readonly Uint8 = new NumberFieldType(1, 'getUint8', 'setUint8');
+
+    public static readonly Int16 = new NumberFieldType(2, 'getInt16', 'setInt16');
+
+    public static readonly Uint16 = new NumberFieldType(2, 'getUint16', 'setUint16');
+
+    public static readonly Int32 = new NumberFieldType(4, 'getInt32', 'setInt32');
+
+    public static readonly Uint32 = new NumberFieldType(4, 'getUint32', 'setUint32');
+}
+
+export class NumberFieldDefinition<
+    TType extends NumberFieldType = NumberFieldType,
+    TTypeScriptType = TType["TTypeScriptType"],
+    > extends StructFieldDefinition<
+    void,
+    TTypeScriptType
+    > {
+    public readonly type: TType;
+
+    public constructor(type: TType, _typescriptType?: TTypeScriptType) {
+        super();
+        this.type = type;
+    }
+
+    public getSize(): number {
+        return this.type.size;
+    }
+
+    public create(
+        options: Readonly<StructOptions>,
+        struct: StructValue,
+        value: TTypeScriptType,
+    ): NumberFieldValue<this> {
+        return new NumberFieldValue(this, options, struct, value);
+    }
+
+    public override deserialize(
+        options: Readonly<StructOptions>,
+        stream: StructDeserializeStream,
+        struct: StructValue,
+    ): NumberFieldValue<this>;
+    public override deserialize(
+        options: Readonly<StructOptions>,
+        stream: StructAsyncDeserializeStream,
+        struct: StructValue,
+    ): Promise<NumberFieldValue<this>>;
+    public override deserialize(
+        options: Readonly<StructOptions>,
+        stream: StructDeserializeStream | StructAsyncDeserializeStream,
+        struct: StructValue,
+    ): ValueOrPromise<NumberFieldValue<this>> {
+        return Syncbird
+            .try(() => {
+                return stream.read(this.getSize());
+            })
+            .then(array => {
+                const view = new DataView(array.buffer, array.byteOffset, array.byteLength);
+                const value = view[this.type.dataViewGetter](
+                    0,
+                    options.littleEndian
+                );
+                return this.create(options, struct, value as any);
+            })
+            .valueOrPromise();
+    }
+}
+
+export class NumberFieldValue<
+    TDefinition extends NumberFieldDefinition<NumberFieldType, any>,
+    > extends StructFieldValue<TDefinition> {
+    public serialize(dataView: DataView, offset: number): void {
+        // `setBigInt64` requires a `bigint` while others require `number`
+        // So `dataView[DataViewSetters]` requires `bigint & number`
+        // and that is, `never`
+        (dataView[this.definition.type.dataViewSetter] as any)(
+            offset,
+            this.value!,
+            this.options.littleEndian
+        );
+    }
+}

package/src/utils.ts

@@ -1,51 +1,70 @@
-/**
- * When evaluating a very complex generic type alias,
- * tell TypeScript to use `T`, instead of current type alias' name, as the result type name
- *
- * Example:
- *
- * ```ts
- * type WithIdentity<T> = Identity<SomeType<T>>;
- * type WithoutIdentity<T> = SomeType<T>;
- *
- * type WithIdentityResult = WithIdentity<number>;
- * // Hover on this one shows `SomeType<number>`
- *
- * type WithoutIdentityResult = WithoutIdentity<number>;
- * // Hover on this one shows `WithoutIdentity<number>`
- * ```
- */
-export type Identity<T> = T;
-
-/**
- * Collapse an intersection type (`{ foo: string } & { bar: number }`) to a simple type (`{ foo: string, bar: number }`)
- */
-export type Evaluate<T> = T extends infer U ? { [K in keyof U]: U[K] } : never;
-
-/**
- * Overwrite fields in `TBase` with fields in `TNew`
- */
-export type Overwrite<TBase extends object, TNew extends object> =
-    Evaluate<Omit<TBase, keyof TNew> & TNew>;
-
-/**
- * Remove fields with `never` type
- */
-export type OmitNever<T> = Pick<T, { [K in keyof T]: [T[K]] extends [never] ? never : K }[keyof T]>;
-
-/**
- * Extract keys of fields in `T` that has type `TValue`
- */
-export type KeysOfType<T, TValue> =
-    { [TKey in keyof T]: T[TKey] extends TValue ? TKey : never }[keyof T];
-
-export type ValueOrPromise<T> = T | Promise<T>;
-
-export type Awaited<T> = T extends Promise<infer R> ? Awaited<R> : T;
-
-/**
- * Returns a (fake) value of the given type.
- */
-export function placeholder<T>(): T {
-    return undefined as unknown as T;
-}
+/**
+ * When evaluating a very complex generic type alias,
+ * tell TypeScript to use `T`, instead of current type alias' name, as the result type name
+ *
+ * Example:
+ *
+ * ```ts
+ * type WithIdentity<T> = Identity<SomeType<T>>;
+ * type WithoutIdentity<T> = SomeType<T>;
+ *
+ * type WithIdentityResult = WithIdentity<number>;
+ * // Hover on this one shows `SomeType<number>`
+ *
+ * type WithoutIdentityResult = WithoutIdentity<number>;
+ * // Hover on this one shows `WithoutIdentity<number>`
+ * ```
+ */
+export type Identity<T> = T;
+
+/**
+ * Collapse an intersection type (`{ foo: string } & { bar: number }`) to a simple type (`{ foo: string, bar: number }`)
+ */
+export type Evaluate<T> = T extends infer U ? { [K in keyof U]: U[K] } : never;
+
+/**
+ * Overwrite fields in `TBase` with fields in `TNew`
+ */
+export type Overwrite<TBase extends object, TNew extends object> =
+    Evaluate<Omit<TBase, keyof TNew> & TNew>;
+
+/**
+ * Remove fields with `never` type
+ */
+export type OmitNever<T> = Pick<T, { [K in keyof T]: [T[K]] extends [never] ? never : K }[keyof T]>;
+
+/**
+ * Extract keys of fields in `T` that has type `TValue`
+ */
+export type KeysOfType<T, TValue> =
+    { [TKey in keyof T]: T[TKey] extends TValue ? TKey : never }[keyof T];
+
+export type ValueOrPromise<T> = T | PromiseLike<T>;
+
+/**
+ * Returns a (fake) value of the given type.
+ */
+export function placeholder<T>(): T {
+    return undefined as unknown as T;
+}
+
+// This library can't use `@types/node` or `lib: dom`
+// because they will pollute the global scope
+// So `TextEncoder` and `TextDecoder` are not available
+
+// Node.js 8.3 ships `TextEncoder` and `TextDecoder` in `util` module.
+// But using top level await to load them requires Node.js 14.1.
+// So there is no point to do that. Let's just assume they exist in global.
+
+// @ts-expect-error
+const Utf8Encoder = new TextEncoder();
+// @ts-expect-error
+const Utf8Decoder = new TextDecoder();
+
+export function encodeUtf8(input: string): Uint8Array {
+    return Utf8Encoder.encode(input);
+}
+
+export function decodeUtf8(buffer: ArrayBufferView | ArrayBuffer): string {
+    return Utf8Decoder.decode(buffer);
+}

package/cjs/basic/context.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StructDefaultOptions = void 0;
-exports.StructDefaultOptions = {
-    littleEndian: false,
-};
-//# sourceMappingURL=context.js.map

package/cjs/basic/context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/basic/context.ts"],"names":[],"mappings":";;;AAuCa,QAAA,oBAAoB,GAA4B;IACzD,YAAY,EAAE,KAAK;CACtB,CAAC"}

package/cjs/basic/definition.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StructFieldDefinition = void 0;
-/**
- * A field definition is a bridge between its type and its runtime value.
- *
- * `Struct` record fields in a list of `StructFieldDefinition`s.
- *
- * When `Struct#create` or `Struct#deserialize` are called, each field's definition
- * crates its own type of `StructFieldValue` to manage the field value in that `Struct` instance.
- *
- * One `StructFieldDefinition` can represents multiple similar types, just returns the corresponding
- * `StructFieldValue` when `createValue` was called.
- *
- * @template TOptions TypeScript type of this definition's `options`.
- * @template TValue TypeScript type of this field.
- * @template TOmitInitKey Optionally remove some fields from the init type. Should be a union of string literal types.
- */
-class StructFieldDefinition {
-    constructor(options) {
-        this.options = options;
-    }
-}
-exports.StructFieldDefinition = StructFieldDefinition;
-//# sourceMappingURL=definition.js.map

package/cjs/basic/definition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../src/basic/definition.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;;;GAcG;AACH,MAAsB,qBAAqB;IAmBvC,YAAmB,OAAiB;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CA2BJ;AAhDD,sDAgDC"}

package/cjs/basic/field-value.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StructFieldValue = void 0;
-/**
- * Field runtime value manages one field of one `Struct` instance.
- *
- * If one `StructFieldDefinition` needs to change other field's semantics
- * It can override other fields' `StructFieldValue` in its own `StructFieldValue`'s constructor
- */
-class StructFieldValue {
-    constructor(definition, options, context, struct, value) {
-        this.definition = definition;
-        this.options = options;
-        this.context = context;
-        this.struct = struct;
-        this.value = value;
-    }
-    /**
-     * Gets size of this field. By default, it returns its `definition`'s size.
-     *
-     * When overridden in derived classes, can have custom logic to calculate the actual size.
-     */
-    getSize() {
-        return this.definition.getSize();
-    }
-    /**
-     * When implemented in derived classes, returns the current value of this field
-     */
-    get() {
-        return this.value;
-    }
-    /**
-     * When implemented in derived classes, update the current value of this field
-     */
-    set(value) {
-        this.value = value;
-    }
-}
-exports.StructFieldValue = StructFieldValue;
-//# sourceMappingURL=field-value.js.map

package/cjs/basic/field-value.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"field-value.js","sourceRoot":"","sources":["../../src/basic/field-value.ts"],"names":[],"mappings":";;;AAIA;;;;;GAKG;AACH,MAAsB,gBAAgB;IAiBlC,YACI,UAAuB,EACvB,OAAgC,EAChC,OAAmC,EACnC,MAAmB,EACnB,KAA4B;QAE5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,OAAO;QACV,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,GAAG;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,KAA4B;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;CAUJ;AA9DD,4CA8DC"}

package/cjs/basic/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./context"), exports);
-tslib_1.__exportStar(require("./definition"), exports);
-tslib_1.__exportStar(require("./field-value"), exports);
-tslib_1.__exportStar(require("./struct-value"), exports);
-//# sourceMappingURL=index.js.map

package/cjs/basic/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/basic/index.ts"],"names":[],"mappings":";;;AAAA,oDAA0B;AAC1B,uDAA6B;AAC7B,wDAA8B;AAC9B,yDAA+B"}

package/cjs/basic/struct-value.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StructValue = void 0;
-/**
- * Manages the initialization process of a struct value
- */
-class StructValue {
-    constructor() {
-        /** @internal */ this.fieldValues = {};
-        /**
-         * Gets the result struct value object
-         */
-        this.value = {};
-    }
-    /**
-     * Sets a `StructFieldValue` for `key`
-     *
-     * @param key The field name
-     * @param value The associated `StructFieldValue`
-     */
-    set(key, value) {
-        // TODO: TypeScript 4.2 will allow this behavior
-        // https://github.com/microsoft/TypeScript/pull/26797
-        // @ts-expect-error Type 'symbol' cannot be used as an index type. ts(2538)
-        this.fieldValues[key] = value;
-        Object.defineProperty(this.value, key, {
-            configurable: true,
-            enumerable: true,
-            get() { return value.get(); },
-            set(v) { value.set(v); },
-        });
-    }
-    /**
-     * Gets a previously `StructFieldValue` for `key`
-     *
-     * @param key The field name
-     */
-    get(key) {
-        // TODO: TypeScript 4.2 will allow this behavior
-        // https://github.com/microsoft/TypeScript/pull/26797
-        // @ts-expect-error Type 'symbol' cannot be used as an index type. ts(2538)
-        return this.fieldValues[key];
-    }
-}
-exports.StructValue = StructValue;
-//# sourceMappingURL=struct-value.js.map

package/cjs/basic/struct-value.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"struct-value.js","sourceRoot":"","sources":["../../src/basic/struct-value.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,WAAW;IAAxB;QACI,gBAAgB,CAAU,gBAAW,GAA0C,EAAE,CAAC;QAElF;;WAEG;QACa,UAAK,GAAiC,EAAE,CAAC;IAiC7D,CAAC;IA/BG;;;;;OAKG;IACI,GAAG,CAAC,GAAgB,EAAE,KAAuB;QAChD,gDAAgD;QAChD,qDAAqD;QACrD,2EAA2E;QAC3E,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAE9B,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE;YACnC,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,IAAI;YAChB,GAAG,KAAK,OAAO,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC7B,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC3B,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,GAAgB;QACvB,gDAAgD;QAChD,qDAAqD;QACrD,2EAA2E;QAC3E,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACJ;AAvCD,kCAuCC"}

package/cjs/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = void 0;
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./basic"), exports);
-tslib_1.__exportStar(require("./struct"), exports);
-var struct_1 = require("./struct");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return struct_1.Struct; } });
-tslib_1.__exportStar(require("./types"), exports);
-tslib_1.__exportStar(require("./utils"), exports);
-//# sourceMappingURL=index.js.map

package/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,kDAAwB;AACxB,mDAAyB;AACzB,mCAA6C;AAApC,iGAAA,MAAM,OAAW;AAC1B,kDAAwB;AACxB,kDAAwB"}