densing 0.1.0

package/dist/schema/builder.d.ts

@@ -0,0 +1,13 @@
+import { BoolField, IntField, EnumField, FixedPointField, DenseField, ArrayField, UnionField, EnumArrayField, OptionalField, ObjectField } from '../schema-type';
+export declare const bool: (name: string, defaultValue?: boolean) => BoolField;
+export declare const int: (name: string, min: number, max: number, defaultValue?: number) => IntField;
+export declare const enumeration: (name: string, options: readonly string[], defaultValue?: string) => EnumField;
+export declare const fixed: (name: string, min: number, max: number, precision: number, defaultValue?: number) => FixedPointField;
+export declare const array: (name: string, minLength: number, maxLength: number, items: DenseField) => ArrayField;
+export declare const union: (name: string, discriminator: EnumField, variants: Record<string, DenseField[]>) => UnionField;
+export declare const enumArray: (name: string, enumDef: EnumField, minLength: number, maxLength: number, defaultValue?: string[]) => EnumArrayField;
+export declare const optional: (name: string, field: DenseField, defaultValue?: any) => OptionalField;
+export declare const object: (name: string, ...fields: DenseField[]) => ObjectField;
+export declare const schema: <const T extends DenseField[]>(...fields: T) => {
+    readonly fields: T;
+};

package/dist/schema/default-data.d.ts

@@ -0,0 +1,7 @@
+import { DenseSchema } from '../schema-type';
+/**
+ * Helper method to get the default state as defined by a schema
+ * @param schema - `Schema` definition
+ * @returns `Object` - A javascript object with the default state described in the schema
+ */
+export declare const getDefaultData: (schema: DenseSchema) => any;

package/dist/schema/index.d.ts

@@ -0,0 +1,5 @@
+export * from './builder';
+export * from './default-data';
+export * from './recursive-builder-helper';
+export * from './type-generator';
+export * from './validation';

package/dist/schema/recursive-builder-helper.d.ts

@@ -0,0 +1,6 @@
+import { DenseField } from '../schema-type';
+/**
+ * Helper function to create a recursive union field with a specified max depth.
+ * This allows you to define the structure ONCE and it gets expanded automatically.
+ */
+export declare const createRecursiveUnion: (name: string, discriminatorOptions: readonly string[], createVariants: (recurse: (fieldName: string, depth?: number) => DenseField) => Record<string, DenseField[]>, maxDepth: number, currentDepth?: number) => DenseField;

package/dist/schema/type-generator.d.ts

@@ -0,0 +1,13 @@
+import { DenseSchema } from '../schema-type';
+/**
+ * Generate TypeScript type definitions from a schema
+ */
+export declare const generateTypes: (schema: DenseSchema, rootTypeName?: string) => string;
+/**
+ * Generate types and write to a .d.ts file
+ */
+export declare const generateTypesFile: (schema: DenseSchema, outputPath: string, rootTypeName?: string) => void;
+/**
+ * Generate types and write to console (for convenience)
+ */
+export declare const printTypes: (schema: DenseSchema, rootTypeName?: string) => void;

package/dist/schema/validation.d.ts

@@ -0,0 +1,10 @@
+import { DenseSchema } from '../schema-type';
+export interface ValidationError {
+    path: string;
+    message: string;
+}
+export interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+}
+export declare const validate: (schema: DenseSchema, data: any) => ValidationResult;

package/dist/schema-type.d.ts

@@ -0,0 +1,63 @@
+export type DenseField = BoolField | IntField | EnumField | FixedPointField | ArrayField | EnumArrayField | UnionField | OptionalField | ObjectField;
+export interface BoolField {
+    type: 'bool';
+    name: string;
+    defaultValue: boolean;
+}
+export interface IntField {
+    type: 'int';
+    name: string;
+    min: number;
+    max: number;
+    defaultValue: number;
+}
+export interface EnumField {
+    type: 'enum';
+    name: string;
+    options: readonly string[];
+    defaultValue: string;
+}
+export interface FixedPointField {
+    type: 'fixed';
+    name: string;
+    min: number;
+    max: number;
+    precision: number;
+    defaultValue: number;
+}
+export interface ArrayField {
+    type: 'array';
+    name: string;
+    items: DenseField;
+    minLength: number;
+    maxLength: number;
+}
+export interface UnionField {
+    type: 'union';
+    name: string;
+    discriminator: EnumField;
+    variants: Record<string, DenseField[]>;
+}
+export interface EnumArrayField {
+    type: 'enum_array';
+    name: string;
+    enum: EnumField;
+    minLength: number;
+    maxLength: number;
+    defaultValue: string[];
+}
+export interface OptionalField {
+    type: 'optional';
+    name: string;
+    field: DenseField;
+    defaultValue?: any;
+}
+export interface ObjectField {
+    type: 'object';
+    name: string;
+    fields: DenseField[];
+}
+export interface DenseSchema {
+    fields: DenseField[];
+}
+export type ConstantBitWidthField = BoolField | IntField | EnumField | FixedPointField;

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "densing",
+  "version": "0.1.0",
+  "description": "Bit and base level packing for TypeScript. Perfect for URLs, QR codes, and other storage constrained contexts.",
+  "author": "Jonas Ward",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/JonasWard/densing.git"
+  },
+  "keywords": [
+    "serialization",
+    "compression",
+    "encoding",
+    "base64",
+    "bit-packing",
+    "schema",
+    "typescript",
+    "url-encoding",
+    "qr-code",
+    "data-compression"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "bun build --target=node ./src/index.ts --outfile=dist/index.js && bun run build:declaration",
+    "build:declaration": "tsc --emitDeclarationOnly --isolatedDeclarations --project tsconfig.types.json",
+    "postbuild": "rimraf tsconfig.types.tsbuildinfo",
+    "benchmark": "bun run benchmark.ts",
+    "test": "bun test",
+    "prepublishOnly": "bun test && bun run build"
+  },
+  "devDependencies": {
+    "bun-types": "latest",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.9.3",
+    "@types/bun": "latest"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}