@rotu/structview 0.7.3 → 0.9.0

package/esm/mod.js

@@ -2,376 +2,5 @@
  * Strongly typed classes for accessing binary data in a structured way
  * @module
  */
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _a;
-const dataViewSymbol = Symbol.for("Struct.dataview");
-/**
- * Get the underlying DataView of a struct
- * @param struct
- * @returns
- */
-export function structDataView(struct) {
-    const result = struct[dataViewSymbol];
-    if (!(result instanceof DataView)) {
-        throw new TypeError("not a struct");
-    }
-    return struct[dataViewSymbol];
-}
-/**
- * Helper method to create a view of a contiguous subregion of a Struct's memory
- * @param struct
- * @param start byte offset to start
- * @param end byte offset of the end of the subrange
- * @returns region of the given struct.
- */
-function structBytes(struct, start, end) {
-    const dv = structDataView(struct);
-    start ??= 0;
-    end ??= dv.byteLength;
-    console.assert(start <= end);
-    console.assert(end <= dv.byteLength);
-    return new Uint8Array(dv.buffer, dv.byteOffset + start, end - start);
-}
-/**
- * Define a descriptor based on a dataview of the struct
- * @param fieldGetter function which, given a dataview, returns
- * @returns
- */
-export function fromDataView(fieldGetter) {
-    return {
-        enumerable: true,
-        get() {
-            const dv = this[dataViewSymbol];
-            return fieldGetter(dv);
-        },
-    };
-}
-/**
- * Field for a 8-bit unsigned integer
- */
-export function u8(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getUint8(fieldOffset);
-        },
-        set(value) {
-            structDataView(this).setUint8(fieldOffset, value);
-        },
-    };
-}
-/**
- * Field for a little-endian 16-bit unsigned integer
- */
-export function u16(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getUint16(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setUint16(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 32-bit unsigned integer
- */
-export function u32(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getUint32(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setUint32(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 64-bit unsigned integer
- */
-export function u64(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getBigUint64(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setBigUint64(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 8-bit signed integer
- */
-export function i8(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getInt8(fieldOffset);
-        },
-        set(value) {
-            structDataView(this).setInt8(fieldOffset, value);
-        },
-    };
-}
-/**
- * Field for a little-endian 16-bit signed integer
- */
-export function i16(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getInt16(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setInt16(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 32-bit signed integer
- */
-export function i32(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getInt32(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setInt32(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 64-bit signed integer
- */
-export function i64(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getBigInt64(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setBigInt64(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 16-bit binary float (float16_t)
- */
-export function f16(fieldOffset) {
-    if (typeof DataView.prototype.getFloat16 !== "function" ||
-        typeof DataView.prototype.setFloat16 !== "function") {
-        throw new TypeError("float16 is not supported in this environment");
-    }
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getFloat16(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setFloat16(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 32-bit binary float (float32_t)
- */
-export function f32(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getFloat32(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setFloat32(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a little-endian 64-bit binary float (float64_t)
- */
-export function f64(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return structDataView(this).getFloat64(fieldOffset, true);
-        },
-        set(value) {
-            structDataView(this).setFloat64(fieldOffset, value, true);
-        },
-    };
-}
-/**
- * Field for a UTF-8 fixed-length string
- */
-export function string(fieldOffset, byteLength) {
-    const TEXT_DECODER = new TextDecoder();
-    const TEXT_ENCODER = new TextEncoder();
-    return {
-        enumerable: true,
-        get() {
-            const str = TEXT_DECODER.decode(structBytes(this, fieldOffset, fieldOffset + byteLength));
-            // trim all trailing null characters
-            return str.replace(/\0+$/, "");
-        },
-        set(value) {
-            const bytes = structBytes(this, fieldOffset, fieldOffset + byteLength);
-            bytes.fill(0);
-            TEXT_ENCODER.encodeInto(value, bytes);
-        },
-    };
-}
-/**
- * Field for a boolean stored in a byte (0 = false, nonzero = true)
- * True will be stored as 1
- */
-export function bool(fieldOffset) {
-    return {
-        enumerable: true,
-        get() {
-            return Boolean(structDataView(this).getUint8(fieldOffset));
-        },
-        set(value) {
-            structDataView(this).setUint8(fieldOffset, value ? 1 : 0);
-        },
-    };
-}
-/**
- * Field for an embedded struct
- * @param ctor constructor for the inner struct
- * @param byteOffset where the inner struct starts relative to the outer struct
- * @param bytelength the length in bytes of the inner struct
- * @returns property descriptor for a struct
- */
-export function substruct(ctor, byteOffset, bytelength) {
-    return fromDataView(function (dv) {
-        const offset2 = dv.byteOffset + (byteOffset ?? 0);
-        const bytelength2 = bytelength ?? (dv.byteLength - (byteOffset ?? 0));
-        return Reflect.construct(ctor, [{
-                buffer: dv.buffer,
-                byteOffset: offset2,
-                byteLength: bytelength2,
-            }]);
-    });
-}
-/**
- * Base class for a structured binary object
- * Note there are no predeclared string-keyed properties - all property names are reserved for user-defined fields
- */
-export class Struct {
-    get [(_a = dataViewSymbol, Symbol.toStringTag)]() {
-        return Struct.name;
-    }
-    static toDataView(o) {
-        return o[dataViewSymbol];
-    }
-    /**
-     * Create a new Struct
-     * @param arg options for creating the struct.
-     *  If options has a `.buffer` property, we will use that as the backing memory (e.g. any TypedArray or DataView).
-     *  If options has no `.buffer` property but has a `.byteLength`, we will allocate a new buffer for the object.
-     */
-    constructor(arg) {
-        Object.defineProperty(this, _a, {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        if (typeof arg !== "object" || arg === null) {
-            throw new TypeError("Expected argument to be an object");
-        }
-        Object.preventExtensions(this);
-        if (arg.buffer) {
-            this[dataViewSymbol] = new DataView(arg.buffer, arg.byteOffset, arg.byteLength);
-        }
-        else if (typeof arg.byteLength === "number") {
-            this[dataViewSymbol] = new DataView(new ArrayBuffer(arg.byteLength + (arg.byteOffset ?? 0)), arg.byteOffset, arg.byteLength);
-        }
-        else {
-            throw new TypeError("Must provide either {buffer} or {byteLength}");
-        }
-    }
-}
-/**
- * Subclass a type by adding the given property descriptors
- * @param ctor constructor for the base class
- * @param propertyDescriptors properties to add to subclass instances
- * @returns A new class, inheriting from the base class, with the new property descriptors added
- */
-function subclassWithProperties(ctor, propertyDescriptors) {
-    var _b;
-    return (_b = class extends ctor {
-        },
-        (() => {
-            Object.defineProperties(_b.prototype, propertyDescriptors);
-        })(),
-        _b);
-}
-/**
- * Subclass struct by adding the given property descriptors
- * @param propertyDescriptors properties to add to subclass instances
- * @returns A new class, inheriting from `Struct`, with the new property descriptors added
- */
-export function defineStruct(propertyDescriptors) {
-    return subclassWithProperties(Struct, propertyDescriptors);
-}
-/**
- * Create a new struct subclass for an array of structs
- * @param arrayOptions
- * @returns A new class, inheriting from `Struct` whose elements are statically typed structs
- */
-export function defineArray(arrayOptions) {
-    var _StructArray_struct, _StructArray_length, _StructArray_byteStride;
-    const { struct, byteStride, length } = arrayOptions;
-    class StructArray extends Struct {
-        constructor() {
-            super(...arguments);
-            _StructArray_struct.set(this, struct);
-            _StructArray_length.set(this, length);
-            _StructArray_byteStride.set(this, byteStride
-            /**
-             * Number of items in the array
-             */
-            );
-        }
-        /**
-         * Number of items in the array
-         */
-        get length() {
-            if (typeof __classPrivateFieldGet(this, _StructArray_length, "f") === "number") {
-                return __classPrivateFieldGet(this, _StructArray_length, "f");
-            }
-            return structDataView(this).byteLength / __classPrivateFieldGet(this, _StructArray_byteStride, "f");
-        }
-        /**
-         * A view of the item at the given index
-         * @param index
-         * @returns a new struct instance viewing the item at the given index
-         */
-        item(index) {
-            const ctor = __classPrivateFieldGet(this, _StructArray_struct, "f");
-            return new ctor(structBytes(this, __classPrivateFieldGet(this, _StructArray_byteStride, "f") * index, __classPrivateFieldGet(this, _StructArray_byteStride, "f") * (index + 1)));
-        }
-        /** @deprecated use item() instead */
-        element(index) {
-            return this.item(index);
-        }
-        /**
-         * Iterate over the items in the array
-         */
-        *[(_StructArray_struct = new WeakMap(), _StructArray_length = new WeakMap(), _StructArray_byteStride = new WeakMap(), Symbol.iterator)]() {
-            for (let i = 0; i < this.length; ++i) {
-                yield this.item(i);
-            }
-        }
-    }
-    return StructArray;
-}
+export * from "./core.js";
+export * from "./fields.js";

package/esm/types.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Helper types for this library
+ * @module
+ */
+import type { dataViewSymbol } from "./core.js";
+export type AnyStruct = {
+    readonly [dataViewSymbol]: DataView;
+};
+export type Constructor<T> = {
+    new (...args: any[]): T;
+};
+export type SubclassWithProperties<Ctor extends Constructor<object>, Mixin> = {
+    [K in keyof Ctor]: Ctor[K];
+} & {
+    new (...args: ConstructorParameters<Ctor>): InstanceType<Ctor> & {
+        [K in keyof Mixin]: Mixin[K];
+    };
+};
+export type TPropertyDescriptor<T> = {
+    enumerable?: boolean;
+    configurable?: boolean;
+    get?(): T;
+    set?(t: T): undefined;
+    value?: T;
+    writable?: boolean;
+};
+export type MixinFromProps<Props extends object> = {
+    -readonly [K in keyof Props]: Props[K] extends TPropertyDescriptor<infer V> ? V : unknown;
+};
+/**
+ * Type of a property descriptor for a struct
+ */
+export type StructPropertyDescriptor<T> = ThisType<AnyStruct> & TPropertyDescriptor<T>;
+export type StructConstructor<T extends object> = {
+    new (arg: {
+        readonly buffer: ArrayBufferLike;
+        readonly byteOffset: number;
+        readonly byteLength: number;
+    }): T;
+};
+//# sourceMappingURL=types.d.ts.map

package/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE/C,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;CAAE,CAAA;AAExD,MAAM,MAAM,sBAAsB,CAChC,IAAI,SAAS,WAAW,CAAC,MAAM,CAAC,EAChC,KAAK,IAEH;KAAG,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC;CAAE,GAC9B;IACA,KACE,GAAG,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,GACnC,YAAY,CAAC,IAAI,CAAC,GAAG;SAAG,CAAC,IAAI,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;KAAE,CAAA;CACzD,CAAA;AAEH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI;IACnC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,GAAG,CAAC,IAAI,CAAC,CAAA;IACT,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IACrB,KAAK,CAAC,EAAE,CAAC,CAAA;IACT,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,MAAM,IAAI;IACjD,CAAC,UAAU,CAAC,IAAI,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,mBAAmB,CAAC,MAAM,CAAC,CAAC,GACvE,CAAC,GACD,OAAO;CACZ,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAClC,QAAQ,CAAC,SAAS,CAAC,GACnB,mBAAmB,CAAC,CAAC,CAAC,CAAA;AAE1B,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,IAAI;IAChD,KAAK,GAAG,EAAE;QACR,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;QAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;QAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;KAC5B,GAAG,CAAC,CAAA;CACN,CAAA"}

package/esm/types.js

@@ -0,0 +1,5 @@
+/**
+ * Helper types for this library
+ * @module
+ */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rotu/structview",
-  "version": "0.7.3+dnt",
+  "version": "0.9.0+dnt",
   "description": "Read and write structured binary data with typesafe views",
   "repository": {
     "type": "git",
@@ -19,6 +19,7 @@
   "devDependencies": {
     "@types/node": "^20.9.0",
     "picocolors": "^1.0.0",
+    "uint8array-extras": "^1.5.0",
     "@deno/shim-deno": "~0.18.0"
   },
   "_generatedBy": "dnt@dev"

package/esm/bigendian.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bigendian.d.ts","sourceRoot":"","sources":["../src/bigendian.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAkB,KAAK,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAExE;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E;AACD;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E;AACD;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E;AACD;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E;AACD;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E;AACD;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAgB3E;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAU3E"}