@remit/backend 2.6.2 → 2.7.0

package/dist/src/config/classification-default.d.ts

@@ -0,0 +1,2 @@
+import { type ClassificationDeploymentDefault } from "@remit/data-ports/classification-presets";
+export declare const classificationDefaultFromEnv: (env: NodeJS.ProcessEnv) => ClassificationDeploymentDefault;

package/dist/src/config/classification-default.js

@@ -0,0 +1,54 @@
+import { CLASSIFICATION_PRESETS, DEFAULT_CLASSIFICATION_DAILY_LIMIT, isClassificationPresetId, } from "@remit/data-ports/classification-presets";
+const PRESET = "CLASSIFICATION_DEFAULT_PRESET";
+const MODEL = "CLASSIFICATION_DEFAULT_MODEL";
+const BASE_URL = "CLASSIFICATION_DEFAULT_BASE_URL";
+const API_KEY = "CLASSIFICATION_DEFAULT_API_KEY";
+const ENABLED = "CLASSIFICATION_DEFAULT_ENABLED";
+const DAILY_LIMIT = "CLASSIFICATION_DEFAULT_DAILY_LIMIT";
+const DEPENDENT_KEYS = [MODEL, BASE_URL, API_KEY, ENABLED, DAILY_LIMIT];
+const refuse = (message) => {
+    throw new Error(`Refusing to start: ${message}`);
+};
+const envValue = (env, key) => (env[key] ?? "").trim();
+const enabledOf = (raw) => {
+    if (raw === "" || raw === "false")
+        return false;
+    if (raw === "true")
+        return true;
+    return refuse(`${ENABLED}=${raw} must be true or false.`);
+};
+const dailyLimitOf = (raw) => {
+    if (raw === "")
+        return DEFAULT_CLASSIFICATION_DAILY_LIMIT;
+    const limit = Number(raw);
+    if (/^\d+$/.test(raw) && Number.isSafeInteger(limit) && limit > 0)
+        return limit;
+    return refuse(`${DAILY_LIMIT}=${raw} must be a positive integer.`);
+};
+export const classificationDefaultFromEnv = (env) => {
+    const presetId = envValue(env, PRESET);
+    if (presetId === "") {
+        const stray = DEPENDENT_KEYS.filter((key) => envValue(env, key) !== "");
+        if (stray.length > 0)
+            return refuse(`${stray.join(", ")} set without ${PRESET}.`);
+        return { state: "None" };
+    }
+    if (!isClassificationPresetId(presetId))
+        return refuse(`${PRESET}=${presetId} is not a known preset. Use one of ${Object.keys(CLASSIFICATION_PRESETS).join(", ")}.`);
+    const preset = CLASSIFICATION_PRESETS[presetId];
+    const apiKey = envValue(env, API_KEY);
+    if (preset.needsKey && apiKey === "")
+        return refuse(`${API_KEY} is not set. ${PRESET}=${presetId} needs a key.`);
+    const baseUrl = envValue(env, BASE_URL) || preset.defaultBaseUrl;
+    if (!baseUrl)
+        return refuse(`${BASE_URL} is not set. ${PRESET}=${presetId} has no default base URL.`);
+    return {
+        state: "Configured",
+        presetId,
+        model: envValue(env, MODEL) || preset.defaultModel,
+        baseUrl,
+        apiKey,
+        enabled: enabledOf(envValue(env, ENABLED)),
+        dailyLimit: dailyLimitOf(envValue(env, DAILY_LIMIT)),
+    };
+};

package/dist/src/service/compose-sqlite.d.ts

@@ -1,3 +1,4 @@
+import type { ClassificationDeploymentDefault } from "@remit/data-ports/classification-presets";
 import { type RemitClient, type RemitClientSharedDeps } from "./create-remit-client.js";
 export declare const composeSqliteClient: (shared: RemitClientSharedDeps) => Promise<RemitClient>;
-export declare const buildSqliteClient: () => Promise<RemitClient>;
+export declare const buildSqliteClient: (classificationDefault: ClassificationDeploymentDefault) => Promise<RemitClient>;

package/dist/src/service/compose-sqlite.js

@@ -12,4 +12,4 @@ export const composeSqliteClient = async (shared) => {
         ...shared,
     });
 };
-export const buildSqliteClient = () => composeSqliteClient(buildSharedDeps(sqsQueues(sqsQueueUrlsFromEnv())));
+export const buildSqliteClient = (classificationDefault) => composeSqliteClient(buildSharedDeps(sqsQueues(sqsQueueUrlsFromEnv()), classificationDefault));

package/dist/src/service/create-remit-client.d.ts

@@ -1,4 +1,5 @@
 import type { IAccountConfigRepository, IAccountExportRequestRepository, IAccountRepository, IAccountSettingRepository, IAddressRepository, ICalendarCollectionRepository, ICalendarEventIndexRepository, ICalendarFeedTokenRepository, ICalendarObjectRepository, ICalendarStore, ICalendarSuggestionRepository, ICalendarTaskRepository, IConfigImportRepository, IEnvelopeRepository, IFilterRepository, ILabelRepository, IMailboxLockRepository, IMailboxRepository, IMailboxSpecialUseRepository, IMessageFlagPushRepository, IMessageFlagRepository, IMessageLabelRepository, IMessagePlacementMoveRepository, IMessageRepository, IOrganizeJobRequestRepository, IOutboxAttachmentRepository, IOutboxMessageRepository, IOutboxSchedulingPartRepository, IQuarantineRepository, ISenderSignerStandingRepository, ISyncWarningRepository, IThreadMessageRepository } from "@remit/data-ports";
+import type { ClassificationDeploymentDefault } from "@remit/data-ports/classification-presets";
 import { BodySyncQueueService, BodySyncService, type ConnectionScope, type FilterConfig, FlagQueueService, type ImapTransport, MailboxQueueService, MessageMoveService, OutboxAttachmentService, OutboxQueueService, SpamReportService } from "@remit/mailbox-service";
 import { type SecretsService } from "@remit/secrets-service";
 import type { SmtpGetSocket } from "@remit/smtp-service";
@@ -47,6 +48,7 @@ export interface RemitClientCore {
     outboxAttachment: OutboxAttachmentService;
     createConnectionScope: (accountId: string) => Promise<ConnectionScope>;
     mailTransports: MailTransports;
+    classificationDefault: ClassificationDeploymentDefault;
 }
 export interface SyncQueueServices {
     flagQueue: FlagQueueService;
@@ -106,6 +108,7 @@ export interface RemitClientSharedDeps {
     connectionScope: ConnectionScopeFactory;
     mailTransports: MailTransports;
     queues: RemitClientQueues;
+    classificationDefault: ClassificationDeploymentDefault;
 }
 export interface RemitClientDeps extends RemitClientSharedDeps {
     repositories: RemitClientRepositories;

package/dist/src/service/create-remit-client.js

@@ -45,7 +45,7 @@ export const buildReadPathFilterConfig = (repositories, queues) => {
     });
 };
 export const createRemitCore = (deps) => {
-    const { repositories, storage, secrets, connectionScope, mailTransports } = deps;
+    const { repositories, storage, secrets, connectionScope, mailTransports, classificationDefault, } = deps;
     return {
         accountConfig: repositories.accountConfig,
         account: repositories.account,
@@ -90,6 +90,7 @@ export const createRemitCore = (deps) => {
         }),
         createConnectionScope: connectionScope(repositories.account, secrets),
         mailTransports,
+        classificationDefault,
     };
 };
 export const composeSyncServices = (core, queues) => {

package/dist/src/service/data-client.js

@@ -1,5 +1,7 @@
+import { classificationDefaultFromEnv } from "../config/classification-default.js";
 let clientPromise = null;
 let injected = null;
+const classificationDefault = classificationDefaultFromEnv(process.env);
 /**
  * Register the client from the composition root. An adapter that lives outside
  * this shared, open-core module — DynamoDB, or a Postgres adapter in the
@@ -27,7 +29,7 @@ const buildRelationalClient = async () => {
         throw new Error("no client registered — register one with setClient() from your composition root");
     }
     const composition = await import("./compose-sqlite.js");
-    return composition.buildSqliteClient();
+    return composition.buildSqliteClient(classificationDefault);
 };
 export const getClient = () => {
     clientPromise ??= injected

package/dist/src/service/shared-deps.d.ts

@@ -1,6 +1,7 @@
+import type { ClassificationDeploymentDefault } from "@remit/data-ports/classification-presets";
 import { type RemitClientSharedDeps } from "./create-remit-client.js";
 import type { QueueName, RemitClientQueues } from "./queues.js";
 export type SqsQueueUrls = Record<QueueName, string>;
 export declare const sqsQueueUrlsFromEnv: () => SqsQueueUrls;
 export declare const sqsQueues: (urls: SqsQueueUrls) => RemitClientQueues;
-export declare const buildSharedDeps: (queues: RemitClientQueues) => RemitClientSharedDeps;
+export declare const buildSharedDeps: (queues: RemitClientQueues, classificationDefault: ClassificationDeploymentDefault) => RemitClientSharedDeps;

package/dist/src/service/shared-deps.js

@@ -22,7 +22,7 @@ export const sqsQueues = (urls) => ({
     }),
     body: createStandardQueueProducer({ queueUrl: urls.body }),
 });
-export const buildSharedDeps = (queues) => {
+export const buildSharedDeps = (queues, classificationDefault) => {
     const imapTransport = nodeTransport();
     return {
         storage: createStorageService(),
@@ -30,5 +30,6 @@ export const buildSharedDeps = (queues) => {
         connectionScope: passwordConnectionScope(imapTransport),
         mailTransports: { imap: () => imapTransport, smtp: directSmtpSocket },
         queues,
+        classificationDefault,
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remit/backend",
-	"version": "2.6.2",
+	"version": "2.7.0",
 	"description": "Remit Mail Inspector API backend",
 	"license": "MIT",
 	"author": "",