@remit/backend 2.3.0 → 2.4.0

package/dist/src/handlers/classification-settings.d.ts

@@ -1,7 +1,7 @@
 import type { ClassificationConfigured, ClassificationNotConfigured, ClassificationPreset, UpdateUserSettingsInput } from "@remit/api-openapi-types";
 import type { IAccountSettingRepository } from "@remit/data-ports";
 import { type ClassificationLabelDeps } from "@remit/mailbox-service";
-import { type SecretsService } from "@remit/secrets-service";
+import { type SecretsService, type SerializedEncryptedPayload } from "@remit/secrets-service";
 import type { UserSettingsOutcome } from "./user-settings.js";
 export declare const CLASSIFICATION_SETTING_NAMES: readonly ["ClassificationPresetId", "ClassificationModel", "ClassificationBaseUrl", "ClassificationApiKey", "ClassificationEnabled", "ClassificationDailyLimit"];
 export type ClassificationSettingsDeps = {
@@ -9,7 +9,9 @@ export type ClassificationSettingsDeps = {
     secrets: Pick<SecretsService, "encrypt">;
     label: ClassificationLabelDeps;
 };
-export type StoredClassification = ClassificationNotConfigured | ClassificationConfigured;
+export type StoredClassification = ClassificationNotConfigured | (ClassificationConfigured & {
+    apiKeyCiphertext: SerializedEncryptedPayload | undefined;
+});
 type Refusal = Extract<UserSettingsOutcome, {
     ok: false;
 }>;
@@ -19,6 +21,7 @@ type Decision<T> = {
 } | Refusal;
 type ApiKeyChange = {
     action: "Keep";
+    ciphertext: SerializedEncryptedPayload;
 } | {
     action: "Replace";
     apiKey: string;
@@ -34,6 +37,7 @@ export interface ClassificationProviderSave {
 type ClassificationInput = Pick<UpdateUserSettingsInput, "classificationPresetId" | "classificationModel" | "classificationBaseUrl" | "classificationApiKey" | "classificationEnabled" | "classificationDailyLimit">;
 export declare const decideClassificationProvider: (input: ClassificationInput, stored: StoredClassification) => Decision<ClassificationProviderSave>;
 export declare const readStoredClassification: (accountSetting: Pick<IAccountSettingRepository, "getMany">, accountConfigId: string) => Promise<StoredClassification>;
+export declare const publicClassification: (stored: StoredClassification) => ClassificationNotConfigured | ClassificationConfigured;
 export declare const classificationPresetsResponse: () => ClassificationPreset[];
 interface ClassificationChange {
     provider: ClassificationProviderSave | undefined;

package/dist/src/handlers/classification-settings.js

@@ -43,8 +43,9 @@ const apiKeyFor = (preset, requested, keptKey) => {
     if (requested !== "") {
         return { ok: true, value: { action: "Replace", apiKey: requested } };
     }
-    if (keptKey)
-        return { ok: true, value: { action: "Keep" } };
+    if (keptKey) {
+        return { ok: true, value: { action: "Keep", ciphertext: keptKey } };
+    }
     return refuse("ClassificationApiKeyRequired", `classificationApiKey is required for ${preset.label}`);
 };
 export const decideClassificationProvider = (input, stored) => {
@@ -58,7 +59,7 @@ export const decideClassificationProvider = (input, stored) => {
     const baseUrl = baseUrlFor(preset, (input.classificationBaseUrl ?? kept?.baseUrl ?? "").trim());
     if (!baseUrl.ok)
         return baseUrl;
-    const apiKey = apiKeyFor(preset, (input.classificationApiKey ?? "").trim(), kept?.apiKeySaved ?? false);
+    const apiKey = apiKeyFor(preset, (input.classificationApiKey ?? "").trim(), kept?.apiKeyCiphertext);
     if (!apiKey.ok)
         return apiKey;
     const model = (input.classificationModel ?? kept?.model ?? "").trim();
@@ -86,6 +87,7 @@ export const readStoredClassification = async (accountSetting, accountConfigId)
         const row = settingOf(rows, name);
         return row ? parseAccountSettingValue(name, row.value).value : "";
     };
+    const keyRow = settingOf(rows, AccountSettingName.ClassificationApiKey);
     const enabledRow = settingOf(rows, AccountSettingName.ClassificationEnabled);
     const limitRow = settingOf(rows, AccountSettingName.ClassificationDailyLimit);
     return {
@@ -93,7 +95,10 @@ export const readStoredClassification = async (accountSetting, accountConfigId)
         presetId,
         model: stringOf(AccountSettingName.ClassificationModel),
         baseUrl: stringOf(AccountSettingName.ClassificationBaseUrl),
-        apiKeySaved: settingOf(rows, AccountSettingName.ClassificationApiKey) !== undefined,
+        apiKeySaved: keyRow !== undefined,
+        apiKeyCiphertext: keyRow
+            ? parseAccountSettingValue(AccountSettingName.ClassificationApiKey, keyRow.value).value
+            : undefined,
         enabled: enabledRow
             ? parseAccountSettingValue(AccountSettingName.ClassificationEnabled, enabledRow.value).value
             : false,
@@ -103,6 +108,12 @@ export const readStoredClassification = async (accountSetting, accountConfigId)
         savedAt: presetRow.updatedAt,
     };
 };
+export const publicClassification = (stored) => {
+    if (stored.state === "NotConfigured")
+        return stored;
+    const { apiKeyCiphertext: _ciphertext, ...configured } = stored;
+    return configured;
+};
 export const classificationPresetsResponse = () => Object.values(CLASSIFICATION_PRESETS);
 export const decideClassificationChange = (input, stored) => {
     let provider;

package/dist/src/handlers/classification-test.d.ts

@@ -0,0 +1,17 @@
+import type { ClassificationTestFailed, ClassificationTestInput, ClassificationTestPassed } from "@remit/api-openapi-types";
+import type { IAccountSettingRepository } from "@remit/data-ports";
+import { type ClassifierLogger } from "@remit/mailbox-service/classifier";
+import { type SecretsService } from "@remit/secrets-service";
+import type { UserSettingsOutcome } from "./user-settings.js";
+export interface ClassificationTestDeps {
+    accountSetting: Pick<IAccountSettingRepository, "getMany">;
+    secrets: Pick<SecretsService, "decrypt">;
+    logger: ClassifierLogger;
+}
+export type ClassificationTestOutcome = {
+    ok: true;
+    value: ClassificationTestPassed | ClassificationTestFailed;
+} | Extract<UserSettingsOutcome, {
+    ok: false;
+}>;
+export declare const testClassificationProvider: (deps: ClassificationTestDeps, accountConfigId: string, input: ClassificationTestInput) => Promise<ClassificationTestOutcome>;

package/dist/src/handlers/classification-test.js

@@ -0,0 +1,76 @@
+import { ClassificationFailureKind as FailureKind, ClassificationField as Field, } from "@remit/domain-enums";
+import { CLASSIFIER_LABELS, CLASSIFIER_SAMPLE_MESSAGE, classifyWithProvider, } from "@remit/mailbox-service/classifier";
+import { deserializeEncryptedPayload, } from "@remit/secrets-service";
+import { decideClassificationProvider, readStoredClassification, } from "./classification-settings.js";
+const REACH_FIX = "Check the endpoint runs and the Remit server can reach it";
+const DEFAULT_MODEL_FIX = "Use the preset's default model";
+const FAILURE_HELP = {
+    [FailureKind.Unauthorized]: {
+        field: Field.ApiKey,
+        fix: "Replace the key, save, test again",
+    },
+    [FailureKind.ModelNotFound]: {
+        field: Field.Model,
+        fix: "Check the model name, or empty it for the default",
+    },
+    [FailureKind.RateLimited]: {
+        fix: "Raise the limit at the provider, or lower the daily limit",
+    },
+    [FailureKind.Rejected]: { field: Field.Model, fix: DEFAULT_MODEL_FIX },
+    [FailureKind.ProviderError]: {
+        fix: "The provider is failing; built-in rules cover until it recovers",
+    },
+    [FailureKind.Unreachable]: { field: Field.BaseUrl, fix: REACH_FIX },
+    [FailureKind.TimedOut]: { field: Field.BaseUrl, fix: REACH_FIX },
+    [FailureKind.Unparseable]: { field: Field.Model, fix: DEFAULT_MODEL_FIX },
+};
+const apiKeyOf = (deps, save) => {
+    if (save.apiKey.action === "Replace") {
+        return Promise.resolve(save.apiKey.apiKey);
+    }
+    if (save.apiKey.action === "Keep") {
+        return deps.secrets.decrypt(deserializeEncryptedPayload(save.apiKey.ciphertext));
+    }
+    return Promise.resolve("");
+};
+const topScore = (scores) => scores.reduce((best, score) => score.confidence > best.confidence ? score : best);
+const answerOf = (result) => {
+    if (result.ok) {
+        const top = topScore(result.scores);
+        return {
+            state: "Passed",
+            latencyMs: result.latencyMs,
+            label: top.label,
+            confidence: top.confidence,
+        };
+    }
+    return {
+        state: "Failed",
+        latencyMs: result.latencyMs,
+        ...(result.status === undefined ? {} : { status: result.status }),
+        kind: result.kind,
+        ...FAILURE_HELP[result.kind],
+    };
+};
+export const testClassificationProvider = async (deps, accountConfigId, input) => {
+    const decided = decideClassificationProvider({
+        classificationPresetId: input.presetId,
+        classificationModel: input.model,
+        classificationBaseUrl: input.baseUrl,
+        classificationApiKey: input.apiKey,
+    }, await readStoredClassification(deps.accountSetting, accountConfigId));
+    if (!decided.ok)
+        return decided;
+    const save = decided.value;
+    const result = await classifyWithProvider({
+        provider: {
+            adapterShape: save.preset.adapterShape,
+            baseUrl: save.baseUrl,
+            model: save.model,
+            apiKey: await apiKeyOf(deps, save),
+        },
+        labels: CLASSIFIER_LABELS,
+        message: CLASSIFIER_SAMPLE_MESSAGE,
+    }, { logger: deps.logger });
+    return { ok: true, value: answerOf(result) };
+};

package/dist/src/handlers/index.d.ts

@@ -125,6 +125,7 @@ export declare const handlers: {
     UserSettingsOperations_getUserSettings: OperationHandler<import("../types.js").UserSettingsOperationIds>;
     UserSettingsOperations_updateUserSettings: OperationHandler<import("../types.js").UserSettingsOperationIds>;
     UserSettingsOperations_clearClassificationProvider: OperationHandler<import("../types.js").UserSettingsOperationIds>;
+    UserSettingsOperations_testClassificationProvider: OperationHandler<import("../types.js").UserSettingsOperationIds>;
     UserSettingsOperations_clearDefaultInvitationSender: OperationHandler<import("../types.js").UserSettingsOperationIds>;
     CalendarFreeBusyOperations_listCalendarFreeBusy: OperationHandler<"CalendarFreeBusyOperations_listCalendarFreeBusy">;
     CalendarEventDetailOperations_getCalendarEvent: OperationHandler<import("../types.js").CalendarEventDetailOperationIds, "smtp">;

package/dist/src/handlers/user-settings.js

@@ -1,8 +1,10 @@
 import { invitationSenderInEffect, sendingAccountFor, } from "@remit/calendar-service";
 import { parseAccountSettingValue } from "@remit/data-ports/account-settings";
 import { AccountSettingName } from "@remit/domain-enums";
+import { logger } from "@remit/logger";
 import { badRequest } from "./calendar.js";
-import { classificationPresetsResponse, clearClassification, decideClassificationChange, readStoredClassification, writeClassificationChange, } from "./classification-settings.js";
+import { classificationPresetsResponse, clearClassification, decideClassificationChange, publicClassification, readStoredClassification, writeClassificationChange, } from "./classification-settings.js";
+import { testClassificationProvider } from "./classification-test.js";
 /** The account the reader chose to send invitations from, if they chose one. */
 export const chosenInvitationSender = async (accountSetting, accountConfigId) => {
     const stored = await accountSetting.get(accountConfigId, AccountSettingName.DefaultInvitationSenderAccountId);
@@ -17,7 +19,7 @@ export const readUserSettings = async (deps, accountConfigId) => {
         ...(inEffect && { defaultInvitationSenderAccountId: inEffect.accountId }),
         defaultInvitationSenderChosen: inEffect !== undefined && inEffect.accountId === chosen,
         classificationPresets: classificationPresetsResponse(),
-        classification: await readStoredClassification(deps.accountSetting, accountConfigId),
+        classification: publicClassification(await readStoredClassification(deps.accountSetting, accountConfigId)),
     };
 };
 export const updateUserSettingsFor = async (deps, accountConfigId, input) => {
@@ -68,4 +70,14 @@ export const UserSettingsOperations = {
         await clearClassification(deps.accountSetting, ctx.identity.accountConfigId);
         return readUserSettings(deps, ctx.identity.accountConfigId);
     },
+    UserSettingsOperations_testClassificationProvider: async (context, ctx) => {
+        const tested = await testClassificationProvider({
+            accountSetting: ctx.client.accountSetting,
+            secrets: ctx.client.secrets,
+            logger,
+        }, ctx.identity.accountConfigId, context.request.requestBody);
+        if (!tested.ok)
+            return badRequest(tested.error);
+        return tested.value;
+    },
 };

package/dist/src/types.d.ts

@@ -3,7 +3,7 @@ import type { ApiConfig } from "./config/api-config.js";
 import type { RemitClient } from "./service/create-remit-client.js";
 import type { QueueName } from "./service/queues.js";
 type MatchPrefix<Prefix extends string, S extends string> = S extends `${Prefix}${infer _}` ? S : never;
-export type OperationIds = "MeOperations_deleteMe" | "MeOperations_listVipSuggestions" | "MeOperations_createExport" | "MeOperations_getExport" | "MeOperations_listQuarantine" | "ConfigOperations_getConfig" | "ConfigOperations_exportConfig" | "ConfigOperations_importConfig" | "SystemOperations_getSystemUpdate" | "SystemOperations_applySystemUpdate" | "PeopleOperations_listPeople" | "PeopleOperations_createStepUp" | "PeopleOperations_signOutPerson" | "PeopleOperations_updatePerson" | "PeopleOperations_createPasswordReset" | "AccountOperations_createAccount" | "AccountOperations_testConnection" | "AccountDetailOperations_updateAccount" | "AccountDetailOperations_deleteAccount" | "MicrosoftOAuthOperations_microsoftOAuthStart" | "MicrosoftOAuthOperations_microsoftOAuthCallback" | "MailboxOperations_listMailboxes" | "MailboxOperations_createMailbox" | "MailboxDetailOperations_getMailbox" | "MailboxDetailOperations_renameMailbox" | "MailboxDetailOperations_deleteMailbox" | "FolderRoleOperations_appointFolderRole" | "FilterOperations_listFilters" | "FilterOperations_createFilter" | "FilterDetailOperations_getFilter" | "FilterDetailOperations_updateFilter" | "FilterDetailOperations_deleteFilter" | "LabelOperations_listLabels" | "LabelOperations_createLabel" | "LabelDetailOperations_getLabel" | "LabelDetailOperations_updateLabel" | "LabelDetailOperations_deleteLabel" | "OrganizeOperations_createOrganizeJob" | "OrganizeOperations_previewOrganize" | "OrganizeJobDetailOperations_getOrganizeJob" | "SyncOperations_triggerSync" | "SyncOperations_getSyncStatus" | "ThreadDetailOperations_listThreadMessages" | "UnifiedThreadOperations_listAllThreads" | "ThreadOperations_listThreads" | "ThreadOperations_searchThreads" | "MessageOperations_describeMessage" | "MessageOperations_getRawMessage" | "MessageOperations_updateMessageFlags" | "MessageBulkOperations_deleteMessages" | "MessageBulkOperations_moveMessages" | "MessageBulkOperations_updateFlags" | "MessageBulkOperations_copyMessages" | "MessageBulkOperations_updateMessageLabels" | "MessageBulkOperations_reportSpam" | "MessageBulkOperations_notSpam" | "CalendarOperations_listCalendars" | "CalendarOperations_createCalendar" | "CalendarDetailOperations_getCalendar" | "CalendarDetailOperations_updateCalendar" | "CalendarDetailOperations_deleteCalendar" | "CalendarDetailOperations_getCalendarFeed" | "CalendarDetailOperations_putCalendarFeed" | "CalendarDetailOperations_revokeCalendarFeed" | "CalendarFeedOperations_getCalendarFeedIcal" | "CalendarEventOperations_listCalendarEvents" | "CalendarEventOperations_createCalendarEvent" | "CalendarEventDetailOperations_getCalendarEvent" | "CalendarEventDetailOperations_updateCalendarEvent" | "CalendarEventDetailOperations_deleteCalendarEvent" | "CalendarFreeBusyOperations_listCalendarFreeBusy" | "UserSettingsOperations_getUserSettings" | "UserSettingsOperations_updateUserSettings" | "UserSettingsOperations_clearDefaultInvitationSender" | "UserSettingsOperations_clearClassificationProvider" | "CalendarTaskOperations_listCalendarTasks" | "CalendarTaskOperations_createCalendarTask" | "CalendarTaskDetailOperations_getCalendarTask" | "CalendarTaskDetailOperations_updateCalendarTask" | "CalendarTaskDetailOperations_deleteCalendarTask" | "TrashOperations_emptyTrash" | "OutboxOperations_createOutboxMessage" | "OutboxOperations_listOutboxMessages" | "OutboxDetailOperations_getOutboxMessage" | "OutboxDetailOperations_updateOutboxMessage" | "OutboxDetailOperations_deleteOutboxMessage" | "OutboxDetailOperations_sendOutboxMessage" | "OutboxDetailOperations_mintOutboxAttachment" | "OutboxAttachmentOperations_completeOutboxAttachment" | "AddressOperations_searchAddresses" | "AddressDetailOperations_updateAddress" | "CalendarSuggestionOperations_listCalendarSuggestions" | "MessageCalendarSuggestionOperations_listMessageCalendarSuggestions" | "CalendarSuggestionActionOperations_acceptCalendarSuggestion" | "CalendarSuggestionActionOperations_declineCalendarSuggestion" | "CalendarSuggestionActionOperations_dismissCalendarSuggestion" | "CalendarSuggestionActionOperations_reopenCalendarSuggestion";
+export type OperationIds = "MeOperations_deleteMe" | "MeOperations_listVipSuggestions" | "MeOperations_createExport" | "MeOperations_getExport" | "MeOperations_listQuarantine" | "ConfigOperations_getConfig" | "ConfigOperations_exportConfig" | "ConfigOperations_importConfig" | "SystemOperations_getSystemUpdate" | "SystemOperations_applySystemUpdate" | "PeopleOperations_listPeople" | "PeopleOperations_createStepUp" | "PeopleOperations_signOutPerson" | "PeopleOperations_updatePerson" | "PeopleOperations_createPasswordReset" | "AccountOperations_createAccount" | "AccountOperations_testConnection" | "AccountDetailOperations_updateAccount" | "AccountDetailOperations_deleteAccount" | "MicrosoftOAuthOperations_microsoftOAuthStart" | "MicrosoftOAuthOperations_microsoftOAuthCallback" | "MailboxOperations_listMailboxes" | "MailboxOperations_createMailbox" | "MailboxDetailOperations_getMailbox" | "MailboxDetailOperations_renameMailbox" | "MailboxDetailOperations_deleteMailbox" | "FolderRoleOperations_appointFolderRole" | "FilterOperations_listFilters" | "FilterOperations_createFilter" | "FilterDetailOperations_getFilter" | "FilterDetailOperations_updateFilter" | "FilterDetailOperations_deleteFilter" | "LabelOperations_listLabels" | "LabelOperations_createLabel" | "LabelDetailOperations_getLabel" | "LabelDetailOperations_updateLabel" | "LabelDetailOperations_deleteLabel" | "OrganizeOperations_createOrganizeJob" | "OrganizeOperations_previewOrganize" | "OrganizeJobDetailOperations_getOrganizeJob" | "SyncOperations_triggerSync" | "SyncOperations_getSyncStatus" | "ThreadDetailOperations_listThreadMessages" | "UnifiedThreadOperations_listAllThreads" | "ThreadOperations_listThreads" | "ThreadOperations_searchThreads" | "MessageOperations_describeMessage" | "MessageOperations_getRawMessage" | "MessageOperations_updateMessageFlags" | "MessageBulkOperations_deleteMessages" | "MessageBulkOperations_moveMessages" | "MessageBulkOperations_updateFlags" | "MessageBulkOperations_copyMessages" | "MessageBulkOperations_updateMessageLabels" | "MessageBulkOperations_reportSpam" | "MessageBulkOperations_notSpam" | "CalendarOperations_listCalendars" | "CalendarOperations_createCalendar" | "CalendarDetailOperations_getCalendar" | "CalendarDetailOperations_updateCalendar" | "CalendarDetailOperations_deleteCalendar" | "CalendarDetailOperations_getCalendarFeed" | "CalendarDetailOperations_putCalendarFeed" | "CalendarDetailOperations_revokeCalendarFeed" | "CalendarFeedOperations_getCalendarFeedIcal" | "CalendarEventOperations_listCalendarEvents" | "CalendarEventOperations_createCalendarEvent" | "CalendarEventDetailOperations_getCalendarEvent" | "CalendarEventDetailOperations_updateCalendarEvent" | "CalendarEventDetailOperations_deleteCalendarEvent" | "CalendarFreeBusyOperations_listCalendarFreeBusy" | "UserSettingsOperations_getUserSettings" | "UserSettingsOperations_updateUserSettings" | "UserSettingsOperations_clearDefaultInvitationSender" | "UserSettingsOperations_clearClassificationProvider" | "UserSettingsOperations_testClassificationProvider" | "CalendarTaskOperations_listCalendarTasks" | "CalendarTaskOperations_createCalendarTask" | "CalendarTaskDetailOperations_getCalendarTask" | "CalendarTaskDetailOperations_updateCalendarTask" | "CalendarTaskDetailOperations_deleteCalendarTask" | "TrashOperations_emptyTrash" | "OutboxOperations_createOutboxMessage" | "OutboxOperations_listOutboxMessages" | "OutboxDetailOperations_getOutboxMessage" | "OutboxDetailOperations_updateOutboxMessage" | "OutboxDetailOperations_deleteOutboxMessage" | "OutboxDetailOperations_sendOutboxMessage" | "OutboxDetailOperations_mintOutboxAttachment" | "OutboxAttachmentOperations_completeOutboxAttachment" | "AddressOperations_searchAddresses" | "AddressDetailOperations_updateAddress" | "CalendarSuggestionOperations_listCalendarSuggestions" | "MessageCalendarSuggestionOperations_listMessageCalendarSuggestions" | "CalendarSuggestionActionOperations_acceptCalendarSuggestion" | "CalendarSuggestionActionOperations_declineCalendarSuggestion" | "CalendarSuggestionActionOperations_dismissCalendarSuggestion" | "CalendarSuggestionActionOperations_reopenCalendarSuggestion";
 export type MeOperationIds = MatchPrefix<"MeOperations_", OperationIds>;
 export type ConfigOperationIds = MatchPrefix<"ConfigOperations_", OperationIds>;
 export type SystemOperationIds = MatchPrefix<"SystemOperations_", OperationIds>;

package/package.json

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