modern-treasury 2.48.0 → 3.0.0

package/CHANGELOG.md

@@ -1,100 +1,23 @@
 # Changelog
 
-## 2.48.0 (2025-09-11)
+## 3.0.0 (2025-09-29)
 
-Full Changelog: [v2.47.0...v2.48.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.47.0...v2.48.0)
+Full Changelog: [v2.48.0...v3.0.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.48.0...v3.0.0)
 
 ### Features
 
-* **api:** api update ([067b5af](https://github.com/Modern-Treasury/modern-treasury-node/commit/067b5af506f47fd451a157d298b5d0cc1263b985))
+* **api:** manual updates ([929997c](https://github.com/Modern-Treasury/modern-treasury-node/commit/929997c7e891dc98b07335fd803e1f48e234722d))
+* **api:** manual updates ([fdf325a](https://github.com/Modern-Treasury/modern-treasury-node/commit/fdf325add6b11c78b63532a4c3568b0c90dd4d48))
 
 
 ### Bug Fixes
 
-* coerce nullable values to undefined ([0d14256](https://github.com/Modern-Treasury/modern-treasury-node/commit/0d142563bf765ce5bdad5cc9d02c7e1d511a7354))
-* **mcp:** fix uploading dxt release assets ([b046ef3](https://github.com/Modern-Treasury/modern-treasury-node/commit/b046ef337f794de93793914a6ae576c56bcc5640))
+* **mcp:** resolve a linting issue in server code ([97e09c1](https://github.com/Modern-Treasury/modern-treasury-node/commit/97e09c126784ce283d63faede1c50f5f484990a6))
 
 
 ### Chores
 
-* **internal:** codegen related update ([ff03fce](https://github.com/Modern-Treasury/modern-treasury-node/commit/ff03fce8b8fd7b0ef843d028a6981f43598f9d42))
-
-## 2.47.0 (2025-09-05)
-
-Full Changelog: [v2.46.0...v2.47.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.46.0...v2.47.0)
-
-### Features
-
-* **api:** api update ([6bd8885](https://github.com/Modern-Treasury/modern-treasury-node/commit/6bd8885120045128b80c1a2d91beaa2961606df3))
-* **api:** api update ([9374f8a](https://github.com/Modern-Treasury/modern-treasury-node/commit/9374f8a5ba1cf3cf6de1ef36e3a8a7cc713781e9))
-* **api:** api update ([856f251](https://github.com/Modern-Treasury/modern-treasury-node/commit/856f2515bfef136d35ed22bc8116ff08a1711bd9))
-* **api:** api update ([bc875bc](https://github.com/Modern-Treasury/modern-treasury-node/commit/bc875bcb8191c9bcd17981c89119d50e3bb77255))
-* **api:** api update ([3b4bdb3](https://github.com/Modern-Treasury/modern-treasury-node/commit/3b4bdb3dff8036a15799b545e61641977dbe4a2b))
-* **mcp:** add code execution tool ([d9e1588](https://github.com/Modern-Treasury/modern-treasury-node/commit/d9e15881552fd78d98c8ef04b58f67e5d7a3d27c))
-* **mcp:** add mcp bundles to build script ([75035cf](https://github.com/Modern-Treasury/modern-treasury-node/commit/75035cf95a3fbcd938937c54b0e8ae01cd619b45))
-* **mcp:** add option to infer mcp client ([2ffe483](https://github.com/Modern-Treasury/modern-treasury-node/commit/2ffe483d5ad2e4d13b46e18824dce3271a034e56))
-* **mcp:** allow setting logging level ([1d5e346](https://github.com/Modern-Treasury/modern-treasury-node/commit/1d5e346379c2454915b424351ca8b2cf2dd291a3))
-* **mcp:** change remote server query option parsing logic ([0a33484](https://github.com/Modern-Treasury/modern-treasury-node/commit/0a334844bd8b50e8ef957295600bb99a58bb4d14))
-* **mcp:** expose client options in `streamableHTTPApp` ([b6dbe2c](https://github.com/Modern-Treasury/modern-treasury-node/commit/b6dbe2c34bb8ef447d530ea47644d7a856d3628a))
-* **mcp:** parse query string as mcp client options in mcp server ([5089733](https://github.com/Modern-Treasury/modern-treasury-node/commit/50897330201d7a8fb15f5feb1fe1a84bd203e67f))
-
-
-### Bug Fixes
-
-* **mcp:** avoid importing unsupported libraries on non-node environments ([63d2587](https://github.com/Modern-Treasury/modern-treasury-node/commit/63d258716d6bc12ea6153ff17a439cb449307830))
-* **mcp:** fix query options parsing ([4c6973c](https://github.com/Modern-Treasury/modern-treasury-node/commit/4c6973c40d3716adb2a90278f0899c1c44aaa4ae))
-
-
-### Chores
-
-* ci build action ([4eece71](https://github.com/Modern-Treasury/modern-treasury-node/commit/4eece7192107015807e3fd6eb9f540c0f0f9c123))
-* **internal:** codegen related update ([8e31ed9](https://github.com/Modern-Treasury/modern-treasury-node/commit/8e31ed9073788daac13e537fea5e0abba2b2e49e))
-* **internal:** codegen related update ([858337d](https://github.com/Modern-Treasury/modern-treasury-node/commit/858337de41d557c03453434fef3d7878baefb0f6))
-* **internal:** codegen related update ([f9e7265](https://github.com/Modern-Treasury/modern-treasury-node/commit/f9e7265a9b9c4dae3c9d44df8b87be7443a5e388))
-* **internal:** codegen related update ([84b3ee5](https://github.com/Modern-Treasury/modern-treasury-node/commit/84b3ee515f9675f8c14b641f4552f39a0b88540c))
-* **internal:** formatting change ([56b885b](https://github.com/Modern-Treasury/modern-treasury-node/commit/56b885b7aceb189e466184e58782b46140d8895d))
-* **internal:** make mcp-server publishing public by defaut ([6534bf4](https://github.com/Modern-Treasury/modern-treasury-node/commit/6534bf4425d9a4d5a787be8b60d6185f92836af1))
-* **internal:** refactor array check ([8f36c30](https://github.com/Modern-Treasury/modern-treasury-node/commit/8f36c302c1c18484c84c6b09478b1f36597843d5))
-* **mcp:** add cors to oauth metadata route ([1bf5a22](https://github.com/Modern-Treasury/modern-treasury-node/commit/1bf5a2225c11d5990286ad0ede459699f4f56591))
-* **mcp:** update package.json ([cdea851](https://github.com/Modern-Treasury/modern-treasury-node/commit/cdea8518bfb7d57eeeb0163b0734b9fd09df1607))
-* **mcp:** update README ([acae046](https://github.com/Modern-Treasury/modern-treasury-node/commit/acae046585f0cedfdf54eb49dbf0cf260a52f82e))
-* **mcp:** update types ([6dda7c3](https://github.com/Modern-Treasury/modern-treasury-node/commit/6dda7c386f7989ee1a862a4322ca3a80b6b35552))
-* update CI script ([fdaa2f5](https://github.com/Modern-Treasury/modern-treasury-node/commit/fdaa2f5a13274434e2423dcffd21998c230076e3))
-
-## 2.46.0 (2025-08-12)
-
-Full Changelog: [v2.45.0...v2.46.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.45.0...v2.46.0)
-
-### Features
-
-* **api:** manual updates ([6fad99a](https://github.com/Modern-Treasury/modern-treasury-node/commit/6fad99a4e63a5dbf9b0aee27ace9237369f12478))
-
-## 2.45.0 (2025-08-12)
-
-Full Changelog: [v2.44.0...v2.45.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.44.0...v2.45.0)
-
-### Features
-
-* **api:** api update ([e17f2a7](https://github.com/Modern-Treasury/modern-treasury-node/commit/e17f2a7a24a8608df69a01c2de71165c044005e6))
-
-## 2.44.0 (2025-08-11)
-
-Full Changelog: [v2.43.0...v2.44.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.43.0...v2.44.0)
-
-### Features
-
-* **api:** api update ([5cbcca9](https://github.com/Modern-Treasury/modern-treasury-node/commit/5cbcca97745ce941e22f2a4bb3cc305cee087909))
-
-## 2.43.0 (2025-08-07)
-
-Full Changelog: [v2.42.0...v2.43.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.42.0...v2.43.0)
-
-### Features
-
-* **api:** api update ([4433412](https://github.com/Modern-Treasury/modern-treasury-node/commit/4433412b6026611b6b35e1f0bfdb151d0929318e))
-* **api:** api update ([7b63781](https://github.com/Modern-Treasury/modern-treasury-node/commit/7b637819e5f9ac8485e88834d0494c5f42d3d07f))
-* **api:** manual updates ([fe3afe8](https://github.com/Modern-Treasury/modern-treasury-node/commit/fe3afe8d266b7d4a568030d77443f034145f0986))
-* **api:** manual updates ([4dc396c](https://github.com/Modern-Treasury/modern-treasury-node/commit/4dc396ca7c32a5e228dd279478e8ce8422e7c47d))
+* sync repo ([97bdad3](https://github.com/Modern-Treasury/modern-treasury-node/commit/97bdad3cfb412750edbaf20c5b6479ae04e2ad1f))
 
 ## 2.42.0 (2025-08-01)
 

package/README.md

@@ -1,6 +1,6 @@
-# Modern Treasury Node API Library
+# Modern Treasury TypeScript API Library
 
-[![NPM version](https://img.shields.io/npm/v/modern-treasury.svg)](https://npmjs.org/package/modern-treasury) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/modern-treasury)
+[![NPM version](<https://img.shields.io/npm/v/modern-treasury.svg?label=npm%20(stable)>)](https://npmjs.org/package/modern-treasury) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/modern-treasury)
 
 This library provides convenient access to the Modern Treasury REST API from server-side TypeScript or JavaScript.
 
@@ -21,7 +21,7 @@ The full API of this library can be found in [api.md](api.md).
 import ModernTreasury from 'modern-treasury';
 
 const client = new ModernTreasury({
-  organizationId: process.env['MODERN_TREASURY_ORGANIZATION_ID'], // This is the default and can be omitted
+  organizationID: process.env['MODERN_TREASURY_ORGANIZATION_ID'], // This is the default and can be omitted
   apiKey: process.env['MODERN_TREASURY_API_KEY'], // This is the default and can be omitted
 });
 
@@ -39,7 +39,7 @@ This library includes TypeScript definitions for all request params and response
 import ModernTreasury from 'modern-treasury';
 
 const client = new ModernTreasury({
-  organizationId: process.env['MODERN_TREASURY_ORGANIZATION_ID'], // This is the default and can be omitted
+  organizationID: process.env['MODERN_TREASURY_ORGANIZATION_ID'], // This is the default and can be omitted
   apiKey: process.env['MODERN_TREASURY_API_KEY'], // This is the default and can be omitted
 });
 
@@ -60,7 +60,6 @@ Request parameters that correspond to file uploads can be passed in many differe
 
 ```ts
 import fs from 'fs';
-import fetch from 'node-fetch';
 import ModernTreasury, { toFile } from 'modern-treasury';
 
 const client = new ModernTreasury();
@@ -211,8 +210,10 @@ while (page.hasNextPage()) {
 ### Accessing raw Response data (e.g., headers)
 
 The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
+This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
 
 You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
+Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
 
 <!-- prettier-ignore -->
 ```ts
@@ -229,6 +230,59 @@ console.log(raw.headers.get('X-My-Header'));
 console.log(counterparty.id);
 ```
 
+### Logging
+
+> [!IMPORTANT]
+> All log messages are intended for debugging only. The format and content of log messages
+> may change between releases.
+
+#### Log levels
+
+The log level can be configured in two ways:
+
+1. Via the `MODERN_TREASURY_LOG` environment variable
+2. Using the `logLevel` client option (overrides the environment variable if set)
+
+```ts
+import ModernTreasury from 'modern-treasury';
+
+const client = new ModernTreasury({
+  logLevel: 'debug', // Show all log messages
+});
+```
+
+Available log levels, from most to least verbose:
+
+- `'debug'` - Show debug messages, info, warnings, and errors
+- `'info'` - Show info messages, warnings, and errors
+- `'warn'` - Show warnings and errors (default)
+- `'error'` - Show only errors
+- `'off'` - Disable all logging
+
+At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
+Some authentication-related headers are redacted, but sensitive data in request and response bodies
+may still be visible.
+
+#### Custom logger
+
+By default, this library logs to `globalThis.console`. You can also provide a custom logger.
+Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
+
+When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
+below the configured level will not be sent to your logger.
+
+```ts
+import ModernTreasury from 'modern-treasury';
+import pino from 'pino';
+
+const logger = pino();
+
+const client = new ModernTreasury({
+  logger: logger.child({ name: 'ModernTreasury' }),
+  logLevel: 'debug', // Send all messages to pino, allowing it to filter
+});
+```
+
 ### Making custom/undocumented requests
 
 This library is typed for convenient access to the documented API. If you need to access undocumented
@@ -253,9 +307,8 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.foo.create({
-  foo: 'my_param',
-  bar: 12,
+client.counterparties.create({
+  // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',
 });
@@ -275,69 +328,85 @@ validate or strip extra properties from the response from the API.
 
 ### Customizing the fetch client
 
-By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
+By default, this library expects a global `fetch` function is defined.
 
-If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
-(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
-add the following import before your first import `from "ModernTreasury"`:
+If you want to use a different `fetch` function, you can either polyfill the global:
 
 ```ts
-// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
-// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
-import 'modern-treasury/shims/web';
-import ModernTreasury from 'modern-treasury';
+import fetch from 'my-fetch';
+
+globalThis.fetch = fetch;
 ```
 
-To do the inverse, add `import "modern-treasury/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/Modern-Treasury/modern-treasury-node/tree/main/src/_shims#readme)).
+Or pass it to the client:
+
+```ts
+import ModernTreasury from 'modern-treasury';
+import fetch from 'my-fetch';
+
+const client = new ModernTreasury({ fetch });
+```
 
-### Logging and middleware
+### Fetch options
 
-You may also provide a custom `fetch` function when instantiating the client,
-which can be used to inspect or alter the `Request` or `Response` before/after each request:
+If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import { fetch } from 'undici'; // as one example
 import ModernTreasury from 'modern-treasury';
 
 const client = new ModernTreasury({
-  fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
-    console.log('About to make a request', url, init);
-    const response = await fetch(url, init);
-    console.log('Got response', response);
-    return response;
+  fetchOptions: {
+    // `RequestInit` options
   },
 });
 ```
 
-Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
-This is intended for debugging purposes only and may change in the future without notice.
+#### Configuring proxies
 
-### Configuring an HTTP(S) Agent (e.g., for proxies)
+To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
+options to requests:
 
-By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
-If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:
+```ts
+import ModernTreasury from 'modern-treasury';
+import * as undici from 'undici';
+
+const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
+const client = new ModernTreasury({
+  fetchOptions: {
+    dispatcher: proxyAgent,
+  },
+});
+```
+
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
-<!-- prettier-ignore -->
 ```ts
-import http from 'http';
-import { HttpsProxyAgent } from 'https-proxy-agent';
+import ModernTreasury from 'modern-treasury';
 
-// Configure the default for all requests:
 const client = new ModernTreasury({
-  httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
+  fetchOptions: {
+    proxy: 'http://localhost:8888',
+  },
 });
+```
 
-// Override per-request:
-await client.counterparties.create(
-  { name: 'my first counterparty' },
-  {
-    httpAgent: new http.Agent({ keepAlive: false }),
+<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
+
+```ts
+import ModernTreasury from 'npm:modern-treasury';
+
+const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
+const client = new ModernTreasury({
+  fetchOptions: {
+    client: httpClient,
   },
-);
+});
 ```
 
+## Frequently Asked Questions
+
 ## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
@@ -352,12 +421,12 @@ We are keen for your feedback; please open an [issue](https://www.github.com/Mod
 
 ## Requirements
 
-TypeScript >= 4.5 is supported.
+TypeScript >= 4.9 is supported.
 
 The following runtimes are supported:
 
 - Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
-- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
 - Deno v1.28.0 or higher.
 - Bun 1.0 or later.
 - Cloudflare Workers.

package/api-promise.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.mjs";
+//# sourceMappingURL=api-promise.d.mts.map

package/api-promise.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.d.mts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/api-promise.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.js";
+//# sourceMappingURL=api-promise.d.ts.map

package/api-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.d.ts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/api-promise.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/api-promise instead */
+tslib_1.__exportStar(require("./core/api-promise.js"), exports);
+//# sourceMappingURL=api-promise.js.map

package/api-promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.js","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,gEAAmC"}

package/api-promise.mjs

@@ -0,0 +1,2 @@
+export * from "./core/api-promise.mjs";
+//# sourceMappingURL=api-promise.mjs.map

package/api-promise.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}

package/bin/cli

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+const { spawnSync } = require('child_process');
+
+const commands = {
+  migrate: {
+    description: 'Run migrations to update your code using modern-treasury@2 to be compatible with modern-treasury@3',
+    fn: () => {
+      const result = spawnSync(
+        'npx',
+        ['-y', 'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz', '--migrationConfig', require.resolve('./migration-config.json'), ...process.argv.slice(3)],
+        { stdio: 'inherit' },
+      );
+      if (result.status !== 0) {
+        process.exit(result.status);
+      }
+    }
+  }
+}
+
+function exitWithHelp() {
+  console.log(`Usage: modern-treasury <subcommand>`);
+  console.log();
+  console.log('Subcommands:');
+
+  for (const [name, info] of Object.entries(commands)) {
+    console.log(`  ${name}  ${info.description}`);
+  }
+
+  console.log();
+  process.exit(1);
+}
+
+if (process.argv.length < 3) {
+  exitWithHelp();
+}
+
+const commandName = process.argv[2];
+
+const command = commands[commandName];
+if (!command) {
+  console.log(`Unknown subcommand ${commandName}.`);
+  exitWithHelp();
+}
+
+command.fn();