@talkpilot/core-db 1.3.58 → 1.3.59

package/src/configuration/models/models.types.ts

@@ -1,80 +1,93 @@
-import { ObjectId } from "mongodb";
-
-import {
-  MODEL_TYPES,
-  REALTIME_MODEL_PROVIDERS,
-  STT_MODEL_PROVIDERS,
-} from "./models.constants";
-
-export type ModelType = (typeof MODEL_TYPES)[number];
-export type RealtimeModelProvider = (typeof REALTIME_MODEL_PROVIDERS)[number];
-export type SttModelProvider = (typeof STT_MODEL_PROVIDERS)[number];
-
-export type SemanticVad = {
-  type: "semantic_vad";
-  eagerness?: "low" | "medium" | "high" | "auto";
-  create_response?: boolean;
-  interrupt_response?: boolean;
-};
-
-export type ServerVad = {
-  type: "server_vad";
-  threshold: number;
-  prefix_padding_ms: number;
-  silence_duration_ms: number;
-  create_response?: boolean;
-  interrupt_response?: boolean;
-};
-
-export type TurnDetection = SemanticVad | ServerVad;
-
-type BaseModelDoc = {
-  _id: ObjectId;
-  /** Public identifier used by the provider, not to be confused with mongo id */
-  modelId: string;
-  name: string;
-  description?: string;
-  available: boolean;
-  configDefaults?: Record<string, unknown>;
-  createdAt: Date;
-  updatedAt: Date;
-};
-
-/** Realtime speech-to-speech model (OpenAI/Gemini). `features.vad` is turn-detection config. */
-export type RealtimeModelDoc = BaseModelDoc & {
-  type: "realtime";
-  provider: RealtimeModelProvider;
-  features?: {
-    supportsAudio?: boolean;
-    supportsText?: boolean;
-    vad?: TurnDetection;
-  };
-};
-
-/** STT engine/preset (openai-stt, google-stt, deepgram-stt/-flux, elevenlabs-scribe, gladia-stt). */
-export type SttModelDoc = BaseModelDoc & {
-  type: "stt";
-  provider: SttModelProvider;
-  features?: {
-    supportsAudio?: boolean;
-    supportsText?: boolean;
-  };
-};
-
-/**
- * A document in the `models` collection (configuration db). Discriminated by `type`.
- *
- * Common fields (all variants):
- * - `_id` — Mongo-managed ObjectId
- * - `modelId` — model's public identifier
- * - `name` — display name
- * - `description?` — display description
- * - `available` — whether the model should be offered/selectable right now
- * - `configDefaults?` — free-form provider-specific config, e.g. the literal vendor
- *   model string, VAD tuning, language, barge-in timings, `contextWindow` (token
- *   budget) — shape varies per `provider`
- * - `createdAt` / `updatedAt`
- *
- * Type-specific fields: see {@link RealtimeModelDoc}, {@link SttModelDoc}.
- */
-export type ModelDoc = RealtimeModelDoc | SttModelDoc;
+import { ObjectId } from "mongodb";
+
+import {
+  MODEL_TYPES,
+  REALTIME_MODEL_PROVIDERS,
+  STT_MODEL_PROVIDERS,
+} from "./models.constants";
+
+export type ModelType = (typeof MODEL_TYPES)[number];
+export type RealtimeModelProvider = (typeof REALTIME_MODEL_PROVIDERS)[number];
+export type SttModelProvider = (typeof STT_MODEL_PROVIDERS)[number];
+
+export type SemanticVad = {
+  type: "semantic_vad";
+  eagerness?: "low" | "medium" | "high" | "auto";
+  create_response?: boolean;
+  interrupt_response?: boolean;
+};
+
+export type ServerVad = {
+  type: "server_vad";
+  threshold: number;
+  prefix_padding_ms: number;
+  silence_duration_ms: number;
+  create_response?: boolean;
+  interrupt_response?: boolean;
+};
+
+export type TurnDetection = SemanticVad | ServerVad;
+
+/** Which provider-catalog keys this realtime model should show in the flow editor. */
+export type ModelUiFields = {
+  /** If set, only these catalog paths are shown. */
+  include?: string[];
+  /** Drop these catalog paths even if they would otherwise show. */
+  exclude?: string[];
+};
+
+type BaseModelDoc = {
+  _id: ObjectId;
+  /** Public identifier used by the provider, not to be confused with mongo id */
+  modelId: string;
+  name: string;
+  description?: string;
+  available: boolean;
+  configDefaults?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** Realtime speech-to-speech model (OpenAI/Gemini). `features.vad` is turn-detection config. */
+export type RealtimeModelDoc = BaseModelDoc & {
+  type: "realtime";
+  provider: RealtimeModelProvider;
+  features?: {
+    supportsAudio?: boolean;
+    supportsText?: boolean;
+    vad?: TurnDetection;
+  };
+  /** Flow-editor field selection for this model. Missing means the full provider catalog. */
+  uiFields?: ModelUiFields;
+};
+
+/** STT engine/preset (openai-stt, google-stt, deepgram-stt/-flux, elevenlabs-scribe, gladia-stt). */
+export type SttModelDoc = BaseModelDoc & {
+  type: "stt";
+  provider: SttModelProvider;
+  features?: {
+    supportsAudio?: boolean;
+    supportsText?: boolean;
+  };
+};
+
+/**
+ * A document in the `models` collection (configuration db). Discriminated by `type`.
+ *
+ * Common fields (all variants):
+ * - `_id` — Mongo-managed ObjectId
+ * - `modelId` — model's public identifier
+ * - `name` — display name
+ * - `description?` — display description
+ * - `available` — whether the model should be offered/selectable right now
+ * - `configDefaults?` — free-form provider-specific config, e.g. the literal vendor
+ *   model string, VAD tuning, language, barge-in timings, `contextWindow` (token
+ *   budget) — shape varies per `provider`
+ * - `createdAt` / `updatedAt`
+ *
+ * Realtime-only:
+ * - `uiFields?` — `include` / `exclude` lists of provider-catalog paths for the flow editor
+ *
+ * Type-specific fields: see {@link RealtimeModelDoc}, {@link SttModelDoc}.
+ */
+export type ModelDoc = RealtimeModelDoc | SttModelDoc;

package/src/configuration/mongodb-client.ts

@@ -1,62 +1,62 @@
-import { MongoClient, Db } from "mongodb";
-import { setDb } from "./index";
-import { validateConfig, validateMongoUri } from "../utils/validation";
-import { configurationDbConfig } from "../config";
-
-class ConfigurationMongoDBClient {
-  private client: MongoClient | null = null;
-  private db: Db | null = null;
-  private readonly defaultDbName = "configuration";
-
-  async connect(uri?: string, dbName?: string): Promise<void> {
-    if (this.client) {
-      return;
-    }
-
-    const mongodbUri = uri || configurationDbConfig.mongoUri;
-    validateConfig("MONGO_URI", mongodbUri);
-    validateMongoUri(mongodbUri!);
-
-    try {
-      this.client = new MongoClient(mongodbUri!);
-      await this.client.connect();
-      const targetDbName =
-        dbName || configurationDbConfig.configurationDbName || this.defaultDbName;
-      this.db = this.client.db(targetDbName);
-      setDb(this.db);
-      console.info(`[core-db] Configuration MongoDB connected: ${targetDbName}`);
-    } catch (error) {
-      console.error("[core-db] Configuration connection failed", error);
-      throw error;
-    }
-  }
-
-  async disconnect(): Promise<void> {
-    if (this.client) {
-      try {
-        await this.client.close();
-        this.client = null;
-        this.db = null;
-        console.info("Configuration MongoDB disconnected successfully");
-      } catch (error) {
-        console.error("[core-db] Configuration disconnection failed", error);
-        throw error;
-      }
-    }
-  }
-
-  getDb(): Db {
-    if (!this.db) {
-      throw new Error(
-        "Configuration database not initialized. Call connect() first.",
-      );
-    }
-    return this.db;
-  }
-
-  isConnected(): boolean {
-    return this.client !== null && this.client !== undefined;
-  }
-}
-
-export const configurationMongodbClient = new ConfigurationMongoDBClient();
+import { MongoClient, Db } from "mongodb";
+import { setDb } from "./index";
+import { validateConfig, validateMongoUri } from "../utils/validation";
+import { configurationDbConfig } from "../config";
+
+class ConfigurationMongoDBClient {
+  private client: MongoClient | null = null;
+  private db: Db | null = null;
+  private readonly defaultDbName = "configuration";
+
+  async connect(uri?: string, dbName?: string): Promise<void> {
+    if (this.client) {
+      return;
+    }
+
+    const mongodbUri = uri || configurationDbConfig.mongoUri;
+    validateConfig("MONGO_URI", mongodbUri);
+    validateMongoUri(mongodbUri!);
+
+    try {
+      this.client = new MongoClient(mongodbUri!);
+      await this.client.connect();
+      const targetDbName =
+        dbName || configurationDbConfig.configurationDbName || this.defaultDbName;
+      this.db = this.client.db(targetDbName);
+      setDb(this.db);
+      console.info(`[core-db] Configuration MongoDB connected: ${targetDbName}`);
+    } catch (error) {
+      console.error("[core-db] Configuration connection failed", error);
+      throw error;
+    }
+  }
+
+  async disconnect(): Promise<void> {
+    if (this.client) {
+      try {
+        await this.client.close();
+        this.client = null;
+        this.db = null;
+        console.info("Configuration MongoDB disconnected successfully");
+      } catch (error) {
+        console.error("[core-db] Configuration disconnection failed", error);
+        throw error;
+      }
+    }
+  }
+
+  getDb(): Db {
+    if (!this.db) {
+      throw new Error(
+        "Configuration database not initialized. Call connect() first.",
+      );
+    }
+    return this.db;
+  }
+
+  isConnected(): boolean {
+    return this.client !== null && this.client !== undefined;
+  }
+}
+
+export const configurationMongodbClient = new ConfigurationMongoDBClient();

package/src/configuration/prompts/index.ts

@@ -1,2 +1,2 @@
-export * from "./prompts.getters";
-export type { Prompt } from "./prompts.types";
+export * from "./prompts.getters";
+export type { Prompt } from "./prompts.types";

package/src/configuration/prompts/prompts.getters.ts

@@ -1,49 +1,49 @@
-import { getDb } from "../index";
-import { Collection, Filter } from "mongodb";
-import { Prompt } from "./prompts.types";
-import { KnownProductKey } from "../../talkpilot";
-
-export const getPromptsCollection = (): Collection<Prompt> => {
-  return getDb().collection<Prompt>("prompts");
-};
-
-/**
- * Get a prompt by its unique name.
- * @param name prompt name
- * @returns the prompt or null if not found
- */
-export const getPromptByName = async (
-  name: string,
-): Promise<Prompt | null> => {
-  return await getPromptsCollection().findOne({ name });
-};
-
-/**
- * Find prompts by filter.
- * @param filter filter to apply
- * @returns array of matching prompts
- */
-export const findPrompts = async (
-  filter: Filter<Prompt> = {},
-): Promise<Prompt[]> => {
-  return await getPromptsCollection().find(filter).toArray();
-};
-
-/**
- * Get all prompts.
- * @returns array of all prompts
- */
-export const getAllPrompts = async (): Promise<Prompt[]> => {
-  return await findPrompts();
-};
-
-/**
- * Get all prompts for a given product.
- * @param productName product key
- * @returns array of matching prompts
- */
-export const getPromptsByProduct = async (
-  productName: KnownProductKey,
-): Promise<Prompt[]> => {
-  return await findPrompts({ productName });
-};
+import { getDb } from "../index";
+import { Collection, Filter } from "mongodb";
+import { Prompt } from "./prompts.types";
+import { KnownProductKey } from "../../talkpilot";
+
+export const getPromptsCollection = (): Collection<Prompt> => {
+  return getDb().collection<Prompt>("prompts");
+};
+
+/**
+ * Get a prompt by its unique name.
+ * @param name prompt name
+ * @returns the prompt or null if not found
+ */
+export const getPromptByName = async (
+  name: string,
+): Promise<Prompt | null> => {
+  return await getPromptsCollection().findOne({ name });
+};
+
+/**
+ * Find prompts by filter.
+ * @param filter filter to apply
+ * @returns array of matching prompts
+ */
+export const findPrompts = async (
+  filter: Filter<Prompt> = {},
+): Promise<Prompt[]> => {
+  return await getPromptsCollection().find(filter).toArray();
+};
+
+/**
+ * Get all prompts.
+ * @returns array of all prompts
+ */
+export const getAllPrompts = async (): Promise<Prompt[]> => {
+  return await findPrompts();
+};
+
+/**
+ * Get all prompts for a given product.
+ * @param productName product key
+ * @returns array of matching prompts
+ */
+export const getPromptsByProduct = async (
+  productName: KnownProductKey,
+): Promise<Prompt[]> => {
+  return await findPrompts({ productName });
+};

package/src/configuration/prompts/prompts.types.ts

@@ -1,11 +1,11 @@
-import { ObjectId } from "mongodb";
-import { KnownProductKey } from "../../talkpilot";
-
-export type Prompt = {
-  _id: ObjectId;
-  name: string;
-  content: string;
-  productName: KnownProductKey;
-  createdAt: Date;
-  updatedAt: Date;
-};
+import { ObjectId } from "mongodb";
+import { KnownProductKey } from "../../talkpilot";
+
+export type Prompt = {
+  _id: ObjectId;
+  name: string;
+  content: string;
+  productName: KnownProductKey;
+  createdAt: Date;
+  updatedAt: Date;
+};

package/src/connection.ts

@@ -1,81 +1,81 @@
-import { mongodbClient } from "./talkpilot";
-import { municipalDataMongodbClient } from "./municipal";
-import { websitalkMongodbClient } from "./websitalk";
-import { configurationMongodbClient } from "./configuration";
-import { configurationDbConfig } from "./config";
-
-let isConnected = false;
-
-/**
- * Ensures the database clients are initialized.
- * This function reads from MONGO_URI.
- */
-export async function ensureDbConnected() {
-  if (isConnected) {
-    return;
-  }
-
-  const mongoUri = process.env.MONGO_URI || process.env.MONGODB_URI;
-  const talkpilotUri = mongoUri;
-  const municipalUri = mongoUri;
-  const websiteTalkUri = mongoUri;
-  const configurationUri = mongoUri;
-
-  if (!talkpilotUri) {
-    console.warn("[core-db] MONGO_URI is not set");
-  } else {
-    const dbNameFromUri = talkpilotUri.split("/").pop()?.split("?")[0];
-    const dbName = dbNameFromUri || process.env.TALKPILOT_DB_NAME;
-    await mongodbClient.connect(talkpilotUri, dbName);
-    console.info(
-      `[core-db] Connected to TalkPilot MongoDB: ${dbName || "via env"}`,
-    );
-  }
-
-  if (!municipalUri) {
-    console.warn("[core-db] MONGO_URI is not set");
-  } else {
-    const dbNameFromUri = municipalUri.split("/").pop()?.split("?")[0];
-    const dbName = dbNameFromUri || process.env.MUNICIPAL_DB_NAME;
-    await municipalDataMongodbClient.connect(municipalUri, dbName);
-    console.info(
-      `[core-db] Connected to Municipal Data MongoDB: ${dbName || "via env"}`,
-    );
-  }
-
-  if (!websiteTalkUri) {
-    console.warn("[core-db] MONGO_URI is not set");
-  } else {
-    const dbName = process.env.WEBSITALK_DB_NAME;
-    await websitalkMongodbClient.connect(websiteTalkUri, dbName);
-    console.info(
-      `[core-db] Connected to Website Talk MongoDB: ${dbName || "website-talk (default)"}`,
-    );
-  }
-
-  if (!configurationUri) {
-    console.warn("[core-db] MONGO_URI is not set");
-  } else {
-    const dbName = configurationDbConfig.configurationDbName;
-    await configurationMongodbClient.connect(configurationUri, dbName);
-    console.info(
-      `[core-db] Connected to Configuration MongoDB: ${dbName || "configuration (default)"}`,
-    );
-  }
-
-  isConnected = true;
-}
-
-export async function disconnectDb(): Promise<void> {
-  if (!isConnected) {
-    return;
-  }
-
-  await Promise.all([
-    mongodbClient.disconnect(),
-    municipalDataMongodbClient.disconnect(),
-    websitalkMongodbClient.disconnect(),
-    configurationMongodbClient.disconnect(),
-  ]);
-  isConnected = false;
-}
+import { mongodbClient } from "./talkpilot";
+import { municipalDataMongodbClient } from "./municipal";
+import { websitalkMongodbClient } from "./websitalk";
+import { configurationMongodbClient } from "./configuration";
+import { configurationDbConfig } from "./config";
+
+let isConnected = false;
+
+/**
+ * Ensures the database clients are initialized.
+ * This function reads from MONGO_URI.
+ */
+export async function ensureDbConnected() {
+  if (isConnected) {
+    return;
+  }
+
+  const mongoUri = process.env.MONGO_URI || process.env.MONGODB_URI;
+  const talkpilotUri = mongoUri;
+  const municipalUri = mongoUri;
+  const websiteTalkUri = mongoUri;
+  const configurationUri = mongoUri;
+
+  if (!talkpilotUri) {
+    console.warn("[core-db] MONGO_URI is not set");
+  } else {
+    const dbNameFromUri = talkpilotUri.split("/").pop()?.split("?")[0];
+    const dbName = dbNameFromUri || process.env.TALKPILOT_DB_NAME;
+    await mongodbClient.connect(talkpilotUri, dbName);
+    console.info(
+      `[core-db] Connected to TalkPilot MongoDB: ${dbName || "via env"}`,
+    );
+  }
+
+  if (!municipalUri) {
+    console.warn("[core-db] MONGO_URI is not set");
+  } else {
+    const dbNameFromUri = municipalUri.split("/").pop()?.split("?")[0];
+    const dbName = dbNameFromUri || process.env.MUNICIPAL_DB_NAME;
+    await municipalDataMongodbClient.connect(municipalUri, dbName);
+    console.info(
+      `[core-db] Connected to Municipal Data MongoDB: ${dbName || "via env"}`,
+    );
+  }
+
+  if (!websiteTalkUri) {
+    console.warn("[core-db] MONGO_URI is not set");
+  } else {
+    const dbName = process.env.WEBSITALK_DB_NAME;
+    await websitalkMongodbClient.connect(websiteTalkUri, dbName);
+    console.info(
+      `[core-db] Connected to Website Talk MongoDB: ${dbName || "website-talk (default)"}`,
+    );
+  }
+
+  if (!configurationUri) {
+    console.warn("[core-db] MONGO_URI is not set");
+  } else {
+    const dbName = configurationDbConfig.configurationDbName;
+    await configurationMongodbClient.connect(configurationUri, dbName);
+    console.info(
+      `[core-db] Connected to Configuration MongoDB: ${dbName || "configuration (default)"}`,
+    );
+  }
+
+  isConnected = true;
+}
+
+export async function disconnectDb(): Promise<void> {
+  if (!isConnected) {
+    return;
+  }
+
+  await Promise.all([
+    mongodbClient.disconnect(),
+    municipalDataMongodbClient.disconnect(),
+    websitalkMongodbClient.disconnect(),
+    configurationMongodbClient.disconnect(),
+  ]);
+  isConnected = false;
+}