@arkadia/ai-data-format 1.0.0

package/dist/models/Schema.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = exports.SchemaKind = void 0;
+const Meta_1 = require("./Meta");
+var SchemaKind;
+(function (SchemaKind) {
+    SchemaKind["PRIMITIVE"] = "PRIMITIVE";
+    SchemaKind["RECORD"] = "RECORD";
+    SchemaKind["LIST"] = "LIST";
+    SchemaKind["DICT"] = "DICT";
+    SchemaKind["ANY"] = "ANY"; // Fallback
+})(SchemaKind || (exports.SchemaKind = SchemaKind = {}));
+class Schema extends Meta_1.Meta {
+    constructor(kind, props = {}) {
+        super(props);
+        // Internal fields storage
+        this._fieldsList = [];
+        this._fieldsMap = new Map();
+        this.kind = kind;
+        this.typeName = props.typeName || "any";
+        this.name = props.name || "";
+        this.element = props.element || null;
+        this.key = props.key || null;
+        this.value = props.value || null;
+        this.required = props.required || false;
+        if (props.fields) {
+            props.fields.forEach(f => this.addField(f));
+        }
+    }
+    // -----------------------------------------------------------
+    // Properties (Is...)
+    // -----------------------------------------------------------
+    get isPrimitive() { return this.kind === SchemaKind.PRIMITIVE; }
+    get isRecord() { return this.kind === SchemaKind.RECORD; }
+    get isList() { return this.kind === SchemaKind.LIST; }
+    get isAny() {
+        return (this.kind === SchemaKind.ANY ||
+            (this.typeName === "any" && this.kind === SchemaKind.PRIMITIVE) ||
+            (this.typeName === "any" && this.kind === SchemaKind.RECORD));
+    }
+    get fields() {
+        return this._fieldsList;
+    }
+    // -----------------------------------------------------------
+    // Field Management
+    // -----------------------------------------------------------
+    clearFields() {
+        this._fieldsList = [];
+        this._fieldsMap.clear();
+    }
+    addField(field) {
+        // Python logic: Auto-switch to RECORD if adding fields
+        if (this.kind !== SchemaKind.RECORD) {
+            this.kind = SchemaKind.RECORD;
+        }
+        // Auto-naming if missing
+        const fName = field.name || String(this._fieldsList.length);
+        field.name = fName;
+        this._fieldsList.push(field);
+        this._fieldsMap.set(fName, field);
+    }
+    /**
+     * Equivalent to Python's __getitem__.
+     * Allows access by numeric index or field name string.
+     */
+    getField(key) {
+        if (!this.isRecord) {
+            throw new Error(`Schema kind ${this.kind} is not subscriptable (not a RECORD).`);
+        }
+        if (typeof key === 'number') {
+            return this._fieldsList[key];
+        }
+        return this._fieldsMap.get(key);
+    }
+    /**
+     * Replaces an existing field with a new definition based on field.name.
+     * Preserves the original order in the fields list.
+     * If the field does not exist, it appends it (like addField).
+     */
+    replaceField(field) {
+        const fName = field.name;
+        if (!fName) {
+            throw new Error("Cannot replace a field without a name.");
+        }
+        if (this._fieldsMap.has(fName)) {
+            // 1. Retrieve the old object to find its index
+            const oldField = this._fieldsMap.get(fName);
+            const idx = this._fieldsList.indexOf(oldField);
+            if (idx !== -1) {
+                // 2. Replace in list (preserve order)
+                this._fieldsList[idx] = field;
+            }
+            else {
+                // Fallback safety (should not happen if map/list synced)
+                this._fieldsList.push(field);
+            }
+            // 3. Update map
+            this._fieldsMap.set(fName, field);
+        }
+        else {
+            // Field doesn't exist, treat as add
+            this.addField(field);
+        }
+    }
+    // -----------------------------------------------------------
+    // Meta Management
+    // -----------------------------------------------------------
+    clearMeta() {
+        this.clearCommonMeta();
+        this.required = false;
+    }
+    applyMeta(info) {
+        if (!info)
+            return;
+        // 1. Apply common stuff (meta dict, comments, tags)
+        this.applyCommonMeta(info);
+        // 2. Apply Schema-specific constraints
+        if (info.required) {
+            this.required = true;
+        }
+    }
+    // -----------------------------------------------------------
+    // Debug / Representation
+    // -----------------------------------------------------------
+    /**
+     * Technical debug representation.
+     * Format: <Schema(KIND:type_name) name='...' details...>
+     */
+    toString() {
+        // 1. Basic Info: Kind and TypeName
+        const kindStr = this.kind;
+        let typeLabel = "";
+        if (this.typeName && this.typeName !== "any" && this.typeName !== this.kind) {
+            typeLabel = `:${this.typeName}`;
+        }
+        const header = `<Schema(${kindStr}${typeLabel})`;
+        // 2. Field Name
+        const nameStr = this.name ? ` name="${this.name}"` : "";
+        // 3. Details
+        const details = [];
+        if (this.required)
+            details.push("!required");
+        const attrKeys = Object.keys(this.attr);
+        if (attrKeys.length > 0)
+            details.push(`attr=[${attrKeys.map(a => '"' + a + '"').join(', ')}]`);
+        if (this.tags.length > 0)
+            details.push(`tags=[${this.tags.join(', ')}]`);
+        if (this.comments.length > 0)
+            details.push(`comments=${this.comments.length}`);
+        // Structure: Record
+        if (this.isRecord) {
+            const count = this._fieldsList.length;
+            if (count > 0) {
+                const limit = 3;
+                const fieldNames = this._fieldsList.slice(0, limit).map(f => f.name);
+                if (count > limit)
+                    fieldNames.push("...");
+                details.push(`fields(${count})=[${fieldNames.join(', ')}]`);
+            }
+            else {
+                details.push("fields=[]");
+            }
+        }
+        // Structure: List
+        else if (this.isList) {
+            const elType = this.element ? (this.element.typeName || "None") : "None";
+            const elKind = this.element ? this.element.kind : "ANY";
+            details.push(`element=${elKind}:${elType}`);
+        }
+        const detailsStr = details.length > 0 ? " " + details.join(" ") : "";
+        return `${header}${nameStr}${detailsStr}>`;
+    }
+}
+exports.Schema = Schema;
+//# sourceMappingURL=Schema.js.map

package/dist/models/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/models/Schema.ts"],"names":[],"mappings":";;;AAAA,iCAAmD;AAEnD,IAAY,UAMX;AAND,WAAY,UAAU;IAClB,qCAAuB,CAAA;IACvB,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,yBAAW,CAAA,CAAc,WAAW;AACxC,CAAC,EANW,UAAU,0BAAV,UAAU,QAMrB;AAYD,MAAa,MAAO,SAAQ,WAAI;IAiB5B,YAAY,IAAgB,EAAE,QAAqB,EAAE;QACjD,KAAK,CAAC,KAAK,CAAC,CAAC;QALjB,0BAA0B;QAClB,gBAAW,GAAa,EAAE,CAAC;QAC3B,eAAU,GAAwB,IAAI,GAAG,EAAE,CAAC;QAKhD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAE7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC;QACrC,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;QAExC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;IACL,CAAC;IAED,8DAA8D;IAC9D,qBAAqB;IACrB,8DAA8D;IAE9D,IAAI,WAAW,KAAc,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IACzE,IAAI,QAAQ,KAAc,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,IAAI,MAAM,KAAc,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/D,IAAI,KAAK;QACL,OAAO,CACH,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,GAAG;YAC5B,CAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,SAAS,CAAC;YAC/D,CAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,CAAC,CAC/D,CAAC;IACN,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,8DAA8D;IAC9D,mBAAmB;IACnB,8DAA8D;IAE9D,WAAW;QACP,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,QAAQ,CAAC,KAAa;QAClB,uDAAuD;QACvD,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;YAClC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC;QAClC,CAAC;QAED,yBAAyB;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC;QAEnB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,GAAoB;QACzB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,CAAC,IAAI,uCAAuC,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,KAAa;QACtB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,+CAA+C;YAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;YAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAE/C,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;gBACb,sCAAsC;gBACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACJ,yDAAyD;gBACzD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC;YAED,gBAAgB;YAChB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACJ,oCAAoC;YACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,8DAA8D;IAC9D,kBAAkB;IAClB,8DAA8D;IAE9D,SAAS;QACL,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC1B,CAAC;IAED,SAAS,CAAC,IAAmC;QACzC,IAAG,CAAC,IAAI;YAAE,OAAO;QACjB,oDAAoD;QACpD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE3B,uCAAuC;QACvC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACzB,CAAC;IACL,CAAC;IAED,8DAA8D;IAC9D,yBAAyB;IACzB,8DAA8D;IAE9D;;;OAGG;IACH,QAAQ;QACJ,mCAAmC;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;QAE1B,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAC1E,SAAS,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,CAAC;QAED,MAAM,MAAM,GAAG,WAAW,OAAO,GAAG,SAAS,GAAG,CAAC;QAEjD,gBAAgB;QAChB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAExD,aAAa;QACb,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,IAAI,IAAI,CAAC,QAAQ;YAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE/F,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzE,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAE/E,oBAAoB;QACpB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;YACtC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACZ,MAAM,KAAK,GAAG,CAAC,CAAC;gBAChB,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBACrE,IAAI,KAAK,GAAG,KAAK;oBAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC1C,OAAO,CAAC,IAAI,CAAC,UAAU,KAAK,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChE,CAAC;iBAAM,CAAC;gBACJ,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;QACD,kBAAkB;aACb,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YACzE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC,WAAW,MAAM,IAAI,MAAM,EAAE,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAErE,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,CAAC;IAC/C,CAAC;CAGJ;AAzMD,wBAyMC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@arkadia/ai-data-format",
+  "version": "1.0.0",
+  "description": "Parser and Stringifier for Arkadia AI Data Format (AID)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc",
+    "verify": "node scripts/verify-build.js",
+    "watch": "tsc -w",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "ai",
+    "data",
+    "format",
+    "parser",
+    "schema",
+    "arkadia"
+  ],
+  "author": "Arkadia AI",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.19.31",
+    "rimraf": "^6.1.2",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  }
+}

package/src/config.ts

@@ -0,0 +1,102 @@
+/**
+ * Configuration options for the AI Data Format Encoder.
+ */
+export interface EncoderConfig {
+    /**
+     * Embed schema directly inside sample data (useful for LLM prompting).
+     * Example: [ (name: string /name of user/, age: int) ]
+     * Default: false
+     */
+    promptOutput: boolean;
+
+    /**
+     * Number of spaces used for indentation.
+     * Default: 2
+     */
+    indent: number;
+
+    /**
+     * Initial indentation offset (level).
+     * Default: 0
+     */
+    startIndent: number;
+
+    /**
+     * Enable compact formatting. Removes unnecessary spaces and newlines.
+     * Default: false
+     */
+    compact: boolean;
+
+    /**
+     * Escape newline characters in strings as literal \n and \r.
+     * Default: false
+     */
+    escapeNewLines: boolean;
+
+    /**
+     * purely removes new lines from strings.
+     * Default: false
+     */
+    removeNewLines: boolean;
+
+    /**
+     * Enable ANSI colorized output for terminal debugging.
+     * Default: false
+     */
+    colorize: boolean;
+
+    /**
+     * Include comments in the output ).
+     * Default: true
+     */
+    includeComments: boolean;
+
+    /**
+     * Include array size information (e.g. [ $size=5 : ... ]).
+     * Default: false
+     */
+    includeArraySize: boolean;
+
+    /**
+     * Include the schema definition header (e.g. <name: string>).
+     * Default: true
+     */
+    includeSchema: boolean;
+
+    /**
+     * Include metadata attributes and tags ($attr=1 #tag).
+     * Default: true
+     */
+    includeMeta: boolean;
+
+    /**
+     * Include type signature after field names (e.g. name: string vs name).
+     * Default: true
+     */
+    includeType: boolean;
+}
+
+/**
+ * Default configuration values.
+ */
+export const DEFAULT_CONFIG: EncoderConfig = {
+    indent: 2,
+    startIndent: 0,
+    compact: false,
+    escapeNewLines: false,
+    removeNewLines: false,
+    colorize: false,
+    includeComments: true,
+    includeArraySize: false,
+    includeSchema: true,
+    includeMeta: true,
+    includeType: true,
+    promptOutput: false,
+};
+
+/**
+ * Helper to merge partial user config with defaults.
+ */
+export function resolveConfig(config?: Partial<EncoderConfig>): EncoderConfig {
+    return { ...DEFAULT_CONFIG, ...config };
+}