@talkpilot/core-db 1.3.6 → 1.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/.cursor/rules/development.mdc +65 -65
  2. package/DEVELOPMENT.md +141 -141
  3. package/README.md +243 -190
  4. package/README_OLD.md +160 -160
  5. package/dist/municipal/tickets/tickets.statistics.getters.d.ts +4 -0
  6. package/dist/municipal/tickets/tickets.statistics.getters.d.ts.map +1 -1
  7. package/dist/municipal/tickets/tickets.statistics.getters.js +30 -3
  8. package/dist/municipal/tickets/tickets.statistics.getters.js.map +1 -1
  9. package/dist/talkpilot/calls/calls.dashboard.d.ts +3 -0
  10. package/dist/talkpilot/calls/calls.dashboard.d.ts.map +1 -0
  11. package/dist/talkpilot/calls/calls.dashboard.js +191 -0
  12. package/dist/talkpilot/calls/calls.dashboard.js.map +1 -0
  13. package/dist/talkpilot/calls/calls.statistics.getters.js +12 -15
  14. package/dist/talkpilot/calls/calls.statistics.getters.js.map +1 -1
  15. package/dist/talkpilot/calls/calls.statistics.types.d.ts +4 -1
  16. package/dist/talkpilot/calls/calls.statistics.types.d.ts.map +1 -1
  17. package/dist/talkpilot/flows/flows.schema.d.ts +3 -0
  18. package/dist/talkpilot/flows/flows.schema.d.ts.map +1 -1
  19. package/dist/talkpilot/flows/flows.schema.js +1 -0
  20. package/dist/talkpilot/flows/flows.schema.js.map +1 -1
  21. package/dist/talkpilot/flows/flows.types.d.ts +1 -0
  22. package/dist/talkpilot/flows/flows.types.d.ts.map +1 -1
  23. package/jest.config.js +20 -20
  24. package/package.json +46 -46
  25. package/src/connection.ts +54 -54
  26. package/src/index.ts +26 -26
  27. package/src/municipal/index.ts +22 -22
  28. package/src/municipal/muniIssues/__tests__/muniIssues.setters.spec.ts +92 -92
  29. package/src/municipal/muniIssues/__tests__/muniIssues.setup.spec.ts +92 -92
  30. package/src/municipal/muniIssues/index.ts +17 -17
  31. package/src/municipal/muniIssues/muniIssues.constants.ts +18 -18
  32. package/src/municipal/muniIssues/muniIssues.getters.ts +24 -24
  33. package/src/municipal/muniIssues/muniIssues.schema.ts +66 -66
  34. package/src/municipal/muniIssues/muniIssues.setters.ts +24 -24
  35. package/src/municipal/muniIssues/muniIssues.setup.ts +65 -65
  36. package/src/municipal/muniIssues/muniIssues.types.ts +37 -37
  37. package/src/municipal/tickets/__tests__/tickets.getters.spec.ts +30 -30
  38. package/src/municipal/tickets/__tests__/tickets.statistics.spec.ts +68 -51
  39. package/src/municipal/tickets/index.ts +3 -3
  40. package/src/municipal/tickets/tickets.constants.ts +8 -8
  41. package/src/municipal/tickets/tickets.getters.ts +121 -121
  42. package/src/municipal/tickets/tickets.statistics.aggregation.ts +96 -96
  43. package/src/municipal/tickets/tickets.statistics.getters.ts +109 -71
  44. package/src/municipal/tickets/tickets.types.ts +53 -53
  45. package/src/talkpilot/calls/__tests__/calls.dashboard.spec.ts +149 -149
  46. package/src/talkpilot/calls/__tests__/calls.statistics.spec.ts +351 -344
  47. package/src/talkpilot/calls/calls.constants.ts +20 -20
  48. package/src/talkpilot/calls/calls.statistics.getters.ts +587 -587
  49. package/src/talkpilot/calls/calls.statistics.types.ts +47 -44
  50. package/src/talkpilot/calls/calls.types.ts +119 -119
  51. package/src/talkpilot/calls/dashboard/calls.dashboard.ts +292 -292
  52. package/src/talkpilot/calls/dashboard/calls.dashboard.types.ts +57 -57
  53. package/src/talkpilot/calls/index.ts +6 -6
  54. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.spec.ts +190 -190
  55. package/src/talkpilot/contextNotes/__tests__/contextNotes.getters.spec.ts +176 -176
  56. package/src/talkpilot/contextNotes/contextNotes.getters.ts +86 -86
  57. package/src/talkpilot/contextNotes/contextNotes.types.ts +20 -20
  58. package/src/talkpilot/contextNotes/index.ts +2 -2
  59. package/src/talkpilot/flows/__tests__/flows.schema.spec.ts +96 -71
  60. package/src/talkpilot/flows/flows.schema.ts +154 -153
  61. package/src/talkpilot/flows/flows.types.ts +187 -186
  62. package/src/talkpilot/index.ts +31 -31
  63. package/src/talkpilot/products/__tests__/products.getters.spec.ts +45 -45
  64. package/src/talkpilot/products/index.ts +2 -2
  65. package/src/talkpilot/products/products.getters.ts +12 -12
  66. package/src/talkpilot/products/products.types.ts +9 -9
  67. package/src/test-utils/db-utils.ts +26 -26
  68. package/src/test-utils/factories/index.ts +15 -15
  69. package/src/test-utils/factories/municipal/muniIssues.ts +32 -32
  70. package/src/test-utils/factories/talkpilot/contextNotes.ts +33 -33
  71. package/src/test-utils/factories/websitalk/scans.ts +23 -23
  72. package/src/utils/date.utils.ts +116 -116
  73. package/src/websitalk/index.ts +15 -15
  74. package/src/websitalk/mongodb-client.ts +61 -61
  75. package/src/websitalk/scans/__tests__/scans.spec.ts +218 -218
  76. package/src/websitalk/scans/index.ts +2 -2
  77. package/src/websitalk/scans/scans.getters.ts +113 -113
  78. package/src/websitalk/scans/scans.types.ts +53 -53
  79. package/tsconfig.json +23 -23
@@ -1,92 +1,92 @@
1
- import { createMuniIssue } from "../muniIssues.setters";
2
- import {
3
- generateMuniIssueId,
4
- getMuniIssueById,
5
- getMuniIssueByJiraKey,
6
- } from "../muniIssues.getters";
7
- import { createMuniIssueInput } from "../../../test-utils/factories";
8
-
9
- describe("muniIssues setters", () => {
10
- describe("createMuniIssue", () => {
11
- it("should insert a well-formed document with createdAt and nested content/jira", async () => {
12
- const input = createMuniIssueInput();
13
- const id = generateMuniIssueId();
14
-
15
- const insertedId = await createMuniIssue(input, id);
16
-
17
- const saved = await getMuniIssueById(insertedId.toString());
18
- expect(saved).toMatchObject({
19
- callSid: input.callSid,
20
- clientId: input.clientId,
21
- cityName: input.cityName,
22
- issueContent: input.issueContent,
23
- jira: input.jira,
24
- });
25
- expect(saved?.createdAt).toBeInstanceOf(Date);
26
- });
27
-
28
- it("should default jira.syncStatus to created when not provided", async () => {
29
- const id = generateMuniIssueId();
30
-
31
- const insertedId = await createMuniIssue(
32
- createMuniIssueInput({ jira: { key: "CP-9" } }),
33
- id,
34
- );
35
-
36
- const saved = await getMuniIssueById(insertedId.toString());
37
- expect(saved?.jira.syncStatus).toBe("created");
38
- });
39
-
40
- it("should store long issueDescription and desiredBehavior in full", async () => {
41
- const issueDescription = "a".repeat(2000);
42
- const desiredBehavior = "b".repeat(2000);
43
- const id = generateMuniIssueId();
44
-
45
- const insertedId = await createMuniIssue(
46
- createMuniIssueInput({
47
- issueContent: {
48
- issuerName: "Dana",
49
- issuerRole: "Agent",
50
- issueDescription,
51
- desiredBehavior,
52
- },
53
- }),
54
- id,
55
- );
56
-
57
- const saved = await getMuniIssueById(insertedId.toString());
58
- expect(saved?.issueContent.issueDescription).toHaveLength(2000);
59
- expect(saved?.issueContent.desiredBehavior).toBe(desiredBehavior);
60
- });
61
-
62
- it("should persist the caller-supplied _id so the Jira ticket can link back", async () => {
63
- const id = generateMuniIssueId();
64
-
65
- const insertedId = await createMuniIssue(createMuniIssueInput(), id);
66
-
67
- expect(insertedId.toString()).toBe(id.toString());
68
- expect(await getMuniIssueById(id.toString())).not.toBeNull();
69
- });
70
- });
71
-
72
- describe("getMuniIssueById", () => {
73
- it("should return null for an unknown or malformed id instead of throwing", async () => {
74
- expect(await getMuniIssueById(generateMuniIssueId().toString())).toBeNull();
75
- expect(await getMuniIssueById("not-a-valid-id")).toBeNull();
76
- });
77
- });
78
-
79
- describe("getMuniIssueByJiraKey", () => {
80
- it("should find the issue with the given Jira key", async () => {
81
- await createMuniIssue(
82
- createMuniIssueInput({ jira: { key: "CP-555" } }),
83
- generateMuniIssueId(),
84
- );
85
-
86
- const found = await getMuniIssueByJiraKey("CP-555");
87
-
88
- expect(found?.jira.key).toBe("CP-555");
89
- expect(await getMuniIssueByJiraKey("CP-nope")).toBeNull();
90
- });
91
- });
92
- });
1
+ import { createMuniIssue } from "../muniIssues.setters";
2
+ import {
3
+ generateMuniIssueId,
4
+ getMuniIssueById,
5
+ getMuniIssueByJiraKey,
6
+ } from "../muniIssues.getters";
7
+ import { createMuniIssueInput } from "../../../test-utils/factories";
8
+
9
+ describe("muniIssues setters", () => {
10
+ describe("createMuniIssue", () => {
11
+ it("should insert a well-formed document with createdAt and nested content/jira", async () => {
12
+ const input = createMuniIssueInput();
13
+ const id = generateMuniIssueId();
14
+
15
+ const insertedId = await createMuniIssue(input, id);
16
+
17
+ const saved = await getMuniIssueById(insertedId.toString());
18
+ expect(saved).toMatchObject({
19
+ callSid: input.callSid,
20
+ clientId: input.clientId,
21
+ cityName: input.cityName,
22
+ issueContent: input.issueContent,
23
+ jira: input.jira,
24
+ });
25
+ expect(saved?.createdAt).toBeInstanceOf(Date);
26
+ });
27
+
28
+ it("should default jira.syncStatus to created when not provided", async () => {
29
+ const id = generateMuniIssueId();
30
+
31
+ const insertedId = await createMuniIssue(
32
+ createMuniIssueInput({ jira: { key: "CP-9" } }),
33
+ id,
34
+ );
35
+
36
+ const saved = await getMuniIssueById(insertedId.toString());
37
+ expect(saved?.jira.syncStatus).toBe("created");
38
+ });
39
+
40
+ it("should store long issueDescription and desiredBehavior in full", async () => {
41
+ const issueDescription = "a".repeat(2000);
42
+ const desiredBehavior = "b".repeat(2000);
43
+ const id = generateMuniIssueId();
44
+
45
+ const insertedId = await createMuniIssue(
46
+ createMuniIssueInput({
47
+ issueContent: {
48
+ issuerName: "Dana",
49
+ issuerRole: "Agent",
50
+ issueDescription,
51
+ desiredBehavior,
52
+ },
53
+ }),
54
+ id,
55
+ );
56
+
57
+ const saved = await getMuniIssueById(insertedId.toString());
58
+ expect(saved?.issueContent.issueDescription).toHaveLength(2000);
59
+ expect(saved?.issueContent.desiredBehavior).toBe(desiredBehavior);
60
+ });
61
+
62
+ it("should persist the caller-supplied _id so the Jira ticket can link back", async () => {
63
+ const id = generateMuniIssueId();
64
+
65
+ const insertedId = await createMuniIssue(createMuniIssueInput(), id);
66
+
67
+ expect(insertedId.toString()).toBe(id.toString());
68
+ expect(await getMuniIssueById(id.toString())).not.toBeNull();
69
+ });
70
+ });
71
+
72
+ describe("getMuniIssueById", () => {
73
+ it("should return null for an unknown or malformed id instead of throwing", async () => {
74
+ expect(await getMuniIssueById(generateMuniIssueId().toString())).toBeNull();
75
+ expect(await getMuniIssueById("not-a-valid-id")).toBeNull();
76
+ });
77
+ });
78
+
79
+ describe("getMuniIssueByJiraKey", () => {
80
+ it("should find the issue with the given Jira key", async () => {
81
+ await createMuniIssue(
82
+ createMuniIssueInput({ jira: { key: "CP-555" } }),
83
+ generateMuniIssueId(),
84
+ );
85
+
86
+ const found = await getMuniIssueByJiraKey("CP-555");
87
+
88
+ expect(found?.jira.key).toBe("CP-555");
89
+ expect(await getMuniIssueByJiraKey("CP-nope")).toBeNull();
90
+ });
91
+ });
92
+ });
@@ -1,92 +1,92 @@
1
- import {
2
- ensureMuniIssuesCollection,
3
- ensureMuniIssuesCollectionOnce,
4
- } from "../muniIssues.setup";
5
- import {
6
- generateMuniIssueId,
7
- getMuniIssuesCollection,
8
- } from "../muniIssues.getters";
9
- import { createMuniIssue } from "../muniIssues.setters";
10
- import { getDb } from "../../index";
11
- import { MUNI_ISSUES_COLLECTION } from "../muniIssues.constants";
12
- import { createMuniIssueInput } from "../../../test-utils/factories";
13
-
14
- describe("muniIssues setup", () => {
15
- describe("ensureMuniIssuesCollection", () => {
16
- it("should create the collection with a validator and the declared indexes", async () => {
17
- await ensureMuniIssuesCollection();
18
-
19
- const [collection] = (await getDb()
20
- .listCollections({ name: MUNI_ISSUES_COLLECTION })
21
- .toArray()) as { options?: { validator?: unknown } }[];
22
- expect(collection?.options?.validator).toHaveProperty("$jsonSchema");
23
-
24
- const indexNames = (await getMuniIssuesCollection().indexes()).map(
25
- (i) => i.name,
26
- );
27
- expect(indexNames).toEqual(
28
- expect.arrayContaining([
29
- "callSid_1",
30
- "createdAt_-1",
31
- "jira_key_unique",
32
- ]),
33
- );
34
- });
35
-
36
- it("should accept a valid document and reject ones that violate the schema", async () => {
37
- await ensureMuniIssuesCollection();
38
-
39
- await expect(
40
- createMuniIssue(createMuniIssueInput(), generateMuniIssueId()),
41
- ).resolves.toBeDefined();
42
-
43
- // Missing required issueContent fields → DB validation rejects it.
44
- await expect(
45
- getMuniIssuesCollection().insertOne({
46
- callSid: "CA-bad",
47
- createdAt: new Date(),
48
- } as never),
49
- ).rejects.toThrow();
50
-
51
- // jira.syncStatus outside the enum → DB validation rejects it.
52
- await expect(
53
- createMuniIssue(
54
- createMuniIssueInput({
55
- jira: { key: "CP-99", syncStatus: "weird" as never },
56
- }),
57
- generateMuniIssueId(),
58
- ),
59
- ).rejects.toThrow();
60
- });
61
-
62
- it("should enforce the unique jira.key index", async () => {
63
- await ensureMuniIssuesCollection();
64
- const input = createMuniIssueInput();
65
- await createMuniIssue(input, generateMuniIssueId());
66
-
67
- // Same jira.key on a second insert violates the unique index.
68
- await expect(
69
- createMuniIssue(input, generateMuniIssueId()),
70
- ).rejects.toThrow();
71
- });
72
-
73
- it("should be idempotent when run twice", async () => {
74
- await ensureMuniIssuesCollection();
75
- await expect(ensureMuniIssuesCollection()).resolves.toBeUndefined();
76
- });
77
- });
78
-
79
- describe("ensureMuniIssuesCollectionOnce", () => {
80
- it("should run the provisioning work at most once per process", async () => {
81
- const createSpy = jest.spyOn(getDb(), "createCollection");
82
-
83
- await Promise.all([
84
- ensureMuniIssuesCollectionOnce(),
85
- ensureMuniIssuesCollectionOnce(),
86
- ]);
87
- await ensureMuniIssuesCollectionOnce();
88
-
89
- expect(createSpy).toHaveBeenCalledTimes(1);
90
- });
91
- });
92
- });
1
+ import {
2
+ ensureMuniIssuesCollection,
3
+ ensureMuniIssuesCollectionOnce,
4
+ } from "../muniIssues.setup";
5
+ import {
6
+ generateMuniIssueId,
7
+ getMuniIssuesCollection,
8
+ } from "../muniIssues.getters";
9
+ import { createMuniIssue } from "../muniIssues.setters";
10
+ import { getDb } from "../../index";
11
+ import { MUNI_ISSUES_COLLECTION } from "../muniIssues.constants";
12
+ import { createMuniIssueInput } from "../../../test-utils/factories";
13
+
14
+ describe("muniIssues setup", () => {
15
+ describe("ensureMuniIssuesCollection", () => {
16
+ it("should create the collection with a validator and the declared indexes", async () => {
17
+ await ensureMuniIssuesCollection();
18
+
19
+ const [collection] = (await getDb()
20
+ .listCollections({ name: MUNI_ISSUES_COLLECTION })
21
+ .toArray()) as { options?: { validator?: unknown } }[];
22
+ expect(collection?.options?.validator).toHaveProperty("$jsonSchema");
23
+
24
+ const indexNames = (await getMuniIssuesCollection().indexes()).map(
25
+ (i) => i.name,
26
+ );
27
+ expect(indexNames).toEqual(
28
+ expect.arrayContaining([
29
+ "callSid_1",
30
+ "createdAt_-1",
31
+ "jira_key_unique",
32
+ ]),
33
+ );
34
+ });
35
+
36
+ it("should accept a valid document and reject ones that violate the schema", async () => {
37
+ await ensureMuniIssuesCollection();
38
+
39
+ await expect(
40
+ createMuniIssue(createMuniIssueInput(), generateMuniIssueId()),
41
+ ).resolves.toBeDefined();
42
+
43
+ // Missing required issueContent fields → DB validation rejects it.
44
+ await expect(
45
+ getMuniIssuesCollection().insertOne({
46
+ callSid: "CA-bad",
47
+ createdAt: new Date(),
48
+ } as never),
49
+ ).rejects.toThrow();
50
+
51
+ // jira.syncStatus outside the enum → DB validation rejects it.
52
+ await expect(
53
+ createMuniIssue(
54
+ createMuniIssueInput({
55
+ jira: { key: "CP-99", syncStatus: "weird" as never },
56
+ }),
57
+ generateMuniIssueId(),
58
+ ),
59
+ ).rejects.toThrow();
60
+ });
61
+
62
+ it("should enforce the unique jira.key index", async () => {
63
+ await ensureMuniIssuesCollection();
64
+ const input = createMuniIssueInput();
65
+ await createMuniIssue(input, generateMuniIssueId());
66
+
67
+ // Same jira.key on a second insert violates the unique index.
68
+ await expect(
69
+ createMuniIssue(input, generateMuniIssueId()),
70
+ ).rejects.toThrow();
71
+ });
72
+
73
+ it("should be idempotent when run twice", async () => {
74
+ await ensureMuniIssuesCollection();
75
+ await expect(ensureMuniIssuesCollection()).resolves.toBeUndefined();
76
+ });
77
+ });
78
+
79
+ describe("ensureMuniIssuesCollectionOnce", () => {
80
+ it("should run the provisioning work at most once per process", async () => {
81
+ const createSpy = jest.spyOn(getDb(), "createCollection");
82
+
83
+ await Promise.all([
84
+ ensureMuniIssuesCollectionOnce(),
85
+ ensureMuniIssuesCollectionOnce(),
86
+ ]);
87
+ await ensureMuniIssuesCollectionOnce();
88
+
89
+ expect(createSpy).toHaveBeenCalledTimes(1);
90
+ });
91
+ });
92
+ });
@@ -1,17 +1,17 @@
1
- export * from "./muniIssues.getters";
2
- export * from "./muniIssues.setters";
3
- export * from "./muniIssues.setup";
4
- export {
5
- MUNI_ISSUES_COLLECTION,
6
- MUNI_ISSUE_SYNC_STATUSES,
7
- MUNI_ISSUE_TEXT_MAX_LENGTH,
8
- MUNI_ISSUE_NAME_MAX_LENGTH,
9
- } from "./muniIssues.constants";
10
- export { muniIssuesJsonSchema, muniIssuesIndexes } from "./muniIssues.schema";
11
- export type {
12
- MuniIssue,
13
- MuniIssueContent,
14
- MuniIssueJira,
15
- MuniIssueSyncStatus,
16
- CreateMuniIssueInput,
17
- } from "./muniIssues.types";
1
+ export * from "./muniIssues.getters";
2
+ export * from "./muniIssues.setters";
3
+ export * from "./muniIssues.setup";
4
+ export {
5
+ MUNI_ISSUES_COLLECTION,
6
+ MUNI_ISSUE_SYNC_STATUSES,
7
+ MUNI_ISSUE_TEXT_MAX_LENGTH,
8
+ MUNI_ISSUE_NAME_MAX_LENGTH,
9
+ } from "./muniIssues.constants";
10
+ export { muniIssuesJsonSchema, muniIssuesIndexes } from "./muniIssues.schema";
11
+ export type {
12
+ MuniIssue,
13
+ MuniIssueContent,
14
+ MuniIssueJira,
15
+ MuniIssueSyncStatus,
16
+ CreateMuniIssueInput,
17
+ } from "./muniIssues.types";
@@ -1,18 +1,18 @@
1
- /** Mongo collection name for reported municipal issues. */
2
- export const MUNI_ISSUES_COLLECTION = "muniIssues";
3
-
4
- /** Sync state of the issue's Jira ticket at write time. */
5
- export const MUNI_ISSUE_SYNC_STATUSES = ["created", "failed"] as const;
6
-
7
- /** Max length for the long free-text fields — well above the ~2000-char target. */
8
- export const MUNI_ISSUE_TEXT_MAX_LENGTH = 5000;
9
-
10
- /** Max length for the short identity fields (a person's name and role). */
11
- export const MUNI_ISSUE_NAME_MAX_LENGTH = 200;
12
-
13
- /** MongoDB error 48 (NamespaceExists): collection already exists, e.g. concurrent createCollection. */
14
- export const NAMESPACE_EXISTS = 48;
15
-
16
- /** Reject (not just flag) writes that fail the $jsonSchema validator. */
17
- export const VALIDATION_LEVEL = "strict" as const;
18
- export const VALIDATION_ACTION = "error" as const;
1
+ /** Mongo collection name for reported municipal issues. */
2
+ export const MUNI_ISSUES_COLLECTION = "muniIssues";
3
+
4
+ /** Sync state of the issue's Jira ticket at write time. */
5
+ export const MUNI_ISSUE_SYNC_STATUSES = ["created", "failed"] as const;
6
+
7
+ /** Max length for the long free-text fields — well above the ~2000-char target. */
8
+ export const MUNI_ISSUE_TEXT_MAX_LENGTH = 5000;
9
+
10
+ /** Max length for the short identity fields (a person's name and role). */
11
+ export const MUNI_ISSUE_NAME_MAX_LENGTH = 200;
12
+
13
+ /** MongoDB error 48 (NamespaceExists): collection already exists, e.g. concurrent createCollection. */
14
+ export const NAMESPACE_EXISTS = 48;
15
+
16
+ /** Reject (not just flag) writes that fail the $jsonSchema validator. */
17
+ export const VALIDATION_LEVEL = "strict" as const;
18
+ export const VALIDATION_ACTION = "error" as const;
@@ -1,24 +1,24 @@
1
- import { Collection, ObjectId } from "mongodb";
2
- import { getDb } from "../index";
3
- import { MuniIssue } from "./muniIssues.types";
4
- import { MUNI_ISSUES_COLLECTION } from "./muniIssues.constants";
5
-
6
- export const getMuniIssuesCollection = (): Collection<MuniIssue> => {
7
- return getDb().collection<MuniIssue>(MUNI_ISSUES_COLLECTION);
8
- };
9
-
10
- export const generateMuniIssueId = (): ObjectId => new ObjectId();
11
-
12
- export const getMuniIssueById = async (
13
- id: string,
14
- ): Promise<MuniIssue | null> => {
15
- // A malformed id is treated as not-found rather than throwing on `new ObjectId`.
16
- if (!ObjectId.isValid(id)) return null;
17
- return getMuniIssuesCollection().findOne({ _id: new ObjectId(id) });
18
- };
19
-
20
- export const getMuniIssueByJiraKey = async (
21
- jiraKey: string,
22
- ): Promise<MuniIssue | null> => {
23
- return getMuniIssuesCollection().findOne({ "jira.key": jiraKey });
24
- };
1
+ import { Collection, ObjectId } from "mongodb";
2
+ import { getDb } from "../index";
3
+ import { MuniIssue } from "./muniIssues.types";
4
+ import { MUNI_ISSUES_COLLECTION } from "./muniIssues.constants";
5
+
6
+ export const getMuniIssuesCollection = (): Collection<MuniIssue> => {
7
+ return getDb().collection<MuniIssue>(MUNI_ISSUES_COLLECTION);
8
+ };
9
+
10
+ export const generateMuniIssueId = (): ObjectId => new ObjectId();
11
+
12
+ export const getMuniIssueById = async (
13
+ id: string,
14
+ ): Promise<MuniIssue | null> => {
15
+ // A malformed id is treated as not-found rather than throwing on `new ObjectId`.
16
+ if (!ObjectId.isValid(id)) return null;
17
+ return getMuniIssuesCollection().findOne({ _id: new ObjectId(id) });
18
+ };
19
+
20
+ export const getMuniIssueByJiraKey = async (
21
+ jiraKey: string,
22
+ ): Promise<MuniIssue | null> => {
23
+ return getMuniIssuesCollection().findOne({ "jira.key": jiraKey });
24
+ };
@@ -1,66 +1,66 @@
1
- import type { Document, IndexDescription } from "mongodb";
2
- import {
3
- MUNI_ISSUE_SYNC_STATUSES,
4
- MUNI_ISSUE_TEXT_MAX_LENGTH,
5
- MUNI_ISSUE_NAME_MAX_LENGTH,
6
- } from "./muniIssues.constants";
7
-
8
- export const muniIssuesJsonSchema: Document = {
9
- bsonType: "object",
10
- required: [
11
- "callSid",
12
- "clientId",
13
- "cityName",
14
- "issueContent",
15
- "jira",
16
- "createdAt",
17
- ],
18
- properties: {
19
- callSid: { bsonType: "string" },
20
- clientId: { bsonType: "string" },
21
- cityName: { bsonType: "string" },
22
- issueContent: {
23
- bsonType: "object",
24
- required: [
25
- "issuerName",
26
- "issuerRole",
27
- "issueDescription",
28
- "desiredBehavior",
29
- ],
30
- properties: {
31
- issuerName: {
32
- bsonType: "string",
33
- maxLength: MUNI_ISSUE_NAME_MAX_LENGTH,
34
- },
35
- issuerRole: {
36
- bsonType: "string",
37
- maxLength: MUNI_ISSUE_NAME_MAX_LENGTH,
38
- },
39
- issueDescription: {
40
- bsonType: "string",
41
- maxLength: MUNI_ISSUE_TEXT_MAX_LENGTH,
42
- },
43
- desiredBehavior: {
44
- bsonType: "string",
45
- maxLength: MUNI_ISSUE_TEXT_MAX_LENGTH,
46
- },
47
- },
48
- },
49
- jira: {
50
- bsonType: "object",
51
- required: ["key", "syncStatus"],
52
- properties: {
53
- key: { bsonType: "string" },
54
- syncStatus: { enum: [...MUNI_ISSUE_SYNC_STATUSES] },
55
- },
56
- },
57
- createdAt: { bsonType: "date" },
58
- },
59
- };
60
-
61
- export const muniIssuesIndexes: IndexDescription[] = [
62
- { key: { callSid: 1 }, name: "callSid_1" },
63
- { key: { createdAt: -1 }, name: "createdAt_-1" },
64
- // Unique: one stored document per Jira ticket, guarding against duplicate writes.
65
- { key: { "jira.key": 1 }, name: "jira_key_unique", unique: true },
66
- ];
1
+ import type { Document, IndexDescription } from "mongodb";
2
+ import {
3
+ MUNI_ISSUE_SYNC_STATUSES,
4
+ MUNI_ISSUE_TEXT_MAX_LENGTH,
5
+ MUNI_ISSUE_NAME_MAX_LENGTH,
6
+ } from "./muniIssues.constants";
7
+
8
+ export const muniIssuesJsonSchema: Document = {
9
+ bsonType: "object",
10
+ required: [
11
+ "callSid",
12
+ "clientId",
13
+ "cityName",
14
+ "issueContent",
15
+ "jira",
16
+ "createdAt",
17
+ ],
18
+ properties: {
19
+ callSid: { bsonType: "string" },
20
+ clientId: { bsonType: "string" },
21
+ cityName: { bsonType: "string" },
22
+ issueContent: {
23
+ bsonType: "object",
24
+ required: [
25
+ "issuerName",
26
+ "issuerRole",
27
+ "issueDescription",
28
+ "desiredBehavior",
29
+ ],
30
+ properties: {
31
+ issuerName: {
32
+ bsonType: "string",
33
+ maxLength: MUNI_ISSUE_NAME_MAX_LENGTH,
34
+ },
35
+ issuerRole: {
36
+ bsonType: "string",
37
+ maxLength: MUNI_ISSUE_NAME_MAX_LENGTH,
38
+ },
39
+ issueDescription: {
40
+ bsonType: "string",
41
+ maxLength: MUNI_ISSUE_TEXT_MAX_LENGTH,
42
+ },
43
+ desiredBehavior: {
44
+ bsonType: "string",
45
+ maxLength: MUNI_ISSUE_TEXT_MAX_LENGTH,
46
+ },
47
+ },
48
+ },
49
+ jira: {
50
+ bsonType: "object",
51
+ required: ["key", "syncStatus"],
52
+ properties: {
53
+ key: { bsonType: "string" },
54
+ syncStatus: { enum: [...MUNI_ISSUE_SYNC_STATUSES] },
55
+ },
56
+ },
57
+ createdAt: { bsonType: "date" },
58
+ },
59
+ };
60
+
61
+ export const muniIssuesIndexes: IndexDescription[] = [
62
+ { key: { callSid: 1 }, name: "callSid_1" },
63
+ { key: { createdAt: -1 }, name: "createdAt_-1" },
64
+ // Unique: one stored document per Jira ticket, guarding against duplicate writes.
65
+ { key: { "jira.key": 1 }, name: "jira_key_unique", unique: true },
66
+ ];