CCM-11228: Update letter repository tests and add MI schema and diagram generation

Author: m-houston

internal/datastore/package.json

@@ -26,7 +26,7 @@
   "name": "datastore",
   "private": true,
   "scripts": {
-    "diagrams": "ts-node src/__test__/genmermaid.ts",
+    "diagrams": "ts-node src/cli/diagrams.ts",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "test:unit": "jest",

internal/datastore/src/__test__/genmermaid.ts

@@ -5,7 +5,7 @@ import { Logger } from 'pino';
 import { createTestLogger, LogStream } from './logs';
 import { PutCommand } from '@aws-sdk/lib-dynamodb';
 
-function createLetter(supplierId: string, letterId: string, status: Letter['status'] = 'PENDING'): Letter {
+function createLetter(supplierId: string, letterId: string, status: Letter['status'] = 'PENDING'): Omit<Letter, 'ttl' | 'supplierStatus'> {
   return {
     id: letterId,
     supplierId: supplierId,
@@ -114,6 +114,8 @@ describe('LetterRepository', () => {
     const originalLetter = await letterRepository.getLetterById('supplier1', 'letter1');
     expect(originalLetter.updatedAt).toBe('2020-02-01T00:00:00.000Z');
 
+    // Month is zero-indexed in JavaScript Date
+    // Day is one-indexed
     jest.setSystemTime(new Date(2020, 1, 2));
     await letterRepository.updateLetterStatus('supplier1', 'letter1', 'DELIVERED');
     const updatedLetter = await letterRepository.getLetterById('supplier1', 'letter1');
@@ -185,6 +187,7 @@ describe('LetterRepository', () => {
   });
 
   test('letter list should return empty when no letters match status', async () => {
+    await letterRepository.putLetter(createLetter('supplier1', 'letter1', 'ACCEPTED'));
     const page = await letterRepository.getLettersByStatus('supplier1', 'PENDING');
     expect(page.letters).toHaveLength(0);
     expect(page.lastEvaluatedKey).toBeUndefined();

internal/datastore/src/__test__/letter-repository.test.ts

@@ -0,0 +1,25 @@
+import { LetterSchema, MISchema } from '../types';
+import { generateMermaidDiagram } from 'zod-mermaid';
+import * as fs from 'node:fs';
+
+const out = fs.openSync('src/types.md', 'w');
+
+fs.writeSync(out, `# Data Store Schemas
+
+This document contains the mermaid diagrams for the data store schemas used in the application.
+
+The schemas are generated from Zod definitions and provide a visual representation of the data structure.
+`);
+
+for (const [name, schema] of Object.entries({ Letter: [LetterSchema], MI: [MISchema] })) {
+  const mermaid = generateMermaidDiagram(schema);
+  fs.writeSync(out, `
+## ${name} schema
+
+\`\`\`mermaid
+${mermaid}
+\`\`\`
+`);
+}
+
+fs.closeSync(out);

internal/datastore/src/cli/diagrams.ts

@@ -6,7 +6,7 @@ import {
   UpdateCommand,
   UpdateCommandOutput
 } from '@aws-sdk/lib-dynamodb';
-import { Letter, LetterDB, LetterSchema } from './types';
+import { Letter, LetterSchema } from './types';
 import { Logger } from 'pino';
 
 export type PagingOptions = Partial<{
@@ -29,8 +29,8 @@ export class LetterRepository {
               readonly config: LetterRepositoryConfig) {
   }
 
-  async putLetter(letter: Letter): Promise<Letter> {
-    const letterDb: LetterDB = {
+  async putLetter(letter: Omit<Letter, 'ttl' | 'supplierStatus'>): Promise<Letter> {
+    const letterDb: Letter = {
       ...letter,
       supplierStatus: `${letter.supplierId}#${letter.status}`,
       ttl: Math.floor(Date.now() / 1000 + 60 * 60 * this.config.ttlHours)

internal/datastore/src/letter-repository.ts

@@ -1,5 +1,10 @@
+# Data Store Schemas
 
-# Letter schema
+This document contains the mermaid diagrams for the data store schemas used in the application.
+
+The schemas are generated from Zod definitions and provide a visual representation of the data structure.
+
+## Letter schema
 
 ```mermaid
 erDiagram
@@ -12,14 +17,30 @@ erDiagram
         string status "enum: PENDING, ACCEPTED, DISPATCHED, FAILED, REJECTED, DELIVERED, CANCELLED"
         string createdAt
         string updatedAt
+        string supplierStatus
+        number ttl "min: -9007199254740991, max: 9007199254740991"
     }
     Supplier {
     }
-    Supplier {
+    Letter }o--|| Supplier : "supplierId"
+```
+
+## MI schema
+
+```mermaid
+erDiagram
+    MI {
         string id
-        string name
-        string apimId
-        string status "enum: ENABLED, DISABLED"
+        string supplierId "ref: Supplier"
+        string specificationId
+        string groupId
+        string lineItem
+        number quantity
+        number stockRemaining
+        string createdAt
+        string updatedAt
     }
-    Letter }o--|| Supplier : "supplierId"
+    Supplier {
+    }
+    MI }o--|| Supplier : "supplierId"
 ```

internal/datastore/src/types.md

@@ -24,18 +24,28 @@ export const LetterSchema = z.object({
   url: z.url(),
   status: LetterStatus,
   createdAt: z.string(),
-  updatedAt: z.string()
-}).describe('Letter');
-
-export type Letter = z.infer<typeof LetterSchema>;
-
-export const LetterDBSchema = LetterSchema.extend({
+  updatedAt: z.string(),
   supplierStatus: z.string().describe('Secondary index PK'),
   ttl: z.int()
-});
+}).describe('Letter');
 
 /**
- * LetterDB is the type used for storing letters in the database.
- * It extends the LetterSchema with a secondary index for supplierStatus.
+ * Letter is the type used for storing letters in the database.
+ * The supplierStatus is a composite key combining supplierId and status.
+ * The ttl is used for automatic deletion of old letters.
  */
-export type LetterDB = z.infer<typeof LetterDBSchema>;
+export type Letter = z.infer<typeof LetterSchema>;
+
+export const MISchema = z.object({
+  id: z.string(),
+  supplierId: idRef(SupplierSchema),
+  specificationId: z.string(),
+  groupId: z.string(),
+  lineItem: z.string(),
+  quantity: z.number(),
+  stockRemaining: z.number(),
+  createdAt: z.string(),
+  updatedAt: z.string()
+}).describe('MI');
+
+export type MI = z.infer<typeof MISchema>;

internal/datastore/src/types.ts

@@ -30,3 +30,4 @@ Terraform
 toolchain
 Trufflehog
 vNext
+Zod