Merge branch 'master' into decorators-fixes-latest

Author: Andrei Bratu

README.md

@@ -91,15 +91,51 @@ try {
 }
 ```
 
+## Pagination
+
+List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
+
+```typescript
+import { HumanloopClient } from "humanloop";
+
+const client = new HumanloopClient({ apiKey: "YOUR_API_KEY" });
+const response = await client.prompts.list({
+    size: 1,
+});
+for await (const item of response) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+const page = await client.prompts.list({
+    size: 1,
+});
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+```
+
 ## Advanced
 
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `headers` request option.
+
+```typescript
+const response = await client.prompts.log(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
 retry limit (default: 2).
 
-A request is deemed retriable when any of the following HTTP status codes is returned:
+A request is deemed retryable when any of the following HTTP status codes is returned:
 
 - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
 - [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)

jest.config.mjs

@@ -0,0 +1,8 @@
+/** @type {import('jest').Config} */
+export default {
+    preset: "ts-jest",
+    testEnvironment: "node",
+    moduleNameMapper: {
+        "(.+)\.js$": "$1",
+    },
+};

package.json

@@ -12,6 +12,13 @@
         "test": "jest"
     },
     "dependencies": {
+        "url-join": "4.0.1",
+        "form-data": "^4.0.0",
+        "formdata-node": "^6.0.3",
+        "node-fetch": "^2.7.0",
+        "qs": "^6.13.1",
+        "readable-stream": "^4.5.2",
+        "form-data-encoder": "^4.0.2",
         "@opentelemetry/api": "1.9.0",
         "@opentelemetry/auto-instrumentations-node": "0.53.0",
         "@opentelemetry/sdk-metrics": "1.28.0",
@@ -34,6 +41,20 @@
         "url-join": "4.0.1"
     },
     "devDependencies": {
+        "@types/url-join": "4.0.1",
+        "@types/qs": "^6.9.17",
+        "@types/node-fetch": "^2.6.12",
+        "@types/readable-stream": "^4.0.18",
+        "webpack": "^5.97.1",
+        "ts-loader": "^9.5.1",
+        "jest": "^29.7.0",
+        "@types/jest": "^29.5.14",
+        "ts-jest": "^29.1.1",
+        "jest-environment-jsdom": "^29.7.0",
+        "@types/node": "^18.19.70",
+        "prettier": "^3.4.2",
+        "typescript": "~5.7.2",
+        "openai": "^4.74.0",
         "@anthropic-ai/sdk": "^0.32.1",
         "@babel/core": "^7.26.0",
         "@babel/plugin-transform-modules-commonjs": "^7.26.3",