Merge pull request #66 from stainless-api/release-please--branches--main--changes--next--components--stainless

release: 0.1.0-alpha.18

Author: meorphis

.devcontainer/Dockerfile

@@ -1,20 +1,17 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/debian
 {
-  "name": "Debian",
-  "build": {
-    "dockerfile": "Dockerfile"
+  "name": "Development",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:latest",
+  "features": {
+    "ghcr.io/devcontainers/features/node:1": {}
+  },
+  "postCreateCommand": "yarn install",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "esbenp.prettier-vscode"
+      ]
+    }
   }
-
-  // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
-
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
-
-  // Configure tool-specific properties.
-  // "customizations": {},
-
-  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-  // "remoteUser": "root"
 }

.devcontainer/devcontainer.json

@@ -63,4 +63,3 @@ jobs:
 
       - name: Run tests
         run: ./scripts/test
-

.eslintrc.js

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.17"
+  ".": "0.1.0-alpha.18"
 }

.github/workflows/ci.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 3
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-671323594ae99d55635e335b7c0d12d5b63fab118eb6db964566f8430ca14d5f.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-efd1aba15824e770232eda85427ae9f27371fdf1e1b3dd734dcf70bef34815a8.yml

.release-please-manifest.json

@@ -1,5 +1,62 @@
 # Changelog
 
+## 0.1.0-alpha.18 (2025-03-20)
+
+Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/stainless-api/builds-node-api/compare/v0.1.0-alpha.17...v0.1.0-alpha.18)
+
+### ⚠ BREAKING CHANGES
+
+* **client:** uri encode path parameters ([#72](https://github.com/stainless-api/builds-node-api/issues/72))
+
+### Features
+
+* add SKIP_BREW env var to ./scripts/bootstrap ([#92](https://github.com/stainless-api/builds-node-api/issues/92)) ([04fcfb8](https://github.com/stainless-api/builds-node-api/commit/04fcfb8ee32f275672a17d60f211d60bd7bb7f7b))
+* **api:** api update ([#100](https://github.com/stainless-api/builds-node-api/issues/100)) ([ea56fde](https://github.com/stainless-api/builds-node-api/commit/ea56fde9c673487f85fbaa0ccf34d872ec602510))
+* **client:** accept RFC6838 JSON content types ([#93](https://github.com/stainless-api/builds-node-api/issues/93)) ([2d9c17d](https://github.com/stainless-api/builds-node-api/commit/2d9c17de975b52c83ae25b58d89bfcb2a580975a))
+* **client:** improve logging ([#79](https://github.com/stainless-api/builds-node-api/issues/79)) ([344d664](https://github.com/stainless-api/builds-node-api/commit/344d6640e00952b1eefd06c092731923c4c02d1e))
+* **client:** send `X-Stainless-Timeout` header ([#71](https://github.com/stainless-api/builds-node-api/issues/71)) ([861184e](https://github.com/stainless-api/builds-node-api/commit/861184e16b2db20c4650890859f3ff5f104200c6))
+
+
+### Bug Fixes
+
+* **client:** fix export map for index exports, accept BunFile ([#76](https://github.com/stainless-api/builds-node-api/issues/76)) ([3c86845](https://github.com/stainless-api/builds-node-api/commit/3c868457d188504afef265ed7b20b0712c3095a1))
+* **client:** fix TypeError with undefined File ([#87](https://github.com/stainless-api/builds-node-api/issues/87)) ([f712ff1](https://github.com/stainless-api/builds-node-api/commit/f712ff1637cb377319f26fad2245a1fd421770ba))
+* **client:** uri encode path parameters ([#72](https://github.com/stainless-api/builds-node-api/issues/72)) ([161de71](https://github.com/stainless-api/builds-node-api/commit/161de7140299d39c751cb1d18628becefc8f98bd))
+* **exports:** ensure resource imports don't require /index ([#95](https://github.com/stainless-api/builds-node-api/issues/95)) ([9a94183](https://github.com/stainless-api/builds-node-api/commit/9a941838ab32777f8c8fb7d26d055d9b95a8b9e1))
+* **internal:** add mts file + crypto shim types ([#96](https://github.com/stainless-api/builds-node-api/issues/96)) ([01eb453](https://github.com/stainless-api/builds-node-api/commit/01eb453cd93e79d458bac967524693e8453e53f9))
+* **internal:** clean up undefined File test ([#88](https://github.com/stainless-api/builds-node-api/issues/88)) ([e01791a](https://github.com/stainless-api/builds-node-api/commit/e01791afd6fee8c70f0b05b25aa01e5ca9c54aa9))
+* **internal:** return in castToError instead of throwing ([#81](https://github.com/stainless-api/builds-node-api/issues/81)) ([9e2c68d](https://github.com/stainless-api/builds-node-api/commit/9e2c68df46639d5b9d2028f9c30c65a914969428))
+* **tests:** manually reset node:buffer File ([#89](https://github.com/stainless-api/builds-node-api/issues/89)) ([3da1ac2](https://github.com/stainless-api/builds-node-api/commit/3da1ac2f68f34468897ad53ab439b7946a22171c))
+
+
+### Chores
+
+* **client:** detect node and deno timeout errors ([#69](https://github.com/stainless-api/builds-node-api/issues/69)) ([b61f88b](https://github.com/stainless-api/builds-node-api/commit/b61f88bef6824e6aaa95dd2e4308debc3506e11d))
+* **client:** handle expo fetch abort errors ([#68](https://github.com/stainless-api/builds-node-api/issues/68)) ([ab3a65b](https://github.com/stainless-api/builds-node-api/commit/ab3a65b9ef6bc12abc13f9dd38b18bf21ddcdd56))
+* **client:** only accept standard types for file uploads ([#84](https://github.com/stainless-api/builds-node-api/issues/84)) ([5311571](https://github.com/stainless-api/builds-node-api/commit/53115711e99f859e6c3bc143d253e564b9547465))
+* **docs:** improve docs for withResponse/asResponse ([#91](https://github.com/stainless-api/builds-node-api/issues/91)) ([0e6d878](https://github.com/stainless-api/builds-node-api/commit/0e6d8785dc1003aba4e264f66f3b132bda7398b3))
+* **exports:** cleaner resource index imports ([#98](https://github.com/stainless-api/builds-node-api/issues/98)) ([633472c](https://github.com/stainless-api/builds-node-api/commit/633472ca26c6f92569c1d14d8974172ab1cf675c))
+* **exports:** stop using path fallbacks ([#99](https://github.com/stainless-api/builds-node-api/issues/99)) ([ea9298e](https://github.com/stainless-api/builds-node-api/commit/ea9298ec40d13ca66107444241780f91e9de5615))
+* **internal:** add explicit export `type` modifier ([#67](https://github.com/stainless-api/builds-node-api/issues/67)) ([15888af](https://github.com/stainless-api/builds-node-api/commit/15888afda1e5b9c04fe33d72efe158d4fe8fb048))
+* **internal:** codegen related update ([#74](https://github.com/stainless-api/builds-node-api/issues/74)) ([aa8d0fe](https://github.com/stainless-api/builds-node-api/commit/aa8d0feee87946224bb27514698b61f049646b9f))
+* **internal:** codegen related update ([#78](https://github.com/stainless-api/builds-node-api/issues/78)) ([843d32f](https://github.com/stainless-api/builds-node-api/commit/843d32f1bc9be52a51ec9e4c515ba140426ca2a2))
+* **internal:** constrain synckit dev dependency ([#86](https://github.com/stainless-api/builds-node-api/issues/86)) ([88ce03d](https://github.com/stainless-api/builds-node-api/commit/88ce03da09cd881e317264fc854417be067c03e3))
+* **internal:** fix devcontainers setup ([#80](https://github.com/stainless-api/builds-node-api/issues/80)) ([5b73626](https://github.com/stainless-api/builds-node-api/commit/5b736268ae733698616daa2e2808a9d360936acb))
+* **internal:** fix tests failing on node v18 ([#85](https://github.com/stainless-api/builds-node-api/issues/85)) ([4aa4e67](https://github.com/stainless-api/builds-node-api/commit/4aa4e67a3c9ef52bff63a5250e1ac1f996ef8a70))
+* **internal:** fix tests not always being type checked ([#77](https://github.com/stainless-api/builds-node-api/issues/77)) ([bdf4826](https://github.com/stainless-api/builds-node-api/commit/bdf4826ef152bbfe42f5bea82981d2ab8896ee52))
+* **internal:** minor client file refactoring ([#97](https://github.com/stainless-api/builds-node-api/issues/97)) ([b16b851](https://github.com/stainless-api/builds-node-api/commit/b16b851f0155a39ce2fa192ee666b7bed7a60f55))
+* **internal:** remove extra empty newlines ([#94](https://github.com/stainless-api/builds-node-api/issues/94)) ([9b8c286](https://github.com/stainless-api/builds-node-api/commit/9b8c28645b4c18ccc8e7b6daf4a5c5eb7623c551))
+* **internal:** remove unnecessary todo ([#82](https://github.com/stainless-api/builds-node-api/issues/82)) ([096c6fe](https://github.com/stainless-api/builds-node-api/commit/096c6fe767f28f483a4e30a855ef274304c9baef))
+* **internal:** remove unused `isRequestOptions()` function ([#70](https://github.com/stainless-api/builds-node-api/issues/70)) ([ea62ef5](https://github.com/stainless-api/builds-node-api/commit/ea62ef59ca827dfafd44be6a83e1a07c9be0435c))
+* **internal:** update eslint config ([#75](https://github.com/stainless-api/builds-node-api/issues/75)) ([957a48e](https://github.com/stainless-api/builds-node-api/commit/957a48e0d89feeacd107bf4a90b26c863232ea42))
+* **types:** improved go to definition on fetchOptions ([#90](https://github.com/stainless-api/builds-node-api/issues/90)) ([4652f7b](https://github.com/stainless-api/builds-node-api/commit/4652f7b19b58496b644363b02058c2d97d8b735b))
+* **types:** remove type-level dependency on some platform specifics ([#65](https://github.com/stainless-api/builds-node-api/issues/65)) ([7da0b05](https://github.com/stainless-api/builds-node-api/commit/7da0b055d754a96c886dd5362cfacfb74848282c))
+
+
+### Documentation
+
+* update URLs from stainlessapi.com to stainless.com ([#83](https://github.com/stainless-api/builds-node-api/issues/83)) ([f1b7512](https://github.com/stainless-api/builds-node-api/commit/f1b7512436a90a9151f28f34bf264dddff481dd4))
+
 ## 0.1.0-alpha.17 (2025-01-23)
 
 Full Changelog: [v0.1.0-alpha.16...v0.1.0-alpha.17](https://github.com/stainless-api/builds-node-api/compare/v0.1.0-alpha.16...v0.1.0-alpha.17)

.stats.yml

@@ -6,7 +6,7 @@ This library provides convenient access to the Stainless REST API from server-si
 
 The REST API documentation can be found on [app.stainlessapi.com](https://app.stainlessapi.com/docs). The full API of this library can be found in [api.md](api.md).
 
-It is generated with [Stainless](https://www.stainlessapi.com/).
+It is generated with [Stainless](https://www.stainless.com/).
 
 ## Installation
 
@@ -15,7 +15,7 @@ npm install git+ssh://[email protected]:stainless-api/builds-node-api.git
 ```
 
 > [!NOTE]
-> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install stainless`
+> Once this package is [published to npm](https://app.stainless.com/docs/guides/publish), this will become: `npm install stainless`
 
 ## Usage
 
@@ -63,6 +63,41 @@ main();
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed in many different forms:
+
+- `File` (or an object with the same structure)
+- a `fetch` `Response` (or an object with the same structure)
+- an `fs.ReadStream`
+- the return value of our `toFile` helper
+
+```ts
+import fs from 'fs';
+import Stainless, { toFile } from 'stainless';
+
+const client = new Stainless();
+
+// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
+await client.builds.create({ oasSpec: fs.createReadStream('/path/to/file'), projectName: 'projectName' });
+
+// Or if you have the web `File` API you can pass a `File` instance:
+await client.builds.create({ oasSpec: new File(['my bytes'], 'file'), projectName: 'projectName' });
+
+// You can also pass a `fetch` `Response`:
+await client.builds.create({ oasSpec: await fetch('https://somesite/file'), projectName: 'projectName' });
+
+// Finally, if none of the above are convenient, you can use our `toFile` helper:
+await client.builds.create({
+  oasSpec: await toFile(Buffer.from('my bytes'), 'file'),
+  projectName: 'projectName',
+});
+await client.builds.create({
+  oasSpec: await toFile(new Uint8Array([0, 1, 2]), 'file'),
+  projectName: 'projectName',
+});
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API,
@@ -146,8 +181,10 @@ Note that requests which time out will be [retried twice by default](#retries).
 ### 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
@@ -164,6 +201,59 @@ console.log(raw.headers.get('X-My-Header'));
 console.log(output.commit);
 ```
 
+### 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 `STAINLESS_LOG` environment variable
+2. Using the `logLevel` client option (overrides the environment variable if set)
+
+```ts
+import Stainless from 'stainless';
+
+const client = new Stainless({
+  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 Stainless from 'stainless';
+import pino from 'pino';
+
+const logger = pino();
+
+const client = new Stainless({
+  logger: logger.child({ name: 'Stainless' }),
+  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
@@ -223,33 +313,12 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
+import Stainless from 'stainless';
 import fetch from 'my-fetch';
 
 const client = new Stainless({ fetch });
 ```
 
-### Logging and middleware
-
-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:
-
-```ts
-import { fetch } from 'undici'; // as one example
-import Stainless from 'stainless';
-
-const client = new Stainless({
-  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;
-  },
-});
-```
-
-Note that if given a `STAINLESS_LOG=debug` 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.
-
 ### Fetch options
 
 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.)

CHANGELOG.md

@@ -2,9 +2,9 @@
 
 ## Reporting Security Issues
 
-This SDK is generated by [Stainless Software Inc](http://stainlessapi.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
 
-To report a security issue, please contact the Stainless team at security@stainlessapi.com.
+To report a security issue, please contact the Stainless team at security@stainless.com.
 
 ## Responsible Disclosure
 

README.md

@@ -0,0 +1,42 @@
+// @ts-check
+import tseslint from 'typescript-eslint';
+import unusedImports from 'eslint-plugin-unused-imports';
+import prettier from 'eslint-plugin-prettier';
+
+export default tseslint.config(
+  {
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: { sourceType: 'module' },
+    },
+    files: ['**/*.ts', '**/*.mts', '**/*.cts', '**/*.js', '**/*.mjs', '**/*.cjs'],
+    ignores: ['dist/**'],
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+      'unused-imports': unusedImports,
+      prettier,
+    },
+    rules: {
+      'no-unused-vars': 'off',
+      'prettier/prettier': 'error',
+      'unused-imports/no-unused-imports': 'error',
+      'no-restricted-imports': [
+        'error',
+        {
+          patterns: [
+            {
+              regex: '^stainless(/.*)?',
+              message: 'Use a relative import, not a package import.',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  {
+    files: ['tests/**', 'examples/**'],
+    rules: {
+      'no-restricted-imports': 'off',
+    },
+  },
+);