@remit/backend 2.4.0 → 2.6.0

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

@@ -1,17 +1,14 @@
-import type { ClassificationConfigured, ClassificationNotConfigured, ClassificationPreset, UpdateUserSettingsInput } from "@remit/api-openapi-types";
+import type { ClassificationConfigured, ClassificationNotConfigured, ClassificationPreset, ClassificationUsage, UpdateUserSettingsInput } from "@remit/api-openapi-types";
 import type { IAccountSettingRepository } from "@remit/data-ports";
+import { type SavedClassificationProvider, type StoredClassification } from "@remit/data-ports/classification-presets";
 import { type ClassificationLabelDeps } from "@remit/mailbox-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 = {
     accountSetting: Pick<IAccountSettingRepository, "getMany" | "upsert" | "delete">;
     secrets: Pick<SecretsService, "encrypt">;
     label: ClassificationLabelDeps;
 };
-export type StoredClassification = ClassificationNotConfigured | (ClassificationConfigured & {
-    apiKeyCiphertext: SerializedEncryptedPayload | undefined;
-});
 type Refusal = Extract<UserSettingsOutcome, {
     ok: false;
 }>;
@@ -36,8 +33,8 @@ 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 publicClassification: (stored: StoredClassification, usage: ClassificationUsage[]) => ClassificationNotConfigured | ClassificationConfigured;
+export declare const readClassificationUsage: (accountSetting: Pick<IAccountSettingRepository, "getMany">, accountConfigId: string, accountIds: readonly string[], saved: Pick<SavedClassificationProvider, "presetId" | "dailyLimit">, now: number) => Promise<ClassificationUsage[]>;
 export declare const classificationPresetsResponse: () => ClassificationPreset[];
 interface ClassificationChange {
     provider: ClassificationProviderSave | undefined;

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

@@ -1,16 +1,8 @@
 import { parseAccountSettingValue } from "@remit/data-ports/account-settings";
-import { CLASSIFICATION_PRESETS, DEFAULT_CLASSIFICATION_DAILY_LIMIT, isClassificationPresetId, } from "@remit/data-ports/classification-presets";
+import { CLASSIFICATION_PRESETS, CLASSIFICATION_SETTING_NAMES, classificationUsageName, utcDateOf, } from "@remit/data-ports/classification-presets";
 import { AccountSettingName } from "@remit/domain-enums";
 import { ensureClassificationLabels, } from "@remit/mailbox-service";
 import { serializeEncryptedPayload, } from "@remit/secrets-service";
-export const CLASSIFICATION_SETTING_NAMES = [
-    AccountSettingName.ClassificationPresetId,
-    AccountSettingName.ClassificationModel,
-    AccountSettingName.ClassificationBaseUrl,
-    AccountSettingName.ClassificationApiKey,
-    AccountSettingName.ClassificationEnabled,
-    AccountSettingName.ClassificationDailyLimit,
-];
 const refuse = (code, message) => ({
     ok: false,
     error: { code, message },
@@ -73,46 +65,48 @@ export const decideClassificationProvider = (input, stored) => {
         },
     };
 };
-const settingOf = (rows, name) => rows.find((row) => row.name === name);
-export const readStoredClassification = async (accountSetting, accountConfigId) => {
-    const rows = await accountSetting.getMany([accountConfigId], CLASSIFICATION_SETTING_NAMES);
-    const presetRow = settingOf(rows, AccountSettingName.ClassificationPresetId);
-    if (!presetRow)
-        return { state: "NotConfigured" };
-    const presetId = parseAccountSettingValue(AccountSettingName.ClassificationPresetId, presetRow.value).value;
-    if (!isClassificationPresetId(presetId)) {
-        throw new Error(`Stored classification preset is unknown: ${presetId}`);
-    }
-    const stringOf = (name) => {
-        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 {
-        state: "Configured",
-        presetId,
-        model: stringOf(AccountSettingName.ClassificationModel),
-        baseUrl: stringOf(AccountSettingName.ClassificationBaseUrl),
-        apiKeySaved: keyRow !== undefined,
-        apiKeyCiphertext: keyRow
-            ? parseAccountSettingValue(AccountSettingName.ClassificationApiKey, keyRow.value).value
-            : undefined,
-        enabled: enabledRow
-            ? parseAccountSettingValue(AccountSettingName.ClassificationEnabled, enabledRow.value).value
-            : false,
-        dailyLimit: limitRow
-            ? parseAccountSettingValue(AccountSettingName.ClassificationDailyLimit, limitRow.value).value
-            : DEFAULT_CLASSIFICATION_DAILY_LIMIT,
-        savedAt: presetRow.updatedAt,
-    };
-};
-export const publicClassification = (stored) => {
+export const publicClassification = (stored, usage) => {
     if (stored.state === "NotConfigured")
         return stored;
     const { apiKeyCiphertext: _ciphertext, ...configured } = stored;
-    return configured;
+    return { ...configured, usage };
+};
+const CLASSIFICATION_INPUT_TOKENS_PER_CALL = 1_500;
+const nextUtcMidnight = (epochMs) => {
+    const now = new Date(epochMs);
+    return new Date(Date.UTC(now.getUTCFullYear(), now.getUTCMonth(), now.getUTCDate() + 1)).toISOString();
+};
+const callsOn = (usage, date) => usage?.date === date ? usage.calls : 0;
+const classificationCost = (preset, calls) => {
+    if (preset.price.state === "NoPrice")
+        return { state: "NoPrice" };
+    return {
+        state: "Priced",
+        currency: preset.price.currency,
+        amount: (calls *
+            CLASSIFICATION_INPUT_TOKENS_PER_CALL *
+            preset.price.perMillionInputTokens) /
+            1_000_000,
+    };
+};
+export const readClassificationUsage = async (accountSetting, accountConfigId, accountIds, saved, now) => {
+    const rows = await accountSetting.getMany([accountConfigId], accountIds.map(classificationUsageName));
+    const today = utcDateOf(now);
+    const resetsAt = nextUtcMidnight(now);
+    const preset = CLASSIFICATION_PRESETS[saved.presetId];
+    return accountIds.map((accountId) => {
+        const row = rows.find((candidate) => candidate.name === classificationUsageName(accountId));
+        const calls = callsOn(row
+            ? parseAccountSettingValue(AccountSettingName.ClassificationUsage, row.value).value
+            : undefined, today);
+        return {
+            accountId,
+            calls,
+            dailyLimit: saved.dailyLimit,
+            resetsAt,
+            cost: classificationCost(preset, calls),
+        };
+    });
 };
 export const classificationPresetsResponse = () => Object.values(CLASSIFICATION_PRESETS);
 export const decideClassificationChange = (input, stored) => {

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

@@ -1,7 +1,8 @@
+import { readStoredClassification } from "@remit/data-ports/classification-presets";
 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";
+import { decideClassificationProvider, } 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 = {

package/dist/src/handlers/message.js

@@ -279,6 +279,7 @@ export const MessageOperations = {
                 const folder = {
                     mailboxId: mailbox.mailboxId,
                     fullPath: mailbox.fullPath,
+                    initialSyncCompletedAt: mailbox.initialSyncCompletedAt,
                     placement: await resolveFolderPlacement(client.mailboxSpecialUse, accountId, mailbox.mailboxId),
                 };
                 const scope = await client.createConnectionScope(accountId);
@@ -385,6 +386,7 @@ export const MessageOperations = {
                 const folder = {
                     mailboxId: mailbox.mailboxId,
                     fullPath: mailbox.fullPath,
+                    initialSyncCompletedAt: mailbox.initialSyncCompletedAt,
                     placement: await resolveFolderPlacement(client.mailboxSpecialUse, accountId, mailbox.mailboxId),
                 };
                 const scope = await client.createConnectionScope(accountId);

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

@@ -1,9 +1,10 @@
 import { invitationSenderInEffect, sendingAccountFor, } from "@remit/calendar-service";
 import { parseAccountSettingValue } from "@remit/data-ports/account-settings";
+import { readStoredClassification } from "@remit/data-ports/classification-presets";
 import { AccountSettingName } from "@remit/domain-enums";
 import { logger } from "@remit/logger";
 import { badRequest } from "./calendar.js";
-import { classificationPresetsResponse, clearClassification, decideClassificationChange, publicClassification, readStoredClassification, writeClassificationChange, } from "./classification-settings.js";
+import { classificationPresetsResponse, clearClassification, decideClassificationChange, publicClassification, readClassificationUsage, 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) => {
@@ -14,12 +15,17 @@ export const chosenInvitationSender = async (accountSetting, accountConfigId) =>
 };
 export const readUserSettings = async (deps, accountConfigId) => {
     const chosen = await chosenInvitationSender(deps.accountSetting, accountConfigId);
-    const inEffect = invitationSenderInEffect(await deps.accounts.listAllByAccountConfig(accountConfigId), chosen);
+    const accounts = await deps.accounts.listAllByAccountConfig(accountConfigId);
+    const inEffect = invitationSenderInEffect(accounts, chosen);
+    const stored = await readStoredClassification(deps.accountSetting, accountConfigId);
+    const usage = stored.state === "Configured"
+        ? await readClassificationUsage(deps.accountSetting, accountConfigId, accounts.map((account) => account.accountId), stored, Date.now())
+        : [];
     return {
         ...(inEffect && { defaultInvitationSenderAccountId: inEffect.accountId }),
         defaultInvitationSenderChosen: inEffect !== undefined && inEffect.accountId === chosen,
         classificationPresets: classificationPresetsResponse(),
-        classification: publicClassification(await readStoredClassification(deps.accountSetting, accountConfigId)),
+        classification: publicClassification(stored, usage),
     };
 };
 export const updateUserSettingsFor = async (deps, accountConfigId, input) => {

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

@@ -158,6 +158,12 @@ export const composeReadPathServices = (core, queues, sync) => ({
         calendarStore: core.calendarStore,
         filterService: core.filter,
         accountService: core.account,
+    }, {
+        accountSetting: core.accountSetting,
+        secrets: core.secrets,
+        labelService: core.label,
+        messageLabelService: core.messageLabel,
+        logger,
     }),
 });
 export const createRemitClient = (deps) => {

package/package.json

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