@yume-chan/struct 0.0.17 → 0.0.19

package/esm/utils.d.ts

@@ -1,48 +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 declare type Identity<T> = T;
-/**
- * Collapse an intersection type (`{ foo: string } & { bar: number }`) to a simple type (`{ foo: string, bar: number }`)
- */
-export declare type Evaluate<T> = T extends infer U ? {
-    [K in keyof U]: U[K];
-} : never;
-/**
- * Overwrite fields in `TBase` with fields in `TNew`
- */
-export declare type Overwrite<TBase extends object, TNew extends object> = Evaluate<Omit<TBase, keyof TNew> & TNew>;
-/**
- * Remove fields with `never` type
- */
-export declare 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 declare type KeysOfType<T, TValue> = {
-    [TKey in keyof T]: T[TKey] extends TValue ? TKey : never;
-}[keyof T];
-export declare 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;
+/**
+ * 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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,oBAAY,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;AAE5B;;GAEG;AACH,oBAAY,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,oBAAY,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM,IAC3D,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;AAE7C;;GAEG;AACH,oBAAY,SAAS,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE;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,CAAC,CAAC;AAEpG;;GAEG;AACH,oBAAY,UAAU,CAAC,CAAC,EAAE,MAAM,IAC5B;KAAG,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,KAAK;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAE1E,oBAAY,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAEnD;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,KAAK,CAAC,CAElC;AAeD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAEpD;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,WAAW,GAAG,MAAM,CAExE"}
+{"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,CAExE"}

package/esm/utils.js

@@ -1,23 +1,16 @@
-/**
- * Returns a (fake) value of the given type.
- */
-export function placeholder() {
-    return undefined;
-}
-// 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) {
-    return Utf8Encoder.encode(input);
-}
-export function decodeUtf8(buffer) {
-    return Utf8Decoder.decode(buffer);
-}
+/**
+ * Returns a (fake) value of the given type.
+ */
+export function placeholder() {
+    return undefined;
+}
+const { TextEncoder, TextDecoder } = globalThis;
+const Utf8Encoder = new TextEncoder();
+const Utf8Decoder = new TextDecoder();
+export function encodeUtf8(input) {
+    return Utf8Encoder.encode(input);
+}
+export function decodeUtf8(buffer) {
+    return Utf8Decoder.decode(buffer);
+}
 //# sourceMappingURL=utils.js.map

package/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AA2CA;;GAEG;AACH,MAAM,UAAU,WAAW;IACvB,OAAO,SAAyB,CAAC;AACrC,CAAC;AAED,qDAAqD;AACrD,6CAA6C;AAC7C,uDAAuD;AAEvD,sEAAsE;AACtE,gEAAgE;AAChE,2EAA2E;AAE3E,mBAAmB;AACnB,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AACtC,mBAAmB;AACnB,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC,MAAM,UAAU,UAAU,CAAC,KAAa;IACpC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAqC;IAC5D,OAAO,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC"}
+{"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,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AACtC,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC,MAAM,UAAU,UAAU,CAAC,KAAa;IACpC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAqC;IAC5D,OAAO,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yume-chan/struct",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "description": "C-style structure serializer and deserializer.",
   "keywords": [
     "structure",
@@ -27,20 +27,24 @@
   "main": "esm/index.js",
   "types": "esm/index.d.ts",
   "dependencies": {
-    "@yume-chan/dataview-bigint-polyfill": "^0.0.17",
-    "tslib": "^2.4.0"
+    "@yume-chan/dataview-bigint-polyfill": "^0.0.19",
+    "tslib": "^2.4.1"
   },
   "devDependencies": {
-    "@jest/globals": "^28.1.2",
-    "@yume-chan/ts-package-builder": "^1.0.0",
+    "@jest/globals": "^29.5.0",
+    "@yume-chan/eslint-config": "^1.0.0",
+    "@yume-chan/tsconfig": "^1.0.0",
     "cross-env": "^7.0.3",
-    "jest": "^28.1.2",
-    "ts-jest": "^28.0.5",
-    "typescript": "^4.7.4"
+    "eslint": "^8.36.0",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.4",
+    "typescript": "^4.9.4"
   },
   "scripts": {
     "build": "tsc -b tsconfig.build.json",
     "build:watch": "tsc -b tsconfig.build.json",
-    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage"
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage",
+    "lint": "eslint src/**/*.ts --fix && prettier src/**/*.ts --write --tab-width 4"
   }
 }

package/src/basic/definition.ts

@@ -1,7 +1,10 @@
-import type { StructAsyncDeserializeStream, StructDeserializeStream } from "./stream.js";
 import type { StructFieldValue } from "./field-value.js";
-import type { StructValue } from "./struct-value.js";
 import type { StructOptions } from "./options.js";
+import type {
+    StructAsyncDeserializeStream,
+    StructDeserializeStream,
+} from "./stream.js";
+import type { StructValue } from "./struct-value.js";
 
 /**
  * A field definition defines how to deserialize a field.
@@ -13,8 +16,8 @@ import type { StructOptions } from "./options.js";
 export abstract class StructFieldDefinition<
     TOptions = void,
     TValue = unknown,
-    TOmitInitKey extends PropertyKey = never,
-    > {
+    TOmitInitKey extends PropertyKey = never
+> {
     /**
      * When `T` is a type initiated `StructFieldDefinition`,
      * use `T['TValue']` to retrieve its `TValue` type parameter.
@@ -46,7 +49,7 @@ export abstract class StructFieldDefinition<
     public abstract create(
         options: Readonly<StructOptions>,
         structValue: StructValue,
-        value: TValue,
+        value: TValue
     ): StructFieldValue<this>;
 
     /**
@@ -58,11 +61,11 @@ export abstract class StructFieldDefinition<
     public abstract deserialize(
         options: Readonly<StructOptions>,
         stream: StructDeserializeStream,
-        structValue: StructValue,
+        structValue: StructValue
     ): StructFieldValue<this>;
     public abstract deserialize(
         options: Readonly<StructOptions>,
         stream: StructAsyncDeserializeStream,
-        struct: StructValue,
+        struct: StructValue
     ): Promise<StructFieldValue<this>>;
 }

package/src/basic/field-value.ts

@@ -9,8 +9,12 @@ import type { StructValue } from "./struct-value.js";
  * helpful for the serialization process.
  */
 export abstract class StructFieldValue<
-    TDefinition extends StructFieldDefinition<any, any, any> = StructFieldDefinition<any, any, any>
-    > {
+    TDefinition extends StructFieldDefinition<
+        any,
+        any,
+        any
+    > = StructFieldDefinition<any, any, any>
+> {
     /** Gets the definition associated with this runtime value */
     public readonly definition: TDefinition;
 
@@ -21,17 +25,19 @@ export abstract class StructFieldValue<
     public readonly struct: StructValue;
 
     public get hasCustomAccessors(): boolean {
-        return this.get !== StructFieldValue.prototype.get ||
-            this.set !== StructFieldValue.prototype.set;
+        return (
+            this.get !== StructFieldValue.prototype.get ||
+            this.set !== StructFieldValue.prototype.set
+        );
     }
 
-    protected value: TDefinition['TValue'];
+    protected value: TDefinition["TValue"];
 
     public constructor(
         definition: TDefinition,
         options: Readonly<StructOptions>,
         struct: StructValue,
-        value: TDefinition['TValue'],
+        value: TDefinition["TValue"]
     ) {
         this.definition = definition;
         this.options = options;
@@ -51,22 +57,19 @@ export abstract class StructFieldValue<
     /**
      * When implemented in derived classes, reads current field's value.
      */
-    public get(): TDefinition['TValue'] {
+    public get(): TDefinition["TValue"] {
         return this.value;
     }
 
     /**
      * When implemented in derived classes, updates current field's value.
      */
-    public set(value: TDefinition['TValue']): void {
+    public set(value: TDefinition["TValue"]): void {
         this.value = value;
     }
 
     /**
      * When implemented in derived classes, serializes this field into `dataView` at `offset`
      */
-    public abstract serialize(
-        dataView: DataView,
-        offset: number,
-    ): void;
+    public abstract serialize(dataView: DataView, offset: number): void;
 }

package/src/basic/index.ts

@@ -1,5 +1,5 @@
-export * from './definition.js';
-export * from './field-value.js';
-export * from './options.js';
-export * from './stream.js';
-export * from './struct-value.js';
+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/struct-value.ts

@@ -6,25 +6,27 @@ export const STRUCT_VALUE_SYMBOL = Symbol("struct-value");
  * A struct value is a map between keys in a struct and their field values.
  */
 export class StructValue {
-    /** @internal */ readonly fieldValues: Record<PropertyKey, StructFieldValue> = {};
+    /** @internal */ readonly fieldValues: Record<
+        PropertyKey,
+        StructFieldValue
+    > = {};
 
     /**
      * Gets the result struct value object
      */
     public readonly value: Record<PropertyKey, unknown>;
 
-    public constructor(prototype: any) {
+    public constructor(prototype: object) {
         // PERF: `Object.create(extra)` is 50% faster
         // than `Object.defineProperties(this.value, extra)`
-        this.value = Object.create(prototype);
+        this.value = Object.create(prototype) as Record<PropertyKey, unknown>;
 
         // PERF: `Object.defineProperty` is slow
         // but we need it to be non-enumerable
-        Object.defineProperty(
-            this.value,
-            STRUCT_VALUE_SYMBOL,
-            { enumerable: false, value: this }
-        );
+        Object.defineProperty(this.value, STRUCT_VALUE_SYMBOL, {
+            enumerable: false,
+            value: this,
+        });
     }
 
     /**
@@ -42,8 +44,12 @@ export class StructValue {
             Object.defineProperty(this.value, name, {
                 configurable: true,
                 enumerable: true,
-                get() { return fieldValue.get(); },
-                set(v) { fieldValue.set(v); },
+                get() {
+                    return fieldValue.get();
+                },
+                set(v) {
+                    fieldValue.set(v);
+                },
             });
         } else {
             this.value[name] = fieldValue.get();

package/src/index.ts

@@ -10,8 +10,8 @@ declare global {
     }
 }
 
-export * from './basic/index.js';
-export * from './struct.js';
-export { Struct as default } from './struct.js';
-export * from './types/index.js';
-export * from './utils.js';
+export * from "./basic/index.js";
+export * from "./struct.js";
+export { Struct as default } from "./struct.js";
+export * from "./types/index.js";
+export * from "./utils.js";