(feature, typescript): Generarte API version scheme (#4071)

fern-api · Jul 17, 2024 · 56797ee · 56797ee
1 parent f6de375
commit 56797ee
Show file tree

Hide file tree

Showing 276 changed files with 6,652 additions and 239 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/cache/@fern-fern-ir-sdk-npm-48.1.0-f606ded772-6eaf4c3812.zip b/.yarn/cache/@fern-fern-ir-sdk-npm-48.1.0-f606ded772-6eaf4c3812.zip
diff --git a/.yarn/cache/@fern-fern-ir-sdk-npm-50.2.0-b03356efcf-052a039584.zip b/.yarn/cache/@fern-fern-ir-sdk-npm-50.2.0-b03356efcf-052a039584.zip
diff --git a/...0-sdk-npm-0.0.1-0de50f847e-0aee4fb1bf.zip → ...0-sdk-npm-0.0.3-4fccf2befd-765f402f93.zip b/...0-sdk-npm-0.0.1-0de50f847e-0aee4fb1bf.zip → ...0-sdk-npm-0.0.3-4fccf2befd-765f402f93.zip
diff --git a/generators/typescript/express/CHANGELOG.md b/generators/typescript/express/CHANGELOG.md
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.17.2] - 2024-07-16
+
+- Internal: Upgrade to IRv48.
+
 ## [0.17.1] - 2024-07-10
 
 - Fix: This fixes a bug introduced in `0.17.0-rc0` that prevented the SDK from serializing types

diff --git a/generators/typescript/express/VERSION b/generators/typescript/express/VERSION
@@ -1 +1 @@
-0.17.1
+0.17.2
diff --git a/generators/typescript/express/cli/package.json b/generators/typescript/express/cli/package.json
@@ -30,7 +30,7 @@
   },
   "devDependencies": {
     "@fern-fern/generator-exec-sdk": "^0.0.898",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-generator-cli": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/generators/typescript/express/express-endpoint-type-schemas-generator/package.json b/generators/typescript/express/express-endpoint-type-schemas-generator/package.json
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/...ss/express-endpoint-type-schemas-generator/src/GeneratedExpressEndpointTypeSchemasImpl.ts b/...ss/express-endpoint-type-schemas-generator/src/GeneratedExpressEndpointTypeSchemasImpl.ts
@@ -190,6 +190,9 @@ export class GeneratedExpressEndpointTypeSchemasImpl implements GeneratedExpress
         if (this.endpoint.response.body?.type === "streaming") {
             throw new Error("Streaming response is not supported");
         }
+        if (this.endpoint.response.body?.type === "streamParameter") {
+            throw new Error("Streaming response is not supported");
+        }
         if (this.endpoint.response.body?.type === "text") {
             throw new Error("Text response is not supported");
         }

diff --git a/generators/typescript/express/express-error-generator/package.json b/generators/typescript/express/express-error-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-error-class-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/generators/typescript/express/express-error-schema-generator/package.json b/generators/typescript/express/express-error-schema-generator/package.json
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/generators/typescript/express/express-inlined-request-body-generator/package.json b/generators/typescript/express/express-inlined-request-body-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*"
   },

diff --git a/generators/typescript/express/express-inlined-request-body-schema-generator/package.json b/generators/typescript/express/express-inlined-request-body-schema-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/generators/typescript/express/express-register-generator/package.json b/generators/typescript/express/express-register-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

diff --git a/generators/typescript/express/express-service-generator/package.json b/generators/typescript/express/express-service-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

diff --git a/generators/typescript/express/express-service-generator/src/GeneratedExpressServiceImpl.ts b/generators/typescript/express/express-service-generator/src/GeneratedExpressServiceImpl.ts
@@ -930,6 +930,9 @@ export class GeneratedExpressServiceImpl implements GeneratedExpressService {
             streaming: () => {
                 throw new Error("Streaming is not supported");
             },
+            streamParameter: () => {
+                throw new Error("Streaming is not supported");
+            },
             fileDownload: () => {
                 throw new Error("File download is not supported");
             },

diff --git a/generators/typescript/express/generator/package.json b/generators/typescript/express/generator/package.json
@@ -28,7 +28,7 @@
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/express-endpoint-type-schemas-generator": "workspace:*",

diff --git a/generators/typescript/model/type-generator/package.json b/generators/typescript/model/type-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/union-generator": "workspace:*",

diff --git a/generators/typescript/model/type-reference-converters/package.json b/generators/typescript/model/type-reference-converters/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",
     "ts-morph": "^15.1.0"

diff --git a/generators/typescript/model/type-reference-example-generator/package.json b/generators/typescript/model/type-reference-example-generator/package.json
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "ts-morph": "^15.1.0"

diff --git a/generators/typescript/model/type-schema-generator/package.json b/generators/typescript/model/type-schema-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/generators/typescript/model/union-generator/package.json b/generators/typescript/model/union-generator/package.json
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "ts-morph": "^15.1.0"

diff --git a/generators/typescript/model/union-schema-generator/package.json b/generators/typescript/model/union-schema-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/generators/typescript/sdk/CHANGELOG.md b/generators/typescript/sdk/CHANGELOG.md
@@ -5,7 +5,50 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.33.0] - 2024-07-15
+## [0.34.0] - 2024-07-16
+
+- Internal: Upgrade to IRv50.
+- Feature: Add support for generating an API version scheme in `version.ts`.
+  Consider the following `api.yml` configuration:
+
+  ```yaml
+  version:
+    header: X-API-Version
+    default: "1.0.0"
+    values:
+      - "1.0.0-alpha"
+      - "1.0.0-beta"
+      - "1.0.0"
+  ```
+
+  The following `version.ts` file is generated:
+
+  ```typescript
+  /**
+   * This file was auto-generated by Fern from our API Definition.
+   */
+
+  /** The version of the API, sent as the X-API-Version header. */
+  export type AcmeVersion = "1.0.0" | "2.0.0" | "latest";
+  ```
+
+  If a default value is specified, it is set on every request but can be overridden
+  in either the client-level `Options` or call-specific `RequestOptions`. If a default
+  value is _not_ specified, the value of the header is required on the generated `Options`.
+
+  An example call is shown below:
+
+  ```typescript
+  import { AcmeClient } from "acme";
+
+  const client = new AcmeClient({ apiKey: "YOUR_API_KEY", xApiVersion: "2.0.0" });
+  await client.users.create({
+    firstName: "john",
+    lastName: "doe"
+  });
+  ```
+
+## [0.33.0] - 2024-07-16
 
 - Fix: This release comes with numerous improvements to multipart uploads: 
 

diff --git a/generators/typescript/sdk/VERSION b/generators/typescript/sdk/VERSION
@@ -1 +1 @@
-0.33.0
+0.34.0
diff --git a/generators/typescript/sdk/cli/package.json b/generators/typescript/sdk/cli/package.json
@@ -34,7 +34,7 @@
   "devDependencies": {
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/generator-commons": "workspace:*",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/abstract-generator-cli": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

diff --git a/generators/typescript/sdk/client-class-generator/package.json b/generators/typescript/sdk/client-class-generator/package.json
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

diff --git a/generators/typescript/sdk/client-class-generator/src/GeneratedSdkClientClassImpl.ts b/generators/typescript/sdk/client-class-generator/src/GeneratedSdkClientClassImpl.ts
@@ -269,6 +269,23 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
                             retainOriginalCasing: this.retainOriginalCasing,
                             omitUndefined: this.omitUndefined
                         }),
+                    streamParameter: (streamParameter) =>
+                        // TODO(amckinney): For now we just generate the stream variant of the endpoint.
+                        // We need to implement both the non-streaming and streaming variants.
+                        new GeneratedStreamingEndpointImplementation({
+                            packageId,
+                            endpoint,
+                            generatedSdkClientClass: this,
+                            includeCredentialsOnCrossOriginRequests,
+                            response: getGeneratedEndpointResponse({
+                                response: HttpResponseBody.streaming(streamParameter.streamResponse)
+                            }),
+                            defaultTimeoutInSeconds,
+                            request: getGeneratedEndpointRequest(),
+                            includeSerdeLayer,
+                            retainOriginalCasing: this.retainOriginalCasing,
+                            omitUndefined: this.omitUndefined
+                        }),
                     text: (textResponse) => {
                         return getDefaultEndpointImplementation({
                             response: HttpResponseBody.text(textResponse)
@@ -797,6 +814,57 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
             );
         }
 
+        const generatedVersion = context.version.getGeneratedVersion();
+        if (generatedVersion != null) {
+            const header = generatedVersion.getHeader();
+            const headerName = this.getOptionKeyForHeader(header);
+            const defaultVersion = generatedVersion.getDefaultVersion();
+
+            let value: ts.Expression;
+            if (defaultVersion != null) {
+                value = ts.factory.createBinaryExpression(
+                    ts.factory.createPropertyAccessChain(
+                        ts.factory.createIdentifier(REQUEST_OPTIONS_PARAMETER_NAME),
+                        ts.factory.createToken(ts.SyntaxKind.QuestionDotToken),
+                        ts.factory.createIdentifier(headerName)
+                    ),
+                    ts.factory.createToken(ts.SyntaxKind.QuestionQuestionToken),
+                    ts.factory.createBinaryExpression(
+                        ts.factory.createPropertyAccessChain(
+                            ts.factory.createPropertyAccessExpression(
+                                ts.factory.createThis(),
+                                GeneratedSdkClientClassImpl.OPTIONS_PRIVATE_MEMBER
+                            ),
+                            ts.factory.createToken(ts.SyntaxKind.QuestionDotToken),
+                            ts.factory.createIdentifier(headerName)
+                        ),
+                        ts.factory.createToken(ts.SyntaxKind.QuestionQuestionToken),
+                        ts.factory.createStringLiteral(defaultVersion)
+                    )
+                );
+            } else {
+                value = ts.factory.createBinaryExpression(
+                    ts.factory.createPropertyAccessChain(
+                        ts.factory.createIdentifier(REQUEST_OPTIONS_PARAMETER_NAME),
+                        ts.factory.createToken(ts.SyntaxKind.QuestionDotToken),
+                        ts.factory.createIdentifier(headerName)
+                    ),
+                    ts.factory.createToken(ts.SyntaxKind.QuestionQuestionToken),
+                    ts.factory.createPropertyAccessExpression(
+                        ts.factory.createPropertyAccessExpression(
+                            ts.factory.createThis(),
+                            GeneratedSdkClientClassImpl.OPTIONS_PRIVATE_MEMBER
+                        ),
+                        ts.factory.createIdentifier(headerName)
+                    )
+                );
+            }
+            headers.push({
+                header: header.name.wireValue,
+                value
+            });
+        }
+
         headers.push(
             {
                 header: "X-Fern-Runtime",
@@ -822,7 +890,7 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
     }
 
     private generateRequestOptionsInterface(context: SdkContext): OptionalKind<InterfaceDeclarationStructure> {
-        return {
+        const requestOptions = {
             name: GeneratedSdkClientClassImpl.REQUEST_OPTIONS_INTERFACE_NAME,
             properties: [
                 {
@@ -853,6 +921,18 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
                 })
             ]
         };
+
+        const generatedVersion = context.version.getGeneratedVersion();
+        if (generatedVersion != null) {
+            const header = generatedVersion.getHeader();
+            requestOptions.properties.push({
+                name: this.getOptionKeyForHeader(header),
+                type: generatedVersion.getEnumValueUnion(),
+                hasQuestionToken: true,
+                docs: [`Override the ${header.name.wireValue} header`]
+            });
+        }
+        return requestOptions;
     }
 
     /******************************
@@ -964,6 +1044,17 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
             }
         }
 
+        const generatedVersion = context.version.getGeneratedVersion();
+        if (generatedVersion != null && !generatedVersion.hasDefaultVersion()) {
+            const header = generatedVersion.getHeader();
+            properties.push(
+                ts.factory.createPropertyAssignment(
+                    this.getOptionKeyForHeader(header),
+                    ts.factory.createStringLiteral(generatedVersion.getFirstEnumValue())
+                )
+            );
+        }
+
         return properties;
     }
 
@@ -1144,6 +1235,17 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
             }
         }
 
+        const generatedVersion = context.version.getGeneratedVersion();
+        if (generatedVersion != null) {
+            const header = generatedVersion.getHeader();
+            properties.push({
+                name: this.getOptionKeyForHeader(header),
+                type: generatedVersion.getEnumValueUnion(),
+                hasQuestionToken: generatedVersion.hasDefaultVersion(),
+                docs: [`Override the ${header.name.wireValue} header`]
+            });
+        }
+
         if (this.allowCustomFetcher) {
             properties.push({
                 name: GeneratedSdkClientClassImpl.CUSTOM_FETCHER_PROPERTY_NAME,

diff --git a/generators/typescript/sdk/endpoint-error-union-generator/package.json b/generators/typescript/sdk/endpoint-error-union-generator/package.json
@@ -26,7 +26,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "48.1.0",
+    "@fern-fern/ir-sdk": "50.2.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",