Restore dataschema diagram generation

Author: m-houston

internal/datastore/package.json

@@ -19,13 +19,15 @@
     "testcontainers": "^11.4.0",
     "ts-jest": "^29.4.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "zod-mermaid": "^1.0.9"
   },
   "license": "MIT",
   "main": "src/index.ts",
   "name": "@internal/datastore",
   "private": true,
   "scripts": {
+    "diagrams": "tsx src/cli/diagrams.ts",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "test:unit": "jest",

internal/datastore/src/cli/diagrams.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/types.md

@@ -0,0 +1,43 @@
+# 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.
+
+## Letter schema
+
+```mermaid
+erDiagram
+    Letter {
+        string id
+        string status "enum: PENDING, ACCEPTED, REJECTED, PRINTED, ENCLOSED, CANCELLED, DISPATCHED, FAILED, RETURNED, DESTROYED, FORWARDED, DELIVERED"
+        string specificationId
+        string groupId
+        number reasonCode
+        string reasonText
+        string supplierId
+        string url "url"
+        string createdAt
+        string updatedAt
+        string supplierStatus
+        string supplierStatusSk
+        number ttl "min: -9007199254740991, max: 9007199254740991"
+    }
+```
+
+## MI schema
+
+```mermaid
+erDiagram
+    MI {
+        string id
+        string supplierId
+        string specificationId
+        string groupId
+        string lineItem
+        number quantity
+        number stockRemaining
+        string createdAt
+        string updatedAt
+    }
+```