@elysiumjs/mnemosyne-drizzle 0.2.0 → 0.3.1

package/src/database.ts

@@ -1,205 +0,0 @@
-// Copyright (c) 2026-present Workbud Technologies Inc. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import type { CacheInterface, DatabaseCacheConfig, DatabaseDriver } from '@elysiumjs/mnemosyne';
-import type { DrizzleConfig } from 'drizzle-orm';
-import type { BunSQLDatabase } from 'drizzle-orm/bun-sql/postgres';
-import type { CacheConfig } from 'drizzle-orm/cache/core/types';
-
-import { Service, ServiceNotReadyError } from '@elysiumjs/core';
-import { AbstractDatabase, createDatabaseCacheStorage } from '@elysiumjs/mnemosyne';
-import { getTableName, is, Table } from 'drizzle-orm';
-import { drizzle } from 'drizzle-orm/bun-sql';
-import { Cache as DrizzleCache } from 'drizzle-orm/cache/core';
-
-// ============================================================================
-// Types
-// ============================================================================
-
-/**
- * Connection configuration for Drizzle ORM.
- *
- * Extends `DrizzleConfig` with connection details and optional caching.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TSchema The Drizzle schema type.
- */
-export type DrizzleConnectionProps<
-	TSchema extends Record<string, unknown> = Record<string, never>
-> = Omit<DrizzleConfig<TSchema>, 'cache'> &
-	({ connection: string | ({ url?: string } & Bun.SQLOptions) } | { client: Bun.SQL }) & {
-		cache?: true | DatabaseCacheConfig;
-	};
-
-/**
- * A Drizzle database connection backed by Bun's SQL driver.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type DrizzleConnection = BunSQLDatabase<Record<string, never>> & { $client: Bun.SQL };
-
-// ============================================================================
-// DrizzleDatabaseCache
-// ============================================================================
-
-/**
- * Drizzle query cache backed by the framework's cache storage.
- *
- * Extends the Drizzle `Cache` base class and implements the
- * framework's `DatabaseCacheStrategy` interface so that query
- * results can be transparently cached and invalidated.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export class DrizzleDatabaseCache extends DrizzleCache {
-	#storageEngine: 'redis' | 'memory';
-	#cache?: Omit<CacheInterface, 'tags'>;
-	private usedTablesPerKey: Record<string, string[]> = {};
-
-	constructor(
-		private readonly cacheStrategy: 'explicit' | 'all' = 'explicit',
-		private readonly globalTtl: number = 1,
-		storageEngine: 'redis' | 'memory' = 'redis'
-	) {
-		super();
-		this.#storageEngine = storageEngine;
-	}
-
-	/**
-	 * Resolves the cache storage on first use rather than at construction, so that a connection
-	 * can be built before the module providing the cache has finished initialising.
-	 */
-	async #storage(): Promise<Omit<CacheInterface, 'tags'>> {
-		if (this.#cache) return this.#cache;
-		try {
-			this.#cache = createDatabaseCacheStorage({ storage: this.#storageEngine });
-		} catch (error) {
-			if (!(error instanceof ServiceNotReadyError)) throw error;
-			await Service.resolve(error.service);
-			this.#cache = createDatabaseCacheStorage({ storage: this.#storageEngine });
-		}
-		return this.#cache;
-	}
-
-	public override strategy(): 'explicit' | 'all' {
-		return this.cacheStrategy;
-	}
-
-	public override async get(key: string): Promise<any[] | undefined> {
-		return (await (await this.#storage()).get<any[]>(key)) ?? undefined;
-	}
-
-	public override async put(
-		key: string,
-		response: any,
-		tables: string[],
-		_isTag: boolean,
-		config?: CacheConfig
-	): Promise<void> {
-		await (await this.#storage()).set(key, response, (config?.ex ?? this.globalTtl) * 1000);
-		for (const table of tables) {
-			const keys = this.usedTablesPerKey[table];
-			if (keys === undefined) {
-				this.usedTablesPerKey[table] = [key];
-			} else {
-				keys.push(key);
-			}
-		}
-	}
-
-	public override async onMutate(params: {
-		tags?: string | string[];
-		tables?: string | string[] | Table<any> | Table<any>[];
-	}): Promise<void> {
-		const tagsArray = params.tags ? (Array.isArray(params.tags) ? params.tags : [params.tags]) : [];
-		const tablesArray = params.tables
-			? Array.isArray(params.tables)
-				? params.tables
-				: [params.tables]
-			: [];
-		const keysToDelete = new Set<string>();
-
-		for (const table of tablesArray) {
-			const tableName = is(table, Table) ? getTableName(table as Table) : (table as string);
-			const keys = this.usedTablesPerKey[tableName] ?? [];
-			for (const key of keys) keysToDelete.add(key);
-		}
-
-		if (keysToDelete.size > 0 || tagsArray.length > 0) {
-			const cache = await this.#storage();
-			await cache.mdel(tagsArray);
-			await cache.mdel([...keysToDelete]);
-			for (const table of tablesArray) {
-				const tableName = is(table, Table) ? getTableName(table as Table) : (table as string);
-				this.usedTablesPerKey[tableName] = [];
-			}
-		}
-	}
-}
-
-// ============================================================================
-// DrizzleDatabase
-// ============================================================================
-
-/**
- * Drizzle-specific database manager.
- *
- * Implements the abstract database class with a driver that creates
- * Drizzle connections using Bun's built-in SQL client.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-class DrizzleDatabase extends AbstractDatabase<DrizzleConnection, DrizzleConnectionProps> {
-	/**
-	 * Creates a Drizzle connection from its properties. Used by the `DrizzleModule` to build
-	 * the `db.connection.{name}` services.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param props The connection properties.
-	 * @returns A new connection.
-	 */
-	public createConnection(props: DrizzleConnectionProps): DrizzleConnection {
-		return this.driver.createConnection(props);
-	}
-
-	protected driver: DatabaseDriver<DrizzleConnection, DrizzleConnectionProps> = {
-		createConnection(config) {
-			const cache =
-				config.cache === undefined
-					? undefined
-					: config.cache === true
-						? new DrizzleDatabaseCache()
-						: config.cache.enabled !== false
-							? new DrizzleDatabaseCache(
-									config.cache.strategy,
-									config.cache.ttl,
-									config.cache.storage
-								)
-							: undefined;
-			return drizzle({ ...config, cache }) as DrizzleConnection;
-		},
-
-		withTransaction(connection, callback) {
-			return (connection as any).transaction((tx: any) => callback(tx));
-		},
-
-		getRawClient(connection) {
-			return connection.$client;
-		}
-	};
-}
-
-/**
- * Singleton Drizzle database manager.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export const Database = new DrizzleDatabase();

package/src/drizzle.module.ts

@@ -1,97 +0,0 @@
-// Copyright (c) 2026-present Workbud Technologies Inc. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import type { TenancyConfig } from '@elysiumjs/mnemosyne';
-import type { DrizzleConnection, DrizzleConnectionProps } from './database';
-
-import { Module, needsDefaultAlias, runAll, Service } from '@elysiumjs/core';
-import {
-	AbstractDatabase,
-	MnemosyneModule,
-	TENANCY_CONFIG_SERVICE,
-	TENANCY_STRATEGY_SERVICE
-} from '@elysiumjs/mnemosyne';
-
-import { MigrationGenerateCommand } from './commands/migration_generate.command';
-import { MigrationRunCommand } from './commands/migration_run.command';
-import { Database } from './database';
-import { DrizzleRLSTenancy, DrizzleSchemaTenancy } from './tenancy';
-
-/**
- * Configuration of the {@link DrizzleModule}.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type DrizzleModuleConfig = {
-	/** The name of the connection that `default` resolves to. */
-	default: string;
-
-	/** The connections to declare, by name. */
-	connections: Record<string, DrizzleConnectionProps>;
-
-	/** The tenancy configuration. Defaults to schema-based tenancy. */
-	tenancy?: TenancyConfig;
-};
-
-/**
- * Declares Drizzle connections as global services named `db.connection.{name}`, plus
- * `db.connection.default` aliasing the configured default, and registers the tenancy config
- * and strategy. Connections are created on first use. Also provides the migration commands.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-@Module.register<DrizzleModuleConfig>({
-	imports: [MnemosyneModule],
-	commands: [MigrationGenerateCommand, MigrationRunCommand],
-	services: (config) => {
-		const alias = needsDefaultAlias('DrizzleModule', config);
-		const tenancy = config.tenancy ?? { mode: 'schema' };
-		return [
-			...Object.entries(config.connections).map(([name, props]) => ({
-				name: AbstractDatabase.getConnectionName(name),
-				global: true,
-				factory: () => Database.createConnection(props)
-			})),
-			...(alias
-				? [
-						{
-							name: AbstractDatabase.getConnectionName('default'),
-							global: true,
-							factory: (_config: unknown, get: <T>(name: string) => T) =>
-								get<DrizzleConnection>(AbstractDatabase.getConnectionName(config.default))
-						}
-					]
-				: []),
-			{ name: TENANCY_CONFIG_SERVICE, global: true, factory: () => tenancy },
-			{
-				name: TENANCY_STRATEGY_SERVICE,
-				global: true,
-				factory: () =>
-					tenancy.mode === 'rls' ? new DrizzleRLSTenancy() : new DrizzleSchemaTenancy()
-			}
-		];
-	}
-})
-export class DrizzleModule extends Module.configurable<DrizzleModuleConfig>({
-	defaults: { default: 'default' },
-	required: ['connections']
-}) {
-	/** Closes the clients of the connections that were created. */
-	public override async onDestroy(): Promise<void> {
-		const names = Object.keys(this.config.connections).map(AbstractDatabase.getConnectionName);
-		await runAll(
-			names
-				.filter((name) => Service.isConstructed(name))
-				.map((name) => () => Service.get<DrizzleConnection>(name)?.$client.close())
-		);
-	}
-}

package/src/index.ts

@@ -1,47 +0,0 @@
-// Copyright (c) 2026-present Workbud Technologies Inc. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-// Re-export drizzle-orm/pg-core with enhanced pgTable
-export * from 'drizzle-orm';
-export * from 'drizzle-orm/pg-core';
-export type {
-	SelectedFields,
-	SelectedFieldsFlat,
-	SelectedFieldsOrdered,
-	TableConfig
-} from 'drizzle-orm/pg-core';
-export { pgTable, getTableBuilders } from './table';
-
-// Re-exports
-export { Database, DrizzleDatabaseCache } from './database';
-export type { DrizzleConnectionProps, DrizzleConnection } from './database';
-export {
-	DrizzleModel,
-	createSchemaFromDrizzle,
-	drizzleAdapter,
-	type DrizzleModelOptions
-} from './model';
-export { DrizzleModule, type DrizzleModuleConfig } from './drizzle.module';
-export { DrizzleRepository } from './repository';
-export {
-	DrizzleSchemaTenancy,
-	DrizzleRLSTenancy,
-	wrapTenantSchema,
-	registerTenantSchema,
-	getTenantSchema,
-	withRLS,
-	setConnectionTenant,
-	getSessionTenant,
-	createRLSPolicy
-} from './tenancy';

package/src/migrations.ts

@@ -1,100 +0,0 @@
-// Copyright (c) 2025-present Workbud Technologies Inc. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import { basename, dirname } from 'node:path';
-
-/** A migration recorded as applied in `elysium_migrations`. */
-export type AppliedMigration = {
-	name: string;
-	appliedAt: Date;
-};
-
-/** The migrations to run, and the applied records to rename to their new names. */
-export type MigrationPlan = {
-	pending: string[];
-	renames: { from: string; to: string }[];
-};
-
-const FOLDER_MIGRATION_FILE = 'migration.sql';
-
-/**
- * Gets the name under which a migration file is tracked. Drizzle Kit 1.0 stores each migration
- * as `<folder>/migration.sql`, in which case the folder name identifies the migration.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param path The path of the migration file.
- */
-export const getMigrationName = (path: string): string =>
-	basename(path) === FOLDER_MIGRATION_FILE ? basename(dirname(path)) : basename(path);
-
-/** Drops the `.sql` extension and the leading index or timestamp: `0001_users.sql` → `users`. */
-const descriptiveName = (name: string): string =>
-	name
-		.replace(/\.sql$/, '')
-		.split('_')
-		.slice(1)
-		.join('_');
-
-/** Reads the UTC `YYYYMMDDHHmmss` timestamp that starts a Drizzle Kit 1.0 folder name. */
-const folderTime = (name: string): number | undefined => {
-	const match = /^(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/.exec(name);
-	return match
-		? Date.UTC(+match[1]!, +match[2]! - 1, +match[3]!, +match[4]!, +match[5]!, +match[6]!)
-		: undefined;
-};
-
-/**
- * Decides which migration files to run.
- *
- * `drizzle-kit up` moves each flat `<prefix>_<name>.sql` file into a
- * `<timestamp>_<name>/migration.sql` folder, where the timestamp is when the migration was
- * generated. An applied record whose flat file is gone is matched, in order, to a folder with
- * the same `<name>` generated before the record was applied; that folder is not run again and
- * the record is renamed. Folders generated later are new migrations and run.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param files The paths of the migration files.
- * @param applied The applied migrations.
- */
-export const planMigrations = (files: string[], applied: AppliedMigration[]): MigrationPlan => {
-	const appliedNames = new Set(applied.map(({ name }) => name));
-	const fileNames = new Set(files.map(getMigrationName));
-
-	const moved = new Map<string, AppliedMigration[]>();
-	for (const record of [...applied].sort((a, b) => a.name.localeCompare(b.name))) {
-		if (!record.name.endsWith('.sql') || fileNames.has(record.name)) continue;
-		const key = descriptiveName(record.name);
-		moved.set(key, [...(moved.get(key) ?? []), record]);
-	}
-
-	const plan: MigrationPlan = { pending: [], renames: [] };
-	for (const file of [...files].sort()) {
-		const name = getMigrationName(file);
-		if (appliedNames.has(name)) continue;
-
-		const from = basename(file) === FOLDER_MIGRATION_FILE ? takeMoved(moved, name) : undefined;
-		if (from) plan.renames.push({ from, to: name });
-		else plan.pending.push(file);
-	}
-	return plan;
-};
-
-/** Removes and returns the first moved record that the folder `name` can be the new home of. */
-const takeMoved = (moved: Map<string, AppliedMigration[]>, name: string): string | undefined => {
-	const records = moved.get(descriptiveName(name));
-	const generatedAt = folderTime(name);
-	const index =
-		records?.findIndex(
-			({ appliedAt }) => generatedAt === undefined || generatedAt <= appliedAt.getTime()
-		) ?? -1;
-	return index < 0 ? undefined : records!.splice(index, 1)[0]!.name;
-};

package/src/model.ts

@@ -1,178 +0,0 @@
-// Copyright (c) 2026-present Workbud Technologies Inc. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import type { ColumnMetadata, ModelAdapter } from '@elysiumjs/mnemosyne';
-import type { PgColumn, PgTableWithColumns, TableConfig } from 'drizzle-orm/pg-core';
-
-import { AbstractModel, createSchemaFromModel } from '@elysiumjs/mnemosyne';
-import { getTableConfig } from 'drizzle-orm/pg-core';
-
-import { getTableBuilders } from './table';
-import { wrapTenantSchema } from './tenancy';
-
-// ============================================================================
-// Column Type Mapping
-// ============================================================================
-
-/**
- * Maps a Drizzle column to a normalized data type.
- * @param col The Drizzle column to inspect.
- * @returns A normalized data type string.
- */
-const mapDrizzleDataType = (col: PgColumn): ColumnMetadata['dataType'] => {
-	if (col.columnType === 'PgUUID') return 'uuid';
-	if ((col as { dimensions?: number }).dimensions) return 'array';
-
-	// Drizzle 1.0 column data types are `<kind>` or `<kind> <constraint>` (e.g. `object json`).
-	const [kind, constraint] = col.dataType.split(' ');
-	switch (kind) {
-		case 'number':
-			return 'number';
-		case 'boolean':
-			return 'boolean';
-		case 'array':
-			return 'array';
-		case 'bigint':
-			return 'bigint';
-		case 'object':
-			switch (constraint) {
-				case 'json':
-					return 'json';
-				case 'date':
-					return 'date';
-				case 'buffer':
-					return 'buffer';
-				default:
-					return 'string';
-			}
-		default:
-			return 'string';
-	}
-};
-
-// ============================================================================
-// Drizzle Model Adapter
-// ============================================================================
-
-/**
- * Drizzle-specific model adapter.
- *
- * Bridges Drizzle's `PgTableWithColumns` to the framework's
- * normalized model metadata.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export const drizzleAdapter: ModelAdapter<PgTableWithColumns<any>> = {
-	getTableName(table) {
-		return getTableConfig(table).name;
-	},
-
-	getColumns(table): ColumnMetadata[] {
-		const config = getTableConfig(table);
-		return config.columns.map((col: PgColumn) => ({
-			name: col.name,
-			dataType: mapDrizzleDataType(col),
-			nullable: !col.notNull,
-			hasDefault: col.hasDefault,
-			isPrimaryKey:
-				col.primary || config.primaryKeys.some((pk) => pk.columns.some((c) => c.name === col.name))
-		}));
-	},
-
-	createTenantTable(table, tenant) {
-		const builders = getTableBuilders(table);
-		if (!builders) {
-			throw new Error(
-				`No column builders registered for table. ` +
-					`Use pgTable() from '@elysiumjs/mnemosyne-drizzle' for tenant support.`
-			);
-		}
-		const config = getTableConfig(table);
-		return wrapTenantSchema(tenant, config.name, builders) as PgTableWithColumns<any>;
-	}
-};
-
-// ============================================================================
-// Schema Helper
-// ============================================================================
-
-/**
- * Creates Elysia validation schemas from a Drizzle table.
- *
- * This is a convenience wrapper around `createSchemaFromModel` that
- * automatically extracts column metadata via the `drizzleAdapter`.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @param table The Drizzle table to generate schemas for.
- * @param opts Schema generation options.
- * @returns An Elysia validation schema.
- */
-export const createSchemaFromDrizzle = (
-	table: PgTableWithColumns<any>,
-	opts?: { mode?: 'create' | 'update' | 'select' }
-) => {
-	return createSchemaFromModel(drizzleAdapter.getColumns(table), opts);
-};
-
-// ============================================================================
-// DrizzleModel Options
-// ============================================================================
-
-/**
- * Options for creating a DrizzleModel.
- */
-export interface DrizzleModelOptions {
-	/**
-	 * Enable tenant schema support for this model.
-	 * @default false
-	 */
-	supportTenancy?: boolean;
-}
-
-// ============================================================================
-// DrizzleModel Function
-// ============================================================================
-
-/**
- * Creates a model class backed by a Drizzle pgTable.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @param table The Drizzle table (created with enhanced pgTable).
- * @param options Model configuration options.
- * @returns A model class with Drizzle-backed static metadata.
- */
-export const DrizzleModel = <TTable extends PgTableWithColumns<TableConfig>>(
-	table: TTable,
-	options?: DrizzleModelOptions
-) => {
-	const config = getTableConfig(table);
-	const builders = getTableBuilders(table);
-
-	type TSelect = TTable['$inferSelect'];
-	type TInsert = TTable['$inferInsert'];
-
-	const Base = AbstractModel(config.name, builders ?? {}, drizzleAdapter, table);
-
-	// Override supportTenancy if specified
-	if (options?.supportTenancy !== undefined) {
-		(Base as any).supportTenancy = options.supportTenancy;
-	}
-
-	return Base as typeof Base & {
-		readonly $inferSelect: TSelect;
-		readonly $inferInsert: TInsert;
-		readonly $inferUpdate: Partial<TInsert>;
-		readonly table: TTable;
-	};
-};