Release 0.0.35

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

@@ -57,23 +57,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.authentication.generateToken(..., {
+    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.
 
@@ -105,21 +118,33 @@ const response = await client.authentication.generateToken(..., {
 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.authentication.generateToken(...).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

jest.config.js renamed to jest.config.mjs

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

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openledger/typescript-sdk",
-    "version": "0.40.8",
+    "version": "0.0.35",
     "private": false,
     "repository": "https://github.com/openledger/openledger-typescript-sdk",
     "main": "./index.js",
@@ -15,30 +15,30 @@
         "url-join": "4.0.1",
         "form-data": "^4.0.0",
         "formdata-node": "^6.0.3",
-        "node-fetch": "2.7.0",
-        "qs": "6.11.2",
+        "node-fetch": "^2.7.0",
+        "qs": "^6.13.1",
         "readable-stream": "^4.5.2",
-        "js-base64": "3.7.2"
+        "js-base64": "3.7.7"
     },
     "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"
+        "@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"
     },
     "browser": {
         "fs": false,
         "os": false,
         "path": false
-    }
+    },
+    "packageManager": "yarn@1.22.22"
 }

scripts/rename-to-esm-files.js

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+
+const fs = require("fs").promises;
+const path = require("path");
+
+const extensionMap = {
+    ".js": ".mjs",
+    ".d.ts": ".d.mts",
+};
+const oldExtensions = Object.keys(extensionMap);
+
+async function findFiles(rootPath) {
+    const files = [];
+
+    async function scan(directory) {
+        const entries = await fs.readdir(directory, { withFileTypes: true });
+
+        for (const entry of entries) {
+            const fullPath = path.join(directory, entry.name);
+
+            if (entry.isDirectory()) {
+                if (entry.name !== "node_modules" && !entry.name.startsWith(".")) {
+                    await scan(fullPath);
+                }
+            } else if (entry.isFile()) {
+                if (oldExtensions.some((ext) => entry.name.endsWith(ext))) {
+                    files.push(fullPath);
+                }
+            }
+        }
+    }
+
+    await scan(rootPath);
+    return files;
+}
+
+async function updateFiles(files) {
+    const updatedFiles = [];
+    for (const file of files) {
+        const updated = await updateFileContents(file);
+        updatedFiles.push(updated);
+    }
+
+    console.log(`Updated imports in ${updatedFiles.length} files.`);
+}
+
+async function updateFileContents(file) {
+    const content = await fs.readFile(file, "utf8");
+
+    let newContent = content;
+    // Update each extension type defined in the map
+    for (const [oldExt, newExt] of Object.entries(extensionMap)) {
+        const regex = new RegExp(`(import|export)(.+from\\s+['"])(\\.\\.?\\/[^'"]+)(\\${oldExt})(['"])`, "g");
+        newContent = newContent.replace(regex, `$1$2$3${newExt}$5`);
+    }
+
+    if (content !== newContent) {
+        await fs.writeFile(file, newContent, "utf8");
+        return true;
+    }
+    return false;
+}
+
+async function renameFiles(files) {
+    let counter = 0;
+    for (const file of files) {
+        const ext = oldExtensions.find((ext) => file.endsWith(ext));
+        const newExt = extensionMap[ext];
+
+        if (newExt) {
+            const newPath = file.slice(0, -ext.length) + newExt;
+            await fs.rename(file, newPath);
+            counter++;
+        }
+    }
+
+    console.log(`Renamed ${counter} files.`);
+}
+
+async function main() {
+    try {
+        const targetDir = process.argv[2];
+        if (!targetDir) {
+            console.error("Please provide a target directory");
+            process.exit(1);
+        }
+
+        const targetPath = path.resolve(targetDir);
+        const targetStats = await fs.stat(targetPath);
+
+        if (!targetStats.isDirectory()) {
+            console.error("The provided path is not a directory");
+            process.exit(1);
+        }
+
+        console.log(`Scanning directory: ${targetDir}`);
+
+        const files = await findFiles(targetDir);
+
+        if (files.length === 0) {
+            console.log("No matching files found.");
+            process.exit(0);
+        }
+
+        console.log(`Found ${files.length} files.`);
+        await updateFiles(files);
+        await renameFiles(files);
+        console.log("\nDone!");
+    } catch (error) {
+        console.error("An error occurred:", error.message);
+        process.exit(1);
+    }
+}
+
+main();

src/Client.ts

@@ -14,69 +14,66 @@ import { Ai } from "./api/resources/ai/client/Client";
 import { Sandbox } from "./api/resources/sandbox/client/Client";
 
 export declare namespace OpenLedgerClientClient {
-    interface Options {
+    export interface Options {
         environment?: core.Supplier<environments.OpenLedgerClientEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         token?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
 
-    interface RequestOptions {
+    export interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
         /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 
 export class OpenLedgerClientClient {
-    constructor(protected readonly _options: OpenLedgerClientClient.Options = {}) {}
-
     protected _authentication: Authentication | undefined;
+    protected _transactions: Transactions | undefined;
+    protected _reports: Reports | undefined;
+    protected _banks: Banks | undefined;
+    protected _integrations: Integrations | undefined;
+    protected _entities: Entities | undefined;
+    protected _ai: Ai | undefined;
+    protected _sandbox: Sandbox | undefined;
+
+    constructor(protected readonly _options: OpenLedgerClientClient.Options = {}) {}
 
     public get authentication(): Authentication {
         return (this._authentication ??= new Authentication(this._options));
     }
 
-    protected _transactions: Transactions | undefined;
-
     public get transactions(): Transactions {
         return (this._transactions ??= new Transactions(this._options));
     }
 
-    protected _reports: Reports | undefined;
-
     public get reports(): Reports {
         return (this._reports ??= new Reports(this._options));
     }
 
-    protected _banks: Banks | undefined;
-
     public get banks(): Banks {
         return (this._banks ??= new Banks(this._options));
     }
 
-    protected _integrations: Integrations | undefined;
-
     public get integrations(): Integrations {
         return (this._integrations ??= new Integrations(this._options));
     }
 
-    protected _entities: Entities | undefined;
-
     public get entities(): Entities {
         return (this._entities ??= new Entities(this._options));
     }
 
-    protected _ai: Ai | undefined;
-
     public get ai(): Ai {
         return (this._ai ??= new Ai(this._options));
     }
 
-    protected _sandbox: Sandbox | undefined;
-
     public get sandbox(): Sandbox {
         return (this._sandbox ??= new Sandbox(this._options));
     }

src/api/errors/BadRequestError.ts

@@ -3,13 +3,15 @@
  */
 
 import * as errors from "../../errors/index";
+import * as core from "../../core";
 
 export class BadRequestError extends errors.OpenLedgerClientError {
-    constructor(body?: unknown) {
+    constructor(body?: unknown, rawResponse?: core.RawResponse) {
         super({
             message: "BadRequestError",
             statusCode: 400,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, BadRequestError.prototype);
     }