#55 , Implement document types

package.json

@@ -51,7 +51,8 @@
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",
     "sqlite3": "^5.1.6",
-    "unist-util-select": "^4.0.3"
+    "unist-util-select": "^4.0.3",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.8",
@@ -69,4 +70,4 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   }
-}
+}

src/lib/CustomConfig.ts

@@ -1,6 +1,11 @@
 import { FileInfo } from "./process.js";
 import { Root } from "remark-parse/lib/index.js";
+import { ZodObject } from "zod";
+
+type ComputedFields = ((fileInfo: FileInfo, ast: Root) => any)[];
+type Schemas = { [index: string]: ZodObject<any> };
 
 export interface CustomConfig {
-  computedFields?: ((fileInfo: FileInfo, ast: Root) => any)[];
+  computedFields?: ComputedFields;
+  schemas?: Schemas;
 }

src/lib/indexFolder.ts

@@ -1,3 +1,4 @@
+import { ZodError } from "zod";
 import { CustomConfig } from "./CustomConfig.js";
 import { FileInfo, processFile } from "./process.js";
 import { recursiveWalkDir } from "./recursiveWalkDir.js";
@@ -14,6 +15,7 @@
   );
   const files: FileInfo[] = [];
   const computedFields = config.computedFields || [];
+  const schemas = config.schemas;
   for (const filePath of filteredFilePathsToIndex) {
     const fileObject = processFile(
       folderPath,
@@ -22,6 +24,33 @@
       filePathsToIndex,
       computedFields
     );
+    const urlPath = fileObject?.url_path ?? "";
+    // This is temporary.
+    // Note: Subject to change pending agreement on the final structure of document types.
+    const flattenedFileObject = {
+      ...fileObject,
+      ...fileObject.metadata,
+      tags: fileObject.tags, // Don't override the tags
+    };
+    const documentType = urlPath.split("/")[0];
+
+    if (schemas && schemas[documentType]) {
+      const result = schemas[documentType].safeParse(flattenedFileObject);
+
+      if (!result.success) {
+        const error: ZodError = (result as any).error;
+
+        error.errors.forEach((err) => {
+          const errorMessage = `Error: In ${
+            fileObject.file_path
+          } for the ${documentType} schema. \n    In "${err.path.join(
+            ","
+          )}" field: ${err.message}`;
+          console.error(errorMessage);
+        });
+      }
+    }
+
     files.push(fileObject);
   }
   return files;