@elysiumjs/drizzle 0.0.0-stage → 0.1.1

package/dist/tenancy.d.ts

@@ -0,0 +1,105 @@
+import type { TenancyStrategy } from '@elysiumjs/olympus/mnemosyne';
+import type { AnyPgColumnBuilder, PgAsyncTransaction, PgSchema, PgTable } from 'drizzle-orm/pg-core';
+import type { DrizzleConnection } from './database';
+/**
+ * Returns the Drizzle `PgSchema` for the given tenant, creating it if needed.
+ * @author Axel Nana <ax.lnana@outlook.com>
+ * @param tenant The tenant identifier.
+ * @returns The tenant's PostgreSQL schema.
+ * @throws {Error} If the tenant identifier is malformed.
+ */
+export declare const getTenantSchema: (tenant: string) => PgSchema;
+/**
+ * Registers a new tenant schema in the registry.
+ * @author Axel Nana <ax.lnana@outlook.com>
+ * @param tenant The tenant identifier.
+ * @returns The newly registered (or existing) `PgSchema`.
+ * @throws {Error} If the tenant identifier is malformed.
+ */
+export declare const registerTenantSchema: (tenant: string) => PgSchema;
+/**
+ * Wraps a table definition in a tenant-specific schema.
+ *
+ * For the `'public'` tenant, returns a standard `pgTable`.
+ * For other tenants, creates a schema-qualified table and caches it.
+ *
+ * @author Axel Nana <ax.lnana@outlook.com>
+ * @param tenant The tenant identifier.
+ * @param tableName The table name.
+ * @param columns The column definitions.
+ * @returns A tenant-scoped `PgTable`.
+ * @throws {Error} If the tenant identifier is malformed.
+ */
+export declare const wrapTenantSchema: <TTableName extends string, TColumnsMap extends Record<string, AnyPgColumnBuilder>>(tenant: string, tableName: TTableName, columns: TColumnsMap) => PgTable;
+/**
+ * Executes a callback within an RLS-scoped transaction for the given tenant.
+ *
+ * The transaction is registered in the async context, so repositories and
+ * `Database.getConnection()` use it inside the callback. When a transaction is already open on the
+ * connection, the callback joins it if it is bound to the same tenant. Work for several tenants
+ * (such as an admin fan-out) must use one `withRLS()` per tenant, outside any transaction.
+ * @author Axel Nana <ax.lnana@outlook.com>
+ * @param tenant The tenant identifier (or `null` for 'public').
+ * @param callback The function to execute within the transaction.
+ * @param connectionName The database connection name.
+ * @returns The return value of the callback.
+ * @throws {TenantMismatchError} If the open transaction is bound to another tenant.
+ */
+export declare const withRLS: <T>(tenant: string | null, callback: (tx: PgAsyncTransaction<any, any>) => Promise<T>, connectionName?: string) => Promise<T>;
+/**
+ * Reads the current tenant from the PostgreSQL tenant variable, on the open transaction when
+ * there is one.
+ * @author Axel Nana <ax.lnana@outlook.com>
+ * @param connectionName The database connection name.
+ * @returns The current tenant identifier, or `null`.
+ */
+export declare const getSessionTenant: (connectionName?: string) => Promise<string | null>;
+/**
+ * Creates an RLS policy for tenant isolation on a table.
+ * @author Axel Nana <ax.lnana@outlook.com>
+ * @param tableName The table name.
+ * @param columnName The tenant column name (defaults to config or 'tenant_id').
+ * @param policyName The policy name (defaults to `{tableName}_tenant_isolation`).
+ * @returns A Drizzle `PgPolicy` instance.
+ */
+export declare const createRLSPolicy: (tableName: string, columnName?: string, policyName?: string) => import("drizzle-orm/pg-core").PgPolicy;
+/**
+ * Schema-based tenancy strategy for Drizzle.
+ *
+ * Each tenant gets its own PostgreSQL schema. Table resolution maps
+ * the base table to a schema-qualified equivalent.
+ *
+ * @author Axel Nana <ax.lnana@outlook.com>
+ */
+export declare class DrizzleSchemaTenancy implements TenancyStrategy<PgTable, DrizzleConnection> {
+    readonly mode = "schema";
+    resolveTable(table: PgTable, tenant: string): PgTable;
+    withIsolation<T>(_connection: DrizzleConnection, _tenant: string, callback: () => Promise<T>): Promise<T>;
+}
+/**
+ * Row-Level Security tenancy strategy for Drizzle.
+ *
+ * All tenants share the same schema. Isolation is achieved via
+ * PostgreSQL RLS policies and a session variable set in each transaction.
+ *
+ * @author Axel Nana <ax.lnana@outlook.com>
+ */
+export declare class DrizzleRLSTenancy implements TenancyStrategy<PgTable, DrizzleConnection> {
+    readonly mode = "rls";
+    resolveTable(table: PgTable, _tenant: string): PgTable;
+    /**
+     * Runs a callback in a transaction scoped to the given tenant.
+     *
+     * The transaction is bound to the tenant for its whole life, registered in the async context
+     * for the connection, and the tenant set as the current tenant, for the duration of the
+     * callback. When a transaction is already open on the connection, the callback joins it, which
+     * is only allowed when that transaction is bound to the same tenant.
+     * @author Axel Nana <ax.lnana@outlook.com>
+     * @param connection The base connection (see `Database.getBaseConnection`).
+     * @param tenant The tenant identifier.
+     * @param callback The function to execute within the isolated context.
+     * @returns The return value of the callback.
+     * @throws {TenantMismatchError} If the open transaction is bound to another tenant.
+     */
+    withIsolation<T>(connection: DrizzleConnection, tenant: string, callback: () => Promise<T>): Promise<T>;
+}

package/package.json

@@ -1,6 +1,103 @@
 {
-  "name": "@elysiumjs/drizzle",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@elysiumjs/drizzle",
+	"version": "0.1.1",
+	"license": "Apache-2.0",
+	"description": "Drizzle ORM backend for the Elysium.js framework: database drivers, models, repositories, queries, migrations, tenancy, the moirai stores, the notification and file stores, abilities as SQL, and the postgres lock.",
+	"private": false,
+	"author": "Axel Nana <ax.lnana@outlook.com>",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/na2axl/elysiumjs.git",
+		"directory": "@elysiumjs/drizzle"
+	},
+	"homepage": "https://github.com/na2axl/elysiumjs/tree/main/@elysiumjs/drizzle#readme",
+	"bugs": {
+		"url": "https://github.com/na2axl/elysiumjs/issues"
+	},
+	"scripts": {
+		"format": "prettier --write \"./src/**/*.ts\"",
+		"clean": "rimraf dist",
+		"build": "bun run clean && bun run build:js && bun run build:ts",
+		"typecheck": "tsc --noEmit && tsc -p tsconfig.types.json",
+		"prepublishOnly": "bun run build",
+		"test": "bun test",
+		"test:coverage": "bun test --coverage",
+		"build:js": "bun build ./src/index.ts ./src/drivers/bun-sql.ts ./src/drivers/postgres-js.ts ./src/drivers/node-postgres.ts ./src/drivers/hyperdrive.ts --outdir ./dist --target node --packages external --root ./src --minify-syntax --minify-whitespace",
+		"build:ts": "tsc --emitDeclarationOnly"
+	},
+	"keywords": [
+		"elysium",
+		"database",
+		"orm",
+		"drizzle",
+		"postgresql"
+	],
+	"module": "dist/index.js",
+	"type": "module",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		},
+		"./bun-sql": {
+			"types": "./dist/drivers/bun-sql.d.ts",
+			"import": "./dist/drivers/bun-sql.js"
+		},
+		"./postgres-js": {
+			"types": "./dist/drivers/postgres-js.d.ts",
+			"import": "./dist/drivers/postgres-js.js"
+		},
+		"./node-postgres": {
+			"types": "./dist/drivers/node-postgres.d.ts",
+			"import": "./dist/drivers/node-postgres.js"
+		},
+		"./hyperdrive": {
+			"types": "./dist/drivers/hyperdrive.d.ts",
+			"import": "./dist/drivers/hyperdrive.js"
+		}
+	},
+	"files": [
+		"dist",
+		"CHANGELOG.md"
+	],
+	"sideEffects": [
+		"./dist/index.js",
+		"./src/index.ts",
+		"./src/lock.ts",
+		"./src/hermes.ts",
+		"./src/pithos.ts"
+	],
+	"peerDependencies": {
+		"@elysiumjs/olympus": "^0.25.0",
+		"@elysiumjs/workers": "^0.1.0",
+		"pg": "^8.0.0",
+		"postgres": "^3.4.0"
+	},
+	"dependencies": {
+		"@casl/ability": "^7.0.2",
+		"drizzle-orm": "^1.0.0-rc.5",
+		"prompts": "^2.4.2",
+		"radash": "^12.1.1"
+	},
+	"devDependencies": {
+		"@elysiumjs/olympus": "0.25.0",
+		"@elysiumjs/bun": "0.1.0",
+		"@elysiumjs/workers": "0.1.0",
+		"@types/pg": "8.15.5",
+		"@types/prompts": "^2.4.9",
+		"pg": "8.16.3",
+		"postgres": "3.4.7"
+	},
+	"peerDependenciesMeta": {
+		"@elysiumjs/workers": {
+			"optional": true
+		},
+		"pg": {
+			"optional": true
+		},
+		"postgres": {
+			"optional": true
+		}
+	}
+}