@yume-chan/struct 0.0.0-20240714132542

package/esm/types/buffer/fixed-length.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixed-length.js","sourceRoot":"","sources":["../../../src/types/buffer/fixed-length.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAMtD,MAAM,OAAO,oCAKX,SAAQ,yBAKT;IACG,OAAO;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;CACJ"}

package/esm/types/buffer/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./base.js";
+export * from "./fixed-length.js";
+export * from "./variable-length.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/types/buffer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/buffer/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}

package/esm/types/buffer/index.js

@@ -0,0 +1,4 @@
+export * from "./base.js";
+export * from "./fixed-length.js";
+export * from "./variable-length.js";
+//# sourceMappingURL=index.js.map

package/esm/types/buffer/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/buffer/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}

package/esm/types/buffer/variable-length.d.ts

@@ -0,0 +1,46 @@
+import type { StructFieldDefinition, StructOptions, StructValue } from "../../basic/index.js";
+import { StructFieldValue } from "../../basic/index.js";
+import type { KeysOfType } from "../../utils.js";
+import type { BufferFieldConverter } from "./base.js";
+import { BufferLikeFieldDefinition, BufferLikeFieldValue } from "./base.js";
+export type LengthField<TFields> = KeysOfType<TFields, number | string>;
+export interface VariableLengthBufferLikeFieldOptions<TFields extends object = object, TLengthField extends LengthField<TFields> = any> {
+    /**
+     * The name of the field that contains the length of the buffer.
+     *
+     * This field must be a `number` or `string` (can't be `bigint`) field.
+     */
+    lengthField: TLengthField;
+    /**
+     * If the `lengthField` refers to a string field,
+     * what radix to use when converting the string to a number.
+     *
+     * @default 10
+     */
+    lengthFieldRadix?: number;
+}
+export declare class VariableLengthBufferLikeFieldDefinition<TConverter extends BufferFieldConverter = BufferFieldConverter, TOptions extends VariableLengthBufferLikeFieldOptions = VariableLengthBufferLikeFieldOptions, TTypeScriptType = TConverter["TTypeScriptType"]> extends BufferLikeFieldDefinition<TConverter, TOptions, TOptions["lengthField"], TTypeScriptType> {
+    getSize(): number;
+    protected getDeserializeSize(struct: StructValue): number;
+    create(options: Readonly<StructOptions>, struct: StructValue, value: TTypeScriptType, array?: Uint8Array): VariableLengthBufferLikeStructFieldValue<this>;
+}
+export declare class VariableLengthBufferLikeStructFieldValue<TDefinition extends VariableLengthBufferLikeFieldDefinition = VariableLengthBufferLikeFieldDefinition> extends BufferLikeFieldValue<TDefinition> {
+    #private;
+    protected length: number | undefined;
+    protected lengthFieldValue: VariableLengthBufferLikeFieldLengthValue;
+    constructor(definition: TDefinition, options: Readonly<StructOptions>, struct: StructValue, value: TDefinition["TValue"], array?: Uint8Array);
+    getSize(): number;
+    set(value: unknown): void;
+}
+type VariableLengthBufferLikeFieldValueLike = StructFieldValue<StructFieldDefinition<VariableLengthBufferLikeFieldOptions<any, any>, any, any>>;
+export declare class VariableLengthBufferLikeFieldLengthValue extends StructFieldValue<StructFieldDefinition<unknown, unknown, PropertyKey>> {
+    protected originalValue: StructFieldValue<StructFieldDefinition<unknown, unknown, PropertyKey>>;
+    protected bufferValue: VariableLengthBufferLikeFieldValueLike;
+    constructor(originalValue: StructFieldValue<StructFieldDefinition<unknown, unknown, PropertyKey>>, bufferValue: VariableLengthBufferLikeFieldValueLike);
+    getSize(): number;
+    get(): string | number;
+    set(): void;
+    serialize(array: Uint8Array, offset: number): void;
+}
+export {};
+//# sourceMappingURL=variable-length.d.ts.map

package/esm/types/buffer/variable-length.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-length.d.ts","sourceRoot":"","sources":["../../../src/types/buffer/variable-length.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACR,qBAAqB,EACrB,aAAa,EACb,WAAW,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAE5E,MAAM,MAAM,WAAW,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAExE,MAAM,WAAW,oCAAoC,CACjD,OAAO,SAAS,MAAM,GAAG,MAAM,EAC/B,YAAY,SAAS,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG;IAE/C;;;;OAIG;IACH,WAAW,EAAE,YAAY,CAAC;IAE1B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,qBAAa,uCAAuC,CAChD,UAAU,SAAS,oBAAoB,GAAG,oBAAoB,EAC9D,QAAQ,SACJ,oCAAoC,GAAG,oCAAoC,EAC/E,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CACjD,SAAQ,yBAAyB,CAC/B,UAAU,EACV,QAAQ,EACR,QAAQ,CAAC,aAAa,CAAC,EACvB,eAAe,CAClB;IACY,OAAO,IAAI,MAAM;cAIP,kBAAkB,CAAC,MAAM,EAAE,WAAW;IAQhD,MAAM,CACX,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,eAAe,EACtB,KAAK,CAAC,EAAE,UAAU,GACnB,wCAAwC,CAAC,IAAI,CAAC;CASpD;AAED,qBAAa,wCAAwC,CACjD,WAAW,SACP,uCAAuC,GAAG,uCAAuC,CACvF,SAAQ,oBAAoB,CAAC,WAAW,CAAC;;IACvC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC,SAAS,CAAC,gBAAgB,EAAE,wCAAwC,CAAC;gBAIjE,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,WAAW,CAAC,QAAQ,CAAC,EAC5B,KAAK,CAAC,EAAE,UAAU;IA2Bb,OAAO,IAAI,MAAM;IAejB,GAAG,CAAC,KAAK,EAAE,OAAO;CAK9B;AAGD,KAAK,sCAAsC,GAAG,gBAAgB,CAC1D,qBAAqB,CACjB,oCAAoC,CAAC,GAAG,EAAE,GAAG,CAAC,EAC9C,GAAG,EACH,GAAG,CACN,CACJ,CAAC;AAEF,qBAAa,wCAAyC,SAAQ,gBAAgB,CAC1E,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CACvD;IACG,SAAS,CAAC,aAAa,EAAE,gBAAgB,CACrC,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CACvD,CAAC;IAEF,SAAS,CAAC,WAAW,EAAE,sCAAsC,CAAC;gBAG1D,aAAa,EAAE,gBAAgB,CAC3B,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CACvD,EACD,WAAW,EAAE,sCAAsC;IAY9C,OAAO;IAIP,GAAG;IAaH,GAAG;IAKZ,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM;CAI9C"}

package/esm/types/buffer/variable-length.js

@@ -0,0 +1,88 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { StructFieldValue } from "../../basic/index.js";
+import { BufferLikeFieldDefinition, BufferLikeFieldValue } from "./base.js";
+export class VariableLengthBufferLikeFieldDefinition extends BufferLikeFieldDefinition {
+    getSize() {
+        return 0;
+    }
+    getDeserializeSize(struct) {
+        let value = struct.value[this.options.lengthField];
+        if (typeof value === "string") {
+            value = Number.parseInt(value, this.options.lengthFieldRadix ?? 10);
+        }
+        return value;
+    }
+    create(options, struct, value, array) {
+        return new VariableLengthBufferLikeStructFieldValue(this, options, struct, value, array);
+    }
+}
+export class VariableLengthBufferLikeStructFieldValue extends BufferLikeFieldValue {
+    length;
+    lengthFieldValue;
+    // eslint-disable-next-line @typescript-eslint/max-params
+    constructor(definition, options, struct, value, array) {
+        super(definition, options, struct, value, array);
+        if (array) {
+            this.length = array.length;
+        }
+        // Patch the associated length field.
+        const lengthField = this.definition.options.lengthField;
+        const originalValue = struct.get(lengthField);
+        this.lengthFieldValue = new VariableLengthBufferLikeFieldLengthValue(originalValue, this);
+        struct.set(lengthField, this.lengthFieldValue);
+    }
+    #tryGetSize() {
+        const length = this.definition.converter.getSize(this.value);
+        if (length !== undefined && length < 0) {
+            throw new Error("Invalid length");
+        }
+        return length;
+    }
+    getSize() {
+        if (this.length === undefined) {
+            // first try to get the size from the converter
+            this.length = this.#tryGetSize();
+        }
+        if (this.length === undefined) {
+            // The converter doesn't know the size, so convert the value to a buffer to get its size
+            this.array = this.definition.converter.toBuffer(this.value);
+            this.length = this.array.length;
+        }
+        return this.length;
+    }
+    set(value) {
+        super.set(value);
+        this.array = undefined;
+        this.length = undefined;
+    }
+}
+export class VariableLengthBufferLikeFieldLengthValue extends StructFieldValue {
+    originalValue;
+    bufferValue;
+    constructor(originalValue, bufferValue) {
+        super(originalValue.definition, originalValue.options, originalValue.struct, 0);
+        this.originalValue = originalValue;
+        this.bufferValue = bufferValue;
+    }
+    getSize() {
+        return this.originalValue.getSize();
+    }
+    get() {
+        let value = this.bufferValue.getSize();
+        const originalValue = this.originalValue.get();
+        if (typeof originalValue === "string") {
+            value = value.toString(this.bufferValue.definition.options.lengthFieldRadix ?? 10);
+        }
+        return value;
+    }
+    set() {
+        // Ignore setting
+        // It will always be in sync with the buffer size
+    }
+    serialize(array, offset) {
+        this.originalValue.set(this.get());
+        this.originalValue.serialize(array, offset);
+    }
+}
+//# sourceMappingURL=variable-length.js.map

package/esm/types/buffer/variable-length.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-length.js","sourceRoot":"","sources":["../../../src/types/buffer/variable-length.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,uDAAuD;AAOvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAIxD,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAwB5E,MAAM,OAAO,uCAKX,SAAQ,yBAKT;IACY,OAAO;QACZ,OAAO,CAAC,CAAC;IACb,CAAC;IAEkB,kBAAkB,CAAC,MAAmB;QACrD,IAAI,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAoB,CAAC;QACtE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEQ,MAAM,CACX,OAAgC,EAChC,MAAmB,EACnB,KAAsB,EACtB,KAAkB;QAElB,OAAO,IAAI,wCAAwC,CAC/C,IAAI,EACJ,OAAO,EACP,MAAM,EACN,KAAK,EACL,KAAK,CACR,CAAC;IACN,CAAC;CACJ;AAED,MAAM,OAAO,wCAGX,SAAQ,oBAAiC;IAC7B,MAAM,CAAqB;IAE3B,gBAAgB,CAA2C;IAErE,yDAAyD;IACzD,YACI,UAAuB,EACvB,OAAgC,EAChC,MAAmB,EACnB,KAA4B,EAC5B,KAAkB;QAElB,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAEjD,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC/B,CAAC;QAED,qCAAqC;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,WAA0B,CAAC;QAEvE,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAwC,CAChE,aAAa,EACb,IAAI,CACP,CAAC;QACF,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC;IAED,WAAW;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEQ,OAAO;QACZ,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,+CAA+C;YAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,wFAAwF;YACxF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QACpC,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAEQ,GAAG,CAAC,KAAc;QACvB,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC5B,CAAC;CACJ;AAWD,MAAM,OAAO,wCAAyC,SAAQ,gBAE7D;IACa,aAAa,CAErB;IAEQ,WAAW,CAAyC;IAE9D,YACI,aAEC,EACD,WAAmD;QAEnD,KAAK,CACD,aAAa,CAAC,UAAU,EACxB,aAAa,CAAC,OAAO,EACrB,aAAa,CAAC,MAAM,EACpB,CAAC,CACJ,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACnC,CAAC;IAEQ,OAAO;QACZ,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;IACxC,CAAC;IAEQ,GAAG;QACR,IAAI,KAAK,GAAoB,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAExD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;QAC/C,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpC,KAAK,GAAG,KAAK,CAAC,QAAQ,CAClB,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,gBAAgB,IAAI,EAAE,CAC7D,CAAC;QACN,CAAC;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAEQ,GAAG;QACR,iBAAiB;QACjB,iDAAiD;IACrD,CAAC;IAED,SAAS,CAAC,KAAiB,EAAE,MAAc;QACvC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;CACJ"}

package/esm/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./bigint.js";
+export * from "./buffer/index.js";
+export * from "./number.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}

package/esm/types/index.js

@@ -0,0 +1,4 @@
+export * from "./bigint.js";
+export * from "./buffer/index.js";
+export * from "./number.js";
+//# sourceMappingURL=index.js.map

package/esm/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}

package/esm/types/number.d.ts

@@ -0,0 +1,28 @@
+import type { AsyncExactReadable, ExactReadable, StructOptions, StructValue } from "../basic/index.js";
+import { StructFieldDefinition, StructFieldValue } from "../basic/index.js";
+export interface NumberFieldVariant {
+    signed: boolean;
+    size: number;
+    deserialize(array: Uint8Array, littleEndian: boolean): number;
+    serialize(array: Uint8Array, offset: number, value: number, littleEndian: boolean): void;
+}
+export declare namespace NumberFieldVariant {
+    const Uint8: NumberFieldVariant;
+    const Int8: NumberFieldVariant;
+    const Uint16: NumberFieldVariant;
+    const Int16: NumberFieldVariant;
+    const Uint32: NumberFieldVariant;
+    const Int32: NumberFieldVariant;
+}
+export declare class NumberFieldDefinition<TVariant extends NumberFieldVariant = NumberFieldVariant, TTypeScriptType = number> extends StructFieldDefinition<void, TTypeScriptType> {
+    readonly variant: TVariant;
+    constructor(variant: TVariant, typescriptType?: TTypeScriptType);
+    getSize(): number;
+    create(options: Readonly<StructOptions>, struct: StructValue, value: TTypeScriptType): NumberFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: ExactReadable, struct: StructValue): NumberFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: AsyncExactReadable, struct: StructValue): Promise<NumberFieldValue<this>>;
+}
+export declare class NumberFieldValue<TDefinition extends NumberFieldDefinition<NumberFieldVariant, unknown>> extends StructFieldValue<TDefinition> {
+    serialize(array: Uint8Array, offset: number): void;
+}
+//# sourceMappingURL=number.d.ts.map

package/esm/types/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../src/types/number.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EACR,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,WAAW,EACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAI5E,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,GAAG,MAAM,CAAC;IAC9D,SAAS,CACL,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,OAAO,GACtB,IAAI,CAAC;CACX;AAED,yBAAiB,kBAAkB,CAAC;IACzB,MAAM,KAAK,EAAE,kBASnB,CAAC;IAEK,MAAM,IAAI,EAAE,kBASlB,CAAC;IAEK,MAAM,MAAM,EAAE,kBAOpB,CAAC;IAEK,MAAM,KAAK,EAAE,kBAOnB,CAAC;IAEK,MAAM,MAAM,EAAE,kBAOpB,CAAC;IAEK,MAAM,KAAK,EAAE,kBAOnB,CAAC;CACL;AAED,qBAAa,qBAAqB,CAC9B,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,EACxD,eAAe,GAAG,MAAM,CAC1B,SAAQ,qBAAqB,CAAC,IAAI,EAAE,eAAe,CAAC;IAClD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;gBAEf,OAAO,EAAE,QAAQ,EAAE,cAAc,CAAC,EAAE,eAAe;IAM/D,OAAO,IAAI,MAAM;IAIjB,MAAM,CACF,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,eAAe,GACvB,gBAAgB,CAAC,IAAI,CAAC;IAIhB,WAAW,CAChB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,WAAW,GACpB,gBAAgB,CAAC,IAAI,CAAC;IAChB,WAAW,CAChB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,WAAW,GACpB,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAkBrC;AAED,qBAAa,gBAAgB,CACzB,WAAW,SAAS,qBAAqB,CAAC,kBAAkB,EAAE,OAAO,CAAC,CACxE,SAAQ,gBAAgB,CAAC,WAAW,CAAC;IACnC,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAQrD"}

package/esm/types/number.js

@@ -0,0 +1,88 @@
+import { getInt16, getInt32, getInt8, getUint16, getUint32, setInt16, setInt32, setUint16, setUint32, } from "@yume-chan/no-data-view";
+import { StructFieldDefinition, StructFieldValue } from "../basic/index.js";
+import { SyncPromise } from "../sync-promise.js";
+export var NumberFieldVariant;
+(function (NumberFieldVariant) {
+    NumberFieldVariant.Uint8 = {
+        signed: false,
+        size: 1,
+        deserialize(array) {
+            return array[0];
+        },
+        serialize(array, offset, value) {
+            array[offset] = value;
+        },
+    };
+    NumberFieldVariant.Int8 = {
+        signed: true,
+        size: 1,
+        deserialize(array) {
+            return getInt8(array, 0);
+        },
+        serialize(array, offset, value) {
+            array[offset] = value;
+        },
+    };
+    NumberFieldVariant.Uint16 = {
+        signed: false,
+        size: 2,
+        deserialize(array, littleEndian) {
+            return getUint16(array, 0, littleEndian);
+        },
+        serialize: setUint16,
+    };
+    NumberFieldVariant.Int16 = {
+        signed: true,
+        size: 2,
+        deserialize(array, littleEndian) {
+            return getInt16(array, 0, littleEndian);
+        },
+        serialize: setInt16,
+    };
+    NumberFieldVariant.Uint32 = {
+        signed: false,
+        size: 4,
+        deserialize(array, littleEndian) {
+            return getUint32(array, 0, littleEndian);
+        },
+        serialize: setUint32,
+    };
+    NumberFieldVariant.Int32 = {
+        signed: true,
+        size: 4,
+        deserialize(array, littleEndian) {
+            return getInt32(array, 0, littleEndian);
+        },
+        serialize: setInt32,
+    };
+})(NumberFieldVariant || (NumberFieldVariant = {}));
+export class NumberFieldDefinition extends StructFieldDefinition {
+    variant;
+    constructor(variant, typescriptType) {
+        void typescriptType;
+        super();
+        this.variant = variant;
+    }
+    getSize() {
+        return this.variant.size;
+    }
+    create(options, struct, value) {
+        return new NumberFieldValue(this, options, struct, value);
+    }
+    deserialize(options, stream, struct) {
+        return SyncPromise.try(() => {
+            return stream.readExactly(this.getSize());
+        })
+            .then((array) => {
+            const value = this.variant.deserialize(array, options.littleEndian);
+            return this.create(options, struct, value);
+        })
+            .valueOrPromise();
+    }
+}
+export class NumberFieldValue extends StructFieldValue {
+    serialize(array, offset) {
+        this.definition.variant.serialize(array, offset, this.value, this.options.littleEndian);
+    }
+}
+//# sourceMappingURL=number.js.map

package/esm/types/number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../src/types/number.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,SAAS,EACT,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,SAAS,GACZ,MAAM,yBAAyB,CAAC;AAQjC,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAejD,MAAM,KAAW,kBAAkB,CA0DlC;AA1DD,WAAiB,kBAAkB;IAClB,wBAAK,GAAuB;QACrC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK;YACb,OAAO,KAAK,CAAC,CAAC,CAAE,CAAC;QACrB,CAAC;QACD,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK;YAC1B,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;KACJ,CAAC;IAEW,uBAAI,GAAuB;QACpC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK;YACb,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC7B,CAAC;QACD,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK;YAC1B,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;KACJ,CAAC;IAEW,yBAAM,GAAuB;QACtC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,OAAO,SAAS,CAAC,KAAK,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;QAC7C,CAAC;QACD,SAAS,EAAE,SAAS;KACvB,CAAC;IAEW,wBAAK,GAAuB;QACrC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,OAAO,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;QACD,SAAS,EAAE,QAAQ;KACtB,CAAC;IAEW,yBAAM,GAAuB;QACtC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,OAAO,SAAS,CAAC,KAAK,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;QAC7C,CAAC;QACD,SAAS,EAAE,SAAS;KACvB,CAAC;IAEW,wBAAK,GAAuB;QACrC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,OAAO,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;QACD,SAAS,EAAE,QAAQ;KACtB,CAAC;AACN,CAAC,EA1DgB,kBAAkB,KAAlB,kBAAkB,QA0DlC;AAED,MAAM,OAAO,qBAGX,SAAQ,qBAA4C;IACzC,OAAO,CAAW;IAE3B,YAAY,OAAiB,EAAE,cAAgC;QAC3D,KAAK,cAAc,CAAC;QACpB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,MAAM,CACF,OAAgC,EAChC,MAAmB,EACnB,KAAsB;QAEtB,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAYQ,WAAW,CAChB,OAAgC,EAChC,MAA0C,EAC1C,MAAmB;QAEnB,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE;YACxB,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC;aACG,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAClC,KAAK,EACL,OAAO,CAAC,YAAY,CACvB,CAAC;YACF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,KAAc,CAAC,CAAC;QACxD,CAAC,CAAC;aACD,cAAc,EAAE,CAAC;IAC1B,CAAC;CACJ;AAED,MAAM,OAAO,gBAEX,SAAQ,gBAA6B;IACnC,SAAS,CAAC,KAAiB,EAAE,MAAc;QACvC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAC7B,KAAK,EACL,MAAM,EACN,IAAI,CAAC,KAAc,EACnB,IAAI,CAAC,OAAO,CAAC,YAAY,CAC5B,CAAC;IACN,CAAC;CACJ"}

package/esm/utils.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 declare function placeholder<T>(): T;
+export declare function encodeUtf8(input: string): Uint8Array;
+export declare function decodeUtf8(buffer: ArrayBufferView | ArrayBuffer): string;
+//# sourceMappingURL=utils.d.ts.map

package/esm/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,KAAK,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM,IAAI,QAAQ,CACvE,IAAI,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,GAAG,IAAI,CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,IAAI,CAC3B,CAAC,EACD;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC;CAAE,CAAC,MAAM,CAAC,CAAC,CAClE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,MAAM,IAAI;KAC/B,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,KAAK;CAC3D,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAEnD;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,KAAK,CAAC,CAElC;AAgCD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAEpD;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,WAAW,GAAG,MAAM,CAIxE"}

package/esm/utils.js

@@ -0,0 +1,18 @@
+/**
+ * Returns a (fake) value of the given type.
+ */
+export function placeholder() {
+    return undefined;
+}
+const { TextEncoder, TextDecoder } = globalThis;
+const SharedEncoder = new TextEncoder();
+const SharedDecoder = new TextDecoder();
+export function encodeUtf8(input) {
+    return SharedEncoder.encode(input);
+}
+export function decodeUtf8(buffer) {
+    // `TextDecoder` has internal states in stream mode,
+    // but this method is not for stream mode, so the instance can be reused
+    return SharedDecoder.decode(buffer);
+}
+//# sourceMappingURL=utils.js.map

package/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAgDA;;GAEG;AACH,MAAM,UAAU,WAAW;IACvB,OAAO,SAAyB,CAAC;AACrC,CAAC;AA2BD,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,UAAwC,CAAC;AAE9E,MAAM,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC;AACxC,MAAM,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC;AAExC,MAAM,UAAU,UAAU,CAAC,KAAa;IACpC,OAAO,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAqC;IAC5D,oDAAoD;IACpD,wEAAwE;IACxE,OAAO,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@yume-chan/struct",
+  "version": "0.0.0-20240714132542",
+  "description": "C-style structure serializer and deserializer.",
+  "keywords": [
+    "structure",
+    "serialization",
+    "deserialization",
+    "typescript"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Simon Chan",
+    "email": "cnsimonchan@live.com",
+    "url": "https://chensi.moe/blog"
+  },
+  "homepage": "https://github.com/yume-chan/ya-webadb/tree/main/packages/struct#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yume-chan/ya-webadb.git",
+    "directory": "packages/struct"
+  },
+  "bugs": {
+    "url": "https://github.com/yume-chan/ya-webadb/issues"
+  },
+  "type": "module",
+  "main": "esm/index.js",
+  "types": "esm/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@yume-chan/no-data-view": "0.0.0-20240714132542"
+  },
+  "devDependencies": {
+    "@jest/globals": "^30.0.0-alpha.4",
+    "@yume-chan/eslint-config": "^1.0.0",
+    "@yume-chan/tsconfig": "^1.0.0",
+    "cross-env": "^7.0.3",
+    "jest": "^30.0.0-alpha.4",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.2",
+    "typescript": "^5.5.3"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "build:watch": "tsc -b tsconfig.build.json",
+    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules --no-warnings\" TS_JEST_DISABLE_VER_CHECKER=true jest --coverage",
+    "lint": "run-eslint && prettier src/**/*.ts --write --tab-width 4"
+  }
+}

package/src/basic/definition.ts

@@ -0,0 +1,68 @@
+import type { StructFieldValue } from "./field-value.js";
+import type { StructOptions } from "./options.js";
+import type { AsyncExactReadable, ExactReadable } from "./stream.js";
+import type { StructValue } from "./struct-value.js";
+
+/**
+ * A field definition defines how to deserialize a field.
+ *
+ * @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.
+ */
+export abstract class StructFieldDefinition<
+    TOptions = void,
+    TValue = unknown,
+    TOmitInitKey extends PropertyKey = never,
+> {
+    /**
+     * When `T` is a type initiated `StructFieldDefinition`,
+     * use `T['TValue']` to retrieve its `TValue` type parameter.
+     */
+    readonly TValue!: TValue;
+
+    /**
+     * When `T` is a type initiated `StructFieldDefinition`,
+     * use `T['TOmitInitKey']` to retrieve its `TOmitInitKey` type parameter.
+     */
+    readonly TOmitInitKey!: TOmitInitKey;
+
+    readonly options: TOptions;
+
+    constructor(options: TOptions) {
+        this.options = options;
+    }
+
+    /**
+     * When implemented in derived classes, returns the size (or minimal size if it's dynamic) of this field.
+     *
+     * Actual size can be retrieved from `StructFieldValue#getSize`
+     */
+    abstract getSize(): number;
+
+    /**
+     * When implemented in derived classes, creates a `StructFieldValue` from a given `value`.
+     */
+    abstract create(
+        options: Readonly<StructOptions>,
+        structValue: StructValue,
+        value: TValue,
+    ): StructFieldValue<this>;
+
+    /**
+     * When implemented in derived classes,It must be synchronous (returns a value) or asynchronous (returns a `Promise`) depending
+     * on the type of `stream`. reads and creates a `StructFieldValue` from `stream`.
+     *
+     *  `SyncPromise` can be used to simplify implementation.
+     */
+    abstract deserialize(
+        options: Readonly<StructOptions>,
+        stream: ExactReadable,
+        structValue: StructValue,
+    ): StructFieldValue<this>;
+    abstract deserialize(
+        options: Readonly<StructOptions>,
+        stream: AsyncExactReadable,
+        struct: StructValue,
+    ): Promise<StructFieldValue<this>>;
+}

package/src/basic/field-value.ts

@@ -0,0 +1,71 @@
+import type { StructFieldDefinition } from "./definition.js";
+import type { StructOptions } from "./options.js";
+import type { StructValue } from "./struct-value.js";
+
+/**
+ * A field value defines how to serialize a field.
+ *
+ * It may contains extra metadata about the value which are essential or
+ * helpful for the serialization process.
+ */
+export abstract class StructFieldValue<
+    TDefinition extends StructFieldDefinition<unknown, unknown, PropertyKey>,
+> {
+    /** Gets the definition associated with this runtime value */
+    readonly definition: TDefinition;
+
+    /** Gets the options of the associated `Struct` */
+    readonly options: Readonly<StructOptions>;
+
+    /** Gets the associated `Struct` instance */
+    readonly struct: StructValue;
+
+    get hasCustomAccessors(): boolean {
+        return (
+            this.get !== StructFieldValue.prototype.get ||
+            this.set !== StructFieldValue.prototype.set
+        );
+    }
+
+    protected value: TDefinition["TValue"];
+
+    constructor(
+        definition: TDefinition,
+        options: Readonly<StructOptions>,
+        struct: StructValue,
+        value: TDefinition["TValue"],
+    ) {
+        this.definition = definition;
+        this.options = options;
+        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(): number {
+        return this.definition.getSize();
+    }
+
+    /**
+     * When implemented in derived classes, reads current field's value.
+     */
+    get(): TDefinition["TValue"] {
+        return this.value as never;
+    }
+
+    /**
+     * When implemented in derived classes, updates current field's value.
+     */
+    set(value: TDefinition["TValue"]): void {
+        this.value = value;
+    }
+
+    /**
+     * When implemented in derived classes, serializes this field into `array` at `offset`
+     */
+    abstract serialize(array: Uint8Array, offset: number): void;
+}

package/src/basic/index.ts

@@ -0,0 +1,5 @@
+export * from "./definition.js";
+export * from "./field-value.js";
+export * from "./options.js";
+export * from "./stream.js";
+export * from "./struct-value.js";

package/src/basic/options.ts

@@ -0,0 +1,19 @@
+export interface StructOptions {
+    /**
+     * Whether all multi-byte fields in this struct are little-endian encoded.
+     *
+     * @default false
+     */
+    littleEndian: boolean;
+
+    // TODO: StructOptions: investigate whether this is necessary
+    // I can't think about any other options which need to be struct wide.
+    // Even endianness can be set on a per-field basis (because it's not meaningful
+    // for some field types like `Uint8Array`, and very rarely, a struct may contain
+    // mixed endianness).
+    // It's just more common and a little more convenient to have it here.
+}
+
+export const StructDefaultOptions: Readonly<StructOptions> = {
+    littleEndian: false,
+};

package/src/basic/stream.ts

@@ -0,0 +1,34 @@
+import type { ValueOrPromise } from "../utils.js";
+
+// TODO: allow over reading (returning a `Uint8Array`, an `offset` and a `length`) to avoid copying
+
+export class ExactReadableEndedError extends Error {
+    constructor() {
+        super("ExactReadable ended");
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+
+export interface ExactReadable {
+    readonly position: number;
+
+    /**
+     * Read data from the underlying data source.
+     *
+     * The stream must return exactly `length` bytes or data. If that's not possible
+     * (due to end of file or other error condition), it must throw an {@link ExactReadableEndedError}.
+     */
+    readExactly(length: number): Uint8Array;
+}
+
+export interface AsyncExactReadable {
+    readonly position: number;
+
+    /**
+     * Read data from the underlying data source.
+     *
+     * The stream must return exactly `length` bytes or data. If that's not possible
+     * (due to end of file or other error condition), it must throw an {@link ExactReadableEndedError}.
+     */
+    readExactly(length: number): ValueOrPromise<Uint8Array>;
+}