@oyinlola141/lattice-serialization 0.1.0

package/dist/serializerTypes/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @oyinlola141/lattice-serialization — Type definitions.
+ *
+ * Core contracts for serializers, transformers, and serialization options.
+ */
+export type { SerializationFormat, SerializedValue, SerializeOptions, DeserializeOptions, SerializationMetadata, SerializedEnvelope, Serializer, AsyncSerializer, TypeTransformer, UndefinedStrategy, } from "./serializer.type.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/serializerTypes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/serializerTypes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACV,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EAClB,UAAU,EACV,eAAe,EACf,eAAe,EACf,iBAAiB,GAClB,MAAM,sBAAsB,CAAC"}

package/dist/serializerTypes/index.js

@@ -0,0 +1,7 @@
+/**
+ * @latticejs/serialization — Type definitions.
+ *
+ * Core contracts for serializers, transformers, and serialization options.
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/dist/serializerTypes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/serializerTypes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/serializerTypes/serializer.type.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @oyinlola141/lattice-serialization — Core type definitions.
+ *
+ * Defines the contracts that all serialization implementations
+ * must satisfy. These types are serialization-specific and are
+ * NOT available in @oyinlola141/lattice-types or @oyinlola141/lattice-constants.
+ */
+/** Supported serialization format identifiers. */
+export type SerializationFormat = "json" | "text" | "binary" | "messagepack" | string;
+/** The output of a serialization operation. */
+export type SerializedValue = string | Uint8Array;
+/** Options for serialization operations. */
+export interface SerializeOptions {
+    /** Pretty-print the output (JSON only). */
+    readonly pretty?: boolean;
+    /** Preserve special JS types (Date, BigInt, Map, Set, etc.). */
+    readonly preserveTypes?: boolean;
+    /** Maximum object depth before throwing. */
+    readonly maxDepth?: number;
+    /** Maximum serialized size in bytes. */
+    readonly maxSize?: number;
+    /** Indentation for pretty-print (default: 2). */
+    readonly indent?: number;
+}
+/** Options for deserialization operations. */
+export interface DeserializeOptions {
+    /** Restore special JS types from tagged representations. */
+    readonly preserveTypes?: boolean;
+    /** Maximum object depth before throwing. */
+    readonly maxDepth?: number;
+    /** Throw on malformed or unexpected data. */
+    readonly strict?: boolean;
+    /** Allow prototype-polluting keys during reconstruction. */
+    readonly allowUnsafeKeys?: boolean;
+}
+/** Metadata attached to serialized output. */
+export interface SerializationMetadata {
+    /** The format used (e.g., "json"). */
+    readonly format: string;
+    /** Schema version for forward/backward compatibility. */
+    readonly version?: number;
+    /** MIME content type (e.g., "application/json"). */
+    readonly contentType?: string;
+    /** Character encoding (e.g., "utf-8"). */
+    readonly encoding?: string;
+}
+/** An envelope wrapping serialized data with metadata. */
+export interface SerializedEnvelope {
+    readonly metadata: SerializationMetadata;
+    readonly data: SerializedValue;
+}
+/** Synchronous serializer contract. */
+export interface Serializer<TValue = unknown, TSerialized = SerializedValue> {
+    /** Canonical name for registry lookup (e.g., "json"). */
+    readonly name: string;
+    /** The MIME content type produced by this serializer. */
+    readonly contentType: string;
+    /** Serialize a value into the target format. */
+    serialize(value: TValue, options?: SerializeOptions): TSerialized;
+    /** Deserialize a value from the target format. */
+    deserialize<T = TValue>(value: TSerialized, options?: DeserializeOptions): T;
+}
+/** Asynchronous serializer contract (for streaming / large payloads). */
+export interface AsyncSerializer<TValue = unknown, TSerialized = SerializedValue> {
+    readonly name: string;
+    readonly contentType: string;
+    serialize(value: TValue, options?: SerializeOptions): Promise<TSerialized>;
+    deserialize<T = TValue>(value: TSerialized, options?: DeserializeOptions): Promise<T>;
+}
+/** Transforms a specific JS type during serialization. */
+export interface TypeTransformer<TValue = unknown> {
+    /** Tag name used in tagged representations (e.g., "Date"). */
+    readonly type: string;
+    /** Returns true when this transformer handles the given value. */
+    canSerialize(value: unknown): value is TValue;
+    /** Convert the value into a JSON-safe representation. */
+    serialize(value: TValue): unknown;
+    /** Reconstruct the original value from the serialized form. */
+    deserialize(value: unknown): TValue;
+}
+/** Strategy for handling `undefined` values. */
+export type UndefinedStrategy = "omit" | "null" | "preserve";
+//# sourceMappingURL=serializer.type.d.ts.map

package/dist/serializerTypes/serializer.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializer.type.d.ts","sourceRoot":"","sources":["../../src/serializerTypes/serializer.type.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,kDAAkD;AAClD,MAAM,MAAM,mBAAmB,GAC3B,MAAM,GACN,MAAM,GACN,QAAQ,GACR,aAAa,GACb,MAAM,CAAC;AAEX,+CAA+C;AAC/C,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAElD,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,2CAA2C;IAC3C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,gEAAgE;IAChE,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,iDAAiD;IACjD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,8CAA8C;AAC9C,MAAM,WAAW,kBAAkB;IACjC,4DAA4D;IAC5D,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,4DAA4D;IAC5D,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,8CAA8C;AAC9C,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,yDAAyD;IACzD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,oDAAoD;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,0DAA0D;AAC1D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAC;IACzC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;CAChC;AAED,uCAAuC;AACvC,MAAM,WAAW,UAAU,CACzB,MAAM,GAAG,OAAO,EAChB,WAAW,GAAG,eAAe;IAE7B,yDAAyD;IACzD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,gDAAgD;IAChD,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,WAAW,CAAC;IAClE,kDAAkD;IAClD,WAAW,CAAC,CAAC,GAAG,MAAM,EACpB,KAAK,EAAE,WAAW,EAClB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,CAAC,CAAC;CACN;AAED,yEAAyE;AACzE,MAAM,WAAW,eAAe,CAC9B,MAAM,GAAG,OAAO,EAChB,WAAW,GAAG,eAAe;IAE7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,SAAS,CACP,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,WAAW,CAAC,CAAC;IACxB,WAAW,CAAC,CAAC,GAAG,MAAM,EACpB,KAAK,EAAE,WAAW,EAClB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,CAAC,CAAC,CAAC;CACf;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAe,CAAC,MAAM,GAAG,OAAO;IAC/C,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kEAAkE;IAClE,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC;IAC9C,yDAAyD;IACzD,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IAClC,+DAA+D;IAC/D,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;CACrC;AAED,gDAAgD;AAChD,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC"}

package/dist/serializerTypes/serializer.type.js

@@ -0,0 +1,9 @@
+/**
+ * @latticejs/serialization — Core type definitions.
+ *
+ * Defines the contracts that all serialization implementations
+ * must satisfy. These types are serialization-specific and are
+ * NOT available in @latticejs/types or @latticejs/constants.
+ */
+export {};
+//# sourceMappingURL=serializer.type.js.map

package/dist/serializerTypes/serializer.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializer.type.js","sourceRoot":"","sources":["../../src/serializerTypes/serializer.type.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@oyinlola141/lattice-serialization",
+  "version": "0.1.0",
+  "description": "Serialization framework for Lattice — multiple format support, type preservation, and streaming",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@oyinlola141/lattice-constants": "workspace:*",
+    "@oyinlola141/lattice-errors": "workspace:*",
+    "@oyinlola141/lattice-types": "workspace:*",
+    "@oyinlola141/lattice-validation": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0",
+    "vitest": "^4.1.11"
+  },
+  "license": "MIT",
+  "keywords": [
+    "lattice",
+    "serialization",
+    "json",
+    "binary",
+    "messagepack",
+    "type-preservation"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  }
+}