@danceroutine/tango-orm 0.1.0 → 1.0.0

package/dist/transaction/UnitOfWork.d.ts

@@ -21,11 +21,29 @@ export declare class UnitOfWork {
     readonly __tangoBrand: typeof UnitOfWork.BRAND;
     protected client: DBClient;
     protected isActive: boolean;
-    static isUnitOfWork(value: unknown): value is UnitOfWork;
     constructor(client: DBClient);
+    /**
+     * Narrow an unknown value to `UnitOfWork`.
+     */
+    static isUnitOfWork(value: unknown): value is UnitOfWork;
+    /**
+     * Convenience factory that constructs and begins a unit of work.
+     */
+    static start(client: DBClient): Promise<UnitOfWork>;
+    /**
+     * Begin a transaction if one is not already active.
+     */
     begin(): Promise<void>;
+    /**
+     * Commit the active transaction.
+     */
     commit(): Promise<void>;
-    rollback(): Promise<void>;
+    /**
+     * Return the underlying database client.
+     */
     getClient(): DBClient;
-    static start(client: DBClient): Promise<UnitOfWork>;
+    /**
+     * Roll back the active transaction.
+     */
+    rollback(): Promise<void>;
 }

package/dist/transaction/index.js

@@ -1,3 +1,3 @@
-import { UnitOfWork } from "../transaction-DIGJnp19.js";
+import { UnitOfWork } from "../transaction-DooTMuAl.js";
 
 export { UnitOfWork };

package/dist/{transaction-DIGJnp19.js → transaction-DooTMuAl.js}

@@ -6,38 +6,56 @@ var UnitOfWork = class UnitOfWork {
 	__tangoBrand = UnitOfWork.BRAND;
 	client;
 	isActive = false;
+	constructor(client) {
+		this.client = client;
+	}
+	/**
+	* Narrow an unknown value to `UnitOfWork`.
+	*/
 	static isUnitOfWork(value) {
 		return typeof value === "object" && value !== null && value.__tangoBrand === UnitOfWork.BRAND;
 	}
-	constructor(client) {
-		this.client = client;
+	/**
+	* Convenience factory that constructs and begins a unit of work.
+	*/
+	static async start(client) {
+		const uow = new UnitOfWork(client);
+		await uow.begin();
+		return uow;
 	}
+	/**
+	* Begin a transaction if one is not already active.
+	*/
 	async begin() {
 		if (!this.isActive) {
 			await this.client.begin();
 			this.isActive = true;
 		}
 	}
+	/**
+	* Commit the active transaction.
+	*/
 	async commit() {
 		if (this.isActive) {
 			await this.client.commit();
 			this.isActive = false;
 		}
 	}
+	/**
+	* Return the underlying database client.
+	*/
+	getClient() {
+		return this.client;
+	}
+	/**
+	* Roll back the active transaction.
+	*/
 	async rollback() {
 		if (this.isActive) {
 			await this.client.rollback();
 			this.isActive = false;
 		}
 	}
-	getClient() {
-		return this.client;
-	}
-	static async start(client) {
-		const uow = new UnitOfWork(client);
-		await uow.begin();
-		return uow;
-	}
 };
 
 //#endregion
@@ -47,4 +65,4 @@ __export(transaction_exports, { UnitOfWork: () => UnitOfWork });
 
 //#endregion
 export { UnitOfWork, transaction_exports };
-//# sourceMappingURL=transaction-DIGJnp19.js.map
+//# sourceMappingURL=transaction-DooTMuAl.js.map

package/dist/transaction-DooTMuAl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-DooTMuAl.js","names":["client: DBClient","value: unknown"],"sources":["../src/transaction/UnitOfWork.ts","../src/transaction/index.ts"],"sourcesContent":["import type { DBClient } from '../connection/clients/DBClient';\n\n/**\n * Unit of Work pattern implementation for managing database transactions.\n * Ensures that a set of operations either all succeed or all fail together.\n *\n * @example\n * ```typescript\n * const uow = await UnitOfWork.start(dbClient);\n * try {\n *   await userRepo.create({ email: 'test@example.com' });\n *   await postRepo.create({ title: 'Hello' });\n *   await uow.commit();\n * } catch (error) {\n *   await uow.rollback();\n *   throw error;\n * }\n * ```\n */\nexport class UnitOfWork {\n    static readonly BRAND = 'tango.orm.unit_of_work' as const;\n    readonly __tangoBrand: typeof UnitOfWork.BRAND = UnitOfWork.BRAND;\n    protected client: DBClient;\n    protected isActive = false;\n\n    constructor(client: DBClient) {\n        this.client = client;\n    }\n\n    /**\n     * Narrow an unknown value to `UnitOfWork`.\n     */\n    static isUnitOfWork(value: unknown): value is UnitOfWork {\n        return (\n            typeof value === 'object' &&\n            value !== null &&\n            (value as { __tangoBrand?: unknown }).__tangoBrand === UnitOfWork.BRAND\n        );\n    }\n\n    /**\n     * Convenience factory that constructs and begins a unit of work.\n     */\n    static async start(client: DBClient): Promise<UnitOfWork> {\n        const uow = new UnitOfWork(client);\n        await uow.begin();\n        return uow;\n    }\n\n    /**\n     * Begin a transaction if one is not already active.\n     */\n    async begin(): Promise<void> {\n        if (!this.isActive) {\n            await this.client.begin();\n            this.isActive = true;\n        }\n    }\n\n    /**\n     * Commit the active transaction.\n     */\n    async commit(): Promise<void> {\n        if (this.isActive) {\n            await this.client.commit();\n            this.isActive = false;\n        }\n    }\n\n    /**\n     * Return the underlying database client.\n     */\n    getClient(): DBClient {\n        return this.client;\n    }\n\n    /**\n     * Roll back the active transaction.\n     */\n    async rollback(): Promise<void> {\n        if (this.isActive) {\n            await this.client.rollback();\n            this.isActive = false;\n        }\n    }\n}\n","/**\n * Domain boundary barrel: centralizes this subdomain's public contract.\n */\n\nexport { UnitOfWork } from './UnitOfWork';\n"],"mappings":";;;IAmBa,aAAN,MAAM,WAAW;CACpB,OAAgB,QAAQ;CACxB,eAAiD,WAAW;CAC5D;CACA,WAAqB;CAErB,YAAYA,QAAkB;AAC1B,OAAK,SAAS;CACjB;;;;CAKD,OAAO,aAAaC,OAAqC;AACrD,gBACW,UAAU,YACjB,UAAU,QACT,MAAqC,iBAAiB,WAAW;CAEzE;;;;CAKD,aAAa,MAAMD,QAAuC;EACtD,MAAM,MAAM,IAAI,WAAW;AAC3B,QAAM,IAAI,OAAO;AACjB,SAAO;CACV;;;;CAKD,MAAM,QAAuB;AACzB,OAAK,KAAK,UAAU;AAChB,SAAM,KAAK,OAAO,OAAO;AACzB,QAAK,WAAW;EACnB;CACJ;;;;CAKD,MAAM,SAAwB;AAC1B,MAAI,KAAK,UAAU;AACf,SAAM,KAAK,OAAO,QAAQ;AAC1B,QAAK,WAAW;EACnB;CACJ;;;;CAKD,YAAsB;AAClB,SAAO,KAAK;CACf;;;;CAKD,MAAM,WAA0B;AAC5B,MAAI,KAAK,UAAU;AACf,SAAM,KAAK,OAAO,UAAU;AAC5B,QAAK,WAAW;EACnB;CACJ;AACJ"}

package/dist/validation/OrmSqlSafetyAdapter.d.ts

@@ -0,0 +1,22 @@
+import { SqlSafetyEngine } from '@danceroutine/tango-core';
+import type { SQLValidationEngine, ValidatedDeleteSqlPlan, ValidatedInsertSqlPlan, ValidatedSelectSqlPlan, ValidatedUpdateSqlPlan } from './SQLValidationEngine';
+import type { DeleteSqlValidationPlan, InsertSqlValidationPlan, SelectSqlValidationPlan, UpdateSqlValidationPlan } from './SqlValidationPlan';
+/**
+ * ORM-local adapter that translates query validation plans into the
+ * shared Tango SQL safety engine.
+ */
+export declare class OrmSqlSafetyAdapter implements SQLValidationEngine {
+    private readonly engine;
+    static readonly BRAND: "tango.orm.orm_sql_safety_adapter";
+    readonly __tangoBrand: typeof OrmSqlSafetyAdapter.BRAND;
+    constructor(engine?: SqlSafetyEngine);
+    validate(plan: SelectSqlValidationPlan): ValidatedSelectSqlPlan;
+    validate(plan: InsertSqlValidationPlan): ValidatedInsertSqlPlan;
+    validate(plan: UpdateSqlValidationPlan): ValidatedUpdateSqlPlan;
+    validate(plan: DeleteSqlValidationPlan): ValidatedDeleteSqlPlan;
+    private validateTableMeta;
+    private validateRelationMeta;
+    private validateFilterKey;
+    private resolveColumn;
+    private resolveRelation;
+}

package/dist/validation/SQLValidationEngine.d.ts

@@ -0,0 +1,51 @@
+import type { RelationMeta, LookupType } from '../query';
+import type { DeleteSqlValidationPlan, InsertSqlValidationPlan, SelectSqlValidationPlan, SqlValidationPlan, UpdateSqlValidationPlan } from './SqlValidationPlan';
+export type ValidatedRelationMeta = RelationMeta & {
+    table: string;
+    targetPk: string;
+    alias: string;
+    localKey?: string;
+    foreignKey?: string;
+};
+export type ValidatedTableMeta = {
+    table: string;
+    pk: string;
+    columns: Record<string, string>;
+    relations?: Record<string, ValidatedRelationMeta>;
+};
+export type ValidatedFilterDescriptor = {
+    rawKey: string;
+    field: string;
+    lookup: LookupType;
+    qualifiedColumn: string;
+};
+export type ValidatedSelectSqlPlan = {
+    kind: 'select';
+    meta: ValidatedTableMeta;
+    selectFields: Record<string, string>;
+    filterKeys: Record<string, ValidatedFilterDescriptor>;
+    orderFields: Record<string, string>;
+    relations: Record<string, ValidatedRelationMeta>;
+};
+export type ValidatedInsertSqlPlan = {
+    kind: 'insert';
+    meta: ValidatedTableMeta;
+    writeKeys: string[];
+};
+export type ValidatedUpdateSqlPlan = {
+    kind: 'update';
+    meta: ValidatedTableMeta;
+    writeKeys: string[];
+};
+export type ValidatedDeleteSqlPlan = {
+    kind: 'delete';
+    meta: ValidatedTableMeta;
+};
+export type ValidatedSqlPlan = ValidatedSelectSqlPlan | ValidatedInsertSqlPlan | ValidatedUpdateSqlPlan | ValidatedDeleteSqlPlan;
+export interface SQLValidationEngine {
+    validate(plan: SelectSqlValidationPlan): ValidatedSelectSqlPlan;
+    validate(plan: InsertSqlValidationPlan): ValidatedInsertSqlPlan;
+    validate(plan: UpdateSqlValidationPlan): ValidatedUpdateSqlPlan;
+    validate(plan: DeleteSqlValidationPlan): ValidatedDeleteSqlPlan;
+    validate(plan: SqlValidationPlan): ValidatedSqlPlan;
+}

package/dist/validation/SqlValidationPlan.d.ts

@@ -0,0 +1,42 @@
+import type { TableMeta } from '../query/domain/TableMeta';
+/**
+ * Validation request for read/query compilation.
+ *
+ * The ORM uses this plan to validate selected fields, filter keys, ordering,
+ * and relation names before SQL is assembled.
+ */
+export type SelectSqlValidationPlan = {
+    kind: 'select';
+    meta: TableMeta;
+    selectFields?: readonly string[];
+    filterKeys?: readonly string[];
+    orderFields?: readonly string[];
+    relationNames?: readonly string[];
+};
+/**
+ * Validation request for insert statements.
+ */
+export type InsertSqlValidationPlan = {
+    kind: 'insert';
+    meta: TableMeta;
+    writeKeys: readonly string[];
+};
+/**
+ * Validation request for update statements.
+ */
+export type UpdateSqlValidationPlan = {
+    kind: 'update';
+    meta: TableMeta;
+    writeKeys: readonly string[];
+};
+/**
+ * Validation request for delete statements.
+ */
+export type DeleteSqlValidationPlan = {
+    kind: 'delete';
+    meta: TableMeta;
+};
+/**
+ * ORM-local SQL validation requests routed through `OrmSqlSafetyAdapter`.
+ */
+export type SqlValidationPlan = SelectSqlValidationPlan | InsertSqlValidationPlan | UpdateSqlValidationPlan | DeleteSqlValidationPlan;

package/dist/validation/index.d.ts

@@ -0,0 +1,3 @@
+export * from './OrmSqlSafetyAdapter';
+export type * from './SQLValidationEngine';
+export type { DeleteSqlValidationPlan, InsertSqlValidationPlan, SelectSqlValidationPlan, SqlValidationPlan, UpdateSqlValidationPlan, } from './SqlValidationPlan';

package/package.json

@@ -1,82 +1,89 @@
 {
-    "name": "@danceroutine/tango-orm",
-    "version": "0.1.0",
-    "description": "QuerySet, Repository, UnitOfWork, and database adapters for Tango",
-    "type": "module",
-    "main": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js"
-        },
-        "./query": {
-            "types": "./dist/query/index.d.ts",
-            "import": "./dist/query/index.js"
-        },
-        "./connection": {
-            "types": "./dist/connection/index.d.ts",
-            "import": "./dist/connection/index.js"
-        },
-        "./transaction": {
-            "types": "./dist/transaction/index.d.ts",
-            "import": "./dist/transaction/index.js"
-        },
-        "./repository": {
-            "types": "./dist/repository/index.d.ts",
-            "import": "./dist/repository/index.js"
-        }
+  "name": "@danceroutine/tango-orm",
+  "version": "1.0.0",
+  "description": "Model-first querying, runtime-managed database access, and transactions for Tango",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     },
-    "files": [
-        "dist"
-    ],
-    "scripts": {
-        "build": "tsdown",
-        "test": "vitest run --coverage",
-        "test:integration": "vitest run src/tests/integration",
-        "test:watch": "vitest",
-        "typecheck": "tsc --noEmit"
+    "./query": {
+      "types": "./dist/query/index.d.ts",
+      "import": "./dist/query/index.js"
     },
-    "keywords": [
-        "tango",
-        "orm",
-        "queryset",
-        "repository",
-        "database"
-    ],
-    "author": "Pedro Del Moral Lopez",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/danceroutine/tango.git",
-        "directory": "packages/orm"
+    "./connection": {
+      "types": "./dist/connection/index.d.ts",
+      "import": "./dist/connection/index.js"
     },
-    "dependencies": {
-        "@danceroutine/tango-config": "workspace:*",
-        "@danceroutine/tango-core": "workspace:*"
+    "./transaction": {
+      "types": "./dist/transaction/index.d.ts",
+      "import": "./dist/transaction/index.js"
     },
-    "peerDependencies": {
-        "pg": "^8.13.1",
-        "better-sqlite3": "^11.7.0"
+    "./runtime": {
+      "types": "./dist/runtime/index.d.ts",
+      "import": "./dist/runtime/index.js"
     },
-    "peerDependenciesMeta": {
-        "pg": {
-            "optional": true
-        },
-        "better-sqlite3": {
-            "optional": true
-        }
+    "./manager": {
+      "types": "./dist/manager/index.d.ts",
+      "import": "./dist/manager/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "tango",
+    "orm",
+    "queryset",
+    "database"
+  ],
+  "author": "Pedro Del Moral Lopez",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/danceroutine/tango.git",
+    "directory": "packages/orm"
+  },
+  "dependencies": {
+    "zod": "^4.0.0",
+    "@danceroutine/tango-config": "1.0.0",
+    "@danceroutine/tango-core": "1.0.0",
+    "@danceroutine/tango-schema": "1.0.0"
+  },
+  "peerDependencies": {
+    "pg": "^8.13.1",
+    "better-sqlite3": "^11.7.0"
+  },
+  "peerDependenciesMeta": {
+    "pg": {
+      "optional": true
     },
-    "devDependencies": {
-        "@danceroutine/tango-migrations": "workspace:*",
-        "@danceroutine/tango-testing": "workspace:*",
-        "@types/better-sqlite3": "^7.6.12",
-        "@types/node": "^22.9.0",
-        "@types/pg": "^8.11.10",
-        "better-sqlite3": "^11.7.0",
-        "pg": "^8.13.1",
-        "tsdown": "^0.4.0",
-        "typescript": "^5.6.3",
-        "vitest": "^4.0.6"
+    "better-sqlite3": {
+      "optional": true
     }
-}
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.12",
+    "@types/node": "^22.9.0",
+    "@types/pg": "^8.11.10",
+    "better-sqlite3": "^11.7.0",
+    "pg": "^8.13.1",
+    "tsdown": "^0.4.0",
+    "typescript": "^5.6.3",
+    "vitest": "^4.0.6",
+    "@danceroutine/tango-migrations": "1.0.0",
+    "@danceroutine/tango-testing": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run --coverage",
+    "test:integration": "vitest run src/tests/integration",
+    "test:watch": "vitest",
+    "typecheck": "pnpm run typecheck:prod && pnpm run typecheck:test",
+    "typecheck:prod": "tsc --noEmit -p tsconfig.json",
+    "typecheck:test": "tsc --noEmit -p tsconfig.tests.json"
+  }
+}

package/dist/PostgresAdapter-DCF8T4vh.js

@@ -1,3 +0,0 @@
-import { PostgresAdapter } from "./PostgresAdapter-_X36-mLL.js";
-
-export { PostgresAdapter };

package/dist/PostgresAdapter-_X36-mLL.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PostgresAdapter-_X36-mLL.js","names":["value: unknown","pool: pg.Pool","client: pg.PoolClient","sql: string","params?: any[]","value: unknown","config: AdapterConfig"],"sources":["../src/connection/clients/dialects/PostgresClient.ts","../src/connection/adapters/dialects/PostgresAdapter.ts"],"sourcesContent":["import type pg from 'pg';\nimport type { DBClient } from '../DBClient';\n\nexport class PostgresClient implements DBClient {\n    static readonly BRAND = 'tango.orm.postgres_client' as const;\n    readonly __tangoBrand: typeof PostgresClient.BRAND = PostgresClient.BRAND;\n\n    static isPostgresClient(value: unknown): value is PostgresClient {\n        return (\n            typeof value === 'object' &&\n            value !== null &&\n            (value as { __tangoBrand?: unknown }).__tangoBrand === PostgresClient.BRAND\n        );\n    }\n\n    constructor(\n        private pool: pg.Pool,\n        private client: pg.PoolClient\n    ) {}\n\n    async query<T = any>(sql: string, params?: any[]): Promise<{ rows: T[] }> {\n        const result = await this.client.query(sql, params);\n        return { rows: result.rows as T[] };\n    }\n\n    async begin(): Promise<void> {\n        await this.client.query('BEGIN');\n    }\n\n    async commit(): Promise<void> {\n        await this.client.query('COMMIT');\n    }\n\n    async rollback(): Promise<void> {\n        await this.client.query('ROLLBACK');\n    }\n\n    async close(): Promise<void> {\n        this.client.release();\n        await this.pool.end();\n    }\n}\n","import pg from 'pg';\nimport type { Adapter, AdapterConfig } from '../Adapter';\nimport type { DBClient } from '../../clients/DBClient';\nimport { PostgresClient } from '../../clients/dialects/PostgresClient';\n\nconst { Pool } = pg;\nexport class PostgresAdapter implements Adapter {\n    static readonly BRAND = 'tango.orm.postgres_adapter' as const;\n    readonly __tangoBrand: typeof PostgresAdapter.BRAND = PostgresAdapter.BRAND;\n    readonly name = 'postgres';\n\n    static isPostgresAdapter(value: unknown): value is PostgresAdapter {\n        return (\n            typeof value === 'object' &&\n            value !== null &&\n            (value as { __tangoBrand?: unknown }).__tangoBrand === PostgresAdapter.BRAND\n        );\n    }\n\n    /**\n     * Declares capabilities of this database adapter.\n     * Used by the migration runner and query compiler to determine which\n     * SQL features can be safely used:\n     * - transactionalDDL: Postgres supports DDL inside transactions (safe rollback of schema changes)\n     * - concurrentIndex: Supports CREATE INDEX CONCURRENTLY (non-blocking index builds)\n     * - validateForeignKeys: Supports deferred FK validation via NOT VALID + VALIDATE CONSTRAINT\n     */\n    readonly features = {\n        transactionalDDL: true,\n        concurrentIndex: true,\n        validateForeignKeys: true,\n    };\n\n    async connect(config: AdapterConfig): Promise<DBClient> {\n        const pool = new Pool({\n            connectionString: config.url,\n            host: config.host,\n            port: config.port,\n            database: config.database,\n            user: config.user,\n            password: config.password,\n            max: config.maxConnections || 10,\n        });\n\n        const client = await pool.connect();\n        return new PostgresClient(pool, client);\n    }\n}\n"],"mappings":";;;IAGa,iBAAN,MAAM,eAAmC;CAC5C,OAAgB,QAAQ;CACxB,eAAqD,eAAe;CAEpE,OAAO,iBAAiBA,OAAyC;AAC7D,gBACW,UAAU,YACjB,UAAU,QACT,MAAqC,iBAAiB,eAAe;CAE7E;CAED,YACYC,MACAC,QACV;AAAA,OAFU,OAAA;AAAA,OACA,SAAA;CACR;CAEJ,MAAM,MAAeC,KAAaC,QAAwC;EACtE,MAAM,SAAS,MAAM,KAAK,OAAO,MAAM,KAAK,OAAO;AACnD,SAAO,EAAE,MAAM,OAAO,KAAa;CACtC;CAED,MAAM,QAAuB;AACzB,QAAM,KAAK,OAAO,MAAM,QAAQ;CACnC;CAED,MAAM,SAAwB;AAC1B,QAAM,KAAK,OAAO,MAAM,SAAS;CACpC;CAED,MAAM,WAA0B;AAC5B,QAAM,KAAK,OAAO,MAAM,WAAW;CACtC;CAED,MAAM,QAAuB;AACzB,OAAK,OAAO,SAAS;AACrB,QAAM,KAAK,KAAK,KAAK;CACxB;AACJ;;;;ACpCD,MAAM,EAAE,MAAM,GAAG;IACJ,kBAAN,MAAM,gBAAmC;CAC5C,OAAgB,QAAQ;CACxB,eAAsD,gBAAgB;CACtE,OAAgB;CAEhB,OAAO,kBAAkBC,OAA0C;AAC/D,gBACW,UAAU,YACjB,UAAU,QACT,MAAqC,iBAAiB,gBAAgB;CAE9E;;;;;;;;;CAUD,WAAoB;EAChB,kBAAkB;EAClB,iBAAiB;EACjB,qBAAqB;CACxB;CAED,MAAM,QAAQC,QAA0C;EACpD,MAAM,OAAO,IAAI,KAAK;GAClB,kBAAkB,OAAO;GACzB,MAAM,OAAO;GACb,MAAM,OAAO;GACb,UAAU,OAAO;GACjB,MAAM,OAAO;GACb,UAAU,OAAO;GACjB,KAAK,OAAO,kBAAkB;EACjC;EAED,MAAM,SAAS,MAAM,KAAK,SAAS;AACnC,SAAO,IAAI,eAAe,MAAM;CACnC;AACJ"}