Remove inline types from error declarations (#813)

* Remove inline types from error declarations * Fix json schema * Add migration * Add comments to tests
fern-api · Oct 12, 2022 · ad0f881 · ad0f881
1 parent 3f20fb2
commit ad0f881
Show file tree

Hide file tree

Showing 40 changed files with 379 additions and 214 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,13 +1,13 @@
 {
   "search.exclude": {
+    "**/.pnp.*": true,
     "**/.yarn": true,
-    "**/.pnp.*": true
+    "packages/cli/migrations/src/**/*.ts": true
   },
   "eslint.nodePath": ".yarn/sdks",
   "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
   "typescript.tsdk": ".yarn/sdks/typescript/lib",
   "typescript.enablePromptUseWorkspaceTsdk": true,
   "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": ["source.fixAll", "source.organizeImports", "source.sortMembers"],
-  "go.inferGopath": false
+  "editor.codeActionsOnSave": ["source.fixAll", "source.organizeImports", "source.sortMembers"]
 }
diff --git a/...del-npm-0.0.227-69424af2b1-bc0a65238a.zip → ...del-npm-0.0.237-8028fcb245-65a74f889c.zip b/...del-npm-0.0.227-69424af2b1-bc0a65238a.zip → ...del-npm-0.0.237-8028fcb245-65a74f889c.zip
diff --git a/fern.schema.json b/fern.schema.json
@@ -354,27 +354,14 @@
         "errors": {
           "type": "object",
           "additionalProperties": {
-            "anyOf": [
-              { "type": "string" },
-              {
-                "type": "object",
-                "properties": {
-                  "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" },
-                  "http": {
-                    "type": "object",
-                    "properties": {
-                      "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" },
-                      "name": { "type": "string" },
-                      "statusCode": { "type": "number" }
-                    },
-                    "required": ["statusCode"],
-                    "additionalProperties": false
-                  },
-                  "type": { "$ref": "#/properties/types/additionalProperties" }
-                },
-                "additionalProperties": false
-              }
-            ]
+            "type": "object",
+            "properties": {
+              "docs": { "$ref": "#/properties/types/additionalProperties/anyOf/1/anyOf/0/properties/docs" },
+              "status-code": { "type": "number" },
+              "type": { "type": "string" }
+            },
+            "required": ["status-code"],
+            "additionalProperties": false
           }
         }
       },

diff --git a/fern/ir-types/definition/errors.yml b/fern/ir-types/definition/errors.yml
@@ -10,10 +10,14 @@ types:
       name: DeclaredErrorName
       discriminantValue: commons.WireStringWithAllCasings
       type:
-        docs: this is deprecated. use typeV2 instead.
+        docs: this is deprecated. use typeV3 instead.
         type: types.Type
-      typeV2: optional<types.Type>
+      typeV2:
+        docs: this is deprecated. use typeV3 instead.
+        type: optional<types.Type>
+      typeV3: optional<types.TypeReference>
       http: optional<HttpErrorConfiguration>
+      statusCode: integer
   DeclaredErrorName:
     properties:
       fernFilepath: commons.FernFilepath

diff --git a/packages/cli/cli/package.json b/packages/cli/cli/package.json
@@ -52,7 +52,7 @@
     "@fern-api/validator": "workspace:*",
     "@fern-api/workspace-loader": "workspace:*",
     "@fern-fern/fiddle-client": "^0.0.49",
-    "@fern-fern/ir-model": "0.0.227",
+    "@fern-fern/ir-model": "0.0.237",
     "ansi-escapes": "^5.0.0",
     "boxen": "^7.0.0",
     "chalk": "^5.0.1",

diff --git a/packages/cli/ete-tests/src/tests/add/__snapshots__/add.test.ts.snap b/packages/cli/ete-tests/src/tests/add/__snapshots__/add.test.ts.snap
@@ -60,8 +60,7 @@ services:
 
 errors:
   NotFoundError:
-    http:
-      statusCode: 404",
+    status-code: 404",
                 "name": "imdb.yml",
                 "type": "file",
               },

diff --git a/packages/cli/ete-tests/src/tests/api-option/fixtures/simple/fern/api1/definition/imdb.yml b/packages/cli/ete-tests/src/tests/api-option/fixtures/simple/fern/api1/definition/imdb.yml
@@ -11,8 +11,7 @@ types:
       rating: double
 errors:
   NotFoundError:
-    http:
-      statusCode: 404
+    status-code: 404
 services:
   http:
     MoviesService:

diff --git a/packages/cli/ete-tests/src/tests/api-option/fixtures/simple/fern/api2/definition/imdb.yml b/packages/cli/ete-tests/src/tests/api-option/fixtures/simple/fern/api2/definition/imdb.yml
@@ -11,8 +11,7 @@ types:
       rating: double
 errors:
   NotFoundError:
-    http:
-      statusCode: 404
+    status-code: 404
 services:
   http:
     MoviesService:

diff --git a/packages/cli/ete-tests/src/tests/init/__snapshots__/init.test.ts.snap b/packages/cli/ete-tests/src/tests/init/__snapshots__/init.test.ts.snap
@@ -58,8 +58,7 @@ services:
 
 errors:
   NotFoundError:
-    http:
-      statusCode: 404",
+    status-code: 404",
             "name": "imdb.yml",
             "type": "file",
           },

diff --git a/packages/cli/ete-tests/src/tests/ir/__snapshots__/ir.test.ts.snap b/packages/cli/ete-tests/src/tests/ir/__snapshots__/ir.test.ts.snap
@@ -744,14 +744,32 @@ exports[`ir simple 1`] = `
             "http": {
                 "statusCode": 404
             },
+            "statusCode": 404,
             "type": {
                 "aliasOf": {
-                    "_type": "void"
+                    "primitive": "STRING",
+                    "_type": "primitive"
                 },
                 "resolvedType": {
-                    "_type": "void"
+                    "primitive": "STRING",
+                    "_type": "primitive"
                 },
                 "_type": "alias"
+            },
+            "typeV2": {
+                "aliasOf": {
+                    "primitive": "STRING",
+                    "_type": "primitive"
+                },
+                "resolvedType": {
+                    "primitive": "STRING",
+                    "_type": "primitive"
+                },
+                "_type": "alias"
+            },
+            "typeV3": {
+                "primitive": "STRING",
+                "_type": "primitive"
             }
         }
     ],
@@ -1036,7 +1054,34 @@ exports[`ir simple 1`] = `
                                         "wireValue": "NotFoundError"
                                     },
                                     "shape": {
-                                        "type": "noProperties"
+                                        "name": {
+                                            "originalValue": "content",
+                                            "camelCase": "content",
+                                            "snakeCase": "content",
+                                            "pascalCase": "Content",
+                                            "screamingSnakeCase": "CONTENT",
+                                            "wireValue": "content"
+                                        },
+                                        "error": {
+                                            "name": "NotFoundError",
+                                            "nameV2": {
+                                                "originalValue": "NotFoundError",
+                                                "camelCase": "notFoundError",
+                                                "snakeCase": "not_found_error",
+                                                "pascalCase": "NotFoundError",
+                                                "screamingSnakeCase": "NOT_FOUND_ERROR"
+                                            },
+                                            "fernFilepath": [
+                                                {
+                                                    "originalValue": "imdb",
+                                                    "camelCase": "imdb",
+                                                    "snakeCase": "imdb",
+                                                    "pascalCase": "Imdb",
+                                                    "screamingSnakeCase": "IMDB"
+                                                }
+                                            ]
+                                        },
+                                        "type": "singleProperty"
                                     }
                                 }
                             ]

diff --git a/packages/cli/ete-tests/src/tests/ir/fixtures/simple/fern/api/definition/imdb.yml b/packages/cli/ete-tests/src/tests/ir/fixtures/simple/fern/api/definition/imdb.yml
@@ -23,8 +23,8 @@ types:
       selfRefrencing: list<RecursiveType>
 errors:
   NotFoundError:
-    http:
-      statusCode: 404
+    status-code: 404
+    type: string
 services:
   http:
     MoviesService:

diff --git a/packages/cli/generation/ir-generator/package.json b/packages/cli/generation/ir-generator/package.json
@@ -28,7 +28,7 @@
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/workspace-loader": "workspace:*",
     "@fern-api/yaml-schema": "workspace:*",
-    "@fern-fern/ir-model": "0.0.227",
+    "@fern-fern/ir-model": "0.0.237",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {

diff --git a/packages/cli/generation/ir-generator/src/__test__/convertErrorDeclaration.test.ts b/packages/cli/generation/ir-generator/src/__test__/convertErrorDeclaration.test.ts