@relaybus/postgres 0.3.1 → 0.4.0

package/dist/index.d.cts

@@ -190,7 +190,18 @@ 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;
 }
@@ -330,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,7 +190,18 @@ 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;
 }
@@ -330,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.js

@@ -491,6 +491,19 @@ var NotificationListener = class {
     await drop?.();
   }
 };
+
+// src/root-pool-executor.ts
+function withRootPool(executor, root) {
+  return {
+    ...executor.sessionTimeouts === void 0 ? {} : { sessionTimeouts: executor.sessionTimeouts },
+    transaction: (work) => executor.transaction(work),
+    ...executor.transactionWithBudget === void 0 ? {} : {
+      transactionWithBudget: (work, timeoutMs) => executor.transactionWithBudget(work, timeoutMs)
+    },
+    // eslint-disable-next-line relaybus/max-two-params -- PostgresExecutor port signature
+    query: (sql, parameters, transaction, options) => transaction === void 0 ? root.query(sql, parameters, void 0, options) : executor.query(sql, parameters, transaction, options)
+  };
+}
 function text(row, column) {
   return row[column];
 }
@@ -1434,7 +1447,7 @@ var PostgresMaintenance = class {
 var WAKE_UPS = ["notify", "poll"];
 var DEFAULT_PURGE_BATCH_SIZE = 1e3;
 function resolveStoreSettings(options) {
-  const sources = [options.pool, options.connectionString, options.executor].filter(
+  const sources = [options.executor ?? options.pool, options.connectionString].filter(
     (source) => source !== void 0
   );
   if (sources.length !== 1) {
@@ -1540,9 +1553,13 @@ WHERE (SELECT count(*) FROM woken) >= 0`;
   RETURNING available_at
 )`;
   }
-  /** One wake-up notification on {@link PostgresNames.notificationChannel}, outside any publishing transaction. */
+  /**
+   * One wake-up notification on {@link PostgresNames.notificationChannel}, outside any publishing
+   * transaction. Returns a boolean column rather than the `void` of `pg_notify`, which some libraries
+   * cannot read (Prisma's raw queries reject a `void` column).
+   */
   get notify() {
-    return `SELECT pg_notify('${this.#names.notificationChannel}', '')`;
+    return `SELECT true AS notified FROM pg_notify('${this.#names.notificationChannel}', '')`;
   }
   /**
    * A CTE `woken` that sends one notification on {@link PostgresNames.notificationChannel} when a row of
@@ -2832,8 +2849,12 @@ var SetupStatements = class {
   WHERE n.nspname = '${this.#names.schema}' AND c.relname = '${this.#names.lanesTableName}' AND d.description = $1::text
 ) AS current`;
   }
+  /**
+   * Takes the setup lock. Returns a boolean column rather than the `void` of the lock function, which
+   * some libraries cannot read (Prisma's raw queries reject a `void` column).
+   */
   get setupLock() {
-    return "SELECT pg_advisory_xact_lock(hashtextextended($1::text, 0))";
+    return "SELECT true AS locked FROM pg_advisory_xact_lock(hashtextextended($1::text, 0))";
   }
 };
 
@@ -3102,7 +3123,12 @@ var PostgresEventStore = class {
 };
 function connect(options, { logger, owned }) {
   if (options.executor !== void 0) {
-    return { executor: options.executor, pool: void 0, ownedPool: void 0 };
+    const { executor: executor2, pool: pool2 } = options;
+    return {
+      executor: pool2 === void 0 ? executor2 : withRootPool(executor2, new PgExecutor(pool2, { logger })),
+      pool: pool2,
+      ownedPool: void 0
+    };
   }
   const pool = options.pool ?? new Pool({
     ...options.poolConfig,