@talkpilot/core-db 1.3.58 → 1.3.59

package/src/bulkWrite/bulkWrite.ops.ts

@@ -1,45 +1,45 @@
-import { Document, Filter, OptionalId } from "mongodb";
-import { BulkWriteOp } from "./bulkWrite.types";
-
-/**
- * Updates specific fields on the record matching filter.
- * Does nothing if no record matches.
- */
-export function buildSetOp<T extends Document>(
-  filter: Filter<T>,
-  setFields: Partial<T>,
-): BulkWriteOp<T> {
-  return { updateOne: { filter, update: { $set: setFields } } };
-}
-
-/**
- * Updates specific fields on the record matching the filter or creates a new record if none matches.
- * setOnInsertFields are only applied when a new record is created; they're ignored on an update.
- */
-export function buildUpsertOp<T extends Document>(
-  filter: Filter<T>,
-  setFields: Partial<T>,
-  setOnInsertFields: Partial<T> = {},
-): BulkWriteOp<T> {
-  return {
-    updateOne: {
-      filter,
-      update: { $set: setFields, $setOnInsert: setOnInsertFields },
-      upsert: true,
-    },
-  };
-}
-
-/** Creates a new record. */
-export function buildInsertOp<T extends Document>(
-  document: OptionalId<T>,
-): BulkWriteOp<T> {
-  return { insertOne: { document } };
-}
-
-/** Permanently removes the record matching the filter. */
-export function buildDeleteOp<T extends Document>(
-  filter: Filter<T>,
-): BulkWriteOp<T> {
-  return { deleteOne: { filter } };
-}
+import { Document, Filter, OptionalId } from "mongodb";
+import { BulkWriteOp } from "./bulkWrite.types";
+
+/**
+ * Updates specific fields on the record matching filter.
+ * Does nothing if no record matches.
+ */
+export function buildSetOp<T extends Document>(
+  filter: Filter<T>,
+  setFields: Partial<T>,
+): BulkWriteOp<T> {
+  return { updateOne: { filter, update: { $set: setFields } } };
+}
+
+/**
+ * Updates specific fields on the record matching the filter or creates a new record if none matches.
+ * setOnInsertFields are only applied when a new record is created; they're ignored on an update.
+ */
+export function buildUpsertOp<T extends Document>(
+  filter: Filter<T>,
+  setFields: Partial<T>,
+  setOnInsertFields: Partial<T> = {},
+): BulkWriteOp<T> {
+  return {
+    updateOne: {
+      filter,
+      update: { $set: setFields, $setOnInsert: setOnInsertFields },
+      upsert: true,
+    },
+  };
+}
+
+/** Creates a new record. */
+export function buildInsertOp<T extends Document>(
+  document: OptionalId<T>,
+): BulkWriteOp<T> {
+  return { insertOne: { document } };
+}
+
+/** Permanently removes the record matching the filter. */
+export function buildDeleteOp<T extends Document>(
+  filter: Filter<T>,
+): BulkWriteOp<T> {
+  return { deleteOne: { filter } };
+}

package/src/bulkWrite/bulkWrite.types.ts

@@ -1,4 +1,4 @@
-import { AnyBulkWriteOperation, Document } from "mongodb";
-
-/** A single MongoDB bulk-write operation, typed against the target document shape. */
-export type BulkWriteOp<T extends Document> = AnyBulkWriteOperation<T>;
+import { AnyBulkWriteOperation, Document } from "mongodb";
+
+/** A single MongoDB bulk-write operation, typed against the target document shape. */
+export type BulkWriteOp<T extends Document> = AnyBulkWriteOperation<T>;

package/src/bulkWrite/index.ts

@@ -1,2 +1,2 @@
-export * from "./bulkWrite.types";
-export * from "./bulkWrite.ops";
+export * from "./bulkWrite.types";
+export * from "./bulkWrite.ops";

package/src/config.ts

@@ -1,9 +1,9 @@
-/**
- * Centralized env var access. Add new fields here instead of reading
- * process.env directly elsewhere, so each env var has exactly one source of truth in the code.
- */
-
-export const configurationDbConfig = {
-  mongoUri: process.env.MONGO_URI || process.env.MONGODB_URI,
-  configurationDbName: process.env.CONFIGURATION_DB_NAME,
-};
+/**
+ * Centralized env var access. Add new fields here instead of reading
+ * process.env directly elsewhere, so each env var has exactly one source of truth in the code.
+ */
+
+export const configurationDbConfig = {
+  mongoUri: process.env.MONGO_URI || process.env.MONGODB_URI,
+  configurationDbName: process.env.CONFIGURATION_DB_NAME,
+};

package/src/configuration/index.ts

@@ -1,17 +1,17 @@
-import { Db, ObjectId as MongoObjectId } from "mongodb";
-
-export * from "./prompts";
-export * from "./models";
-export * from "./internalModels";
-export { configurationMongodbClient } from "./mongodb-client";
-
-let db: Db;
-export const setDb = (d: Db) => {
-  db = d;
-};
-
-export const getDb = (): Db => {
-  if (!db) throw new Error("Configuration DB not initialised");
-  return db;
-};
-export const ObjectId = MongoObjectId;
+import { Db, ObjectId as MongoObjectId } from "mongodb";
+
+export * from "./prompts";
+export * from "./models";
+export * from "./internalModels";
+export { configurationMongodbClient } from "./mongodb-client";
+
+let db: Db;
+export const setDb = (d: Db) => {
+  db = d;
+};
+
+export const getDb = (): Db => {
+  if (!db) throw new Error("Configuration DB not initialised");
+  return db;
+};
+export const ObjectId = MongoObjectId;

package/src/configuration/internalModels/index.ts

@@ -1,3 +1,3 @@
-export { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
-export * from "./internalModels.getters";
-export type { InternalModel } from "./internalModels.types";
+export { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
+export * from "./internalModels.getters";
+export type { InternalModel } from "./internalModels.types";

package/src/configuration/internalModels/internalModels.constants.ts

@@ -1 +1 @@
-export const INTERNAL_MODELS_COLLECTION = "internal-models";
+export const INTERNAL_MODELS_COLLECTION = "internal-models";

package/src/configuration/internalModels/internalModels.getters.ts

@@ -1,33 +1,33 @@
-import { getDb } from "../index";
-import { Collection, Filter } from "mongodb";
-import { InternalModel } from "./internalModels.types";
-import { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
-
-export const getInternalModelsCollection = (): Collection<InternalModel> => {
-  return getDb().collection<InternalModel>(INTERNAL_MODELS_COLLECTION);
-};
-
-/**
- * Get an internal model config by its unique name
- */
-export const getInternalModelByName = async (
-  name: string
-): Promise<InternalModel | null> => {
-  return await getInternalModelsCollection().findOne({ name });
-};
-
-/**
- * Find internal models by filter.
- */
-export const findInternalModels = async (
-  filter: Filter<InternalModel> = {}
-): Promise<InternalModel[]> => {
-  return await getInternalModelsCollection().find(filter).toArray();
-};
-
-/**
- * Get all internal models.
- */
-export const getAllInternalModels = async (): Promise<InternalModel[]> => {
-  return await findInternalModels();
-};
+import { getDb } from "../index";
+import { Collection, Filter } from "mongodb";
+import { InternalModel } from "./internalModels.types";
+import { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
+
+export const getInternalModelsCollection = (): Collection<InternalModel> => {
+  return getDb().collection<InternalModel>(INTERNAL_MODELS_COLLECTION);
+};
+
+/**
+ * Get an internal model config by its unique name
+ */
+export const getInternalModelByName = async (
+  name: string
+): Promise<InternalModel | null> => {
+  return await getInternalModelsCollection().findOne({ name });
+};
+
+/**
+ * Find internal models by filter.
+ */
+export const findInternalModels = async (
+  filter: Filter<InternalModel> = {}
+): Promise<InternalModel[]> => {
+  return await getInternalModelsCollection().find(filter).toArray();
+};
+
+/**
+ * Get all internal models.
+ */
+export const getAllInternalModels = async (): Promise<InternalModel[]> => {
+  return await findInternalModels();
+};

package/src/configuration/internalModels/internalModels.types.ts

@@ -1,12 +1,12 @@
-import { ObjectId } from "mongodb";
-
-export type InternalModel = {
-  _id: ObjectId;
-  /** Has to be unique between other names in collection */
-  name: string;
-  provider: string;
-  model: string;
-  config?: Record<string, unknown>;
-  createdAt: Date;
-  updatedAt: Date;
-};
+import { ObjectId } from "mongodb";
+
+export type InternalModel = {
+  _id: ObjectId;
+  /** Has to be unique between other names in collection */
+  name: string;
+  provider: string;
+  model: string;
+  config?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+};

package/src/configuration/models/__tests__/models.getters.spec.ts

@@ -1,67 +1,86 @@
-import { ObjectId } from "mongodb";
-import { MODELS_COLLECTION } from "../models.constants";
-import {
-  getModelsCollection,
-  getModelContextWindow,
-} from "../models.getters";
-import type { RealtimeModelDoc } from "../models.types";
-
-function realtimeModel(
-  overrides: Partial<RealtimeModelDoc> & Pick<RealtimeModelDoc, "modelId">,
-): RealtimeModelDoc {
-  const now = new Date();
-  return {
-    _id: new ObjectId(),
-    name: overrides.modelId,
-    type: "realtime",
-    provider: "openai",
-    available: true,
-    createdAt: now,
-    updatedAt: now,
-    ...overrides,
-  };
-}
-
-describe("getModelContextWindow", () => {
-  it("returns configDefaults.contextWindow for the model", async () => {
-    await getModelsCollection().insertOne(
-      realtimeModel({
-        modelId: "gpt-realtime",
-        configDefaults: { contextWindow: 32_000 },
-      }),
-    );
-
-    await expect(getModelContextWindow("gpt-realtime")).resolves.toBe(32_000);
-  });
-
-  it("returns null when the model is missing", async () => {
-    await expect(getModelContextWindow("missing-model")).resolves.toBeNull();
-  });
-
-  it("returns null when contextWindow is missing or not a positive number", async () => {
-    await getModelsCollection().insertMany([
-      realtimeModel({
-        modelId: "no-window",
-        configDefaults: {},
-      }),
-      realtimeModel({
-        modelId: "zero-window",
-        configDefaults: { contextWindow: 0 },
-      }),
-      realtimeModel({
-        modelId: "string-window",
-        configDefaults: { contextWindow: "64000" },
-      }),
-    ]);
-
-    await expect(getModelContextWindow("no-window")).resolves.toBeNull();
-    await expect(getModelContextWindow("zero-window")).resolves.toBeNull();
-    await expect(getModelContextWindow("string-window")).resolves.toBeNull();
-  });
-});
-
-describe("models collection", () => {
-  it(`uses the "${MODELS_COLLECTION}" collection`, () => {
-    expect(getModelsCollection().collectionName).toBe(MODELS_COLLECTION);
-  });
-});
+import { ObjectId } from "mongodb";
+import { MODELS_COLLECTION } from "../models.constants";
+import {
+  getModelsCollection,
+  getModelContextWindow,
+  getModelByModelId,
+} from "../models.getters";
+import type { RealtimeModelDoc } from "../models.types";
+
+function realtimeModel(
+  overrides: Partial<RealtimeModelDoc> & Pick<RealtimeModelDoc, "modelId">,
+): RealtimeModelDoc {
+  const now = new Date();
+  return {
+    _id: new ObjectId(),
+    name: overrides.modelId,
+    type: "realtime",
+    provider: "openai",
+    available: true,
+    createdAt: now,
+    updatedAt: now,
+    ...overrides,
+  };
+}
+
+describe("getModelContextWindow", () => {
+  it("returns configDefaults.contextWindow for the model", async () => {
+    await getModelsCollection().insertOne(
+      realtimeModel({
+        modelId: "gpt-realtime",
+        configDefaults: { contextWindow: 32_000 },
+      }),
+    );
+
+    await expect(getModelContextWindow("gpt-realtime")).resolves.toBe(32_000);
+  });
+
+  it("returns null when the model is missing", async () => {
+    await expect(getModelContextWindow("missing-model")).resolves.toBeNull();
+  });
+
+  it("returns null when contextWindow is missing or not a positive number", async () => {
+    await getModelsCollection().insertMany([
+      realtimeModel({
+        modelId: "no-window",
+        configDefaults: {},
+      }),
+      realtimeModel({
+        modelId: "zero-window",
+        configDefaults: { contextWindow: 0 },
+      }),
+      realtimeModel({
+        modelId: "string-window",
+        configDefaults: { contextWindow: "64000" },
+      }),
+    ]);
+
+    await expect(getModelContextWindow("no-window")).resolves.toBeNull();
+    await expect(getModelContextWindow("zero-window")).resolves.toBeNull();
+    await expect(getModelContextWindow("string-window")).resolves.toBeNull();
+  });
+});
+
+describe("models collection", () => {
+  it(`uses the "${MODELS_COLLECTION}" collection`, () => {
+    expect(getModelsCollection().collectionName).toBe(MODELS_COLLECTION);
+  });
+});
+
+describe("RealtimeModelDoc.uiFields", () => {
+  it("round-trips include and exclude through getModelByModelId", async () => {
+    await getModelsCollection().insertOne(
+      realtimeModel({
+        modelId: "gemini-live",
+        provider: "gemini",
+        uiFields: { include: ["thinkingLevel"], exclude: ["speed"] },
+      }),
+    );
+
+    const doc = await getModelByModelId("gemini-live");
+    expect(doc && "uiFields" in doc ? doc.uiFields : undefined).toEqual({
+      include: ["thinkingLevel"],
+      exclude: ["speed"],
+    });
+  });
+});

package/src/configuration/models/index.ts

@@ -1,27 +1,28 @@
-export {
-  MODELS_COLLECTION,
-  MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
-  MODEL_TYPES,
-  REALTIME_MODEL_PROVIDERS,
-  STT_MODEL_PROVIDERS,
-} from "./models.constants";
-export {
-  getModelsCollection,
-  findModels,
-  getModelByModelId,
-  getModelContextWindow,
-  getModelsByProvider,
-  getModelsByType,
-  getAvailableModelsByType,
-} from "./models.getters";
-export type {
-  ModelType,
-  RealtimeModelProvider,
-  SttModelProvider,
-  SemanticVad,
-  ServerVad,
-  TurnDetection,
-  RealtimeModelDoc,
-  SttModelDoc,
-  ModelDoc,
-} from "./models.types";
+export {
+  MODELS_COLLECTION,
+  MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
+  MODEL_TYPES,
+  REALTIME_MODEL_PROVIDERS,
+  STT_MODEL_PROVIDERS,
+} from "./models.constants";
+export {
+  getModelsCollection,
+  findModels,
+  getModelByModelId,
+  getModelContextWindow,
+  getModelsByProvider,
+  getModelsByType,
+  getAvailableModelsByType,
+} from "./models.getters";
+export type {
+  ModelType,
+  RealtimeModelProvider,
+  SttModelProvider,
+  SemanticVad,
+  ServerVad,
+  TurnDetection,
+  RealtimeModelDoc,
+  SttModelDoc,
+  ModelDoc,
+  ModelUiFields,
+} from "./models.types";

package/src/configuration/models/models.constants.ts

@@ -1,15 +1,15 @@
-export const MODELS_COLLECTION = "models";
-
-export const MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW = "contextWindow";
-
-export const MODEL_TYPES = ["realtime", "stt"] as const;
-
-export const REALTIME_MODEL_PROVIDERS = ["openai", "gemini", "xai"] as const;
-export const STT_MODEL_PROVIDERS = [
-  "openai-stt",
-  "google-stt",
-  "deepgram-stt",
-  "deepgram-flux",
-  "elevenlabs-scribe",
-  "gladia-stt",
-] as const;
+export const MODELS_COLLECTION = "models";
+
+export const MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW = "contextWindow";
+
+export const MODEL_TYPES = ["realtime", "stt"] as const;
+
+export const REALTIME_MODEL_PROVIDERS = ["openai", "gemini", "xai"] as const;
+export const STT_MODEL_PROVIDERS = [
+  "openai-stt",
+  "google-stt",
+  "deepgram-stt",
+  "deepgram-flux",
+  "elevenlabs-scribe",
+  "gladia-stt",
+] as const;

package/src/configuration/models/models.getters.ts

@@ -1,71 +1,71 @@
-import { Collection, Filter } from "mongodb";
-
-import { getDb } from "../index";
-import {
-  MODELS_COLLECTION,
-  MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
-} from "./models.constants";
-import { ModelDoc, ModelType } from "./models.types";
-
-/** Raw typed handle to the `models` collection. */
-export const getModelsCollection = (): Collection<ModelDoc> => {
-  return getDb().collection<ModelDoc>(MODELS_COLLECTION);
-};
-
-/** Find models by an arbitrary filter. */
-export const findModels = async (
-  filter: Filter<ModelDoc> = {},
-): Promise<ModelDoc[]> => {
-  return await getModelsCollection().find(filter).toArray();
-};
-
-/**
- * Get a single model by its `modelId`, optionally scoped to a `type`.
- * @param modelId e.g. "deepgram-stt-phonecall"
- * @param type optional narrowing filter, since `modelId` isn't guaranteed unique across types
- */
-export const getModelByModelId = async (
-  modelId: string,
-  type?: ModelType,
-): Promise<ModelDoc | null> => {
-  const filter = (type ? { modelId, type } : { modelId }) as Filter<ModelDoc>;
-  return await getModelsCollection().findOne(filter);
-};
-
-/**
- * Token context window for a model (`configDefaults.contextWindow`).
- * `null` when the model is missing or the value is not a positive number.
- */
-export const getModelContextWindow = async (
-  modelId: string,
-): Promise<number | null> => {
-  const doc = await getModelByModelId(modelId);
-  const value = doc?.configDefaults?.[MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW];
-  if (typeof value !== "number" || !Number.isFinite(value) || value <= 0) {
-    return null;
-  }
-  return Math.floor(value);
-};
-
-/**
- * Get all models for a given `provider`, optionally scoped to a `type`.
- */
-export const getModelsByProvider = async (
-  provider: string,
-  type?: ModelType,
-): Promise<ModelDoc[]> => {
-  const filter = (type ? { provider, type } : { provider }) as Filter<ModelDoc>;
-  return await findModels(filter);
-};
-
-/** Get all models of a given `type`. */
-export const getModelsByType = async (type: ModelType): Promise<ModelDoc[]> => {
-  return await findModels({ type } as Filter<ModelDoc>);
-};
-
-/** Get all models of a given `type` where `available` is true. */
-export const getAvailableModelsByType = async (
-  type: ModelType,
-): Promise<ModelDoc[]> => {
-  return await findModels({ type, available: true } as Filter<ModelDoc>);
-};
+import { Collection, Filter } from "mongodb";
+
+import { getDb } from "../index";
+import {
+  MODELS_COLLECTION,
+  MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
+} from "./models.constants";
+import { ModelDoc, ModelType } from "./models.types";
+
+/** Raw typed handle to the `models` collection. */
+export const getModelsCollection = (): Collection<ModelDoc> => {
+  return getDb().collection<ModelDoc>(MODELS_COLLECTION);
+};
+
+/** Find models by an arbitrary filter. */
+export const findModels = async (
+  filter: Filter<ModelDoc> = {},
+): Promise<ModelDoc[]> => {
+  return await getModelsCollection().find(filter).toArray();
+};
+
+/**
+ * Get a single model by its `modelId`, optionally scoped to a `type`.
+ * @param modelId e.g. "deepgram-stt-phonecall"
+ * @param type optional narrowing filter, since `modelId` isn't guaranteed unique across types
+ */
+export const getModelByModelId = async (
+  modelId: string,
+  type?: ModelType,
+): Promise<ModelDoc | null> => {
+  const filter = (type ? { modelId, type } : { modelId }) as Filter<ModelDoc>;
+  return await getModelsCollection().findOne(filter);
+};
+
+/**
+ * Token context window for a model (`configDefaults.contextWindow`).
+ * `null` when the model is missing or the value is not a positive number.
+ */
+export const getModelContextWindow = async (
+  modelId: string,
+): Promise<number | null> => {
+  const doc = await getModelByModelId(modelId);
+  const value = doc?.configDefaults?.[MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW];
+  if (typeof value !== "number" || !Number.isFinite(value) || value <= 0) {
+    return null;
+  }
+  return Math.floor(value);
+};
+
+/**
+ * Get all models for a given `provider`, optionally scoped to a `type`.
+ */
+export const getModelsByProvider = async (
+  provider: string,
+  type?: ModelType,
+): Promise<ModelDoc[]> => {
+  const filter = (type ? { provider, type } : { provider }) as Filter<ModelDoc>;
+  return await findModels(filter);
+};
+
+/** Get all models of a given `type`. */
+export const getModelsByType = async (type: ModelType): Promise<ModelDoc[]> => {
+  return await findModels({ type } as Filter<ModelDoc>);
+};
+
+/** Get all models of a given `type` where `available` is true. */
+export const getAvailableModelsByType = async (
+  type: ModelType,
+): Promise<ModelDoc[]> => {
+  return await findModels({ type, available: true } as Filter<ModelDoc>);
+};