Add error constants to IR (#815)

* Add error constants to IR * string -> wire string * Add doc
fern-api · Oct 13, 2022 · 1d1a924 · 1d1a924
1 parent ad0f881
commit 1d1a924
Show file tree

Hide file tree

Showing 15 changed files with 87 additions and 27 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/...del-npm-0.0.237-8028fcb245-65a74f889c.zip → ...del-npm-0.0.241-b830f65b3a-8098b61521.zip b/...del-npm-0.0.237-8028fcb245-65a74f889c.zip → ...del-npm-0.0.241-b830f65b3a-8098b61521.zip
diff --git a/fern/fern.config.json b/fern/fern.config.json
@@ -1,4 +1,4 @@
 {
   "organization": "fern",
-  "version": "0.0.208"
+  "version": "0.0.211"
 }
diff --git a/fern/ir-types/definition/constants.yml b/fern/ir-types/definition/constants.yml
@@ -0,0 +1,12 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/fern-api/fern/main/fern.schema.json
+imports:
+  commons: commons.yml
+types:
+  Constants:
+    properties:
+      errors: ErrorConstants
+  ErrorConstants:
+    properties:
+      errorDiscriminant: commons.WireStringWithAllCasings
+      errorInstanceIdKey: commons.WireStringWithAllCasings
+      errorContentKey: commons.WireStringWithAllCasings
diff --git a/fern/ir-types/definition/ir.yml b/fern/ir-types/definition/ir.yml
@@ -7,6 +7,7 @@ imports:
   serviceCommons: services/commons.yml
   http: services/http.yml
   websocket: services/websocket.yml
+  constants: constants.yml
 types:
   IntermediateRepresentation:
     docs: "Complete representation of the API schema"
@@ -20,7 +21,10 @@ types:
         docs: "The services exposed by this API"
         type: Services
       errors: list<errors.ErrorDeclaration>
-      constants: FernConstants
+      constants:
+        type: FernConstants
+        docs: this is deprecated. use constantsV2
+      constantsV2: constants.Constants
   Services:
     properties:
       http: list<http.HttpService>

diff --git a/fern/ir-types/definition/services/commons.yml b/fern/ir-types/definition/services/commons.yml
@@ -16,14 +16,19 @@ types:
       error: errors.DeclaredErrorName
 
   ResponseErrorsV2:
+    docs: this is deprecated. use ResponseErrors. Yes, this is weird.
     properties:
       discriminant: commons.WireStringWithAllCasings
       types: list<ResponseErrorV2>
   ResponseErrorV2:
     extends: commons.WithDocs
     properties:
-      discriminantValue: commons.WireStringWithAllCasings
-      shape: ResponseErrorShape
+      discriminantValue:
+        type: commons.WireStringWithAllCasings
+        docs: this is deprecated. use the discriminant value on the error declaration.
+      shape:
+        type: ResponseErrorShape
+        docs: this is deprecated. if the error has a type, then use the errorBody constant.
   ResponseErrorShape:
     union:
       singleProperty: SingleResponseErrorProperty

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.237",
+    "@fern-fern/ir-model": "0.0.241",
     "ansi-escapes": "^5.0.0",
     "boxen": "^7.0.0",
     "chalk": "^5.0.1",

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
@@ -1096,6 +1096,34 @@ exports[`ir simple 1`] = `
         "errorDiscriminant": "_error",
         "errorInstanceIdKey": "_errorInstanceId",
         "unknownErrorDiscriminantValue": "_unknown"
+    },
+    "constantsV2": {
+        "errors": {
+            "errorDiscriminant": {
+                "originalValue": "error",
+                "camelCase": "error",
+                "snakeCase": "error",
+                "pascalCase": "Error",
+                "screamingSnakeCase": "ERROR",
+                "wireValue": "error"
+            },
+            "errorInstanceIdKey": {
+                "originalValue": "errorInstanceId",
+                "camelCase": "errorInstanceId",
+                "snakeCase": "error_instance_id",
+                "pascalCase": "ErrorInstanceId",
+                "screamingSnakeCase": "ERROR_INSTANCE_ID",
+                "wireValue": "errorInstanceId"
+            },
+            "errorContentKey": {
+                "originalValue": "content",
+                "camelCase": "content",
+                "snakeCase": "content",
+                "pascalCase": "Content",
+                "screamingSnakeCase": "CONTENT",
+                "wireValue": "content"
+            }
+        }
     }
 }"
 `;
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.237",
+    "@fern-fern/ir-model": "0.0.241",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {

diff --git a/packages/cli/generation/ir-generator/src/FernConstants.ts b/packages/cli/generation/ir-generator/src/FernConstants.ts
@@ -1,7 +1,17 @@
+import { Constants } from "@fern-fern/ir-model/constants";
 import { FernConstants } from "@fern-fern/ir-model/ir";
+import { generateWireStringWithAllCasings } from "./utils/generateCasings";
 
 export const FERN_CONSTANTS: FernConstants = {
     errorDiscriminant: "_error",
     errorInstanceIdKey: "_errorInstanceId",
     unknownErrorDiscriminantValue: "_unknown",
 };
+
+export const FERN_CONSTANTS_V2: Constants = {
+    errors: {
+        errorDiscriminant: generateWireStringWithAllCasings({ wireValue: "error", name: "error" }),
+        errorInstanceIdKey: generateWireStringWithAllCasings({ wireValue: "errorInstanceId", name: "errorInstanceId" }),
+        errorContentKey: generateWireStringWithAllCasings({ wireValue: "content", name: "content" }),
+    },
+};
diff --git a/packages/cli/generation/ir-generator/src/generateIntermediateRepresentation.ts b/packages/cli/generation/ir-generator/src/generateIntermediateRepresentation.ts
@@ -7,7 +7,7 @@ import { convertErrorDeclaration } from "./converters/convertErrorDeclaration";
 import { convertHttpService } from "./converters/services/convertHttpService";
 import { convertWebsocketChannel } from "./converters/services/convertWebsocketChannel";
 import { convertTypeDeclaration } from "./converters/type-declarations/convertTypeDeclaration";
-import { FERN_CONSTANTS } from "./FernConstants";
+import { FERN_CONSTANTS, FERN_CONSTANTS_V2 } from "./FernConstants";
 import { constructFernFileContext, FernFileContext } from "./FernFileContext";
 import { ErrorResolverImpl } from "./resolvers/ErrorResolver";
 import { TypeResolverImpl } from "./resolvers/TypeResolver";
@@ -31,6 +31,7 @@ export async function generateIntermediateRepresentation(workspace: Workspace):
             websocket: [],
         },
         constants: FERN_CONSTANTS,
+        constantsV2: FERN_CONSTANTS_V2,
     };
 
     const typeResolver = new TypeResolverImpl(workspace);

diff --git a/packages/cli/generation/local-generation/local-workspace-runner/package.json b/packages/cli/generation/local-generation/local-workspace-runner/package.json
@@ -30,7 +30,7 @@
     "@fern-api/generators-configuration": "workspace:*",
     "@fern-api/workspace-loader": "workspace:*",
     "@fern-fern/generator-exec-client": "0.0.5",
-    "@fern-fern/ir-model": "0.0.237",
+    "@fern-fern/ir-model": "0.0.241",
     "tmp-promise": "^3.0.3"
   },
   "devDependencies": {

diff --git a/packages/cli/generation/remote-generation/remote-workspace-runner/package.json b/packages/cli/generation/remote-generation/remote-workspace-runner/package.json
@@ -31,7 +31,7 @@
     "@fern-api/task-context": "workspace:*",
     "@fern-api/workspace-loader": "workspace:*",
     "@fern-fern/fiddle-client": "^0.0.49",
-    "@fern-fern/ir-model": "0.0.237",
+    "@fern-fern/ir-model": "0.0.241",
     "axios": "^0.27.2",
     "chalk": "^5.0.1",
     "decompress": "^4.2.1",

diff --git a/packages/cli/yaml/yaml-schema/package.json b/packages/cli/yaml/yaml-schema/package.json
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-model": "0.0.237",
+    "@fern-fern/ir-model": "0.0.241",
     "zod": "^3.14.3"
   },
   "devDependencies": {

diff --git a/yarn.lock b/yarn.lock
@@ -3175,7 +3175,7 @@ __metadata:
     "@fern-api/validator": "workspace:*"
     "@fern-api/workspace-loader": "workspace:*"
     "@fern-fern/fiddle-client": ^0.0.49
-    "@fern-fern/ir-model": 0.0.237
+    "@fern-fern/ir-model": 0.0.241
     "@types/boxen": ^3.0.1
     "@types/inquirer": ^9.0.1
     "@types/is-ci": ^3.0.0
@@ -3420,7 +3420,7 @@ __metadata:
     "@fern-api/core-utils": "workspace:*"
     "@fern-api/workspace-loader": "workspace:*"
     "@fern-api/yaml-schema": "workspace:*"
-    "@fern-fern/ir-model": 0.0.237
+    "@fern-fern/ir-model": 0.0.241
     "@types/jest": ^29.0.3
     "@types/lodash-es": ^4.17.6
     "@types/node": ^18.7.18
@@ -3487,7 +3487,7 @@ __metadata:
     "@fern-api/generators-configuration": "workspace:*"
     "@fern-api/workspace-loader": "workspace:*"
     "@fern-fern/generator-exec-client": 0.0.5
-    "@fern-fern/ir-model": 0.0.237
+    "@fern-fern/ir-model": 0.0.241
     "@types/jest": ^29.0.3
     "@types/node": ^18.7.18
     "@types/tmp": ^0.2.3
@@ -3677,7 +3677,7 @@ __metadata:
     "@fern-api/task-context": "workspace:*"
     "@fern-api/workspace-loader": "workspace:*"
     "@fern-fern/fiddle-client": ^0.0.49
-    "@fern-fern/ir-model": 0.0.237
+    "@fern-fern/ir-model": 0.0.241
     "@types/decompress": ^4.2.4
     "@types/jest": ^29.0.3
     "@types/lodash-es": ^4.17.6
@@ -3827,7 +3827,7 @@ __metadata:
     "@babel/preset-env": ^7.19.1
     "@babel/preset-typescript": ^7.18.6
     "@fern-api/core-utils": "workspace:*"
-    "@fern-fern/ir-model": 0.0.237
+    "@fern-fern/ir-model": 0.0.241
     "@types/jest": ^29.0.3
     "@types/node": ^18.7.18
     depcheck: ^1.4.3
@@ -3863,10 +3863,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@fern-fern/ir-model@npm:0.0.237":
-  version: 0.0.237
-  resolution: "@fern-fern/ir-model@npm:0.0.237"
-  checksum: 65a74f889cb87954aa9e2e6f6c3d6f5f269cd568c32b28ae4f14899b2d6fc4c7f0fd1d13f0d81845a02f7349c633094859016053fa84e6526366c8ac6c22e981
+"@fern-fern/ir-model@npm:0.0.241":
+  version: 0.0.241
+  resolution: "@fern-fern/ir-model@npm:0.0.241"
+  checksum: 8098b61521022b535c8a44ded72bd7c072078ad75dd4dc950d7c8b332a6eec6aba5f831f0d57fe7eca3e10c53c30ad5270c70cd7bdfc4829f5caeac64381b24d
   languageName: node
   linkType: hard