@drizzle-adapter/d1 1.0.1 → 1.0.4

package/README.md

@@ -34,6 +34,18 @@ D1 offers unique advantages for Cloudflare Workers:
 pnpm install @drizzle-adapter/core @drizzle-adapter/d1
 ```
 
+## Important: Adapter Registration
+
+For the adapter to work correctly with the DrizzleAdapterFactory, you must import it for its self-registration side effects:
+
+```typescript
+// Import for side effects - adapter will self-register
+import '@drizzle-adapter/d1';
+
+// Now you can use the factory
+import { DrizzleAdapterFactory } from '@drizzle-adapter/core';
+```
+
 ## Usage
 
 ### Cloudflare Workers Setup
@@ -67,7 +79,7 @@ const config: TypeDrizzleDatabaseConfig = {
 };
 
 const factory = new DrizzleAdapterFactory();
-const adapter = await factory.create(config);
+const adapter = factory.create(config);
 ```
 
 ### Important Note About Connections
@@ -201,7 +213,7 @@ interface Env {
 export default {
   async fetch(request: Request, env: Env): Promise<Response> {
     const factory = new DrizzleAdapterFactory();
-    const adapter = await factory.create({
+    const adapter = factory.create({
       DATABASE_DRIVER: 'd1',
       DATABASE: env.DB
     });

package/dist/Adapter/D1DrizzleMigrator.d.ts

@@ -1,12 +1,17 @@
-import type { DrizzleMigratorInterface } from '@drizzle-adapter/core';
-import type { MigrationConfig } from 'drizzle-orm/migrator';
+import type { DrizzleMigratorInterface, TypeDrizzleMigratorConfig } from '@drizzle-adapter/core';
 import type { D1DrizzleClientInterface } from '../Interface/index.js';
 export declare class D1DrizzleMigrator implements DrizzleMigratorInterface {
+    private readonly config;
+    /**
+     * Constructor.
+     *
+     * @param {TypeDrizzleMigratorConfig} config The migrator configuration.
+     */
+    constructor(config: TypeDrizzleMigratorConfig);
     /**
      * Migrate the database.
      *
      * @param {DrizzleClientInterface} client The Drizzle client.
-     * @param {MigrationConfig} config The migration configuration.
      */
-    migrate(client: D1DrizzleClientInterface, config: MigrationConfig): Promise<void>;
+    migrate(client: D1DrizzleClientInterface): Promise<void>;
 }

package/dist/Adapter/D1DrizzleMigrator.js

@@ -1,13 +1,25 @@
 import { DrizzleD1Database } from 'drizzle-orm/d1/driver';
 import { migrate } from 'drizzle-orm/d1/migrator';
 export class D1DrizzleMigrator {
+    config;
+    /**
+     * Constructor.
+     *
+     * @param {TypeDrizzleMigratorConfig} config The migrator configuration.
+     */
+    constructor(config) {
+        this.config = config;
+    }
     /**
      * Migrate the database.
      *
      * @param {DrizzleClientInterface} client The Drizzle client.
-     * @param {MigrationConfig} config The migration configuration.
      */
-    async migrate(client, config) {
-        await migrate(client, config);
+    async migrate(client) {
+        await migrate(client, {
+            migrationsFolder: this.config.DATABASE_MIGRATIONS_FOLDER,
+            migrationsTable: this.config.DATABASE_MIGRATIONS_TABLE,
+            migrationsSchema: this.config.DATABASE_MIGRATIONS_SCHEMA
+        });
     }
 }

package/dist/Adapter/index.d.ts

@@ -1,2 +1,3 @@
 export * from './D1DrizzleAdapter.js';
 export * from './D1DrizzleConnection.js';
+export * from './D1DrizzleMigrator.js';

package/dist/Adapter/index.js

@@ -1,2 +1,3 @@
 export * from './D1DrizzleAdapter.js';
 export * from './D1DrizzleConnection.js';
+export * from './D1DrizzleMigrator.js';

package/dist/Factory/D1DrizzleAdapterFactory.d.ts

@@ -6,7 +6,7 @@ export declare class D1DrizzleAdapterFactory implements DrizzleAdapterFactoryInt
      * Returns a adapter.
      *
      * @param {TypeD1DatabaseConfig} databaseConfig
-     * @returns {Promise<D1DrizzleAdapter>}
+     * @returns {D1DrizzleAdapter}
      */
-    create(databaseConfig: TypeD1DatabaseConfig): Promise<D1DrizzleAdapter>;
+    create(databaseConfig: TypeD1DatabaseConfig): D1DrizzleAdapter;
 }

package/dist/Factory/D1DrizzleAdapterFactory.js

@@ -4,9 +4,9 @@ export class D1DrizzleAdapterFactory {
      * Returns a adapter.
      *
      * @param {TypeD1DatabaseConfig} databaseConfig
-     * @returns {Promise<D1DrizzleAdapter>}
+     * @returns {D1DrizzleAdapter}
      */
-    async create(databaseConfig) {
+    create(databaseConfig) {
         return new D1DrizzleAdapter(databaseConfig.DATABASE);
     }
 }

package/dist/Factory/D1DrizzleMigratorFactory.d.ts

@@ -0,0 +1,11 @@
+import type { DrizzleMigratorFactoryInterface, TypeDrizzleMigratorConfig } from '@drizzle-adapter/core';
+import { D1DrizzleMigrator } from '../Adapter/index.js';
+export declare class D1DrizzleMigratorFactory implements DrizzleMigratorFactoryInterface {
+    /**
+     * Returns a new migrator.
+     *
+     * @param {TypeDrizzleMigratorConfig} config
+     * @returns {D1DrizzleMigrator}
+     */
+    create(config: TypeDrizzleMigratorConfig): D1DrizzleMigrator;
+}

package/dist/Factory/D1DrizzleMigratorFactory.js

@@ -0,0 +1,12 @@
+import { D1DrizzleMigrator } from '../Adapter/index.js';
+export class D1DrizzleMigratorFactory {
+    /**
+     * Returns a new migrator.
+     *
+     * @param {TypeDrizzleMigratorConfig} config
+     * @returns {D1DrizzleMigrator}
+     */
+    create(config) {
+        return new D1DrizzleMigrator(config);
+    }
+}

package/dist/Factory/index.d.ts

@@ -1 +1,2 @@
 export * from './D1DrizzleAdapterFactory.js';
+export * from './D1DrizzleMigratorFactory.js';

package/dist/Factory/index.js

@@ -1 +1,2 @@
 export * from './D1DrizzleAdapterFactory.js';
+export * from './D1DrizzleMigratorFactory.js';

package/dist/index.js

@@ -3,5 +3,7 @@ export * from './Factory/index.js';
 export * from './Interface/index.js';
 export * from './Type/index.js';
 // default export so that core factory can use it directly
-import { D1DrizzleAdapterFactory } from './Factory/index.js';
+import { D1DrizzleAdapterFactory, D1DrizzleMigratorFactory } from './Factory/index.js';
 export default D1DrizzleAdapterFactory;
+import { DrizzleAdapterFactoryRegistry } from '@drizzle-adapter/core';
+DrizzleAdapterFactoryRegistry.register('d1', D1DrizzleAdapterFactory, D1DrizzleMigratorFactory);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@drizzle-adapter/d1",
   "type": "module",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "devDependencies": {
@@ -18,9 +18,10 @@
     "wrangler": "^3.91.0"
   },
   "dependencies": {
+    "@drizzle-adapter/core": ">=1.0.4",
+    "@drizzle-adapter/sqlite-core": ">=1.0.4",
     "@libsql/client": "^0.5.6",
-    "drizzle-orm": "^0.36.4",
-    "@drizzle-adapter/sqlite-core": "1.0.0"
+    "drizzle-orm": "^0.36.4"
   },
   "scripts": {
     "lint": "eslint src/",

package/src/Adapter/D1DrizzleMigrator.ts

@@ -1,19 +1,28 @@
-import type { DrizzleMigratorInterface } from '@drizzle-adapter/core';
-import type { MigrationConfig } from 'drizzle-orm/migrator';
+import type { DrizzleMigratorInterface, TypeDrizzleMigratorConfig } from '@drizzle-adapter/core';
 import { DrizzleD1Database } from 'drizzle-orm/d1/driver';
 import { migrate } from 'drizzle-orm/d1/migrator';
 import type { D1DrizzleClientInterface } from '../Interface';
 
 export class D1DrizzleMigrator implements DrizzleMigratorInterface
 {
+	/**
+	 * Constructor.
+	 *
+	 * @param {TypeDrizzleMigratorConfig} config The migrator configuration.
+	 */
+	public constructor(private readonly config: TypeDrizzleMigratorConfig) {}
+
 	/**
 	 * Migrate the database.
 	 *
 	 * @param {DrizzleClientInterface} client The Drizzle client.
-	 * @param {MigrationConfig} config The migration configuration.
 	 */
-	public async migrate(client: D1DrizzleClientInterface, config: MigrationConfig): Promise<void>
+	public async migrate(client: D1DrizzleClientInterface): Promise<void>
 	{
-		await migrate(client as unknown as DrizzleD1Database<Record<string, unknown>>, config);
+		await migrate(client as unknown as DrizzleD1Database<Record<string, unknown>>, {
+			migrationsFolder: this.config.DATABASE_MIGRATIONS_FOLDER,
+			migrationsTable: this.config.DATABASE_MIGRATIONS_TABLE,
+			migrationsSchema: this.config.DATABASE_MIGRATIONS_SCHEMA
+		});
 	}
 }

package/src/Adapter/index.ts

@@ -1,2 +1,3 @@
 export * from './D1DrizzleAdapter';
 export * from './D1DrizzleConnection';
+export * from './D1DrizzleMigrator';

package/src/Factory/D1DrizzleAdapterFactory.ts

@@ -8,9 +8,9 @@ export class D1DrizzleAdapterFactory implements DrizzleAdapterFactoryInterface
 	 * Returns a adapter.
 	 *
 	 * @param {TypeD1DatabaseConfig} databaseConfig
-	 * @returns {Promise<D1DrizzleAdapter>}
+	 * @returns {D1DrizzleAdapter}
 	 */
-	public async create(databaseConfig: TypeD1DatabaseConfig): Promise<D1DrizzleAdapter>
+	public create(databaseConfig: TypeD1DatabaseConfig): D1DrizzleAdapter
 	{
 		return new D1DrizzleAdapter(databaseConfig.DATABASE);
 	}

package/src/Factory/D1DrizzleMigratorFactory.ts

@@ -0,0 +1,16 @@
+import type { DrizzleMigratorFactoryInterface, TypeDrizzleMigratorConfig } from '@drizzle-adapter/core';
+import { D1DrizzleMigrator } from '../Adapter';
+
+export class D1DrizzleMigratorFactory implements DrizzleMigratorFactoryInterface
+{
+	/**
+	 * Returns a new migrator.
+	 *
+	 * @param {TypeDrizzleMigratorConfig} config
+	 * @returns {D1DrizzleMigrator}
+	 */
+	public create(config: TypeDrizzleMigratorConfig): D1DrizzleMigrator
+	{
+		return new D1DrizzleMigrator(config);
+	}
+}

package/src/Factory/index.ts

@@ -1 +1,2 @@
 export * from './D1DrizzleAdapterFactory';
+export * from './D1DrizzleMigratorFactory';

package/src/index.ts

@@ -4,5 +4,8 @@ export * from './Interface';
 export * from './Type';
 
 // default export so that core factory can use it directly
-import { D1DrizzleAdapterFactory } from './Factory';
+import { D1DrizzleAdapterFactory, D1DrizzleMigratorFactory } from './Factory';
 export default D1DrizzleAdapterFactory;
+
+import { DrizzleAdapterFactoryRegistry } from '@drizzle-adapter/core';
+DrizzleAdapterFactoryRegistry.register('d1', D1DrizzleAdapterFactory, D1DrizzleMigratorFactory);

package/tests/Adapter/D1DrizzleMigrator.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest';
 import { D1DrizzleMigrator } from '../../src/Adapter/D1DrizzleMigrator';
 import * as migrator from 'drizzle-orm/d1/migrator';
-import type { MigrationConfig } from 'drizzle-orm/migrator';
+import type { TypeDrizzleMigratorConfig } from '@drizzle-adapter/core';
 import type { D1DrizzleClientInterface } from '../../src/Interface';
 
 // Mock the migrate function from drizzle-orm/d1/migrator
@@ -19,39 +19,47 @@ describe('D1DrizzleMigrator', () => {
 		mockedClient: true
 	} as unknown as D1DrizzleClientInterface;
 
-	const mockConfig: MigrationConfig = {
-		migrationsFolder: './drizzle'
+	const mockConfig: TypeDrizzleMigratorConfig = {
+		DATABASE_DRIVER: 'd1',
+		DATABASE_URL: 'file:./test.db',
+		DATABASE_MIGRATIONS_FOLDER: './drizzle',
+		DATABASE_MIGRATIONS_TABLE: 'drizzle_migrations',
+		DATABASE_MIGRATIONS_SCHEMA: 'public'
 	};
 
 	beforeEach(() => {
 		vi.clearAllMocks();
 	});
 
-	it('should create an instance with a D1 client', () => {
-		const migratorInstance = new D1DrizzleMigrator();
+	it('should create an instance with config', () => {
+		const migratorInstance = new D1DrizzleMigrator(mockConfig);
 		expect(migratorInstance).toBeInstanceOf(D1DrizzleMigrator);
 	});
 
 	it('should call migrate with correct parameters', async () => {
-		const migratorInstance = new D1DrizzleMigrator();
-		await migratorInstance.migrate(mockClient, mockConfig);
+		const migratorInstance = new D1DrizzleMigrator(mockConfig);
+		await migratorInstance.migrate(mockClient);
 
 		expect(migrator.migrate).toHaveBeenCalledWith(
 			expect.objectContaining({ mockedClient: true }),
-			mockConfig
+			{
+				migrationsFolder: mockConfig.DATABASE_MIGRATIONS_FOLDER,
+				migrationsTable: mockConfig.DATABASE_MIGRATIONS_TABLE,
+				migrationsSchema: mockConfig.DATABASE_MIGRATIONS_SCHEMA,
+			}
 		);
 		expect(migrator.migrate).toHaveBeenCalledTimes(1);
 	});
 
 	it('should handle migration errors', async () => {
-		const migratorInstance = new D1DrizzleMigrator();
+		const migratorInstance = new D1DrizzleMigrator(mockConfig);
 		
 		// Mock migrate to throw an error
 		vi.mocked(migrator.migrate).mockImplementationOnce(async () => {
 			throw new Error('Migration failed');
 		});
 
-		await expect(migratorInstance.migrate(mockClient, mockConfig))
+		await expect(migratorInstance.migrate(mockClient))
 			.rejects
 			.toThrow('Migration failed');
 	});

package/tests/Factory/D1DrizzleAdapterFactory.test.ts

@@ -34,7 +34,7 @@ describe('D1DrizzleAdapterFactory', () => {
 
 	it('should create a D1DrizzleAdapter instance', async () => {
 		const factory = new D1DrizzleAdapterFactory();
-		const adapter = await factory.create(mockDatabaseConfig);
+		const adapter = factory.create(mockDatabaseConfig);
 
 		expect(adapter).toBeInstanceOf(D1DrizzleAdapter);
 	});

package/tests/Factory/D1DrizzleMigratorFactory.test.ts

@@ -0,0 +1,36 @@
+import { describe, it, expect } from 'vitest';
+import { D1DrizzleMigratorFactory } from '../../src/Factory';
+import { D1DrizzleMigrator } from '../../src/Adapter';
+import type { TypeDrizzleMigratorConfig } from '@drizzle-adapter/core';
+
+describe('D1DrizzleMigratorFactory', () => {
+	const mockMigratorConfig: TypeDrizzleMigratorConfig = {
+		DATABASE_DRIVER: 'd1',
+		DATABASE_URL: 'file:./test.db',
+		DATABASE_MIGRATIONS_FOLDER: './drizzle',
+		DATABASE_MIGRATIONS_TABLE: 'drizzle_migrations',
+		DATABASE_MIGRATIONS_SCHEMA: 'public'
+	};
+
+	it('should be instantiable', () => {
+		const factory = new D1DrizzleMigratorFactory();
+		expect(factory).toBeInstanceOf(D1DrizzleMigratorFactory);
+	});
+
+	it('should create a D1DrizzleMigrator instance', () => {
+		const factory = new D1DrizzleMigratorFactory();
+		const migrator = factory.create(mockMigratorConfig);
+
+		expect(migrator).toBeInstanceOf(D1DrizzleMigrator);
+	});
+
+	it('should pass the config to the migrator', () => {
+		const factory = new D1DrizzleMigratorFactory();
+		const migrator = factory.create(mockMigratorConfig);
+
+		// Verify the migrator was created with the correct config
+		expect(migrator).toBeInstanceOf(D1DrizzleMigrator);
+		// @ts-expect-error Accessing private property for testing
+		expect(migrator.config).toEqual(mockMigratorConfig);
+	});
+});

package/tests/worker.ts

@@ -21,7 +21,7 @@ export default {
 			case '/test/create-record': {
 				try {
 					const factory = new D1DrizzleAdapterFactory();
-					const adapter = await factory.create({
+					const adapter = factory.create({
 						DATABASE: env.DB
 					}) as D1DrizzleAdapter;
 
@@ -65,7 +65,7 @@ export default {
 			case '/test/update-record': {
 				try {
 					const factory = new D1DrizzleAdapterFactory();
-					const adapter = await factory.create({
+					const adapter = factory.create({
 						DATABASE: env.DB
 					}) as D1DrizzleAdapter;
 
@@ -116,7 +116,7 @@ export default {
 			case '/test/select-records': {
 				try {
 					const factory = new D1DrizzleAdapterFactory();
-					const adapter = await factory.create({
+					const adapter = factory.create({
 						DATABASE: env.DB
 					}) as D1DrizzleAdapter;
 
@@ -174,7 +174,7 @@ export default {
 			case '/test/migrations': {
 				try {
 					const factory = new D1DrizzleAdapterFactory();
-					const adapter = await factory.create({
+					const adapter = factory.create({
 						DATABASE: env.DB
 					}) as D1DrizzleAdapter;
 
@@ -277,7 +277,7 @@ export default {
 			case '/test/text-type': {
 				try {
 					const factory = new D1DrizzleAdapterFactory();
-					const adapter = await factory.create({
+					const adapter = factory.create({
 						DATABASE: env.DB
 					}) as D1DrizzleAdapter;