@talkpilot/core-db 1.3.50 → 1.3.52

package/src/talkpilot/clients/__tests__/clients.quota.spec.ts

@@ -1,123 +1,123 @@
-import {
-  getClientsConfigCollection,
-  incrementClientQuotaUsage,
-  listClientIdsWithConfiguredQuota,
-  resetClientQuotaUsage,
-} from "../../clientsConfig/clientsConfig.getters";
-import { getClientsCollection } from "../clients.getters";
-import {
-  markQuotaAlertSent,
-  markQuotaExpiredSent,
-  updateQuotaAlertsConfig,
-} from "../clients.quota.getters";
-
-describe("quota getters", () => {
-  beforeEach(async () => {
-    await getClientsConfigCollection().deleteMany({});
-    await getClientsCollection().deleteMany({});
-  });
-
-  const seed = async (clientId: string, configQuota: object, clientQuota?: object) => {
-    await getClientsConfigCollection().insertOne({
-      clientId,
-      products: {},
-      quota: configQuota,
-    } as any);
-    if (clientQuota !== undefined) {
-      await getClientsCollection().insertOne({
-        clientId,
-        createdAt: new Date(),
-        updatedAt: new Date(),
-        credits: 0,
-        quota: clientQuota,
-      } as any);
-    }
-  };
-
-  it("updateQuotaAlertsConfig stores alerts on clients", async () => {
-    const clientId = "quota-alerts";
-    await seed(clientId, { totalQuota: 100, usedQuota: 5 });
-
-    await updateQuotaAlertsConfig(clientId, [
-      { thresholdPct: 50, recipientEmails: ["a@example.com"] },
-      { thresholdPct: 80, recipientEmails: ["b@example.com", "c@example.com"] },
-    ]);
-
-    const client = await getClientsCollection().findOne({ clientId });
-    expect(client?.quota?.alerts).toEqual([
-      { thresholdPct: 50, recipientEmails: ["a@example.com"] },
-      { thresholdPct: 80, recipientEmails: ["b@example.com", "c@example.com"] },
-    ]);
-
-    const config = await getClientsConfigCollection().findOne({ clientId });
-    expect(config?.quota).toEqual({ totalQuota: 100, usedQuota: 5 });
-  });
-
-  it("markQuotaAlertSent returns true only on first transition", async () => {
-    const clientId = "quota-alert-sent";
-    await seed(
-      clientId,
-      { totalQuota: 100, usedQuota: 0 },
-      { alerts: [{ thresholdPct: 50, recipientEmails: ["a@b.com"] }] },
-    );
-
-    expect(await markQuotaAlertSent(clientId, 0)).toBe(true);
-    expect(await markQuotaAlertSent(clientId, 0)).toBe(false);
-
-    const client = await getClientsCollection().findOne({ clientId });
-    expect(client?.quota?.alerts?.[0]?.thresholdSent).toBe(true);
-  });
-
-  it("markQuotaExpiredSent returns true only on first transition", async () => {
-    const clientId = "quota-notify";
-    await seed(clientId, { totalQuota: 10, usedQuota: 10 });
-
-    expect(await markQuotaExpiredSent(clientId)).toBe(true);
-    expect(await markQuotaExpiredSent(clientId)).toBe(false);
-
-    const client = await getClientsCollection().findOne({ clientId });
-    expect(client?.quota?.expiredSent).toBe(true);
-  });
-
-  it("listClientIdsWithConfiguredQuota returns clientIds with totalQuota set", async () => {
-    await seed("quota-a", { totalQuota: 100, usedQuota: 0 });
-    await seed("quota-b", { totalQuota: 50, usedQuota: 10 });
-    await getClientsConfigCollection().insertOne({
-      clientId: "no-quota",
-      products: {},
-    } as any);
-
-    const ids = await listClientIdsWithConfiguredQuota();
-    expect(ids.sort()).toEqual(["quota-a", "quota-b"]);
-  });
-
-  it("incrementClientQuotaUsage increments usedQuota on clientsConfig", async () => {
-    const clientId = "quota-inc";
-    await seed(clientId, { totalQuota: 100, usedQuota: 3 });
-
-    await incrementClientQuotaUsage(clientId, 2);
-    const config = await getClientsConfigCollection().findOne({ clientId });
-    expect(config?.quota?.usedQuota).toBe(5);
-  });
-
-  it("resetClientQuotaUsage zeros usedQuota and clears client quota flags", async () => {
-    const clientId = "quota-reset";
-    await seed(
-      clientId,
-      { totalQuota: 100, usedQuota: 50 },
-      {
-        expiredSent: true,
-        alerts: [{ thresholdPct: 50, recipientEmails: ["a@b.com"], thresholdSent: true }],
-      },
-    );
-
-    await resetClientQuotaUsage(clientId);
-
-    const config = await getClientsConfigCollection().findOne({ clientId });
-    expect(config?.quota?.usedQuota).toBe(0);
-
-    const client = await getClientsCollection().findOne({ clientId });
-    expect(client?.quota?.expiredSent).toBeUndefined();
-    expect(client?.quota?.alerts?.[0]?.thresholdSent).toBeUndefined();
-  });
-});
+import {
+  getClientsConfigCollection,
+  incrementClientQuotaUsage,
+  listClientIdsWithConfiguredQuota,
+  resetClientQuotaUsage,
+} from "../../clientsConfig/clientsConfig.getters";
+import { getClientsCollection } from "../clients.getters";
+import {
+  markQuotaAlertSent,
+  markQuotaExpiredSent,
+  updateQuotaAlertsConfig,
+} from "../clients.quota.getters";
+
+describe("quota getters", () => {
+  beforeEach(async () => {
+    await getClientsConfigCollection().deleteMany({});
+    await getClientsCollection().deleteMany({});
+  });
+
+  const seed = async (clientId: string, configQuota: object, clientQuota?: object) => {
+    await getClientsConfigCollection().insertOne({
+      clientId,
+      products: {},
+      quota: configQuota,
+    } as any);
+    if (clientQuota !== undefined) {
+      await getClientsCollection().insertOne({
+        clientId,
+        createdAt: new Date(),
+        updatedAt: new Date(),
+        credits: 0,
+        quota: clientQuota,
+      } as any);
+    }
+  };
+
+  it("updateQuotaAlertsConfig stores alerts on clients", async () => {
+    const clientId = "quota-alerts";
+    await seed(clientId, { totalQuota: 100, usedQuota: 5 });
+
+    await updateQuotaAlertsConfig(clientId, [
+      { thresholdPct: 50, recipientEmails: ["a@example.com"] },
+      { thresholdPct: 80, recipientEmails: ["b@example.com", "c@example.com"] },
+    ]);
+
+    const client = await getClientsCollection().findOne({ clientId });
+    expect(client?.quota?.alerts).toEqual([
+      { thresholdPct: 50, recipientEmails: ["a@example.com"] },
+      { thresholdPct: 80, recipientEmails: ["b@example.com", "c@example.com"] },
+    ]);
+
+    const config = await getClientsConfigCollection().findOne({ clientId });
+    expect(config?.quota).toEqual({ totalQuota: 100, usedQuota: 5 });
+  });
+
+  it("markQuotaAlertSent returns true only on first transition", async () => {
+    const clientId = "quota-alert-sent";
+    await seed(
+      clientId,
+      { totalQuota: 100, usedQuota: 0 },
+      { alerts: [{ thresholdPct: 50, recipientEmails: ["a@b.com"] }] },
+    );
+
+    expect(await markQuotaAlertSent(clientId, 0)).toBe(true);
+    expect(await markQuotaAlertSent(clientId, 0)).toBe(false);
+
+    const client = await getClientsCollection().findOne({ clientId });
+    expect(client?.quota?.alerts?.[0]?.thresholdSent).toBe(true);
+  });
+
+  it("markQuotaExpiredSent returns true only on first transition", async () => {
+    const clientId = "quota-notify";
+    await seed(clientId, { totalQuota: 10, usedQuota: 10 });
+
+    expect(await markQuotaExpiredSent(clientId)).toBe(true);
+    expect(await markQuotaExpiredSent(clientId)).toBe(false);
+
+    const client = await getClientsCollection().findOne({ clientId });
+    expect(client?.quota?.expiredSent).toBe(true);
+  });
+
+  it("listClientIdsWithConfiguredQuota returns clientIds with totalQuota set", async () => {
+    await seed("quota-a", { totalQuota: 100, usedQuota: 0 });
+    await seed("quota-b", { totalQuota: 50, usedQuota: 10 });
+    await getClientsConfigCollection().insertOne({
+      clientId: "no-quota",
+      products: {},
+    } as any);
+
+    const ids = await listClientIdsWithConfiguredQuota();
+    expect(ids.sort()).toEqual(["quota-a", "quota-b"]);
+  });
+
+  it("incrementClientQuotaUsage increments usedQuota on clientsConfig", async () => {
+    const clientId = "quota-inc";
+    await seed(clientId, { totalQuota: 100, usedQuota: 3 });
+
+    await incrementClientQuotaUsage(clientId, 2);
+    const config = await getClientsConfigCollection().findOne({ clientId });
+    expect(config?.quota?.usedQuota).toBe(5);
+  });
+
+  it("resetClientQuotaUsage zeros usedQuota and clears client quota flags", async () => {
+    const clientId = "quota-reset";
+    await seed(
+      clientId,
+      { totalQuota: 100, usedQuota: 50 },
+      {
+        expiredSent: true,
+        alerts: [{ thresholdPct: 50, recipientEmails: ["a@b.com"], thresholdSent: true }],
+      },
+    );
+
+    await resetClientQuotaUsage(clientId);
+
+    const config = await getClientsConfigCollection().findOne({ clientId });
+    expect(config?.quota?.usedQuota).toBe(0);
+
+    const client = await getClientsCollection().findOne({ clientId });
+    expect(client?.quota?.expiredSent).toBeUndefined();
+    expect(client?.quota?.alerts?.[0]?.thresholdSent).toBeUndefined();
+  });
+});

package/src/talkpilot/clients/clients.constants.ts

@@ -0,0 +1,2 @@
+/** Collections to always skip during client deletion — e.g. auditLogs, which must survive it. */
+export const DELETE_DENYLIST: string[] = ["auditLogs"];

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

@@ -1,16 +1,23 @@
-import { getDb, Client } from "../index";
-import { Collection } from "mongodb";
-
-export const getClientsCollection = (): Collection<Client> => {
-  return getDb().collection<Client>("clients");
-};
-
-export const getClientByAPIKey = async (
-  apiKey: string,
-): Promise<Client | null> => {
-  const client = await getClientsCollection().findOne({
-    apiKey,
-    isActive: true,
-  });
-  return client ? client : null;
-};
+import { getDb, Client } from "../index";
+import { Collection } from "mongodb";
+
+export const getClientsCollection = (): Collection<Client> => {
+  return getDb().collection<Client>("clients");
+};
+
+export const getClientByAPIKey = async (
+  apiKey: string,
+): Promise<Client | null> => {
+  const client = await getClientsCollection().findOne({
+    apiKey,
+    isActive: true,
+  });
+  return client ? client : null;
+};
+
+export const getAllClientCredits = async (): Promise<Map<string, number>> => {
+  const docs = await getClientsCollection()
+    .find({}, { projection: { clientId: 1, credits: 1 } })
+    .toArray();
+  return new Map(docs.map((c) => [c.clientId, c.credits ?? 0]));
+};

package/src/talkpilot/clients/clients.lifecycle.ts

@@ -0,0 +1,116 @@
+import { Db } from "mongodb";
+import { getDb, insertAuditLog } from "../index";
+import { getDb as getMunicipalDataDb } from "../../municipal";
+import { DELETE_DENYLIST } from "./clients.constants";
+import {
+  CollectionMatch,
+  CollectionDeleteResult,
+  DeleteClientDataSummary,
+} from "./clients.types";
+
+// Skips websitalk on purpose — see the warning on `deleteClientDataAcrossDomains` below.
+const findClientMatchInDb = async (
+  db: Db,
+  clientId: string,
+): Promise<CollectionMatch[]> => {
+  const collections = await db.listCollections().toArray();
+  return Promise.all(
+    collections
+      .filter((c) => !DELETE_DENYLIST.includes(c.name))
+      .map(async (c) => {
+        const doc = await db
+          .collection(c.name)
+          .findOne({ $or: [{ clientId }, { client_id: clientId }] });
+        return { collectionName: c.name, matched: !!doc };
+      }),
+  );
+};
+
+export const clientExistsInAnyCollection = async (
+  clientId: string,
+): Promise<boolean> => {
+  const [talkpilotResults, municipalResults] = await Promise.all([
+    findClientMatchInDb(getDb(), clientId),
+    findClientMatchInDb(getMunicipalDataDb(), clientId),
+  ]);
+  return [...talkpilotResults, ...municipalResults].some((r) => r.matched);
+};
+
+const deleteClientFromDb = async (
+  db: Db,
+  clientId: string,
+): Promise<CollectionDeleteResult[]> => {
+  const collections = await db.listCollections().toArray();
+  return Promise.all(
+    collections
+      .filter((c) => !DELETE_DENYLIST.includes(c.name))
+      .map(async (c) => {
+        try {
+          const result = await db
+            .collection(c.name)
+            .deleteMany({ $or: [{ clientId }, { client_id: clientId }] });
+          return {
+            collectionName: c.name,
+            deletedCount: result.deletedCount,
+            success: true,
+          };
+        } catch (error) {
+          return {
+            collectionName: c.name,
+            deletedCount: 0,
+            success: false,
+            error: error instanceof Error ? error.message : String(error),
+          };
+        }
+      }),
+  );
+};
+
+/**
+ * Deletes a client's data across talkpilot/municipal collections and logs the action.
+ *
+ * ⚠️ Does NOT delete website-talk data — `scans`/`websiteUrls` are the lookup key an
+ * external API needs to clean up that domain. Callers must invoke that API separately.
+ */
+export const deleteClientDataAcrossDomains = async (
+  clientId: string,
+  adminEmail: string,
+): Promise<DeleteClientDataSummary> => {
+  const exists = await clientExistsInAnyCollection(clientId);
+  if (!exists) {
+    return {
+      clientId,
+      deleted: false,
+      reason: "Client does not exist in any collection",
+    };
+  }
+
+  const [talkpilotResults, municipalResults] = await Promise.all([
+    deleteClientFromDb(getDb(), clientId),
+    deleteClientFromDb(getMunicipalDataDb(), clientId),
+  ]);
+  const results = [...talkpilotResults, ...municipalResults];
+  const allSucceeded = results.every((r) => r.success);
+
+  await insertAuditLog({
+    clientId,
+    adminEmail,
+    action: "delete",
+    timestamp: new Date(),
+    allSucceeded,
+    ...(allSucceeded
+      ? {}
+      : {
+          failedCollections: results
+            .filter((r) => !r.success)
+            .map((r) => r.collectionName),
+        }),
+  });
+
+  return {
+    clientId,
+    deleted: true,
+    results,
+    allSucceeded,
+  };
+};

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": "" },
+      },
+    );
+  }
+}