feat(typescript): document auto pagination (#5241)

generators/typescript/sdk/CHANGELOG.md

@@ -5,6 +5,25 @@ 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.2] - 2024-11-21
+
+- Improvement: Added documentation for pagination in the README. The snippet below will 
+  now show up on generated READMEs. 
+
+  ```typescript
+  // Iterate through all items
+  const response = await client.users.list();
+  for await (const item of response) {
+    console.log(item);
+  }
+
+  // Or manually paginate
+  let page = await client.users.list();
+  while (page.hasNextPage()) {
+    page = await page.getNextPage();
+  }
+  ```
+
 
 ## [0.42.1] - 2024-11-20
 

generators/typescript/sdk/VERSION

@@ -1 +1 @@
-0.42.1
+0.42.2

generators/typescript/sdk/features.yml

@@ -12,6 +12,10 @@ 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: PAGINATION
+    description: | 
+      List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
  
   - id: RAW_RESPONSES
     advanced: true

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

@@ -27,15 +27,15 @@ export class ReadmeConfigBuilder {
         const snippets = readmeSnippetBuilder.buildReadmeSnippets();
         const features: FernGeneratorCli.ReadmeFeature[] = [];
         for (const feature of featureConfig.features) {
-            const featureSnippets = snippets[feature.id];
-            if (!featureSnippets) {
+            const snippetForFeature = snippets[feature.id];
+            if (snippetForFeature == null) {
                 continue;
             }
             features.push({
                 id: feature.id,
                 advanced: feature.advanced,
                 description: feature.description,
-                snippets: featureSnippets,
+                snippets: snippetForFeature,
                 snippetsAreOptional: false
             });
         }

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

@@ -73,7 +73,7 @@ export class ReadmeSnippetBuilder extends AbstractReadmeSnippetBuilder {
         snippets[ReadmeSnippetBuilder.ADDITIONAL_HEADERS_FEATURE_ID] = this.buildAdditionalHeadersSnippets();
 
         if (this.isPaginationEnabled) {
-            snippets[ReadmeSnippetBuilder.PAGINATION_FEATURE_ID] = this.buildPaginationSnippets();
+            snippets[FernGeneratorCli.StructuredFeatureId.Pagination] = this.buildPaginationSnippets();
         }
 
         const requestAndResponseTypesSnippets = this.buildRequestAndResponseTypesSnippets();