@remit/imap-worker 0.0.93 → 0.0.94

package/dist/lifecycle-connection-scope.d.ts

@@ -0,0 +1,24 @@
+import type { ConnectionScopeFactory } from "@remit/backend/create-remit-client";
+import type { AccountItem } from "@remit/data-ports";
+import { ConflictError } from "@remit/data-ports/errors";
+import type { Logger } from "@remit/logger";
+import type { ConnectionScope } from "@remit/mailbox-service";
+import type { MailCredentials } from "@remit/mailbox-service/types";
+import type { TokenService } from "./context.js";
+/**
+ * The account holds no credential a connection can be opened with: it stores
+ * none, or its OAuth consent was withdrawn. The account has already been
+ * flipped to the state that says so; the caller has to reconnect it.
+ */
+export declare class AccountNeedsReconnectError extends ConflictError {
+    name: string;
+    constructor(accountId: string);
+}
+export type OpenConnection = (account: AccountItem, credentials: MailCredentials) => ConnectionScope | Promise<ConnectionScope>;
+/**
+ * The read path's connection scope, resolving credentials under the same OAuth
+ * lifecycle the queue handlers run: a rotated refresh token is persisted, and a
+ * revoked token or a missing credential flips the account's connection state
+ * and answers 409 instead of surfacing as a 500.
+ */
+export declare const lifecycleConnectionScope: (tokenService: TokenService, open: OpenConnection, log: Logger) => ConnectionScopeFactory;

package/dist/lifecycle-connection-scope.js

@@ -0,0 +1,35 @@
+import { ConflictError } from "@remit/data-ports/errors";
+import { withOAuthLifecycle } from "./with-oauth-lifecycle.js";
+import { buildLifecycleDeps } from "./with-oauth-lifecycle-deps.js";
+/**
+ * The account holds no credential a connection can be opened with: it stores
+ * none, or its OAuth consent was withdrawn. The account has already been
+ * flipped to the state that says so; the caller has to reconnect it.
+ */
+export class AccountNeedsReconnectError extends ConflictError {
+    name = "AccountNeedsReconnectError";
+    constructor(accountId) {
+        super(`Account ${accountId} has to be reconnected before it can be read`);
+        this.publicApiError = {
+            code: "account_needs_reconnect",
+            details: { accountId },
+        };
+    }
+}
+/**
+ * The read path's connection scope, resolving credentials under the same OAuth
+ * lifecycle the queue handlers run: a rotated refresh token is persisted, and a
+ * revoked token or a missing credential flips the account's connection state
+ * and answers 409 instead of surfacing as a 500.
+ */
+export const lifecycleConnectionScope = (tokenService, open, log) => (accountService, secrets) => async (accountId) => {
+    const account = await accountService.get(accountId);
+    const opened = [];
+    await withOAuthLifecycle(buildLifecycleDeps(secrets, accountService, tokenService), account, log, async (credentials) => {
+        opened.push(await open(account, credentials));
+    });
+    const [scope] = opened;
+    if (scope === undefined)
+        throw new AccountNeedsReconnectError(accountId);
+    return scope;
+};

package/dist/process.d.ts

@@ -2,5 +2,6 @@ export type { ConnectionScope } from "@remit/mailbox-service";
 export { type BorrowedConnection, type ConnectImap, type ConnectionPool, type ConnectionPoolOptions, createConnectionPool, type PoolAccount, type PoolOverflow, } from "./connection-pool.js";
 export { type AccountObjectPage, type AccountObjectStore, type AttemptBudgets, DEFAULT_MAILBOX_FRESHNESS_MS, defaultImapWorkerConfig, type ImapFailureKind, type ImapWorkerConfig, type ImapWorkerQueueName, type ProcessContext, type TokenService, type WorkerMetrics, } from "./context.js";
 export type { ImapEvent, WorkerEvent } from "./events.js";
+export { AccountNeedsReconnectError, lifecycleConnectionScope, type OpenConnection, } from "./lifecycle-connection-scope.js";
 export { processEvent } from "./processor.js";
 export type { WorkerQueues } from "./queues.js";

package/dist/process.js

@@ -1,3 +1,4 @@
 export { createConnectionPool, } from "./connection-pool.js";
 export { DEFAULT_MAILBOX_FRESHNESS_MS, defaultImapWorkerConfig, } from "./context.js";
+export { AccountNeedsReconnectError, lifecycleConnectionScope, } from "./lifecycle-connection-scope.js";
 export { processEvent } from "./processor.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remit/imap-worker",
-	"version": "0.0.93",
+	"version": "0.0.94",
 	"type": "module",
 	"main": "dist/index.js",
 	"exports": {