@drizzle-adapter/d1 1.0.14 → 1.0.17

package/src/Factory/D1DrizzleAdapterFactory.ts

@@ -1,14 +1,19 @@
-import type { TypeD1DatabaseConfig } from '../Type/Types';
-import { D1DrizzleAdapter } from '../Adapter/D1DrizzleAdapter';
 import type { DrizzleAdapterFactoryInterface } from '@drizzle-adapter/core';
 
+import { D1DrizzleAdapter } from '../Adapter/D1DrizzleAdapter';
+import type { TypeD1DatabaseConfig } from '../Type/Types';
+
+/**
+ * Factory for creating D1 adapter instances.
+ * Implements the DrizzleAdapterFactoryInterface for D1 database operations.
+ */
 export class D1DrizzleAdapterFactory implements DrizzleAdapterFactoryInterface
 {
 	/**
 	 * Returns a adapter.
 	 *
-	 * @param {TypeD1DatabaseConfig} databaseConfig
-	 * @returns {D1DrizzleAdapter}
+	 * @param {TypeD1DatabaseConfig} databaseConfig - The D1 database configuration
+	 * @returns {D1DrizzleAdapter} A new D1 adapter instance
 	 */
 	public create(databaseConfig: TypeD1DatabaseConfig): D1DrizzleAdapter
 	{

package/src/Factory/D1DrizzleDataTypesFactory.ts

@@ -1,13 +1,17 @@
 import type { DrizzleDataTypesFactoryInterface, TypeDrizzleDatabaseConfig } from '@drizzle-adapter/core';
 import { SqliteCoreDrizzleDataTypes } from '@drizzle-adapter/sqlite-core';
 
+/**
+ * Factory for creating D1 data types instances.
+ * Implements the DrizzleDataTypesFactoryInterface for D1 database operations.
+ */
 export class D1DrizzleDataTypesFactory implements DrizzleDataTypesFactoryInterface
 {
 	/**
 	 * Creates a new data types instance.
 	 *
 	 * @param {TypeDrizzleDatabaseConfig} _config - Not used in this implementation
-	 * @returns {SqliteCoreDrizzleDataTypes}
+	 * @returns {SqliteCoreDrizzleDataTypes} A new SQLite core data types instance
 	 */
 	public create(_config: TypeDrizzleDatabaseConfig): SqliteCoreDrizzleDataTypes
 	{

package/src/Factory/D1DrizzleMigratorFactory.ts

@@ -1,13 +1,18 @@
 import type { DrizzleMigratorFactoryInterface, TypeDrizzleMigratorConfig } from '@drizzle-adapter/core';
+
 import { D1DrizzleMigrator } from '../migrator';
 
+/**
+ * Factory for creating D1 migrator instances.
+ * Implements the DrizzleMigratorFactoryInterface for D1 database migrations.
+ */
 export class D1DrizzleMigratorFactory implements DrizzleMigratorFactoryInterface
 {
 	/**
 	 * Returns a new migrator.
 	 *
-	 * @param {TypeDrizzleMigratorConfig} config
-	 * @returns {D1DrizzleMigrator}
+	 * @param {TypeDrizzleMigratorConfig} config - The migrator configuration
+	 * @returns {D1DrizzleMigrator} A new D1 migrator instance
 	 */
 	public create(config: TypeDrizzleMigratorConfig): D1DrizzleMigrator
 	{

package/src/Interface/D1DrizzleClientInterface.ts

@@ -1,6 +1,10 @@
-import type { AnyD1Database } from 'drizzle-orm/d1';
 import type { DrizzleClientInterface } from '@drizzle-adapter/core';
+import type { AnyD1Database } from 'drizzle-orm/d1';
 
+/**
+ * Interface for D1 Drizzle client operations.
+ * Extends the core DrizzleClientInterface with D1-specific database operations.
+ */
 export interface D1DrizzleClientInterface extends DrizzleClientInterface
 {
 	execute(...args: any[]): ReturnType<AnyD1Database['run']>;

package/src/Type/Types.ts

@@ -1,6 +1,10 @@
 import type { D1Database } from '@cloudflare/workers-types';
 import type { TypeDrizzleDatabaseConfig } from '@drizzle-adapter/core';
 
+/**
+ * Configuration interface for D1 database connections.
+ * Extends the core database configuration with D1-specific settings.
+ */
 export interface TypeD1DatabaseConfig extends TypeDrizzleDatabaseConfig
 {
 	readonly DATABASE: D1Database;