Merge pull request #231 from seamapi/update-feb20

feat: Update @seamapi/http to v1.25.0

Author: razor-x

.github/workflows/_build.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Package
         run: npm pack
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: build-${{ github.sha }}
           if-no-files-found: error

.github/workflows/_publish.yml

@@ -30,7 +30,7 @@ jobs:
         with:
           install_dependencies: 'false'
       - name: Download artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ inputs.artifact_name }}
           path: .

.github/workflows/check.yml

@@ -78,24 +78,24 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - name: Download artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ needs.build.outputs.artifact_name }}
           path: .
       - name: Find packages
-        uses: tj-actions/glob@v17
+        uses: tj-actions/glob@v21
         id: packages
         with:
           files: '*.tgz'
       - name: Create package.json
-        uses: DamianReeves/write-file-action@v1.2
+        uses: DamianReeves/write-file-action@v1.3
         with:
           write-mode: overwrite
           path: package.json
           contents: |
             {"type":"module"}
       - name: Create index.js
-        uses: DamianReeves/write-file-action@v1.2
+        uses: DamianReeves/write-file-action@v1.3
         with:
           write-mode: overwrite
           path: index.js

.github/workflows/publish.yml

@@ -23,7 +23,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Download artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ needs.build.outputs.artifact_name }}
           path: .
@@ -33,10 +33,10 @@ jobs:
           mkdir tmp
           outfile=tmp/changelog.txt
           echo "outfile=${outfile}" >> $GITHUB_OUTPUT
-          npx standard-changelog@^2.0.0 --release-count 2 --infile $outfile.tmp --outfile $outfile.tmp
+          npx standard-changelog@^5.0.0 --release-count 2 --infile $outfile.tmp --outfile $outfile.tmp
           sed '1,3d' $outfile.tmp > $outfile
       - name: Create GitHub release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           token: ${{ secrets.GH_TOKEN }}
           fail_on_unmatched_files: true

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021-2023 Seam Labs, Inc.
+Copyright (c) 2021-2025 Seam Labs, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -43,6 +43,11 @@ Instead, it re-exports from a core set of Seam modules:
     - [Personal Access Token](#personal-access-token)
     - [Console Session Token](#console-session-token)
   - [Action Attempts](#action-attempts)
+  - [Pagination](#pagination)
+    - [Manually fetch pages with the nextPageCursor](#manually-fetch-pages-with-the-nextpagecursor)
+    - [Iterate over all pages](#iterate-over-all-pages)
+    - [Iterate over all resources](#iterate-over-all-resources)
+    - [Return all resources across all pages as an array](#return-all-resources-across-all-pages-as-an-array)
   - [Interacting with Multiple Workspaces](#interacting-with-multiple-workspaces)
     - [Personal Access Token](#personal-access-token-1)
     - [Console Session Token](#console-session-token-1)
@@ -313,6 +318,67 @@ try {
 
 [action attempt]: https://docs.seam.co/latest/core-concepts/action-attempts
 
+### Pagination
+
+Some Seam API endpoints that return lists of resources support pagination.
+Use the `SeamPaginator` class to fetch and process resources across multiple pages.
+
+#### Manually fetch pages with the nextPageCursor
+
+```ts
+const pages = seam.createPaginator(
+  seam.devices.list({
+    limit: 20,
+  }),
+)
+
+const [devices, { hasNextPage, nextPageCursor }] = await pages.firstPage()
+
+if (hasNextPage) {
+  const [moreDevices] = await pages.nextPage(nextPageCursor)
+}
+```
+
+#### Iterate over all pages
+
+```ts
+const pages = seam.createPaginator(
+  seam.devices.list({
+    limit: 20,
+  }),
+)
+
+for await (const devices of pages) {
+  console.log(`There are ${devices.length} devices on this page.`)
+}
+```
+
+#### Iterate over all resources
+
+```ts
+const pages = seam.createPaginator(
+  seam.devices.list({
+    limit: 20,
+  }),
+)
+
+for await (const device of pages.flatten()) {
+  console.log(devices.name)
+}
+```
+
+#### Return all resources across all pages as an array
+
+```ts
+const pages = seam.createPaginator(
+  seam.devices.list({
+    limit: 20,
+  }),
+)
+
+const devices = await pages.toArray()
+```
+
 ### Interacting with Multiple Workspaces
 
 Some Seam API endpoints interact with multiple workspaces.