feat: change to have up to do date version in contract root

Author: April-Bates-Dev

event-catalog/events/PersonRegisteredContract/index.md

@@ -0,0 +1,20 @@
+---
+name: PersonRegisteredContract
+version: 2
+summary: |
+  A summary
+producers:
+  - Producer
+consumers:
+  - Consumer
+owners:
+  - Name
+---
+
+<Admonition>Some information</Admonition>
+
+### Details
+
+Some details...
+
+<Schema />

event-catalog/events/PersonRegisteredContract/schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "detail-type": {
+      "type": "string",
+      "const": "PersonRegisteredContract"
+    },
+    "detail": {
+      "type": "object",
+      "properties": {
+        "detail-version": {
+          "type": "number",
+          "const": 2
+        },
+        "data": {
+          "type": "object",
+          "properties": {
+            "firstName": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "firstName"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "detail-version",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "detail",
+    "detail-type"
+  ],
+  "additionalProperties": false,
+  "definitions": {}
+}

event-catalog/events/Test/index.md

@@ -0,0 +1,20 @@
+---
+name: Test
+version: 1
+summary: |
+  A summary
+producers:
+  - Producer
+consumers:
+  - Consumer
+owners:
+  - Name
+---
+
+<Admonition>Some information</Admonition>
+
+### Details
+
+Some details...
+
+<Schema />

event-catalog/events/Test/schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "detail-type": {
+      "type": "string",
+      "const": "Test"
+    },
+    "detail": {
+      "type": "object",
+      "properties": {
+        "detail-version": {
+          "type": "number",
+          "const": 1
+        },
+        "data": {
+          "type": "object",
+          "properties": {
+            "test": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "test"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "detail-version",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "detail",
+    "detail-type"
+  ],
+  "additionalProperties": false,
+  "definitions": {}
+}

event-catalog/events/Test/versioned/1/index.md

@@ -0,0 +1,20 @@
+---
+name: Test
+version: 1
+summary: |
+  A summary
+producers:
+  - Producer
+consumers:
+  - Consumer
+owners:
+  - Name
+---
+
+<Admonition>Some information</Admonition>
+
+### Details
+
+Some details...
+
+<Schema />

event-catalog/events/Test/versioned/1/schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "detail-type": {
+      "type": "string",
+      "const": "Test"
+    },
+    "detail": {
+      "type": "object",
+      "properties": {
+        "detail-version": {
+          "type": "number",
+          "const": 1
+        },
+        "data": {
+          "type": "object",
+          "properties": {
+            "test": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "test"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "detail-version",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "detail",
+    "detail-type"
+  ],
+  "additionalProperties": false,
+  "definitions": {}
+}

example-architecture/events/contracts/testContractV1.ts

@@ -0,0 +1,10 @@
+import { Contract } from "../../types";
+export interface Test extends Contract {
+  "detail-type": "Test";
+  detail: {
+    "detail-version": 1;
+    data: {
+      test: string;
+    };
+  };
+}

src/generate-docs.ts

@@ -5,6 +5,7 @@ import path from "path";
 import { generateSchemaDetails } from "./helpers/generateSchemaDetails.js";
 import { writeIndexFile } from "./helpers/writeIndexFile.js";
 import { writeSchemaFile } from "./helpers/writeSchemaFile.js";
+import { ContractSchemaType, SchemaDetails } from "./types.js";
 
 //Note: contract file name must include term 'Contract' to be parsed
 const getContractFileNames = async (
@@ -15,27 +16,65 @@ const getContractFileNames = async (
   return files.filter((fileName) => fileName.includes("Contract"));
 };
 
-const getRecordOfNewestVersions = (
-  newestVersions: Record<string, number>,
-  detailType: string,
-  detailVersion: number
-): Record<string, number> => {
-  if ("detailType" in newestVersions) {
-    if (newestVersions[detailType] < detailVersion) {
-      newestVersions[detailType] = detailVersion;
+const getRecordOfNewestContractVersions = (
+  newestContractVersions: Record<
+    string,
+    { detailVersion: number; schema: ContractSchemaType }
+  >,
+  schemaDetails: SchemaDetails
+): Record<string, { detailVersion: number; schema: ContractSchemaType }> => {
+  const { detailType, detailVersion, schema } = schemaDetails;
+
+  if ("detailType" in newestContractVersions) {
+    if (newestContractVersions[detailType].detailVersion < detailVersion) {
+      newestContractVersions[detailType] = {
+        detailVersion,
+        schema,
+      };
     }
   } else {
-    newestVersions[detailType] = detailVersion;
+    newestContractVersions[detailType] = {
+      detailVersion,
+      schema,
+    };
+  }
+  return newestContractVersions;
+};
+
+const writeNewestContractVersionDocs = async (
+  newestContractVersions: Record<
+    string,
+    { detailVersion: number; schema: ContractSchemaType }
+  >,
+  pathToDocumentationFolder: string
+) => {
+  for (const detailType in newestContractVersions) {
+    const detailVersion = newestContractVersions[detailType].detailVersion;
+    const pathToContractDocumentationFolder = path.join(
+      `${pathToDocumentationFolder}/${detailType}`
+    );
+    await writeIndexFile(
+      pathToContractDocumentationFolder,
+      detailType,
+      detailVersion
+    );
+
+    await writeSchemaFile(
+      pathToContractDocumentationFolder,
+      newestContractVersions[detailType].schema
+    );
   }
-  return newestVersions;
 };
 
 export const generateDocumentation = async (
   pathToContractsFolder: string,
   pathToDocumentationFolder: string
 ): Promise<void> => {
   const contractFileNames = await getContractFileNames(pathToContractsFolder);
-  let newestVersions: Record<string, number> = {};
+  let newestContractVersions: Record<
+    string,
+    { detailVersion: number; schema: ContractSchemaType }
+  > = {};
 
   for (const contractFileName of contractFileNames) {
     const { detailType, detailVersion, schema } = generateSchemaDetails(
@@ -57,13 +96,16 @@ export const generateDocumentation = async (
 
     await writeSchemaFile(pathToContractDocumentationFolder, schema);
 
-    newestVersions = getRecordOfNewestVersions(
-      newestVersions,
-      detailType,
-      detailVersion
+    newestContractVersions = getRecordOfNewestContractVersions(
+      newestContractVersions,
+      { detailType, detailVersion, schema }
     );
 
-    console.log(`Created docs for ${contractFileName}`);
-    console.log(newestVersions);
+    console.log(newestContractVersions);
   }
+
+  writeNewestContractVersionDocs(
+    newestContractVersions,
+    pathToDocumentationFolder
+  );
 };