@nnilky/structo 1.0.0 → 1.0.2

package/dist/structo/write.d.ts

@@ -0,0 +1,3 @@
+import type { WriterContext, Serializer } from "./types";
+export declare function write<T>(serializer: Serializer<T>, value: T): ArrayBuffer;
+export declare function createdWriterContext(type: Serializer<any>): WriterContext;

package/{structo/write.ts → dist/structo/write.js}

@@ -1,17 +1,14 @@
-import type { WriterContext, Serializer } from "./types";
-
-export function write<T>(serializer: Serializer<T>, value: T): ArrayBuffer {
+export function write(serializer, value) {
     const ctx = createdWriterContext(serializer);
     serializer.write(ctx, value);
-
     if (ctx.buffer.byteLength === ctx.offset) {
         return ctx.buffer;
-    } else {
+    }
+    else {
         return ctx.buffer.transfer(ctx.offset);
     }
 }
-
-export function createdWriterContext(type: Serializer<any>): WriterContext {
+export function createdWriterContext(type) {
     if (type.size) {
         let buffer = new ArrayBuffer(type.size);
         const view = new DataView(buffer);
@@ -19,9 +16,10 @@ export function createdWriterContext(type: Serializer<any>): WriterContext {
             offset: 0,
             buffer,
             view,
-            alloc: Function.prototype as () => void,
+            alloc: Function.prototype,
         };
-    } else {
+    }
+    else {
         let bufferLength = 64;
         let buffer = new ArrayBuffer(bufferLength);
         const view = new DataView(buffer);
@@ -30,8 +28,8 @@ export function createdWriterContext(type: Serializer<any>): WriterContext {
             buffer,
             view,
             alloc(length) {
-                if (length < 0) return;
-
+                if (length < 0)
+                    return;
                 while (this.offset + length >= bufferLength) {
                     bufferLength = this.buffer.byteLength * 2;
                     this.buffer = this.buffer.transfer(bufferLength);

package/package.json

@@ -1,23 +1,47 @@
 {
   "name": "@nnilky/structo",
   "description": "A library for serializing and deserializing binary content",
-  "keywords": ["library"],
+  "keywords": ["binary", "library", "utility", "web", "node"],
   "license": "ISC",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "author": "Ben Brady",
   "private": false,
-  "publishConfig": {
-    "access": "public"
+  "publishConfig": {"access": "public"},
+
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ben-Brady/structo-ts.git"
   },
 
   "readme": "README.md",
-  "main": "structo/index.ts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "import": "./structo/index.ts"
+    "./package.json": "./package.json",
+    ".": {
+      "default": "./dist/index.js",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./index.js": {
+      "default": "./dist/index.js",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
   },
-  "files": ["./structo", "package.json"],
+  "files": [
+    "LICENSE",
+    "README.md",
+    "./dist/**/*.d.ts",
+    "./dist/**/*.js.map",
+    "./dist/**/*.js"
+  ],
 
   "scripts": {
+    "build": "tsc",
+    "prepublish": "tsc",
     "check": "tsc --noEmit",
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/structo/datatypes/containers/__snapshots__/list.test.ts.snap

@@ -1,25 +0,0 @@
-// Bun Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`st.list matches snapshots 1`] = `
-ArrayBuffer [
-  3,
-  0,
-  0,
-  0,
-  3,
-  0,
-  102,
-  111,
-  111,
-  3,
-  0,
-  98,
-  97,
-  114,
-  3,
-  0,
-  98,
-  97,
-  122,
-]
-`;

package/structo/datatypes/containers/__snapshots__/object.test.ts.snap

@@ -1,37 +0,0 @@
-// Bun Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`st.object matches snapshots 1`] = `
-ArrayBuffer [
-  1,
-  0,
-  0,
-  0,
-  19,
-  0,
-  0,
-  0,
-  119,
-  111,
-  111,
-  102,
-  32,
-  119,
-  111,
-  111,
-  102,
-  32,
-  98,
-  97,
-  114,
-  107,
-  32,
-  98,
-  97,
-  114,
-  107,
-  19,
-  87,
-  19,
-  83,
-]
-`;

package/structo/datatypes/containers/array.test.ts

@@ -1,28 +0,0 @@
-//@ts-ignore TODO
-import { describe, it, expect } from "bun:test";
-import { expectEncode, expectError, randint } from "../utils.test";
-
-import * as st from "../../index";
-
-describe("st.array", () => {
-    it("encode correctly", () => {
-        const spec = st.array(4, st.u16());
-        expectEncode(spec, [1, 2, 3, 4]);
-    });
-
-    it("works on empty lists", () => {
-        const spec = st.array(0, st.u16());
-        expectEncode(spec, []);
-    });
-
-    it("throws error on invalid size", () => {
-        const spec = st.array(2, st.u16());
-        expectError(() => st.write(spec, [1]));
-    });
-
-    it("throws error on invalid value", () => {
-        const spec = st.array(2, st.u16());
-        expectError(() => st.write(spec, [1, -1]));
-        expectError(() => st.write(spec, [2 ** 16 + 1, 0]));
-    });
-});

package/structo/datatypes/containers/list.test.ts

@@ -1,44 +0,0 @@
-//@ts-ignore TODO
-import { describe, it, expect } from "bun:test";
-import { expectEncode, expectEncodeSnapshot, expectError, randint } from "../utils.test";
-
-import * as st from "../../index";
-
-describe("st.list", () => {
-    it("encode correctly", () => {
-        const spec = st.list({ type: st.u16(), length: st.u8() });
-        expectEncode(spec, [1, 2, 3, 4]);
-    });
-
-    it("works on empty lists", () => {
-        const spec = st.list({ type: st.u16(), length: st.u8() });
-        expectEncode(spec, []);
-    });
-
-    it("throws error on too large array", () => {
-        const spec = st.list({ type: st.u16(), length: st.u8() });
-        expectError(() => {
-            st.write(
-                spec,
-                Array.from({ length: 10000 }, () => 0),
-            );
-        });
-    });
-
-    it("throws error on invalid value", () => {
-        const spec = st.list({ type: st.u16(), length: st.u8() });
-        expectError(() => {
-            st.write(spec, [-1]);
-        });
-    });
-
-    it(`matches snapshots`, () => {
-        expectEncodeSnapshot(
-            st.list({
-                type: st.string(st.u16()),
-                length: st.s32(),
-            }),
-            ["foo", "bar", "baz"],
-        );
-    });
-});

package/structo/datatypes/containers/object.test.ts

@@ -1,42 +0,0 @@
-//@ts-ignore TODO
-import { describe, it, expect } from "bun:test";
-import { bytes, expectEncode, expectEncodeSnapshot } from "../utils.test";
-
-import * as st from "../../index";
-
-describe("st.object", () => {
-    const test = st.object({
-        a: st.u8(),
-        b: st.u8(),
-    });
-
-    it("encodes correctly", () => {
-        st.write(test, { b: 2, a: 1 });
-    });
-
-    it("encode in correct order", () => {
-        const data = st.write(test, { b: 2, a: 1 });
-        const arr = new Uint8Array(data);
-        expect(arr[0]).toBe(1);
-        expect(arr[1]).toBe(2);
-    });
-
-    it("encodes empty", () => {
-        expectEncode(st.object({}), {});
-    });
-
-    it(`matches snapshots`, () => {
-        expectEncodeSnapshot(
-            st.object({
-                number: st.u32(),
-                puppy: st.string(st.s32()),
-                buffer: st.buffer(4),
-            }),
-            {
-                number: 1,
-                puppy: "woof woof bark bark",
-                buffer: bytes([19, 87, 19, 83]),
-            },
-        );
-    });
-});

package/structo/datatypes/containers/object.ts

@@ -1,40 +0,0 @@
-import type { InferInput, InferOutput, Serializer } from "../../types";
-
-type InferObjectInfer<T> =
-    T extends Record<string, Serializer<any>> ? { [Key in keyof T]: InferInput<T[Key]> } : never;
-
-type InferObjectOutput<T> =
-    T extends Record<string, Serializer<any>> ? { [Key in keyof T]: InferOutput<T[Key]> } : never;
-
-export function object<T extends Record<string, Serializer<any>>>(
-    definition: T,
-): Serializer<InferObjectInfer<T>, InferObjectOutput<T>> {
-    const entires = Object.entries(definition);
-
-    // Use the fact: number + undefined = NaN
-    // Check for NaN afterwards
-    let computedSize = Object.values(definition).reduce(
-        (total, v) => total + (v.size as number),
-        0,
-    );
-    const size = isNaN(computedSize) ? undefined : computedSize;
-
-    return {
-        size,
-        write: (ctx, value) => {
-            if (size) ctx.alloc(size);
-
-            for (let i = 0; i < entires.length; i++) {
-                entires[i][1].write(ctx, value[entires[i][0]]);
-            }
-        },
-        read: (ctx) => {
-            const output: [string, unknown][] = new Array(entires.length);
-            for (let i = 0; i < entires.length; i++) {
-                output[i] = [entires[i][0], entires[i][1].read(ctx)];
-            }
-
-            return Object.fromEntries(output) as InferObject<T>;
-        },
-    };
-}

package/structo/datatypes/containers/sizedbuffer.test.ts

@@ -1,34 +0,0 @@
-//@ts-ignore TODO
-import { describe, it, expect } from "bun:test";
-import { bytes, expectEncode, expectError, randint } from "../utils.test";
-
-import * as st from "../../index";
-
-describe("st.buffer", () => {
-    it("encode correctly", () => {
-        const buffer = st.sizedBuffer(st.u8());
-        expectEncode(buffer, bytes([1, 2]));
-    });
-
-    it("encodes empty correctly", () => {
-        const spec = st.sizedBuffer(st.u8());
-        expectEncode(spec, bytes([]));
-    });
-
-    it("holds large data", () => {
-        const size = 1024 * 1024 * 8; // 8MB
-        const spec = st.sizedBuffer(st.u32());
-
-        const data = new Uint8Array(size);
-        data.set([3, 4], 1000);
-        data.set([3, 4], 2000);
-        expectEncode(spec, data.buffer);
-    });
-
-    it("errors on invalid length", () => {
-        const spec = st.sizedBuffer(st.u8());
-        expectError(() => {
-            st.write(spec, bytes(Array.from({ length: 256 }, () => 0)));
-        });
-    });
-});

package/structo/datatypes/numbers/__snapshots__/bigints.test.ts.snap

@@ -1,261 +0,0 @@
-// Bun Snapshot v1, https://bun.sh/docs/test/snapshots
-
-exports[`st.u64(little) matches snapshots 1`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.u64(little) matches snapshots 2`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.u64(little) matches snapshots 3`] = `
-ArrayBuffer [
-  10,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.u64(little) matches snapshots 4`] = `
-ArrayBuffer [
-  245,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-]
-`;
-
-exports[`st.u64(little) matches snapshots 5`] = `
-ArrayBuffer [
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-]
-`;
-
-exports[`st.u64(big) matches snapshots 1`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.u64(big) matches snapshots 2`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.u64(big) matches snapshots 3`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  10,
-]
-`;
-
-exports[`st.u64(big) matches snapshots 4`] = `
-ArrayBuffer [
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  245,
-]
-`;
-
-exports[`st.u64(big) matches snapshots 5`] = `
-ArrayBuffer [
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-]
-`;
-
-exports[`st.s64(little) matches snapshots 1`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.s64(little) matches snapshots 2`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  128,
-]
-`;
-
-exports[`st.s64(little) matches snapshots 3`] = `
-ArrayBuffer [
-  10,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  128,
-]
-`;
-
-exports[`st.s64(little) matches snapshots 4`] = `
-ArrayBuffer [
-  245,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  127,
-]
-`;
-
-exports[`st.s64(little) matches snapshots 5`] = `
-ArrayBuffer [
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  127,
-]
-`;
-
-exports[`st.s64(big) matches snapshots 1`] = `
-ArrayBuffer [
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.s64(big) matches snapshots 2`] = `
-ArrayBuffer [
-  128,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-]
-`;
-
-exports[`st.s64(big) matches snapshots 3`] = `
-ArrayBuffer [
-  128,
-  0,
-  0,
-  0,
-  0,
-  0,
-  0,
-  10,
-]
-`;
-
-exports[`st.s64(big) matches snapshots 4`] = `
-ArrayBuffer [
-  127,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  245,
-]
-`;
-
-exports[`st.s64(big) matches snapshots 5`] = `
-ArrayBuffer [
-  127,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-  255,
-]
-`;