fix

generators/typescript/sdk/CHANGELOG.md

@@ -5,6 +5,17 @@ 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.42.0] - 2024-11-15
+
+- Feat: Added support for `.asRaw()` which allows users to access raw response data including headers. For example:
+
+  ```ts
+  const response = await client.someEndpoint().asRaw();
+  console.log(response.headers['X-My-Header']); 
+  console.log(response.body);
+  ```
+
+
 ## [0.41.1] - 2024-11-02
 
 - Fix: Remove dev dependency on `jest-fetch-mock`. 

generators/typescript/sdk/VERSION

@@ -1 +1 @@
-0.41.1
+0.42.0

generators/typescript/sdk/features.yml

@@ -12,7 +12,13 @@ features:
     description: |
       When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
       will be thrown.
-
+ 
+  - id: RAW_RESPONSES
+    advanced: true
+    description: | 
+      The SDK provides access to raw response data, including headers, through the `.asRaw()` method. When using `.asRaw()`, 
+      the parsed response body will be available in the `body` field, along with the response headers:
+  
   - id: RETRIES
     advanced: true
     description: |
@@ -54,4 +60,5 @@ features:
       ### Customizing Fetch Client
 
       The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
-      unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+      unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+  

generators/typescript/sdk/generator/src/readme/ReadmeSnippetBuilder.ts

@@ -5,12 +5,9 @@ import {
     FeatureId,
     FernFilepath,
     HttpEndpoint,
-    HttpService,
-    ReadmeConfig,
     SdkRequestWrapper,
-    ServiceId
 } from "@fern-fern/ir-sdk/api";
-import { getTextOfTsNode, NpmPackage } from "@fern-typescript/commons";
+import { getTextOfTsNode } from "@fern-typescript/commons";
 import { SdkContext } from "@fern-typescript/contexts";
 import { code, Code } from "ts-poet";
 import { AbstractReadmeSnippetBuilder } from "@fern-api/generator-commons";
@@ -32,6 +29,7 @@ export class ReadmeSnippetBuilder extends AbstractReadmeSnippetBuilder {
     private static RUNTIME_COMPATIBILITY_FEATURE_ID: FernGeneratorCli.FeatureId = "RUNTIME_COMPATIBILITY";
     private static STREAMING_FEATURE_ID: FernGeneratorCli.FeatureId = "STREAMING";
     private static PAGINATION_FEATURE_ID: FernGeneratorCli.FeatureId = "PAGINATION";
+    private static RAW_RESPONSES_FEATURE_ID: FernGeneratorCli.FeatureId = "RAW_RESPONSES";
 
     private readonly context: SdkContext;
     private readonly isPaginationEnabled: boolean;
@@ -71,10 +69,12 @@ export class ReadmeSnippetBuilder extends AbstractReadmeSnippetBuilder {
         snippets[FernGeneratorCli.StructuredFeatureId.Usage] = this.buildUsageSnippets();
         snippets[FernGeneratorCli.StructuredFeatureId.Retries] = this.buildRetrySnippets();
         snippets[FernGeneratorCli.StructuredFeatureId.Timeouts] = this.buildTimeoutSnippets();
+
         snippets[ReadmeSnippetBuilder.ABORTING_REQUESTS_FEATURE_ID] = this.buildAbortSignalSnippets();
         snippets[ReadmeSnippetBuilder.EXCEPTION_HANDLING_FEATURE_ID] = this.buildExceptionHandlingSnippets();
         snippets[ReadmeSnippetBuilder.RUNTIME_COMPATIBILITY_FEATURE_ID] = this.buildRuntimeCompatibilitySnippets();
         snippets[ReadmeSnippetBuilder.STREAMING_FEATURE_ID] = this.buildStreamingSnippets();
+        snippets[ReadmeSnippetBuilder.RAW_RESPONSES_FEATURE_ID] = this.buildRawResponseSnippets();
 
         if (this.isPaginationEnabled) {
             snippets[ReadmeSnippetBuilder.PAGINATION_FEATURE_ID] = this.buildPaginationSnippets();
@@ -152,6 +152,20 @@ const request: ${requestTypeName} = {
         ];
     }
 
+    private buildRawResponseSnippets(): string[] {
+        const rawResponseEndpoints = this.getEndpointsForFeature(ReadmeSnippetBuilder.RAW_RESPONSES_FEATURE_ID);
+        return rawResponseEndpoints.map((rawResponseEndpoint) =>
+            this.writeCode(
+                code`
+const response = await ${this.getMethodCall(rawResponseEndpoint)}(...).asRaw();
+
+console.log(response.headers['X-My-Header']);
+console.log(response.body);
+`
+            )
+        );
+    }
+
     private buildRetrySnippets(): string[] {
         const retryEndpoints = this.getEndpointsForFeature(FernGeneratorCli.StructuredFeatureId.Retries);
         return retryEndpoints.map((retryEndpoint) =>