@ciscode/database-kit 1.0.0 → 1.0.1

package/dist/adapters/postgres.adapter.d.ts

@@ -1,5 +1,5 @@
-import { Knex } from 'knex';
-import { PostgresDatabaseConfig, PostgresEntityConfig, Repository } from '../contracts/database.contracts';
+import { Knex } from "knex";
+import { PostgresDatabaseConfig, PostgresEntityConfig, PostgresTransactionContext, Repository, TransactionOptions, TransactionCallback, HealthCheckResult } from "../contracts/database.contracts";
 /**
  * PostgreSQL adapter for DatabaseKit.
  * Handles PostgreSQL connection and repository creation via Knex.
@@ -37,13 +37,60 @@ export declare class PostgresAdapter {
      * Checks if connected to PostgreSQL.
      */
     isConnected(): boolean;
+    /**
+     * Performs a health check on the PostgreSQL connection.
+     * Executes a simple query to verify the database is responsive.
+     *
+     * @returns Health check result with status and response time
+     *
+     * @example
+     * ```typescript
+     * const health = await adapter.healthCheck();
+     * if (!health.healthy) {
+     *   console.error('Database unhealthy:', health.error);
+     * }
+     * ```
+     */
+    healthCheck(): Promise<HealthCheckResult>;
     /**
      * Creates a repository for a PostgreSQL table.
      * The repository provides a standardized CRUD interface.
      *
      * @param cfg - Configuration for the entity/table
+     * @param trx - Optional Knex transaction for transaction support
      * @returns Repository instance with CRUD methods
      */
-    createRepository<T = unknown>(cfg: PostgresEntityConfig): Repository<T>;
+    createRepository<T = unknown>(cfg: PostgresEntityConfig<T>, trx?: Knex.Transaction): Repository<T>;
+    /**
+     * Executes a callback within a PostgreSQL transaction.
+     * All database operations within the callback are atomic.
+     *
+     * @param callback - Function to execute within the transaction
+     * @param options - Transaction options including isolation level
+     * @returns Result of the callback function
+     * @throws Error if transaction fails after all retries
+     *
+     * @example
+     * ```typescript
+     * const result = await postgresAdapter.withTransaction(async (ctx) => {
+     *   const usersRepo = ctx.createRepository<User>({ table: 'users' });
+     *   const ordersRepo = ctx.createRepository<Order>({ table: 'orders' });
+     *
+     *   const [user] = await usersRepo.create({ name: 'John' });
+     *   const [order] = await ordersRepo.create({ user_id: user.id, total: 100 });
+     *
+     *   return { user, order };
+     * }, { isolationLevel: 'serializable' });
+     * ```
+     */
+    withTransaction<TResult>(callback: TransactionCallback<PostgresTransactionContext, TResult>, options?: TransactionOptions): Promise<TResult>;
+    /**
+     * Checks if a PostgreSQL error is retryable.
+     */
+    private isRetryableError;
+    /**
+     * Simple sleep utility for retry backoff.
+     */
+    private sleep;
 }
 //# sourceMappingURL=postgres.adapter.d.ts.map

package/dist/adapters/postgres.adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postgres.adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/postgres.adapter.ts"],"names":[],"mappings":"AAEA,OAAa,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EACH,sBAAsB,EACtB,oBAAoB,EACpB,UAAU,EAGb,MAAM,iCAAiC,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,qBACa,eAAe;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoC;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;IAChD,OAAO,CAAC,YAAY,CAAC,CAAO;gBAEhB,MAAM,EAAE,sBAAsB;IAI1C;;;;;;OAMG;IACH,OAAO,CAAC,SAAS,GAAE,IAAI,CAAC,MAAW,GAAG,IAAI;IAiB1C;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQjC;;;OAGG;IACH,OAAO,IAAI,IAAI;IAOf;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;;OAMG;IACH,gBAAgB,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,oBAAoB,GAAG,UAAU,CAAC,CAAC,CAAC;CA0J1E"}
+{"version":3,"file":"postgres.adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/postgres.adapter.ts"],"names":[],"mappings":"AACA,OAAa,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,0BAA0B,EAC1B,UAAU,EAGV,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EAElB,MAAM,iCAAiC,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,qBACa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoC;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;IAChD,OAAO,CAAC,YAAY,CAAC,CAAO;gBAEhB,MAAM,EAAE,sBAAsB;IAI1C;;;;;;OAMG;IACH,OAAO,CAAC,SAAS,GAAE,IAAI,CAAC,MAAW,GAAG,IAAI;IA2B1C;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQjC;;;OAGG;IACH,OAAO,IAAI,IAAI;IAOf;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;;;;;;;;;OAaG;IACG,WAAW,IAAI,OAAO,CAAC,iBAAiB,CAAC;IA8C/C;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,GAAG,OAAO,EAC1B,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAC5B,GAAG,CAAC,EAAE,IAAI,CAAC,WAAW,GACrB,UAAU,CAAC,CAAC,CAAC;IAgehB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,OAAO,EAC3B,QAAQ,EAAE,mBAAmB,CAAC,0BAA0B,EAAE,OAAO,CAAC,EAClE,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,OAAO,CAAC;IAsDnB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoBxB;;OAEG;IACH,OAAO,CAAC,KAAK;CAGd"}