@talkpilot/core-db 1.3.84 → 1.3.85

package/src/municipal/systemInstructions/instructions.getters.ts

@@ -1,57 +1,57 @@
-import { CityName, getDb, ObjectId } from "../index";
-import { Collection, Filter } from "mongodb";
-import { MIS_SystemInstruction, MIS_Tool } from "./instructions.types";
-
-export const getSystemInstructionsCollection =
-  (): Collection<MIS_SystemInstruction> => {
-    return getDb().collection<MIS_SystemInstruction>("system_instructions");
-  };
-/**
- * Find system instructions by filter
- * @param filter filter to apply
- * @returns array of system instructions
- */
-export const findSystemInstructions = async (
-  filter: Filter<MIS_SystemInstruction> = {},
-): Promise<MIS_SystemInstruction[]> => {
-  return await getSystemInstructionsCollection().find(filter).toArray();
-};
-
-/**
- * Get system instruction by id
- * @param id system instruction id
- * @returns system instruction or null if not found
- */
-export const getSystemInstructionById = async (
-  id: string,
-): Promise<MIS_SystemInstruction | null> => {
-  return await getSystemInstructionsCollection().findOne({
-    _id: new ObjectId(id),
-  });
-};
-/**
- * Get all active system instructions for a city
- * @param cityName city name
- * @returns array of active system instructions
- */
-export const getActiveSystemInstructionsByCity = async (
-  cityName: CityName,
-): Promise<MIS_SystemInstruction[]> => {
-  return await getSystemInstructionsCollection()
-    .find({ cityName, isActive: true })
-    .toArray();
-};
-/**
- * Get system instructions by tool and city
- * @param cityName city name
- * @param toolName tool name
- * @returns array of system instructions
- */
-export const getSystemInstructionsByToolAndCity = async (
-  cityName: CityName,
-  toolName: MIS_Tool,
-): Promise<MIS_SystemInstruction[]> => {
-  return await getSystemInstructionsCollection()
-    .find({ cityName: cityName, tool: toolName })
-    .toArray();
-};
+import { CityName, getDb, ObjectId } from "../index";
+import { Collection, Filter } from "mongodb";
+import { MIS_SystemInstruction, MIS_Tool } from "./instructions.types";
+
+export const getSystemInstructionsCollection =
+  (): Collection<MIS_SystemInstruction> => {
+    return getDb().collection<MIS_SystemInstruction>("system_instructions");
+  };
+/**
+ * Find system instructions by filter
+ * @param filter filter to apply
+ * @returns array of system instructions
+ */
+export const findSystemInstructions = async (
+  filter: Filter<MIS_SystemInstruction> = {},
+): Promise<MIS_SystemInstruction[]> => {
+  return await getSystemInstructionsCollection().find(filter).toArray();
+};
+
+/**
+ * Get system instruction by id
+ * @param id system instruction id
+ * @returns system instruction or null if not found
+ */
+export const getSystemInstructionById = async (
+  id: string,
+): Promise<MIS_SystemInstruction | null> => {
+  return await getSystemInstructionsCollection().findOne({
+    _id: new ObjectId(id),
+  });
+};
+/**
+ * Get all active system instructions for a city
+ * @param cityName city name
+ * @returns array of active system instructions
+ */
+export const getActiveSystemInstructionsByCity = async (
+  cityName: CityName,
+): Promise<MIS_SystemInstruction[]> => {
+  return await getSystemInstructionsCollection()
+    .find({ cityName, isActive: true })
+    .toArray();
+};
+/**
+ * Get system instructions by tool and city
+ * @param cityName city name
+ * @param toolName tool name
+ * @returns array of system instructions
+ */
+export const getSystemInstructionsByToolAndCity = async (
+  cityName: CityName,
+  toolName: MIS_Tool,
+): Promise<MIS_SystemInstruction[]> => {
+  return await getSystemInstructionsCollection()
+    .find({ cityName: cityName, tool: toolName })
+    .toArray();
+};

package/src/municipal/systemInstructions/instructions.setters.ts

@@ -1,119 +1,119 @@
-import { ObjectId } from "../index";
-import { ObjectId as MongoObjectId } from "mongodb";
-import {
-  MIS_SystemInstruction,
-  MIS_TOOLS,
-  QUERY_TYPES,
-} from "./instructions.types";
-import { getSystemInstructionsCollection } from "./instructions.getters";
-
-/**
- * Validate system instruction data
- * @param data partial system instruction data
- * @throws Error if tool or queryType is invalid
- */
-const validateInstructionData = (data: Partial<MIS_SystemInstruction>) => {
-  if (
-    data.tool &&
-    !(Object.values(MIS_TOOLS) as string[]).includes(data.tool)
-  ) {
-    throw new Error(
-      `Invalid tool value: ${data.tool}. Allowed values are: ${Object.values(MIS_TOOLS).join(", ")}`,
-    );
-  }
-  if (
-    data.queryType &&
-    !(Object.values(QUERY_TYPES) as string[]).includes(data.queryType)
-  ) {
-    throw new Error(
-      `Invalid queryType value: ${data.queryType}. Allowed values are: ${Object.values(QUERY_TYPES).join(", ")}`,
-    );
-  }
-};
-
-/**
- * Create a new system instruction
- * @param instructionData system instruction data
- * @returns inserted system instruction id
- */
-export const createSystemInstruction = async (
-  instructionData: Omit<
-    MIS_SystemInstruction,
-    "_id" | "createdAt" | "updatedAt"
-  >,
-): Promise<MongoObjectId> => {
-  validateInstructionData(instructionData as Partial<MIS_SystemInstruction>);
-  const instruction: Omit<MIS_SystemInstruction, "_id"> = {
-    //append doc metadata to user provided data
-    ...instructionData,
-    createdAt: new Date(),
-    updatedAt: new Date(),
-  };
-  const { insertedId } = await getSystemInstructionsCollection().insertOne(
-    instruction as MIS_SystemInstruction,
-  );
-  return insertedId;
-};
-
-/**
- * Update a system instruction by id
- * @param id system instruction id
- * @param data partial system instruction data
- * @returns updated system instruction or null if not found
- */
-export const updateSystemInstruction = async (
-  id: string,
-  data: Partial<Omit<MIS_SystemInstruction, "_id" | "createdAt" | "updatedAt">>,
-): Promise<MIS_SystemInstruction | null> => {
-  validateInstructionData(data as Partial<MIS_SystemInstruction>);
-  const result = await getSystemInstructionsCollection().findOneAndUpdate(
-    { _id: new ObjectId(id) },
-    { $set: { ...data, updatedAt: new Date() } },
-    { returnDocument: "after" },
-  );
-  return result || null;
-};
-
-/**
- * Delete a system instruction by id
- * @param id system instruction id
- * @returns true if deleted, false otherwise
- */
-export const deleteSystemInstruction = async (id: string): Promise<boolean> => {
-  const result = await getSystemInstructionsCollection().deleteOne({
-    _id: new ObjectId(id),
-  });
-  return result.deletedCount > 0;
-};
-/**
- * Activate a system instruction by id, sets isActive to true.
- * Does not check the current instruction state, calling this on an active instruction will do nothing.
- * @param id system instruction id
- * @returns true on success, false otherwise
- */
-export const activateSystemInstruction = async (
-  id: string,
-): Promise<boolean> => {
-  const result = await getSystemInstructionsCollection().findOneAndUpdate(
-    { _id: new ObjectId(id) },
-    { $set: { isActive: true } },
-    { returnDocument: "after" },
-  );
-  return Boolean(result);
-};
-/**
- * Deactivate a system instruction by id, sets isActive to false.
- * Does not check the current instruction state, calling this on a deactivated instruction will do nothing.
- * @param id system instruction id
- * @returns true on success, false otherwise
- */
-export const deactivateSystemInstruction = async (
-  id: string,
-): Promise<boolean> => {
-  const result = await getSystemInstructionsCollection().findOneAndUpdate(
-    { _id: new ObjectId(id) },
-    { $set: { isActive: false } },
-    { returnDocument: "after" },
-  );
-  return Boolean(result);
-};
+import { ObjectId } from "../index";
+import { ObjectId as MongoObjectId } from "mongodb";
+import {
+  MIS_SystemInstruction,
+  MIS_TOOLS,
+  QUERY_TYPES,
+} from "./instructions.types";
+import { getSystemInstructionsCollection } from "./instructions.getters";
+
+/**
+ * Validate system instruction data
+ * @param data partial system instruction data
+ * @throws Error if tool or queryType is invalid
+ */
+const validateInstructionData = (data: Partial<MIS_SystemInstruction>) => {
+  if (
+    data.tool &&
+    !(Object.values(MIS_TOOLS) as string[]).includes(data.tool)
+  ) {
+    throw new Error(
+      `Invalid tool value: ${data.tool}. Allowed values are: ${Object.values(MIS_TOOLS).join(", ")}`,
+    );
+  }
+  if (
+    data.queryType &&
+    !(Object.values(QUERY_TYPES) as string[]).includes(data.queryType)
+  ) {
+    throw new Error(
+      `Invalid queryType value: ${data.queryType}. Allowed values are: ${Object.values(QUERY_TYPES).join(", ")}`,
+    );
+  }
+};
+
+/**
+ * Create a new system instruction
+ * @param instructionData system instruction data
+ * @returns inserted system instruction id
+ */
+export const createSystemInstruction = async (
+  instructionData: Omit<
+    MIS_SystemInstruction,
+    "_id" | "createdAt" | "updatedAt"
+  >,
+): Promise<MongoObjectId> => {
+  validateInstructionData(instructionData as Partial<MIS_SystemInstruction>);
+  const instruction: Omit<MIS_SystemInstruction, "_id"> = {
+    //append doc metadata to user provided data
+    ...instructionData,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  };
+  const { insertedId } = await getSystemInstructionsCollection().insertOne(
+    instruction as MIS_SystemInstruction,
+  );
+  return insertedId;
+};
+
+/**
+ * Update a system instruction by id
+ * @param id system instruction id
+ * @param data partial system instruction data
+ * @returns updated system instruction or null if not found
+ */
+export const updateSystemInstruction = async (
+  id: string,
+  data: Partial<Omit<MIS_SystemInstruction, "_id" | "createdAt" | "updatedAt">>,
+): Promise<MIS_SystemInstruction | null> => {
+  validateInstructionData(data as Partial<MIS_SystemInstruction>);
+  const result = await getSystemInstructionsCollection().findOneAndUpdate(
+    { _id: new ObjectId(id) },
+    { $set: { ...data, updatedAt: new Date() } },
+    { returnDocument: "after" },
+  );
+  return result || null;
+};
+
+/**
+ * Delete a system instruction by id
+ * @param id system instruction id
+ * @returns true if deleted, false otherwise
+ */
+export const deleteSystemInstruction = async (id: string): Promise<boolean> => {
+  const result = await getSystemInstructionsCollection().deleteOne({
+    _id: new ObjectId(id),
+  });
+  return result.deletedCount > 0;
+};
+/**
+ * Activate a system instruction by id, sets isActive to true.
+ * Does not check the current instruction state, calling this on an active instruction will do nothing.
+ * @param id system instruction id
+ * @returns true on success, false otherwise
+ */
+export const activateSystemInstruction = async (
+  id: string,
+): Promise<boolean> => {
+  const result = await getSystemInstructionsCollection().findOneAndUpdate(
+    { _id: new ObjectId(id) },
+    { $set: { isActive: true } },
+    { returnDocument: "after" },
+  );
+  return Boolean(result);
+};
+/**
+ * Deactivate a system instruction by id, sets isActive to false.
+ * Does not check the current instruction state, calling this on a deactivated instruction will do nothing.
+ * @param id system instruction id
+ * @returns true on success, false otherwise
+ */
+export const deactivateSystemInstruction = async (
+  id: string,
+): Promise<boolean> => {
+  const result = await getSystemInstructionsCollection().findOneAndUpdate(
+    { _id: new ObjectId(id) },
+    { $set: { isActive: false } },
+    { returnDocument: "after" },
+  );
+  return Boolean(result);
+};

package/src/municipal/systemInstructions/instructions.types.ts

@@ -1,30 +1,30 @@
-import { ObjectId } from "mongodb";
-
-import { CityName } from "../utils/types";
-
-export const MIS_TOOLS = {
-  findStreet: "findStreet",
-  findSubject: "findSubject",
-} as const;
-
-export const QUERY_TYPES = {
-  exactlyOne: "exactlyOne",
-  any: "any",
-  all: "all",
-  none: "none",
-} as const;
-
-export type MIS_Tool = (typeof MIS_TOOLS)[keyof typeof MIS_TOOLS];
-export type QueryType = (typeof QUERY_TYPES)[keyof typeof QUERY_TYPES];
-
-export type MIS_SystemInstruction = {
-  _id: ObjectId;
-  createdAt: Date;
-  updatedAt: Date;
-  cityName: CityName;
-  instruction: string;
-  isActive: boolean;
-  tool: MIS_Tool;
-  queryType: QueryType;
-  tags?: string[]; //no tags implies all wildcard (?)
-};
+import { ObjectId } from "mongodb";
+
+import { CityName } from "../utils/types";
+
+export const MIS_TOOLS = {
+  findStreet: "findStreet",
+  findSubject: "findSubject",
+} as const;
+
+export const QUERY_TYPES = {
+  exactlyOne: "exactlyOne",
+  any: "any",
+  all: "all",
+  none: "none",
+} as const;
+
+export type MIS_Tool = (typeof MIS_TOOLS)[keyof typeof MIS_TOOLS];
+export type QueryType = (typeof QUERY_TYPES)[keyof typeof QUERY_TYPES];
+
+export type MIS_SystemInstruction = {
+  _id: ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+  cityName: CityName;
+  instruction: string;
+  isActive: boolean;
+  tool: MIS_Tool;
+  queryType: QueryType;
+  tags?: string[]; //no tags implies all wildcard (?)
+};

package/src/municipal/tickets/__tests__/tickets.getters.spec.ts

@@ -1,30 +1,30 @@
-import { findTicketsByCallSid } from "../tickets.getters";
-import { setDb } from "../../index";
-import { Db, Collection } from "mongodb";
-import { createTicket } from "../../../test-utils/factories";
-
-describe("tickets getters", () => {
-  let mockDb: Partial<Db>;
-  let mockCollection: Partial<Collection>;
-
-  beforeEach(() => {
-    const mockTicket = createTicket({ callSid: "123" });
-    mockCollection = {
-      find: jest.fn().mockReturnValue({
-        toArray: jest.fn().mockResolvedValue([mockTicket]),
-      }),
-    };
-    mockDb = {
-      collection: jest.fn().mockReturnValue(mockCollection),
-    };
-    setDb(mockDb as Db);
-  });
-
-  it("findTicketsByCallSid should return tickets for the given callSid", async () => {
-    const result = await findTicketsByCallSid("123");
-
-    expect(mockDb.collection).toHaveBeenCalledWith("tickets");
-    expect(mockCollection.find).toHaveBeenCalledWith({ callSid: "123" });
-    expect(result[0].callSid).toBe("123");
-  });
-});
+import { findTicketsByCallSid } from "../tickets.getters";
+import { setDb } from "../../index";
+import { Db, Collection } from "mongodb";
+import { createTicket } from "../../../test-utils/factories";
+
+describe("tickets getters", () => {
+  let mockDb: Partial<Db>;
+  let mockCollection: Partial<Collection>;
+
+  beforeEach(() => {
+    const mockTicket = createTicket({ callSid: "123" });
+    mockCollection = {
+      find: jest.fn().mockReturnValue({
+        toArray: jest.fn().mockResolvedValue([mockTicket]),
+      }),
+    };
+    mockDb = {
+      collection: jest.fn().mockReturnValue(mockCollection),
+    };
+    setDb(mockDb as Db);
+  });
+
+  it("findTicketsByCallSid should return tickets for the given callSid", async () => {
+    const result = await findTicketsByCallSid("123");
+
+    expect(mockDb.collection).toHaveBeenCalledWith("tickets");
+    expect(mockCollection.find).toHaveBeenCalledWith({ callSid: "123" });
+    expect(result[0].callSid).toBe("123");
+  });
+});