@remit/backend 2.5.0 → 2.6.1

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

@@ -1,6 +1,6 @@
-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 StoredClassification } from "@remit/data-ports/classification-presets";
+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";
@@ -33,7 +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 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,4 +1,5 @@
-import { CLASSIFICATION_PRESETS, CLASSIFICATION_SETTING_NAMES, } from "@remit/data-ports/classification-presets";
+import { parseAccountSettingValue } from "@remit/data-ports/account-settings";
+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";
@@ -64,11 +65,48 @@ export const decideClassificationProvider = (input, stored) => {
         },
     };
 };
-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/user-settings.js

@@ -4,7 +4,7 @@ import { readStoredClassification } from "@remit/data-ports/classification-prese
 import { AccountSettingName } from "@remit/domain-enums";
 import { logger } from "@remit/logger";
 import { badRequest } from "./calendar.js";
-import { classificationPresetsResponse, clearClassification, decideClassificationChange, publicClassification, 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) => {
@@ -15,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/package.json

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