@talkpilot/core-db 1.3.38 → 1.3.39

package/src/talkpilot/clients/clients.quota.getters.ts

@@ -1,119 +1,119 @@
-import { getClientConfig } from "../clientsConfig/clientsConfig.getters";
-import { getClientsCollection } from "./clients.getters";
-import type {
-  ClientQuotaState,
-  QuotaAlertInput,
-} from "./clients.quota.types";
-
-export async function getClientQuotaState(
-  clientId: string,
-): Promise<ClientQuotaState | null> {
-  const [config, client] = await Promise.all([
-    getClientConfig(clientId),
-    getClientsCollection().findOne({ clientId }),
-  ]);
-
-  const usage = config?.quota;
-  if (usage?.totalQuota === undefined || usage?.totalQuota === null) return null;
-
-  const settings = client?.quota;
-
-  return {
-    totalQuota: usage.totalQuota,
-    usedQuota: usage.usedQuota ?? 0,
-    expiresAt: usage.expiresAt,
-    alerts: settings?.alerts,
-    expiredSent: settings?.expiredSent,
-  };
-}
-
-const ensureClientDoc = async (clientId: string): Promise<void> => {
-  const now = new Date();
-  await getClientsCollection().updateOne(
-    { clientId },
-    { $setOnInsert: { clientId, createdAt: now, updatedAt: now, credits: 0 } },
-    { upsert: true },
-  );
-  await getClientsCollection().updateOne({ clientId }, { $set: { updatedAt: now } });
-};
-
-export async function updateQuotaAlertsConfig(
-  clientId: string,
-  alerts: QuotaAlertInput[],
-): Promise<void> {
-  const config = await getClientConfig(clientId);
-  if (!config) {
-    throw new Error(`No client config found for clientId: ${clientId}`);
-  }
-
-  await ensureClientDoc(clientId);
-  const state = await getClientQuotaState(clientId);
-  const existing = state?.alerts ?? [];
-  const sentByThreshold = new Map(
-    existing.filter((a) => a.thresholdSent).map((a) => [a.thresholdPct, true]),
-  );
-  const merged = alerts.map((alert) => ({
-    thresholdPct: alert.thresholdPct,
-    recipientEmails: alert.recipientEmails,
-    ...(sentByThreshold.get(alert.thresholdPct) ? { thresholdSent: true as const } : {}),
-  }));
-
-  const result = await getClientsCollection().updateOne(
-    { clientId },
-    { $set: { "quota.alerts": merged, updatedAt: new Date() } },
-  );
-
-  if (result.matchedCount === 0) {
-    throw new Error(`No client found for clientId: ${clientId}`);
-  }
-}
-
-export async function markQuotaAlertSent(
-  clientId: string,
-  alertIndex: number,
-): Promise<boolean> {
-  await ensureClientDoc(clientId);
-  const result = await getClientsCollection().findOneAndUpdate(
-    {
-      clientId,
-      [`quota.alerts.${alertIndex}.thresholdSent`]: { $ne: true },
-    },
-    { $set: { [`quota.alerts.${alertIndex}.thresholdSent`]: true, updatedAt: new Date() } },
-    { returnDocument: "after" },
-  );
-
-  return result !== null;
-}
-
-export async function markQuotaExpiredSent(clientId: string): Promise<boolean> {
-  await ensureClientDoc(clientId);
-  const result = await getClientsCollection().findOneAndUpdate(
-    {
-      clientId,
-      "quota.expiredSent": { $ne: true },
-    },
-    { $set: { "quota.expiredSent": true, updatedAt: new Date() } },
-    { returnDocument: "after" },
-  );
-
-  return result !== null;
-}
-
-export async function resetClientQuotaSettings(clientId: string): Promise<void> {
-  const client = await getClientsCollection().findOne({ clientId });
-  const alerts =
-    client?.quota?.alerts?.map(({ thresholdSent: _s, ...alert }) => alert) ?? [];
-
-  if (client) {
-    await getClientsCollection().updateOne(
-      { clientId },
-      {
-        $set: {
-          ...(alerts.length ? { "quota.alerts": alerts } : {}),
-          updatedAt: new Date(),
-        },
-        $unset: { "quota.expiredSent": "" },
-      },
-    );
-  }
-}
+import { getClientConfig } from "../clientsConfig/clientsConfig.getters";
+import { getClientsCollection } from "./clients.getters";
+import type {
+  ClientQuotaState,
+  QuotaAlertInput,
+} from "./clients.quota.types";
+
+export async function getClientQuotaState(
+  clientId: string,
+): Promise<ClientQuotaState | null> {
+  const [config, client] = await Promise.all([
+    getClientConfig(clientId),
+    getClientsCollection().findOne({ clientId }),
+  ]);
+
+  const usage = config?.quota;
+  if (usage?.totalQuota === undefined || usage?.totalQuota === null) return null;
+
+  const settings = client?.quota;
+
+  return {
+    totalQuota: usage.totalQuota,
+    usedQuota: usage.usedQuota ?? 0,
+    expiresAt: usage.expiresAt,
+    alerts: settings?.alerts,
+    expiredSent: settings?.expiredSent,
+  };
+}
+
+const ensureClientDoc = async (clientId: string): Promise<void> => {
+  const now = new Date();
+  await getClientsCollection().updateOne(
+    { clientId },
+    { $setOnInsert: { clientId, createdAt: now, updatedAt: now, credits: 0 } },
+    { upsert: true },
+  );
+  await getClientsCollection().updateOne({ clientId }, { $set: { updatedAt: now } });
+};
+
+export async function updateQuotaAlertsConfig(
+  clientId: string,
+  alerts: QuotaAlertInput[],
+): Promise<void> {
+  const config = await getClientConfig(clientId);
+  if (!config) {
+    throw new Error(`No client config found for clientId: ${clientId}`);
+  }
+
+  await ensureClientDoc(clientId);
+  const state = await getClientQuotaState(clientId);
+  const existing = state?.alerts ?? [];
+  const sentByThreshold = new Map(
+    existing.filter((a) => a.thresholdSent).map((a) => [a.thresholdPct, true]),
+  );
+  const merged = alerts.map((alert) => ({
+    thresholdPct: alert.thresholdPct,
+    recipientEmails: alert.recipientEmails,
+    ...(sentByThreshold.get(alert.thresholdPct) ? { thresholdSent: true as const } : {}),
+  }));
+
+  const result = await getClientsCollection().updateOne(
+    { clientId },
+    { $set: { "quota.alerts": merged, updatedAt: new Date() } },
+  );
+
+  if (result.matchedCount === 0) {
+    throw new Error(`No client found for clientId: ${clientId}`);
+  }
+}
+
+export async function markQuotaAlertSent(
+  clientId: string,
+  alertIndex: number,
+): Promise<boolean> {
+  await ensureClientDoc(clientId);
+  const result = await getClientsCollection().findOneAndUpdate(
+    {
+      clientId,
+      [`quota.alerts.${alertIndex}.thresholdSent`]: { $ne: true },
+    },
+    { $set: { [`quota.alerts.${alertIndex}.thresholdSent`]: true, updatedAt: new Date() } },
+    { returnDocument: "after" },
+  );
+
+  return result !== null;
+}
+
+export async function markQuotaExpiredSent(clientId: string): Promise<boolean> {
+  await ensureClientDoc(clientId);
+  const result = await getClientsCollection().findOneAndUpdate(
+    {
+      clientId,
+      "quota.expiredSent": { $ne: true },
+    },
+    { $set: { "quota.expiredSent": true, updatedAt: new Date() } },
+    { returnDocument: "after" },
+  );
+
+  return result !== null;
+}
+
+export async function resetClientQuotaSettings(clientId: string): Promise<void> {
+  const client = await getClientsCollection().findOne({ clientId });
+  const alerts =
+    client?.quota?.alerts?.map(({ thresholdSent: _s, ...alert }) => alert) ?? [];
+
+  if (client) {
+    await getClientsCollection().updateOne(
+      { clientId },
+      {
+        $set: {
+          ...(alerts.length ? { "quota.alerts": alerts } : {}),
+          updatedAt: new Date(),
+        },
+        $unset: { "quota.expiredSent": "" },
+      },
+    );
+  }
+}

package/src/talkpilot/clients/clients.quota.types.ts

@@ -1,27 +1,27 @@
-export type QuotaThresholdAlert = {
-  thresholdPct: number;
-  recipientEmails: string[];
-  thresholdSent?: boolean;
-};
-
-export type ClientQuotaSettings = {
-  /** Up to 3 threshold alerts, each with up to 3 recipient emails. */
-  alerts?: QuotaThresholdAlert[];
-  /** Set after expired-quota email is sent successfully. */
-  expiredSent?: boolean;
-};
-
-export type QuotaAlertInput = {
-  thresholdPct: number;
-  recipientEmails: string[];
-};
-
-export type ClientQuotaUsage = {
-  totalQuota: number;
-  usedQuota: number;
-  expiresAt?: Date;
-  /** Human-readable account label for quota alert emails. */
-  clientDisplayName?: string;
-};
-
-export type ClientQuotaState = ClientQuotaUsage & ClientQuotaSettings;
+export type QuotaThresholdAlert = {
+  thresholdPct: number;
+  recipientEmails: string[];
+  thresholdSent?: boolean;
+};
+
+export type ClientQuotaSettings = {
+  /** Up to 3 threshold alerts, each with up to 3 recipient emails. */
+  alerts?: QuotaThresholdAlert[];
+  /** Set after expired-quota email is sent successfully. */
+  expiredSent?: boolean;
+};
+
+export type QuotaAlertInput = {
+  thresholdPct: number;
+  recipientEmails: string[];
+};
+
+export type ClientQuotaUsage = {
+  totalQuota: number;
+  usedQuota: number;
+  expiresAt?: Date;
+  /** Human-readable account label for quota alert emails. */
+  clientDisplayName?: string;
+};
+
+export type ClientQuotaState = ClientQuotaUsage & ClientQuotaSettings;

package/src/talkpilot/clients/clients.types.ts

@@ -1,18 +1,18 @@
-import { ObjectId } from "mongodb";
-import { ClientQuotaSettings } from "./clients.quota.types";
-
-export type { QuotaThresholdAlert, ClientQuotaSettings, QuotaAlertInput, ClientQuotaUsage, ClientQuotaState } from "./clients.quota.types";
-
-export type Client = {
-  _id?: ObjectId;
-  createdAt: Date;
-  updatedAt: Date;
-  clientId: string;
-  isActive?: boolean | null;
-  apiKey?: string | null;
-  credits: number;
-  managedBy?: string;
-  quota?: ClientQuotaSettings;
-};
-
-export type ClientDoc = Client & { _id: ObjectId };
+import { ObjectId } from "mongodb";
+import { ClientQuotaSettings } from "./clients.quota.types";
+
+export type { QuotaThresholdAlert, ClientQuotaSettings, QuotaAlertInput, ClientQuotaUsage, ClientQuotaState } from "./clients.quota.types";
+
+export type Client = {
+  _id?: ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+  clientId: string;
+  isActive?: boolean | null;
+  apiKey?: string | null;
+  credits: number;
+  managedBy?: string;
+  quota?: ClientQuotaSettings;
+};
+
+export type ClientDoc = Client & { _id: ObjectId };

package/src/talkpilot/clients/index.ts

@@ -1,4 +1,4 @@
-export * from "./clients.getters";
-export * from "./clients.types";
-export * from "./clients.quota.getters";
-export * from "./clients.quota.types";
+export * from "./clients.getters";
+export * from "./clients.types";
+export * from "./clients.quota.getters";
+export * from "./clients.quota.types";

package/src/talkpilot/clientsConfig/__tests__/clientsConfig.getters.spec.ts

@@ -5,7 +5,15 @@ import {
   updateActiveScanId,
   clearActiveScanId,
   updateProductConfig,
+  getActiveScanIds,
+  addActiveScanId,
+  removeActiveScanId,
+  getPrimaryScanId,
+  setPrimaryScanId,
+  clearPrimaryScanId,
 } from "../clientsConfig.getters";
+import { MAX_ACTIVE_SCANS } from "../clientsConfig.constants";
+import { createClientConfig } from "../../../test-utils/factories/talkpilot/clientsConfig";
 
 describe("updateProductConfig", () => {
   beforeEach(async () => {
@@ -103,3 +111,313 @@ describe("activeScanId", () => {
     expect(await getActiveScanId(clientId)).toBeUndefined();
   });
 });
+
+describe("activeScanIds (CP-1628)", () => {
+  beforeEach(async () => {
+    await getClientsConfigCollection().deleteMany({});
+  });
+
+  afterEach(async () => {
+    await getClientsConfigCollection().deleteMany({});
+  });
+
+  it("returns an empty list when nothing is set", async () => {
+    const clientId = "client-list-1";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: { companyName: "X", timezone: "UTC", language: "he" },
+        },
+      }),
+    );
+
+    expect(await getActiveScanIds(clientId)).toEqual([]);
+  });
+
+  it("falls back to wrapping the legacy activeScanId when activeScanIds is absent", async () => {
+    const clientId = "client-list-2";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanId: "scan-legacy",
+          },
+        },
+      }),
+    );
+
+    expect(await getActiveScanIds(clientId)).toEqual(["scan-legacy"]);
+  });
+
+  it("adds a scan id and returns it from getActiveScanIds", async () => {
+    const clientId = "client-list-3";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: { companyName: "X", timezone: "UTC", language: "he" },
+        },
+      }),
+    );
+
+    await addActiveScanId(clientId, "scan-a");
+    await addActiveScanId(clientId, "scan-b");
+
+    expect(await getActiveScanIds(clientId)).toEqual(["scan-a", "scan-b"]);
+  });
+
+  it("does not duplicate an already-present scan id, and does not count it against the cap", async () => {
+    const clientId = "client-list-4";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanIds: ["scan-a", "scan-b", "scan-c"],
+          },
+        },
+      }),
+    );
+
+    await expect(addActiveScanId(clientId, "scan-a")).resolves.toBeUndefined();
+    expect(await getActiveScanIds(clientId)).toEqual([
+      "scan-a",
+      "scan-b",
+      "scan-c",
+    ]);
+  });
+
+  it(`throws when adding a new scan id beyond MAX_ACTIVE_SCANS (${MAX_ACTIVE_SCANS})`, async () => {
+    const clientId = "client-list-5";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanIds: ["scan-a", "scan-b", "scan-c"],
+          },
+        },
+      }),
+    );
+
+    await expect(addActiveScanId(clientId, "scan-d")).rejects.toThrow(
+      `Client ${clientId} already has the maximum of ${MAX_ACTIVE_SCANS} active scans`,
+    );
+    expect(await getActiveScanIds(clientId)).toEqual([
+      "scan-a",
+      "scan-b",
+      "scan-c",
+    ]);
+  });
+
+  it("removes a scan id without affecting the others", async () => {
+    const clientId = "client-list-6";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanIds: ["scan-a", "scan-b"],
+          },
+        },
+      }),
+    );
+
+    await removeActiveScanId(clientId, "scan-a");
+    expect(await getActiveScanIds(clientId)).toEqual(["scan-b"]);
+  });
+
+  it("removing a scan id that isn't present is a harmless no-op", async () => {
+    const clientId = "client-list-7";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanIds: ["scan-a"],
+          },
+        },
+      }),
+    );
+
+    await expect(
+      removeActiveScanId(clientId, "scan-x"),
+    ).resolves.toBeUndefined();
+    expect(await getActiveScanIds(clientId)).toEqual(["scan-a"]);
+  });
+
+  it("throws when removing from a client that doesn't exist", async () => {
+    await expect(
+      removeActiveScanId("no-such-client", "scan-a"),
+    ).rejects.toThrow("No client config found for clientId: no-such-client");
+  });
+
+  it("migrates a legacy-only activeScanId into activeScanIds instead of dropping it when adding a new one", async () => {
+    const clientId = "client-list-8";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanId: "scan-legacy",
+          },
+        },
+      }),
+    );
+
+    await addActiveScanId(clientId, "scan-new");
+
+    expect(await getActiveScanIds(clientId)).toEqual(["scan-legacy", "scan-new"]);
+    const doc = await getClientsConfigCollection().findOne({ clientId });
+    expect(doc?.products?.websiteTalk?.activeScanId).toBeUndefined();
+  });
+
+  it("throws when adding to a client that doesn't exist", async () => {
+    await expect(
+      addActiveScanId("no-such-client", "scan-a"),
+    ).rejects.toThrow("No client config found for clientId: no-such-client");
+  });
+
+  it("unsets a legacy-only activeScanId when it is the one being removed", async () => {
+    const clientId = "client-list-9";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanId: "scan-legacy",
+          },
+        },
+      }),
+    );
+
+    await removeActiveScanId(clientId, "scan-legacy");
+
+    expect(await getActiveScanIds(clientId)).toEqual([]);
+    const doc = await getClientsConfigCollection().findOne({ clientId });
+    expect(doc?.products?.websiteTalk?.activeScanId).toBeUndefined();
+  });
+});
+
+describe("primaryScanId (CP-1628 follow-up)", () => {
+  beforeEach(async () => {
+    await getClientsConfigCollection().deleteMany({});
+  });
+
+  afterEach(async () => {
+    await getClientsConfigCollection().deleteMany({});
+  });
+
+  it("returns undefined when nothing is set", async () => {
+    const clientId = "client-primary-1";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: { companyName: "X", timezone: "UTC", language: "he" },
+        },
+      }),
+    );
+
+    expect(await getPrimaryScanId(clientId)).toBeUndefined();
+  });
+
+  it("sets and returns the primary scan id, independent of activeScanIds", async () => {
+    const clientId = "client-primary-2";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            activeScanIds: ["scan-a", "scan-b"],
+          },
+        },
+      }),
+    );
+
+    await setPrimaryScanId(clientId, "scan-c");
+
+    expect(await getPrimaryScanId(clientId)).toBe("scan-c");
+    expect(await getActiveScanIds(clientId)).toEqual(["scan-a", "scan-b"]);
+  });
+
+  it("replaces the previous primary scan id when set again", async () => {
+    const clientId = "client-primary-3";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            primaryScanId: "scan-a",
+          },
+        },
+      }),
+    );
+
+    await setPrimaryScanId(clientId, "scan-b");
+
+    expect(await getPrimaryScanId(clientId)).toBe("scan-b");
+  });
+
+  it("clears the primary scan id", async () => {
+    const clientId = "client-primary-4";
+    await getClientsConfigCollection().insertOne(
+      createClientConfig({
+        clientId,
+        products: {
+          websiteTalk: {
+            companyName: "X",
+            timezone: "UTC",
+            language: "he",
+            primaryScanId: "scan-a",
+          },
+        },
+      }),
+    );
+
+    await clearPrimaryScanId(clientId);
+
+    expect(await getPrimaryScanId(clientId)).toBeUndefined();
+  });
+
+  it("throws when setting the primary scan for a client that doesn't exist", async () => {
+    await expect(
+      setPrimaryScanId("no-such-client", "scan-a"),
+    ).rejects.toThrow("No client config found for clientId: no-such-client");
+  });
+
+  it("throws when clearing the primary scan for a client that doesn't exist", async () => {
+    await expect(
+      clearPrimaryScanId("no-such-client"),
+    ).rejects.toThrow("No client config found for clientId: no-such-client");
+  });
+});