feat: add support for proper schema segmentation

This officially formally supports being able to validate specific
versions for of an open-rpc document.

Previously we had a sort of catchall for all documents, now
we have a formal system for validating specific versions. This
means we have a pathway forward for larger changes to occur
in the ecosystem while maintaining reliability.

Author: zcstarr

.gitignore

@@ -4,4 +4,5 @@ build
 docs
 .DS_Store
 dist
-.vscode
+.vscode
+LLMLOG.MD

jest.config.js

@@ -4,5 +4,8 @@ module.exports = {
   resetMocks: true,
   restoreMocks: true,
   rootDir: "./src",
-  preset: "ts-jest",
+  transformIgnorePatterns: ["node_modules/(?!((@open-rpc/spec-types|@open-rpc/spec))/)"],
+  transform: {
+    "^.+\\.[tj]sx?$": ["ts-jest", { tsconfig: { allowJs: true } }],
+  },
 };

package-lock.json

@@ -34,7 +34,7 @@
     "@json-schema-tools/dereferencer": "^1.6.3",
     "@json-schema-tools/meta-schema": "^1.7.5",
     "@json-schema-tools/reference-resolver": "^1.2.6",
-    "@open-rpc/meta-schema": "^1.14.9",
+    "@open-rpc/spec-types": "^0.0.1",
     "@open-rpc/specification-extension-spec": "^1.0.2",
     "ajv": "^6.10.0",
     "detect-node": "^2.0.4",
@@ -44,6 +44,7 @@
     "isomorphic-fetch": "^3.0.0"
   },
   "devDependencies": {
+    "@babel/core": "^7.29.0",
     "@types/detect-node": "^2.0.0",
     "@types/fs-extra": "^9.0.1",
     "@types/is-url": "^1.2.28",
@@ -61,7 +62,7 @@
     "json-schema": "^0.4.0",
     "prettier": "^2.0.0",
     "rimraf": "^3.0.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "29.4.6",
     "typedoc": "^0.25.13",
     "typescript": "^4.9.5",
     "webpack": "^5.1.3",

package.json

@@ -5,7 +5,7 @@ import getExtendedMetaSchema from "./get-extended-metaschema";
 
 describe("applyExtensionSpec", () => {
   it("should successfully apply extension spec to meta schema", () => {
-    const result = applyExtensionSpec(goodSchema as OpenrpcDocument, getExtendedMetaSchema());
+    const result = applyExtensionSpec(goodSchema as OpenrpcDocument, getExtendedMetaSchema("1.3"));
 
     // Check if extension was applied to methodObject
     const methodObjectDef = result.definitions.methodObject;
@@ -47,7 +47,7 @@ describe("applyExtensionSpec", () => {
       "x-extensions": [],
     };
 
-    const schema = getExtendedMetaSchema();
+    const schema = getExtendedMetaSchema("1.3");
     const result = applyExtensionSpec(emptyExtensionsDoc as OpenrpcDocument, schema);
     expect(result).toEqual(schema);
   });
@@ -64,7 +64,7 @@ describe("applyExtensionSpec", () => {
     };
 
     expect(() => {
-      applyExtensionSpec(badDoc as OpenrpcDocument, getExtendedMetaSchema());
+      applyExtensionSpec(badDoc as OpenrpcDocument, getExtendedMetaSchema("1.3"));
     }).toThrow("nonExistentDefinition does not exist, cannot apply extension x-notification");
   });
 
@@ -96,7 +96,7 @@ describe("applyExtensionSpec", () => {
       ],
     };
 
-    const result = applyExtensionSpec(doc as OpenrpcDocument, getExtendedMetaSchema());
+    const result = applyExtensionSpec(doc as OpenrpcDocument, getExtendedMetaSchema("1.3"));
     expect(result.definitions["x-test-potate"]).toBeDefined();
     expect(result.definitions["x-test-potate"].properties["x-next"]).toBeDefined();
     expect(result.definitions["x-test-potate"].properties["x-next"].type).toBe("boolean");
@@ -119,7 +119,7 @@ describe("applyExtensionSpec", () => {
   });
 
   it("should throw error when extension property already exists", () => {
-    const schema = getExtendedMetaSchema();
+    const schema = getExtendedMetaSchema("1.3");
     const modifiedSchema = {
       ...schema,
       definitions: {

src/apply-extension-spec.test.ts

@@ -1,11 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import dereferenceDocument, { OpenRPCDocumentDereferencingError } from "./dereference-document";
-import {
-  OpenrpcDocument,
-  ContentDescriptorObject,
-  JSONSchema,
-  MethodObject,
-} from "./types";
+import { OpenrpcDocument, ContentDescriptorObject, JSONSchema, MethodObject } from "./types";
 import { JSONSchemaObject } from "@json-schema-tools/meta-schema";
 
 const workingDocument: OpenrpcDocument = {

src/dereference-document.test.ts

@@ -1,5 +1,5 @@
 import Dereferencer from "@json-schema-tools/dereferencer";
-import metaSchema from "@open-rpc/meta-schema";
+import getMetaSchemaForVersion from "./get-meta-schema-for-version";
 import {
   OpenrpcDocument as OpenRPC,
   ReferenceObject,
@@ -476,6 +476,7 @@ export default async function dereferenceDocument(
   derefDoc = await handleSchemaComponents(derefDoc);
   derefDoc = await handleSchemasInsideContentDescriptorComponents(derefDoc);
 
+  const metaSchema = getMetaSchemaForVersion(openrpcDocument.openrpc);
   const definitionsMap = createDefinitionsMap(metaSchema);
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const extensions = [] as any;

src/dereference-document.ts

@@ -4,7 +4,7 @@ import getExtendedMetaSchema from "./get-extended-metaschema";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export default function getDocumentExtendedMetaSchema(document: OpenrpcDocument): any {
-  const extendedMetaSchema = getExtendedMetaSchema();
+  const extendedMetaSchema = getExtendedMetaSchema(document.openrpc);
   const extendedDocument = applyExtensionSpec(document, extendedMetaSchema);
   return extendedDocument;
 }

src/get-document-extended-metaschema.ts

@@ -1,10 +1,10 @@
-import metaSchema from "@open-rpc/meta-schema";
+import getMetaSchemaForVersion from "./get-meta-schema-for-version";
 import { metaSchema as extensionMetaSchema } from "@open-rpc/specification-extension-spec";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function getExtendedMetaSchema(): any {
+function getExtendedMetaSchema(version = "1.3"): any {
   // NOTE: this is to make sure we don't mutate the original meta schema
-  const metaSchemaCopy = JSON.parse(JSON.stringify(metaSchema));
+  const metaSchemaCopy = JSON.parse(JSON.stringify(getMetaSchemaForVersion(version)));
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const extensionMetaSchemaCopy = { ...extensionMetaSchema } as any;
 

src/get-extended-metaschema.ts

@@ -0,0 +1,27 @@
+import getMetaSchemaForVersion from "./get-meta-schema-for-version";
+
+describe("getMetaSchemaForVersion", () => {
+  it("should successfully apply extension spec to meta schema", () => {
+    const result = getMetaSchemaForVersion("1.3");
+    expect(result).toBeDefined();
+    if ("enum" in result.properties["openrpc"]) {
+      expect(result.properties["openrpc"].enum).toContain("1.3.2");
+    } else {
+      throw new Error("OpenRPC schema version 1.3 is not supported");
+    }
+
+    const result1_4 = getMetaSchemaForVersion("1.4");
+    expect(result1_4).toBeDefined();
+    if ("regex" in result1_4.properties["openrpc"]) {
+      expect(result1_4.properties["openrpc"].regex).toContain("4");
+    } else {
+      throw new Error("OpenRPC schema version 1.4 is not supported");
+    }
+  });
+
+  it("should throw an error for an unsupported version", () => {
+    expect(() => getMetaSchemaForVersion("99.9")).toThrow(
+      "Unsupported OpenRPC schema version: 99.9"
+    );
+  });
+});