@plyaz/db 0.0.0

package/dist/factory/createDatabaseService.d.ts

@@ -0,0 +1,121 @@
+/**
+ * DATABASE SERVICE FACTORY - Main Entry Point
+ *
+ * This file is responsible for creating fully configured database services with extension chains.
+ * It implements the decorator pattern to wrap base adapters with feature extensions.
+ *
+ * **RESPONSIBILITIES:**
+ * 1. Config Validation - Ensures valid configuration before proceeding
+ * 2. Base Adapter Creation - Creates core database adapters (Drizzle/Supabase/SQL)
+ * 3. Adapter Chain Building - Wraps adapters with extensions in correct order
+ * 4. Service Assembly - Creates final DatabaseService with all components
+ * 5. Initialization - Establishes database connections and readiness
+ *
+ * **ADAPTER CHAIN ORDER:**
+ * Base → Encryption → SoftDelete → Caching → Audit → ReadReplica
+ * (innermost to outermost - each wraps the previous)
+ */
+import type { DatabaseServiceInterface, DatabaseServiceConfig } from "@plyaz/types/db";
+/**
+ * MAIN FACTORY - Application Entry Point
+ *
+ * Creates a fully configured database service with extension chain.
+ * This is the ONLY way applications should create database services.
+ *
+ * **Application Flow:**
+ * 1. App calls createDatabaseService() at startup
+ * 2. Factory validates config and creates base adapter (Drizzle/Supabase/etc.)
+ * 3. Factory builds 6-layer adapter chain: Base → Encryption → SoftDelete → Cache → Audit → ReadReplica
+ * 4. Factory creates DatabaseService with final wrapped adapter
+ * 5. App uses returned DatabaseServiceInterface in repositories/services
+ *
+ * **What this function does:**
+ * - Validates configuration using validateConfig()
+ * - Creates base adapter via AdapterFactory.create()
+ * - Builds decorator chain via buildAdapterChain()
+ * - Initializes database connection
+ * - Returns configured DatabaseService instance
+ *
+ * **Called by:** Application startup code (app.ts, main.ts)
+ * **Calls:** validateConfig(), AdapterFactory.create(), buildAdapterChain(), DatabaseService constructor
+ * **Returns to:** Application layer for injection into repositories
+ *
+ * @param config Complete database service configuration including adapter and extensions
+ * @returns Promise resolving to configured DatabaseServiceInterface instance
+ *
+ * @throws {BaseError} When configuration is invalid or initialization fails
+ *
+ * @example
+ * ### Basic Setup (app.ts)
+ * ```typescript
+ * import { createDatabaseService, Tables } from '@plyaz/db';
+ *
+ * // Called once at application startup
+ * const db = await createDatabaseService({
+ *   adapter: 'drizzle',
+ *   config: { connectionString: process.env.DATABASE_URL }
+ * });
+ *
+ * // Inject into services
+ * const userService = new UserService(db);
+ * ```
+ *
+ * @example
+ * ### Production Configuration
+ * ```typescript
+ * const db = await createDatabaseService({
+ *   adapter: 'drizzle',
+ *   config: {
+ *     connectionString: process.env.DATABASE_URL,
+ *     poolSize: 20
+ *   },
+ *
+ *   // Extensions applied in order: Base → Encryption → SoftDelete → Cache → Audit → ReadReplica
+ *   encryption: {
+ *     enabled: true,
+ *     key: process.env.ENCRYPTION_KEY,
+ *     fields: {
+ *       [Tables.USERS]: ['ssn', 'taxId'],
+ *       [Tables.PAYMENTS]: ['cardNumber', 'cvv']
+ *     }
+ *   },
+ *
+ *   softDelete: {
+ *     enabled: true,
+ *     field: 'deletedAt'
+ *   },
+ *
+ *   audit: {
+ *     enabled: true,
+ *     retentionDays: 90,
+ *     onAuditAfterWrite: async (event) => {
+ *       await complianceService.recordAudit(event);
+ *     }
+ *   },
+ *
+ *   cache: {
+ *     enabled: true,
+ *     ttl: 300,
+ *     invalidation: 'write'
+ *   },
+ *
+ *   events: {
+ *     onAfterWrite: async (event) => {
+ *       await notificationService.send(event);
+ *     }
+ *   }
+ * });
+ * ```
+ *
+ * @example
+ * ### Testing Setup
+ * ```typescript
+ * // Use mock adapter for tests
+ * const db = await createDatabaseService({
+ *   adapter: 'mock',
+ *   config: { logging: true }
+ * });
+ * ```
+ */
+export declare function createDatabaseService(config: DatabaseServiceConfig): Promise<DatabaseServiceInterface>;
+//# sourceMappingURL=createDatabaseService.d.ts.map

package/dist/factory/createDatabaseService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDatabaseService.d.ts","sourceRoot":"","sources":["../../src/factory/createDatabaseService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAmBH,OAAO,KAAK,EACV,wBAAwB,EAKxB,qBAAqB,EAEtB,MAAM,iBAAiB,CAAC;AAuLzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,wBAAwB,CAAC,CAmDnC"}