seam 1.41.0 → 1.48.0

package/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

package/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.

package/dist/index.cjs

@@ -25,5 +25,5 @@ Object.keys(webhook).forEach(function (k) {
     get: function () { return webhook[k]; }
   });
 });
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAA;AAAA,EACE,YAAY;AAAA,EACZ,0BAA0B;AAAA,OAGrB;AAEP,cAAc;AAEd,cAAc","sourcesContent":["import {\n  SeamHttp as Seam,\n  SeamHttpMultiWorkspace as SeamMultiWorkspace,\n  type SeamHttpMultiWorkspaceOptions as SeamMultiWorkspaceOptions,\n  type SeamHttpOptions as SeamOptions,\n} from '@seamapi/http/connect'\n\nexport * from '@seamapi/http/connect'\nexport type * from '@seamapi/types/connect'\nexport * from '@seamapi/webhook'\nexport { Seam, SeamMultiWorkspace }\nexport type { SeamMultiWorkspaceOptions, SeamOptions }\n"]}
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs","sourcesContent":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seam",
-  "version": "1.41.0",
+  "version": "1.48.0",
   "description": "JavaScript SDK for the Seam API written in TypeScript.",
   "type": "module",
   "main": "index.js",
@@ -65,8 +65,8 @@
     "npm": ">= 9.0.0"
   },
   "dependencies": {
-    "@seamapi/http": "1.17.0",
-    "@seamapi/types": "1.304.0",
+    "@seamapi/http": "1.25.0",
+    "@seamapi/types": "1.355.0",
     "@seamapi/webhook": "1.1.1",
     "zod": "^3.21.4"
   },