feat: switch collections to JSON schema

- Add VS Code support for autocomplete in collections

Author: harjot1singh

.vscode/settings.json

@@ -29,5 +29,11 @@
   "[html]": {
     "editor.defaultFormatter": "biomejs.biome"
   },
-  "dbmlERDPreviewer.preferredTheme": "dark"
+  "dbmlERDPreviewer.preferredTheme": "dark",
+  "json.schemas": [
+    {
+      "fileMatch": ["collections/assets/**/*.json"],
+      "url": "./collections/$schemas/assets.json"
+    }
+  ]
 }

collections/$schemas/assets.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "assets.json",
+  "title": "Asset",
+  "description": "An asset in the collection",
+  "definitions": {
+    "Source": {
+      "type": "object",
+      "required": ["authors", "title", "publisher", "publication"],
+      "properties": {
+        "authors": {
+          "type": "array",
+          "items": { "$ref": "common.json#/definitions/Person" }
+        },
+        "translators": {
+          "type": "array",
+          "items": { "$ref": "common.json#/definitions/Person" }
+        },
+        "title": { "type": "string" },
+        "subtitle": { "type": "string" },
+        "edition": { "type": "string" },
+        "publisher": { "$ref": "common.json#/definitions/Publisher" },
+        "publication": { "$ref": "common.json#/definitions/Publication" },
+        "url": { "type": "string" },
+        "accessed": { "type": "string" },
+        "volume": { "$ref": "common.json#/definitions/Volume" },
+        "type": { "type": "string" },
+        "language": { "type": "string" },
+        "isbn": { "type": "string" },
+        "doi": { "type": "string" },
+        "pages": { "type": "string" },
+        "notes": { "type": "string" }
+      }
+    }
+  },
+  "type": "object",
+  "required": ["name", "source"],
+  "properties": {
+    "name": { "$ref": "common.json#/definitions/Iso15924" },
+    "source": { "$ref": "#/definitions/Source" }
+  }
+}

collections/$schemas/common.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "common.json",
+  "definitions": {
+    "Iso15924": {
+      "type": "object",
+      "required": ["Latn", "Guru"],
+      "properties": {
+        "Latn": { "type": "string" },
+        "Guru": { "type": "string" }
+      }
+    },
+    "Person": {
+      "type": "object",
+      "required": ["first", "last"],
+      "properties": {
+        "first": { "type": "string" },
+        "middle": { "type": "string" },
+        "last": { "type": "string" },
+        "prefix": { "type": "string" },
+        "suffix": { "type": "string" }
+      }
+    },
+    "Publisher": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name": { "type": "string" },
+        "city": { "type": "string" },
+        "country": { "type": "string" }
+      }
+    },
+    "Publication": {
+      "type": "object",
+      "required": ["date"],
+      "properties": {
+        "date": { "type": "string" },
+        "version": { "type": "string" }
+      }
+    },
+    "Volume": {
+      "type": "object",
+      "properties": {
+        "current": { "type": "number" },
+        "total": { "type": "number" }
+      }
+    }
+  }
+}

package-lock.json

@@ -19,7 +19,9 @@
     "url": "git+https://github.com/ShabadOS/database.git"
   },
   "author": "Shabad OS Team <team@shabados.com>",
-  "contributors": ["GurbaniNow Team <contact@gurbaninow.com> (https://gurbaninow.com)"],
+  "contributors": [
+    "GurbaniNow Team <contact@gurbaninow.com> (https://gurbaninow.com)"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/ShabadOS/database/issues"
@@ -34,11 +36,11 @@
     "validate": "node --experimental-strip-types scripts/validate-collections.ts"
   },
   "dependencies": {
-    "@types/node": "^22.13.9",
-    "valibot": "^1.0.0-rc.3"
+    "ajv": "^8.17.1"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
+    "@types/node": "^22.13.9",
     "chalk": "^5.4.1",
     "dedent": "^1.5.3",
     "fast-glob": "^3.3.3"

package.json

@@ -1,33 +1,62 @@
-import fg from 'fast-glob'
-import { type ObjectEntries, type ObjectSchema, safeParseAsync } from 'valibot'
-
 import { readFile } from 'node:fs/promises'
+import Ajv from 'ajv'
 import chalk from 'chalk'
 import dedent from 'dedent'
-import { AssetSchema } from '#~/types/collections'
+import fg from 'fast-glob'
+
+const ajv = new Ajv({
+  allErrors: true,
+})
+
+const SCHEMA_PATH = './collections/$schemas'
+
+const commonSchema = JSON.parse(await readFile(`${SCHEMA_PATH}/common.json`, 'utf-8'))
+ajv.addSchema(commonSchema)
+
+const validateCollection = async (schemaFile: string, collectionName: string) => {
+  console.log(
+    chalk.green(`\nValidating ${collectionName} collection using ${schemaFile} schema...`),
+  )
 
-const validateCollection = async (name: string, schema: ObjectSchema<ObjectEntries, undefined>) => {
-  console.log(chalk.green(`\nValidating ${name} collection...`))
+  const schemaContent = JSON.parse(await readFile(`${SCHEMA_PATH}/${schemaFile}`, 'utf-8'))
+  const validate = ajv.compile(schemaContent)
 
-  const collectionPath = `./collections/${name}`
+  const collectionPath = `./collections/${collectionName}`
   const collection = await fg(`${collectionPath}/**/*.json`)
 
+  let hasErrors = false
+
   for (const filePath of collection) {
     const data = JSON.parse(await readFile(filePath, 'utf-8'))
-    const result = await safeParseAsync(schema, data)
+    const isValid = validate(data)
 
     const fileName = filePath.replace(`${collectionPath}/`, '')
 
-    if (!result.success) {
+    if (!isValid) {
+      hasErrors = true
       console.error(
         chalk.red(
-          dedent`Invalid ${name} document: ${fileName}
-          ${result.issues.map((issue) => `- ${issue.message}`).join('\n')}
+          dedent`Invalid ${collectionName} document: ${fileName}
+          ${validate.errors?.map((error) => `- ${error.instancePath || '/'} ${error.message}`).join('\n')}
       `,
         ),
       )
     }
   }
+
+  if (!hasErrors) {
+    console.log(chalk.green(`✓ All ${collectionName} documents are valid`))
+  }
+
+  return !hasErrors
+}
+
+const validationConfigs = [{ schemaFile: 'assets.json', collectionName: 'assets' }]
+
+let allSuccess = true
+for (const config of validationConfigs) {
+  const success = await validateCollection(config.schemaFile, config.collectionName)
+  if (!success) allSuccess = false
 }
 
-await validateCollection('assets', AssetSchema)
+process.exit(allSuccess ? 0 : 1)