@relaybus/postgres 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -190,11 +190,23 @@ interface PostgresConnectionOptions extends PostgresEventStoreSettings {
 /** Use another database library through an adapter. The store never closes it. */
 interface PostgresExecutorOptions<TTransaction> extends PostgresEventStoreSettings {
     readonly executor: PostgresExecutor<TTransaction>;
-    readonly pool?: never;
+    /**
+     * Optional `pg` pool on the same database, for example the one an ORM's `pg` driver adapter uses
+     * (`new PrismaPg(pool)`, Kysely's `PostgresDialect`, Drizzle's `node-postgres`). The store never
+     * closes it. With it:
+     * - the statements the store sends outside a transaction (the dispatcher's claims, completions and
+     *   lease renewals, maintenance) run on it as prepared statements (`preparedStatements`), which ORM
+     *   raw queries cannot do; statements in a transaction still go through `executor`;
+     * - with `wakeUp: 'notify'` the store listens for wake-ups with its connection settings, so a
+     *   delivery published in an ORM transaction is dispatched right after that transaction commits,
+     *   instead of after a fixed delay or the next poll.
+     */
+    readonly pool?: Pool;
     readonly connectionString?: never;
     readonly poolConfig?: never;
 }
 type PostgresEventStoreOptions<TTransaction = PoolClient> = PostgresPoolOptions | PostgresConnectionOptions | PostgresExecutorOptions<TTransaction>;
+
 /**
  * PostgreSQL {@link EventStore} (PostgreSQL 13 or newer).
  *
@@ -329,4 +341,5 @@ declare class ReconcileFailedError extends RelayBusError {
     readonly code: string;
 }
 
-export { PgExecutor, type PgExecutorOptions, type PostgresConnectionOptions, PostgresEventStore, type PostgresEventStoreOptions, type PostgresEventStoreSettings, PostgresExecutor, type PostgresExecutorOptions, type PostgresNames, PostgresParameter, type PostgresPoolOptions, PostgresQueryOptions, PostgresRow, type PostgresSchemaOptions, type PostgresWakeUp, ReconcileFailedError, createPostgresSchemaSql, createPostgresSchemaStatements, resolvePostgresNames };
+export { PgExecutor, PostgresEventStore, PostgresExecutor, PostgresParameter, PostgresQueryOptions, PostgresRow, ReconcileFailedError, createPostgresSchemaSql, createPostgresSchemaStatements, resolvePostgresNames };
+export type { PgExecutorOptions, PostgresConnectionOptions, PostgresEventStoreOptions, PostgresEventStoreSettings, PostgresExecutorOptions, PostgresNames, PostgresPoolOptions, PostgresSchemaOptions, PostgresWakeUp };

package/dist/index.d.ts

@@ -190,11 +190,23 @@ interface PostgresConnectionOptions extends PostgresEventStoreSettings {
 /** Use another database library through an adapter. The store never closes it. */
 interface PostgresExecutorOptions<TTransaction> extends PostgresEventStoreSettings {
     readonly executor: PostgresExecutor<TTransaction>;
-    readonly pool?: never;
+    /**
+     * Optional `pg` pool on the same database, for example the one an ORM's `pg` driver adapter uses
+     * (`new PrismaPg(pool)`, Kysely's `PostgresDialect`, Drizzle's `node-postgres`). The store never
+     * closes it. With it:
+     * - the statements the store sends outside a transaction (the dispatcher's claims, completions and
+     *   lease renewals, maintenance) run on it as prepared statements (`preparedStatements`), which ORM
+     *   raw queries cannot do; statements in a transaction still go through `executor`;
+     * - with `wakeUp: 'notify'` the store listens for wake-ups with its connection settings, so a
+     *   delivery published in an ORM transaction is dispatched right after that transaction commits,
+     *   instead of after a fixed delay or the next poll.
+     */
+    readonly pool?: Pool;
     readonly connectionString?: never;
     readonly poolConfig?: never;
 }
 type PostgresEventStoreOptions<TTransaction = PoolClient> = PostgresPoolOptions | PostgresConnectionOptions | PostgresExecutorOptions<TTransaction>;
+
 /**
  * PostgreSQL {@link EventStore} (PostgreSQL 13 or newer).
  *
@@ -329,4 +341,5 @@ declare class ReconcileFailedError extends RelayBusError {
     readonly code: string;
 }
 
-export { PgExecutor, type PgExecutorOptions, type PostgresConnectionOptions, PostgresEventStore, type PostgresEventStoreOptions, type PostgresEventStoreSettings, PostgresExecutor, type PostgresExecutorOptions, type PostgresNames, PostgresParameter, type PostgresPoolOptions, PostgresQueryOptions, PostgresRow, type PostgresSchemaOptions, type PostgresWakeUp, ReconcileFailedError, createPostgresSchemaSql, createPostgresSchemaStatements, resolvePostgresNames };
+export { PgExecutor, PostgresEventStore, PostgresExecutor, PostgresParameter, PostgresQueryOptions, PostgresRow, ReconcileFailedError, createPostgresSchemaSql, createPostgresSchemaStatements, resolvePostgresNames };
+export type { PgExecutorOptions, PostgresConnectionOptions, PostgresEventStoreOptions, PostgresEventStoreSettings, PostgresExecutorOptions, PostgresNames, PostgresPoolOptions, PostgresSchemaOptions, PostgresWakeUp };