Release 0.1.7

Author: fern-api[bot]

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up node
         uses: actions/setup-node@v3
@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up node
         uses: actions/setup-node@v3
@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up node
         uses: actions/setup-node@v3
       - name: Install dependencies

README.md

@@ -17,7 +17,7 @@ npm i -s @beehiiv/sdk
 
 ## Reference
 
-A full reference for this library is available [here](./reference.md).
+A full reference for this library is available [here](https://github.com/beehiiv/typescript-sdk/blob/HEAD/./reference.md).
 
 ## Usage
 
@@ -32,8 +32,8 @@ await client.automationJourneys.create(
     "aut_00000000-0000-0000-0000-000000000000",
     {
         email: "[email protected]",
-        doubleOptOverride: "on",
-    }
+        double_opt_override: "on",
+    },
 );
 ```
 
@@ -65,23 +65,36 @@ try {
         console.log(err.statusCode);
         console.log(err.message);
         console.log(err.body);
+        console.log(err.rawResponse);
     }
 }
 ```
 
 ## 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.automationJourneys.create(..., {
+    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)
--   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+- [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)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
 
 Use the `maxRetries` request option to configure this behavior.
 
@@ -113,21 +126,33 @@ const response = await client.automationJourneys.create(..., {
 controller.abort(); // aborts the request
 ```
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.automationJourneys.create(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
 ### Runtime Compatibility
 
 The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
 runtimes:
 
--   Node.js 18+
--   Vercel
--   Cloudflare Workers
--   Deno v1.25+
--   Bun 1.0+
--   React Native
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
 
 ### Customizing Fetch Client
 
-The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+The SDK provides a way for you 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.
 
 ```typescript
@@ -147,10 +172,10 @@ than the configured retry limit (default: 2).
 
 A request is deemed retriable when any of the following HTTP status codes is returned:
 
--   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
--   [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
--   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
--   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
 
 Use the `maxRetries` request option to configure this behavior.
 
@@ -178,12 +203,12 @@ works in the following runtimes:
 
 The following runtimes are supported:
 
--   Node.js 15+
--   Vercel
--   Cloudflare Workers
--   Deno v1.25+
--   Bun 1.0+
--   React Native
+- Node.js 15+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
 
 ### Customizing Fetch client
 

jest.config.js

@@ -0,0 +1,42 @@
+/** @type {import('jest').Config} */
+export default {
+    preset: "ts-jest",
+    testEnvironment: "node",
+    projects: [
+        {
+            displayName: "unit",
+            preset: "ts-jest",
+            testEnvironment: "node",
+            moduleNameMapper: {
+                "^(\.{1,2}/.*)\.js$": "$1",
+            },
+            roots: ["<rootDir>/tests"],
+            testPathIgnorePatterns: ["\.browser\.(spec|test)\.[jt]sx?$", "/tests/wire/"],
+            setupFilesAfterEnv: [],
+        },
+        {
+            displayName: "browser",
+            preset: "ts-jest",
+            testEnvironment: "<rootDir>/tests/BrowserTestEnvironment.ts",
+            moduleNameMapper: {
+                "^(\.{1,2}/.*)\.js$": "$1",
+            },
+            roots: ["<rootDir>/tests"],
+            testMatch: ["<rootDir>/tests/unit/**/?(*.)+(browser).(spec|test).[jt]s?(x)"],
+            setupFilesAfterEnv: [],
+        },
+        ,
+        {
+            displayName: "wire",
+            preset: "ts-jest",
+            testEnvironment: "node",
+            moduleNameMapper: {
+                "^(\.{1,2}/.*)\.js$": "$1",
+            },
+            roots: ["<rootDir>/tests/wire"],
+            setupFilesAfterEnv: ["<rootDir>/tests/mock-server/setup.ts"],
+        },
+    ],
+    workerThreads: false,
+    passWithNoTests: true,
+};

jest.config.mjs

@@ -1,44 +1,65 @@
 {
     "name": "@beehiiv/sdk",
-    "version": "0.1.6",
+    "version": "0.1.7",
     "private": false,
-    "repository": "https://github.com/beehiiv/typescript-sdk",
-    "main": "./index.js",
-    "types": "./index.d.ts",
+    "repository": "github:beehiiv/typescript-sdk",
+    "type": "commonjs",
+    "main": "./dist/cjs/index.js",
+    "module": "./dist/esm/index.mjs",
+    "types": "./dist/cjs/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/cjs/index.d.ts",
+            "import": {
+                "types": "./dist/esm/index.d.mts",
+                "default": "./dist/esm/index.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/index.d.ts",
+                "default": "./dist/cjs/index.js"
+            },
+            "default": "./dist/cjs/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist",
+        "reference.md",
+        "README.md",
+        "LICENSE"
+    ],
     "scripts": {
         "format": "prettier . --write --ignore-unknown",
-        "build": "tsc",
-        "prepack": "cp -rv dist/. .",
-        "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.11.2",
-        "readable-stream": "^4.5.2",
-        "js-base64": "3.7.2"
+        "build": "yarn build:cjs && yarn build:esm",
+        "build:cjs": "tsc --project ./tsconfig.cjs.json",
+        "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
+        "test": "jest --config jest.config.mjs",
+        "test:unit": "jest --selectProjects unit",
+        "test:browser": "jest --selectProjects browser",
+        "test:wire": "jest --selectProjects wire"
     },
     "devDependencies": {
-        "@types/url-join": "4.0.1",
-        "@types/qs": "6.9.8",
-        "@types/node-fetch": "2.6.9",
-        "@types/readable-stream": "^4.0.15",
-        "fetch-mock-jest": "^1.5.1",
-        "webpack": "^5.94.0",
-        "ts-loader": "^9.3.1",
-        "jest": "29.7.0",
-        "@types/jest": "29.5.5",
-        "ts-jest": "29.1.1",
-        "jest-environment-jsdom": "29.7.0",
-        "@types/node": "17.0.33",
-        "prettier": "2.7.1",
-        "typescript": "4.6.4"
+        "webpack": "^5.97.1",
+        "ts-loader": "^9.5.1",
+        "jest": "^29.7.0",
+        "@jest/globals": "^29.7.0",
+        "@types/jest": "^29.5.14",
+        "ts-jest": "^29.3.4",
+        "jest-environment-jsdom": "^29.7.0",
+        "msw": "^2.8.4",
+        "@types/node": "^18.19.70",
+        "prettier": "^3.4.2",
+        "typescript": "~5.7.2"
     },
     "browser": {
         "fs": false,
         "os": false,
-        "path": false
-    }
+        "path": false,
+        "stream": false
+    },
+    "packageManager": "[email protected]",
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "sideEffects": false
 }