fix(cli): handle object extensions and literals for json schema (#4961)

fern-api · Oct 21, 2024 · 7a5f1c5 · 7a5f1c5
1 parent a381d5f
commit 7a5f1c5
Show file tree

Hide file tree

Showing 48 changed files with 1,262 additions and 211 deletions.
diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,12 @@
+- changelogEntry: 
+    - summary: | 
+        Improved JSON Schema generation for object extensions and const values:
+        - Object extensions are now properly represented using `allOf` in the JSON Schema
+        - Literal values (string and boolean) are now correctly represented using `const` in the JSON Schema
+      type: internal
+  irVersion: 53
+  version: 0.45.0-rc9
+
 - changelogEntry: 
     - summary: | 
         Add `#!/usr/bin/env node` to the CLI to prevent runtime errors.

diff --git a/packages/cli/fern-definition/ir-to-jsonschema/package.json b/packages/cli/fern-definition/ir-to-jsonschema/package.json
@@ -29,11 +29,14 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-api/ir-sdk": "workspace:*",
-    "@fern-api/task-context": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
-    "@fern-api/project-loader": "workspace:*",
     "@fern-api/ir-generator": "workspace:*",
+    "@fern-api/ir-sdk": "workspace:*",
+    "@fern-api/project-loader": "workspace:*",
+    "@fern-api/task-context": "workspace:*",
+    "@types/ajv": "^1.0.0",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
     "json-schema": "^0.4.0"
   },
   "devDependencies": {

diff --git a/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:Child.json b/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:Child.json
@@ -1,5 +1,10 @@
 {
   "type": "object",
+  "allOf": [
+    {
+      "$ref": "#/definitions/Parent"
+    }
+  ],
   "properties": {
     "child": {
       "type": "string"
@@ -8,5 +13,17 @@
   "required": [
     "child"
   ],
-  "definitions": {}
+  "definitions": {
+    "Parent": {
+      "type": "object",
+      "properties": {
+        "parent": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "parent"
+      ]
+    }
+  }
 }
diff --git a/...-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_:ImportingA.json b/...-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_:ImportingA.json
@@ -6,9 +6,24 @@
     }
   },
   "definitions": {
+    "RootType": {
+      "type": "object",
+      "properties": {
+        "s": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "s"
+      ]
+    },
     "a.A": {
       "type": "object",
-      "properties": {}
+      "allOf": [
+        {
+          "$ref": "#/definitions/RootType"
+        }
+      ]
     }
   }
 }
diff --git a/...on/ir-to-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_a:A.json b/...on/ir-to-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_a:A.json
@@ -1,5 +1,21 @@
 {
   "type": "object",
-  "properties": {},
-  "definitions": {}
+  "allOf": [
+    {
+      "$ref": "#/definitions/RootType"
+    }
+  ],
+  "definitions": {
+    "RootType": {
+      "type": "object",
+      "properties": {
+        "s": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "s"
+      ]
+    }
+  }
 }
diff --git a/...nschema/src/__test__/__snapshots__/circular-references-advanced/type_ast:ObjectValue.json b/...nschema/src/__test__/__snapshots__/circular-references-advanced/type_ast:ObjectValue.json
@@ -1,5 +1,4 @@
 {
   "type": "object",
-  "properties": {},
   "definitions": {}
 }
diff --git a/...ion/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_:ImportingA.json b/...ion/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_:ImportingA.json
@@ -6,9 +6,24 @@
     }
   },
   "definitions": {
+    "RootType": {
+      "type": "object",
+      "properties": {
+        "s": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "s"
+      ]
+    },
     "a.A": {
       "type": "object",
-      "properties": {}
+      "allOf": [
+        {
+          "$ref": "#/definitions/RootType"
+        }
+      ]
     }
   }
 }
diff --git a/...-definition/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_a:A.json b/...-definition/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_a:A.json
@@ -1,5 +1,21 @@
 {
   "type": "object",
-  "properties": {},
-  "definitions": {}
+  "allOf": [
+    {
+      "$ref": "#/definitions/RootType"
+    }
+  ],
+  "definitions": {
+    "RootType": {
+      "type": "object",
+      "properties": {
+        "s": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "s"
+      ]
+    }
+  }
 }
diff --git a/...ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:ObjectValue.json b/...ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:ObjectValue.json
@@ -1,5 +1,4 @@
 {
   "type": "object",
-  "properties": {},
   "definitions": {}
 }
diff --git a/...on/ir-to-jsonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_a/aa:A.json b/...on/ir-to-jsonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_a/aa:A.json
@@ -1,5 +1,4 @@
 {
   "type": "object",
-  "properties": {},
   "definitions": {}
 }
diff --git a/...on/ir-to-jsonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_a/aa:B.json b/...on/ir-to-jsonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_a/aa:B.json
@@ -1,5 +1,4 @@
 {
   "type": "object",
-  "properties": {},
   "definitions": {}
 }
diff --git a/...sonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_a/aa:SubTestType.json b/...sonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_a/aa:SubTestType.json
@@ -14,12 +14,10 @@
   ],
   "definitions": {
     "a.aa.A": {
-      "type": "object",
-      "properties": {}
+      "type": "object"
     },
     "a.aa.B": {
-      "type": "object",
-      "properties": {}
+      "type": "object"
     }
   }
 }
diff --git a/...r-to-jsonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_b:TestType.json b/...r-to-jsonschema/src/__test__/__snapshots__/csharp-namespace-conflict/type_b:TestType.json
@@ -14,12 +14,10 @@
   ],
   "definitions": {
     "a.aa.A": {
-      "type": "object",
-      "properties": {}
+      "type": "object"
     },
     "a.aa.B": {
-      "type": "object",
-      "properties": {}
+      "type": "object"
     }
   }
 }
diff --git a/...nition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_types:ExtendedMovie.json b/...nition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_types:ExtendedMovie.json
@@ -1,5 +1,10 @@
 {
   "type": "object",
+  "allOf": [
+    {
+      "$ref": "#/definitions/types.Movie"
+    }
+  ],
   "properties": {
     "cast": {
       "type": "array",
@@ -11,5 +16,67 @@
   "required": [
     "cast"
   ],
-  "definitions": {}
+  "definitions": {
+    "types.MovieId": {
+      "type": "string"
+    },
+    "commons.types.Tag": {
+      "type": "string"
+    },
+    "types.Movie": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/types.MovieId"
+        },
+        "prequel": {
+          "$ref": "#/definitions/types.MovieId"
+        },
+        "title": {
+          "type": "string"
+        },
+        "from": {
+          "type": "string"
+        },
+        "rating": {
+          "type": "number"
+        },
+        "type": {
+          "const": "movie"
+        },
+        "tag": {
+          "$ref": "#/definitions/commons.types.Tag"
+        },
+        "book": {
+          "type": "string"
+        },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": {
+            "type": [
+              "string",
+              "number",
+              "boolean",
+              "object",
+              "array",
+              "null"
+            ]
+          }
+        },
+        "revenue": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "id",
+        "title",
+        "from",
+        "rating",
+        "type",
+        "tag",
+        "metadata",
+        "revenue"
+      ]
+    }
+  }
 }
diff --git a/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_types:Movie.json b/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_types:Movie.json
@@ -17,10 +17,7 @@
       "type": "number"
     },
     "type": {
-      "const": {
-        "string": "movie",
-        "type": "string"
-      }
+      "const": "movie"
     },
     "tag": {
       "$ref": "#/definitions/commons.types.Tag"

diff --git a/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/extends/type_:ExampleType.json b/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/extends/type_:ExampleType.json
@@ -1,5 +1,10 @@
 {
   "type": "object",
+  "allOf": [
+    {
+      "$ref": "#/definitions/Docs"
+    }
+  ],
   "properties": {
     "name": {
       "type": "string"
@@ -8,5 +13,17 @@
   "required": [
     "name"
   ],
-  "definitions": {}
+  "definitions": {
+    "Docs": {
+      "type": "object",
+      "properties": {
+        "docs": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "docs"
+      ]
+    }
+  }
 }
diff --git a/...s/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/extends/type_:JSON.json b/...s/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/extends/type_:JSON.json
@@ -1,5 +1,10 @@
 {
   "type": "object",
+  "allOf": [
+    {
+      "$ref": "#/definitions/Docs"
+    }
+  ],
   "properties": {
     "raw": {
       "type": "string"
@@ -8,5 +13,17 @@
   "required": [
     "raw"
   ],
-  "definitions": {}
+  "definitions": {
+    "Docs": {
+      "type": "object",
+      "properties": {
+        "docs": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "docs"
+      ]
+    }
+  }
 }