wip

Author: paula-stacho

package-lock.json

@@ -1,5 +1,58 @@
 import { z } from '@mongodb-js/compass-user-data';
 
+export const RelationshipSideSchema = z.object({
+  ns: z.string(),
+  cardinality: z.number(),
+  fields: z.array(z.string()),
+});
+
+export type RelationshipSide = z.output<typeof RelationshipSideSchema>;
+
+export const RelationshipSchema = z.object({
+  id: z.string(),
+  relationship: z.tuple([RelationshipSideSchema, RelationshipSideSchema]),
+  isInferred: z.boolean(),
+});
+
+export type Relationship = z.output<typeof RelationshipSchema>;
+
+export const StaticModelSchema = z.object({
+  collections: z.array(
+    z.object({
+      ns: z.string(),
+      jsonSchema: z.unknown(), // MongoDBJSONSchema is not directly representable in zod
+      indexes: z.array(z.record(z.unknown())),
+      shardKey: z.record(z.unknown()).optional(),
+      displayPosition: z.tuple([z.number(), z.number()]),
+    })
+  ),
+  relationships: z.array(RelationshipSchema),
+});
+
+export type StaticModel = z.output<typeof StaticModelSchema>;
+
+export const EditSchema = z.discriminatedUnion('type', [
+  z.object({
+    type: z.literal('SetModel'),
+    id: z.string(),
+    timestamp: z.string(),
+    model: StaticModelSchema,
+  }),
+  z.object({
+    type: z.literal('AddRelationship'),
+    id: z.string(),
+    timestamp: z.string(),
+    relationship: RelationshipSchema,
+  }),
+  z.object({
+    type: z.literal('RemoveRelationship'),
+    id: z.string(),
+    timestamp: z.string(),
+  }),
+]);
+
+export type Edit = z.output<typeof EditSchema>;
+
 export const MongoDBDataModelDescriptionSchema = z.object({
   id: z.string(),
   name: z.string(),
@@ -11,8 +64,7 @@ export const MongoDBDataModelDescriptionSchema = z.object({
    */
   connectionId: z.string().nullable(),
 
-  // TODO: define rest of the schema based on arch doc / tech design
-  edits: z.array(z.unknown()).default([]),
+  edits: z.array(EditSchema).default([]),
 });
 
 export type MongoDBDataModelDescription = z.output<

packages/compass-data-modeling/src/services/data-model-storage.ts

@@ -1,7 +1,10 @@
 import type { Reducer } from 'redux';
 import { UUID } from 'bson';
 import { isAction } from './util';
-import type { MongoDBDataModelDescription } from '../services/data-model-storage';
+import type {
+  Edit,
+  MongoDBDataModelDescription,
+} from '../services/data-model-storage';
 import { AnalysisProcessActionTypes } from './analysis-process';
 import { memoize } from 'lodash';
 import type { DataModelingState, DataModelingThunkAction } from './reducer';
@@ -10,9 +13,9 @@ import { showConfirmation, showPrompt } from '@mongodb-js/compass-components';
 export type DiagramState =
   | (Omit<MongoDBDataModelDescription, 'edits'> & {
       edits: {
-        prev: MongoDBDataModelDescription['edits'][];
-        current: MongoDBDataModelDescription['edits'];
-        next: MongoDBDataModelDescription['edits'][];
+        prev: Edit[];
+        current: Edit[];
+        next: Edit[];
       };
     })
   | null; // null when no diagram is currently open
@@ -44,7 +47,6 @@ export type RenameDiagramAction = {
 
 export type ApplyEditAction = {
   type: DiagramActionTypes.APPLY_EDIT;
-  // TODO
   edit: unknown;
 };
 

packages/compass-data-modeling/src/store/diagram.ts

@@ -60,7 +60,7 @@
     "lodash": "^4.17.21",
     "react": "^17.0.2",
     "yargs-parser": "^21.1.1",
-    "zod": "^3.22.3"
+    "zod": "^3.24.4"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-compass": "^1.3.8",

packages/compass-preferences-model/package.json

@@ -52,7 +52,7 @@
     "@mongodb-js/compass-logging": "^1.6.9",
     "@mongodb-js/compass-utils": "^0.8.8",
     "write-file-atomic": "^5.0.1",
-    "zod": "^3.22.3"
+    "zod": "^3.24.4"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-compass": "^1.3.8",