(feat, in progress): ir supports user agent headers (#4232)

fern-api · Aug 8, 2024 · 1b35061 · 1b35061
1 parent b95287f
commit 1b35061
Show file tree

Hide file tree

Showing 89 changed files with 351 additions and 97 deletions.
diff --git a/packages/cli/cli/src/commands/generate-ir/generateIrForFernWorkspace.ts b/packages/cli/cli/src/commands/generate-ir/generateIrForFernWorkspace.ts
@@ -32,6 +32,8 @@ export async function generateIrForFernWorkspace({
         smartCasing,
         disableExamples,
         audiences,
-        readme
+        readme,
+        version: undefined,
+        packageName: undefined
     });
 }
diff --git a/packages/cli/cli/src/commands/mock/mockServer.ts b/packages/cli/cli/src/commands/mock/mockServer.ts
@@ -42,7 +42,9 @@ export async function mockServer({
             keywords: undefined,
             smartCasing: false,
             disableExamples: false,
-            readme: undefined
+            readme: undefined,
+            version: undefined,
+            packageName: undefined
         });
 
         const mockServer = new MockServer({

diff --git a/packages/cli/cli/src/commands/test/testOutput.ts b/packages/cli/cli/src/commands/test/testOutput.ts
@@ -50,7 +50,9 @@ export async function testOutput({
             keywords: undefined,
             smartCasing: false,
             disableExamples: false,
-            readme: undefined
+            readme: undefined,
+            version: undefined,
+            packageName: undefined
         });
 
         const mockServer = new MockServer({

diff --git a/packages/cli/docs-resolver/src/DocsDefinitionResolver.ts b/packages/cli/docs-resolver/src/DocsDefinitionResolver.ts
@@ -370,7 +370,9 @@ export class DocsDefinitionResolver {
                     keywords: undefined,
                     smartCasing: false,
                     disableExamples: false,
-                    readme: undefined
+                    readme: undefined,
+                    version: undefined,
+                    packageName: undefined
                 });
                 const apiDefinitionId = await this.registerApi({ ir, snippetsConfig });
                 const api = convertIrToApiDefinition(ir, apiDefinitionId);

diff --git a/packages/cli/docs-resolver/src/__test__/api-resolver.test.ts b/packages/cli/docs-resolver/src/__test__/api-resolver.test.ts
@@ -61,7 +61,9 @@ it("converts to api reference node", async () => {
         keywords: undefined,
         smartCasing: false,
         disableExamples: false,
-        readme: undefined
+        readme: undefined,
+        version: undefined,
+        packageName: undefined
     });
 
     const apiDefinition = convertIrToApiDefinition(ir, apiDefinitionId);

diff --git a/packages/cli/docs-resolver/src/__test__/stream.test.ts b/packages/cli/docs-resolver/src/__test__/stream.test.ts
@@ -65,7 +65,9 @@ it("converts to api reference node", async () => {
         keywords: undefined,
         smartCasing: false,
         disableExamples: false,
-        readme: undefined
+        readme: undefined,
+        version: undefined,
+        packageName: undefined
     });
 
     const apiDefinition = convertIrToApiDefinition(ir, apiDefinitionId);

diff --git a/packages/cli/ete-tests/src/tests/dependencies/__snapshots__/dependencies.test.ts.snap b/packages/cli/ete-tests/src/tests/dependencies/__snapshots__/dependencies.test.ts.snap
@@ -850,10 +850,11 @@ exports[`dependencies correctly incorporates dependencies 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
 `;
 
-exports[`dependencies file dependencies 1`] = `3033661`;
+exports[`dependencies file dependencies 1`] = `3033692`;
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
@@ -139,7 +139,8 @@ exports[`ir {"name":"auth-header-prefix"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -1336,7 +1337,8 @@ exports[`ir {"name":"extended-examples"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -1868,7 +1870,8 @@ exports[`ir {"name":"file-upload"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -8639,7 +8642,8 @@ exports[`ir {"name":"multiple-environment-urls"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -8938,7 +8942,8 @@ exports[`ir {"name":"navigation-points-to"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -11058,7 +11063,8 @@ exports[`ir {"name":"nested-example-reference"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -12249,7 +12255,8 @@ exports[`ir {"name":"packages"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -13773,7 +13780,8 @@ exports[`ir {"name":"response-property"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -15451,7 +15459,8 @@ exports[`ir {"name":"simple","audiences":["internal"]} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -19494,7 +19503,8 @@ exports[`ir {"name":"simple","audiences":["test"]} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -34582,7 +34592,8 @@ exports[`ir {"name":"simple"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -35220,7 +35231,8 @@ exports[`ir {"name":"streaming"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -36416,7 +36428,8 @@ exports[`ir {"name":"variables"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"
@@ -36721,7 +36734,8 @@ exports[`ir {"name":"webhooks"} 1`] = `
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }"

diff --git a/packages/cli/generation/ir-generator/src/__test__/generateAndSnapshotIR.ts b/packages/cli/generation/ir-generator/src/__test__/generateAndSnapshotIR.ts
@@ -54,7 +54,9 @@ export async function generateAndSnapshotIR({
         keywords: undefined,
         smartCasing: true,
         disableExamples: false,
-        readme: undefined
+        readme: undefined,
+        version: undefined,
+        packageName: undefined
     });
 
     const intermediateRepresentationJson = await IrSerialization.IntermediateRepresentation.jsonOrThrow(

diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/audiences.json b/packages/cli/generation/ir-generator/src/__test__/irs/audiences.json
@@ -1508,7 +1508,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiences.json b/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiences.json
@@ -5427,7 +5427,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/fhir.json b/packages/cli/generation/ir-generator/src/__test__/irs/fhir.json
@@ -1264378,7 +1264378,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/.../generation/ir-generator/src/__test__/test-definitions-openapi/code-samples-open-api.json b/.../generation/ir-generator/src/__test__/test-definitions-openapi/code-samples-open-api.json
@@ -1958,7 +1958,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/enum-casing.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/enum-casing.json
@@ -1513,7 +1513,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/...eneration/ir-generator/src/__test__/test-definitions-openapi/inline-schema-reference.json b/...eneration/ir-generator/src/__test__/test-definitions-openapi/inline-schema-reference.json
@@ -1079,7 +1079,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/names.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/names.json
@@ -3545,7 +3545,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias-extends.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias-extends.json
@@ -1219,7 +1219,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias.json
@@ -1163,7 +1163,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/api-wide-base-path.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/api-wide-base-path.json
@@ -762,7 +762,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/audiences.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/audiences.json
@@ -3810,7 +3810,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/...cli/generation/ir-generator/src/__test__/test-definitions/auth-environment-variables.json b/...cli/generation/ir-generator/src/__test__/test-definitions/auth-environment-variables.json
@@ -653,7 +653,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/...neration/ir-generator/src/__test__/test-definitions/basic-auth-environment-variables.json b/...neration/ir-generator/src/__test__/test-definitions/basic-auth-environment-variables.json
@@ -1454,7 +1454,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth.json
@@ -1454,7 +1454,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }
diff --git a/...eration/ir-generator/src/__test__/test-definitions/bearer-token-environment-variable.json b/...eration/ir-generator/src/__test__/test-definitions/bearer-token-environment-variable.json
@@ -359,7 +359,8 @@
         "platformHeaders": {
             "language": "X-Fern-Language",
             "sdkName": "X-Fern-SDK-Name",
-            "sdkVersion": "X-Fern-SDK-Version"
+            "sdkVersion": "X-Fern-SDK-Version",
+            "userAgent": null
         }
     }
 }