box-node-sdk 3.8.2 → 4.0.0

package/README.md

@@ -2,329 +2,263 @@
   <img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
 </p>
 
-# Deprecation notice
-
-This version of the Box Node SDK is under maintenance mode, and will be deprecated soon, only critical security updates and bug fixes will be provided. We recommend using the new version Box Typescript SDK, which can be found at [box/box-typescript-sdk-gen](https://github.com/box/box-typescript-sdk-gen)
-
-You can find the migration guide [here](https://github.com/box/box-typescript-sdk-gen/blob/main/migration-guide.md) for transitioning from Box Node SDK to the new `box-typescript-sdk-gen` package. If you have any questions, please create an issue in the new repository or reach out to [Box Developer Support](https://developer.box.com/support/).
-
-# Box Node.js SDK
+# Box Node SDK v4
 
+[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
 [![Known Vulnerabilities](https://snyk.io/test/github/box/box-node-sdk/badge.svg)](https://snyk.io/test/github/box/box-node-sdk)
-![Platform](https://img.shields.io/badge/node-14--20-blue)
-[![Project Status](http://opensource.box.com/badges/stable.svg)](http://opensource.box.com/badges)
+![Platform](https://img.shields.io/badge/node-18--24-blue)
 [![Coverage](https://coveralls.io/repos/github/box/box-node-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-node-sdk?branch=main)
 
-A Node.js interface to the [Box Content API](https://developer.box.com/reference/).
-
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Deprecation notice](#deprecation-notice)
-- [Box Node.js SDK](#box-nodejs-sdk)
-  - [Installation](#installation)
-  - [Getting Started](#getting-started)
-  - [Creating API Clients](#creating-api-clients)
-    - [Basic Client](#basic-client)
-    - [Persistent Client](#persistent-client)
-    - [App Auth Client](#app-auth-client)
-  - [Using the Client to Make API Calls](#using-the-client-to-make-api-calls)
-    - [Constructing API Calls Manually](#constructing-api-calls-manually)
-  - [FIPS 140-2 Compliance](#fips-140-2-compliance)
-  - [Versions](#versions)
-    - [Supported Version](#supported-version)
-    - [Version schedule](#version-schedule)
-  - [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
-  - [Contributing to the Box Node.js SDK](#contributing-to-the-box-nodejs-sdk)
-  - [Changelog](#changelog)
-  - [Upgrades](#upgrades)
-  - [Documentation](#documentation)
-  - [Copyright and License](#copyright-and-license)
+- [Introduction](#introduction)
+- [Supported versions](#supported-versions)
+  - [Version v4](#version-v4)
+  - [Version v10](#version-v10)
+  - [Which Version Should I Use?](#which-version-should-i-use)
+  - [Deprecation of the manually written SDK](#deprecation-of-the-manually-written-sdk)
+- [Installing](#installing)
+- [Getting Started](#getting-started)
+  - [With sdk_gen module (recommended)](#with-sdk_gen-module-recommended)
+  - [With manual SDK (deprecated)](#with-manual-sdk-deprecated)
+- [Authentication](#authentication)
+- [Using both sdk_gen and manual legacy SDK simultaneously](#using-both-sdk_gen-and-manual-legacy-sdk-simultaneously)
+- [Documentation](#documentation)
+- [Migration guides](#migration-guides)
+- [Versioning](#versioning)
+  - [Version schedule](#version-schedule)
+- [Contributing](#contributing)
+- [FIPS 140-2 Compliance](#fips-140-2-compliance)
+- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
+- [Copyright and License](#copyright-and-license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-## Installation
+# Introduction
 
-Node SDK Installation [details](https://developer.box.com/guides/tooling/sdks/node/).
+We are excited to introduce the v4 major release of the Box Node SDK,
+designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
 
-```
-npm install --save box-node-sdk
-```
+With this SDK version, alongside the existing `box-node-sdk` codebase, we’re introducing a new `sdk-gen` module which gives you access to:
 
-## Getting Started
+1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.
+2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
+3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.
+4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.
+5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.
 
-To get started with the SDK, get a Developer Token from the Configuration page
-of your platform app in the [Box Developer Console][dev-console].
-You can use this token to make test calls for your own Box account.
+Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.
 
-```js
-var BoxSDK = require('box-node-sdk');
+# Supported versions
 
-// Initialize the SDK with your app credentials
-var sdk = new BoxSDK({
-  clientID: 'CLIENT_ID',
-  clientSecret: 'CLIENT_SECRET',
-});
+To enhance developer experience, we have introduced the new generated codebase through the `sdk-gen` module.
+The `sdk-gen` module is available in two major supported versions: v4 and v10.
 
-// Create a basic API client, which does not automatically refresh the access token
-var client = sdk.getBasicClient('DEVELOPER_TOKEN');
+## Version v4
 
-// Get your own user object from the Box API
-// All client methods return a promise that resolves to the results of the API call,
-// or rejects when an error occurs
-client.users
-  .get(client.CURRENT_USER_ID)
-  .then((user) => console.log('Hello', user.name, '!'))
-  .catch((err) => console.log('Got an error!', err));
-```
+In v4 of the Box Node SDK, we are introducing a version that consolidates both the manually written package (legacy SDK) and the generated SDK (currently in v10, formerly known as [box-typescript-sdk-gen](https://github.com/box/box-typescript-sdk-gen)) into a single SDK package for improved usability and maintenance. This allows developers to use both modules within a single project.
 
-[dev-console]: https://app.box.com/developers/console
+The codebase for v4 of the Box Node SDK is currently available in the [combined-sdk](https://github.com/box/box-node-sdk/tree/combined-sdk) branch.
+Migration guide for migrating from manually written SDK to generated SDK can be found [here](./migration-guides/from-box-node-sdk-to-sdk-gen.md).
 
-## Creating API Clients
+Version v4 is intended for:
 
-Clients are used to communicate with the API on behalf of a user.
+- Existing developers of the Box Node SDK v3 who want to access new API features while keeping their current codebase largely unchanged.
+- Existing developers who are in the process of migrating to `sdk-gen` module, but do not want to move all their code to the new module immediately.
 
-Box supports three different types of client:
+## Version v10
 
-- **Basic Client:** Simple, makes calls via the given access token until the access token expires
-- **Persistent Client:** For use with traditional OAuth2 apps, can refresh its tokens automatically and persist them via a token store
-- **App Auth Client:** Uses the app auth JWT grant to act on behalf of app/managed users and create new tokens automatically
+Starting from v10, the SDK is built entirely on the generated `sdk-gen` module, which fully and exclusively replaces the old `boxsdk` module.
+The codebase for v10 of the Box Node SDK is currently available in the [sdk-gen](https://github.com/box/box-node-sdk/tree/sdk-gen) branch.
 
-### Basic Client
+Version v10 is intended for:
 
-Returns a Box Client with a Basic API Session. The client is able to make requests on behalf of a user. A basic session has no access to a user's refresh token. Because of this, once the session's tokens expire the client cannot recover and a new session will need to be generated.
+- New users of the Box Node SDK.
+- Developers already working with the generated Box TypeScript SDK previously available under the [Box TypeScript SDK Gen repository](https://github.com/box/box-typescript-sdk-gen).
 
-```js
-var client = BoxSDK.getBasicClient('ACCESS_TOKEN');
-```
+## Which Version Should I Use?
 
-### Persistent Client
+| Scenario                                                                                                                                                              | Recommended Version                                                    | Example Dependency            |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------- |
+| Creating a new application                                                                                                                                            | Use [v10](https://github.com/box/box-node-sdk/tree/sdk-gen)            | `npm install box-node-sdk@10` |
+| Existing app using [box-typescript-sdk-gen](https://www.npmjs.com/package/box-typescript-sdk-gen) artifact                                                            | Migrate to [v10](https://github.com/box/box-node-sdk/tree/sdk-gen)     | `npm install box-node-sdk@10` |
+| Existing app using both [box-typescript-sdk-gen](https://www.npmjs.com/package/box-typescript-sdk-gen) and [box-node-sdk](https://www.npmjs.com/package/box-node-sdk) | Upgrade to [v4](https://github.com/box/box-node-sdk/tree/combined-sdk) | `npm install box-node-sdk@^4` |
+| Existing app using v3 of [box-node-sdk](https://www.npmjs.com/package/box-node-sdk) artifact                                                                          | Upgrade to [v4](https://github.com/box/box-node-sdk/tree/combined-sdk) | `npm install box-node-sdk@^4` |
 
-Returns a Box Client with a persistent API session. A persistent API session helps manage the user's tokens, and can refresh them automatically if the access token expires. If a central data-store is given, the session can read & write tokens to it.
+For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).
 
-> NOTE: If tokenInfo or tokenStore are formatted incorrectly, this method will throw an error. If you haven't explicitly created either of these objects or are otherwise not completely confident in their validity, you should wrap your call to getPersistentClient in a try-catch to handle any potential errors.
+## Deprecation of the manually written SDK
 
-If you do not provide a token store object, the SDK will continue refreshing tokens locally as long
-as the Node.js process lives, but will not able to restore the user's authentication on process
-restart or share that authentication state between different processes.
+The manual module of `box-node-sdk` will be marked as deprecated, will receive only bug fixes and security patches,
+and reach end of support in 2027.
 
-```js
-var client = sdk.getPersistentClient(tokenInfo, null);
-```
+All new features and functionality will be provided exclusively in the `sdk-gen` module.
 
-Providing a token store will allow the SDK to persist the user's authentication state
-so that you can resume making API calls as a user if the Node.js process needs to restart,
-or share the authentication state between multiple different processes.
+# Installing
 
-```js
-var client = sdk.getPersistentClient(tokenInfo, tokenStore);
+To install Box Node SDK v4 version that consolidates both the manual written package (legacy SDK) and the generated SDK (sdk-gen), run the command:
+
+```bash
+npm install --save box-node-sdk@^4
 ```
 
-The token store is the interface used by persistent clients to interact with the consumer app's central storage layer. For a token store to be valid, it must have the following three methods:
+Supported Node versions are 18 and above.
+
+**Important:** In version v4, the manually written SDK is available in the `box-node-sdk` module, and the generated SDK is available in the `box-node-sdk/sdk-gen` module.
+
+# Getting Started
+
+To get started with the SDK, get a Developer Token from the Configuration page of your app in the [Box Developer Console](https://app.box.com/developers/console).
+Developer Tokens are short-lived and expire after 60 minutes, which is good for testing but not for production use.
+To learn about other authentication methods, see the [Authentication](#authentication) section below.
+
+The examples below demonstrate how to authenticate with Developer Token and print names of all items inside a root folder.
+
+## With sdk_gen module (recommended)
+
+The SDK provides an `BoxDeveloperTokenAuth` class, which allows you to authenticate using your Developer Token.
+Use instance of `BoxDeveloperTokenAuth` to initialize BoxClient object. Using `BoxClient` object you can access managers,
+which allow you to perform some operations on your Box account.
 
 ```js
-store.read(function (err, data) {}); // read TokenInfo from app central store.
-store.write(tokenInfo, function (err, data) {}); // write TokenInfo to the app's central store.
-store.clear(function (err, data) {}); // delete TokenInfo from the app's central store.
-```
+import { BoxClient, BoxDeveloperTokenAuth } from 'box-node-sdk/sdk-gen';
+
+async function main(token) {
+  let auth = new BoxDeveloperTokenAuth({ token });
+  let client = new BoxClient({ auth });
+  let entries = (await client.folders.getFolderItems('0')).entries;
+  entries.forEach((entry) => console.log(entry.name));
+}
 
-Note that these methods don't pass in identifying information as arguments. You'll most likely need to create them on-demand for each client.
+main('INSERT YOUR DEVELOPER TOKEN HERE');
+```
 
-### App Auth Client
+## With manual SDK (deprecated)
 
-App Auth allows an platform app to fully manage the Box accounts of its users; they do not
-have direct login credentials to Box and all operations are performed through the API
-using a JWT grant.
+From version v4, we are adding support for ESM modules, and keeping support for CommonJS modules.
+For each class in the package are exported as a default export, and you can import them using the following syntax:
 
-If you have a JSON configuration file from the [Box Developer Console][dev-console]
-that includes your private key information, you can import that directly to create an SDK instance:
+Using `import` syntax:
 
 ```js
-var sdkConfig = require('/path/to/config.json');
-var sdk = BoxSDK.getPreconfiguredInstance(sdkConfig);
+import BoxSDK from 'box-node-sdk';
+```
 
-// Get the service account client, used to create and manage app user accounts
-// The enterprise ID is pre-populated by the JSON configuration,
-// so you don't need to specify it here
-var serviceAccountClient = sdk.getAppAuthClient('enterprise');
+Using `require` syntax:
 
-// Get an app user or managed user client
-var appUserClient = sdk.getAppAuthClient('user', 'YOUR-APP-USER-ID');
+```js
+const BoxSDK = require('box-node-sdk').default;
 ```
 
-Otherwise, you can manually pass the necessary configuration parameters to the SDK:
+Then, you can use the SDK to make API calls. For example:
 
 ```js
+// Initialize the SDK with your app credentials
 var sdk = new BoxSDK({
   clientID: 'CLIENT_ID',
   clientSecret: 'CLIENT_SECRET',
-  appAuth: {
-    keyID: 'PUBLIC_KEY_ID',
-    privateKey: 'PRIVATE_KEY',
-    passphrase: 'PRIVATE_KEY_PASSPHRASE',
-  },
 });
 
-// Get the service account client, used to create and manage app user accounts
-var serviceAccountClient = sdk.getAppAuthClient(
-  'enterprise',
-  'APP_ENTERPRISE_ID'
-);
+// Create a basic API client, which does not automatically refresh the access token
+var client = sdk.getBasicClient('DEVELOPER_TOKEN');
 
-// Get an app user or managed user client
-var appUserClient = sdk.getAppAuthClient('user', 'YOUR-APP-USER-ID');
+// Get your own user object from the Box API
+// All client methods return a promise that resolves to the results of the API call,
+// or rejects when an error occurs
+client.users
+  .get(client.CURRENT_USER_ID)
+  .then((user) => console.log('Hello', user.name, '!'))
+  .catch((err) => console.log('Got an error!', err));
 ```
 
-## Using the Client to Make API Calls
+# Authentication
 
-The different API endpoints you can call are represented as methods, grouped into
-managers by the type of object they interact with.
+Both the manual and `sdk-gen` modules support multiple authentication methods, including
+Developer Token, OAuth 2.0, Client Credentials Grant, and JSON Web Token (JWT).
 
-For example:
+You can find detailed instructions and example code for each authentication method in the following documentation:
 
-```js
-// Get the user object for the current user
-client.users
-  .get(client.CURRENT_USER_ID)
-  .then((currentUser) => {
-    /* ... */
-  })
-  .catch((error) => {
-    /* handle any errors */
-  });
-
-// Update the name for folder with ID 123
-client.folders
-  .update('123', { name: 'New Folder Name' })
-  .then((folderInfo) => {
-    /* ... */
-  })
-  .catch((error) => {
-    /* handle any errors */
-  });
-
-// Upload a new file to folder 123
-client.files
-  .uploadFile('123', 'bicycle.png', fileContents)
-  .then((fileObject) => {
-    /* ... */
-  })
-  .catch((error) => {
-    /* handle any errors */
-  });
-
-// Delete the comment with ID 456
-client.comments
-  .delete('456')
-  .then(() => {
-    /* ... */
-  })
-  .catch((error) => {
-    /* handle any errors */
-  });
-```
+- [Authentication for the `sdk-gen` module](./docs/sdk-gen/authentication.md)
+- [Authentication for the manual SDK](./docs/authentication.md)
+
+# Using both sdk_gen and manual legacy SDK simultaneously
 
-For complete documentation about the available operations, please see
-the [SDK documentation pages](./docs) and the auto-generated
-[JSDocs](https://rawgit.com/box/box-node-sdk/main/docs/jsdoc/index.html).
-These contain detailed information about which methods are available and
-how to use them.
+With v4 of the Box Python SDK, you can use both the `sdk-gen` and manual modules in the same project.
 
-### Constructing API Calls Manually
+```js
+import BoxSDK from 'box-node-sdk';
+import { BoxClient, BoxDeveloperTokenAuth } from 'box-node-sdk/sdk-gen';
 
-The SDK also exposes low-level request methods for constructing your own API calls.
-These can be useful for adding your own API calls that aren't yet explicitly supported by the SDK.
+// Using the generated SDK (recommended)
+const newAuth = new BoxDeveloperTokenAuth({ token: 'DEVELOPER_TOKEN' });
+const newClient = new BoxClient({ auth: newAuth });
+const newFolderItems = await newClient.folders.getFolderItems('0');
 
-The low-level methods always return a response object that contains the raw API response, and do not
-turn non-2xx status codes into errors like the normal client methods do.
+// Using the manual legacy SDK (deprecated)
+const legacySdk = new BoxSDK({ clientID: 'id', clientSecret: 'secret' });
+const manualClient = legacySdk.getBasicClient('DEVELOPER_TOKEN');
+const manualFolderItems = await manualClient.folders.getItems('0');
 
-```js
-// GET /files/123?fields=id,name
-client.get('/files/123', {qs: {fields: 'id,name'}})
-	.then(response => { /* ... */ })
-	.catch(error => { /* handle any errors */ });
-
-// PUT /files/123
-// {
-//     "name": "New File Name"
-// }
-client.put('/files/123', {body: {name: 'New File Name'}});
-	.then(response => { /* ... */ })
-	.catch(error => { /* handle any errors */ });
-
-// DELETE /files/123
-client.del('/files/123');
-	.then(response => { /* ... */ })
-	.catch(error => { /* handle any errors */ });
+// Both clients can be used in the same application
 ```
 
-## FIPS 140-2 Compliance
+# Documentation
 
-The Box Node SDK allows the use of FIPS 140-2 validated SSL libraries, such as OpenSSL 3.0.
-However, some actions are required to enable this functionality.
+Full documentation of the available functionality, along with example code can be found:
 
-By default, the version of OpenSSL Node.js includes is not FIPS enabled. Therefore, if you want to use OpenSSL 3.0 with FIPS, you need to [build OpenSSL 3.0 with FIPS enabled](https://github.com/openssl/openssl/blob/master/README-FIPS.md) and then build Node.js use the shared OpenSSL 3.0 library.
+- for the `sdk-gen` module in the [sdk-gen](./docs/sdk-gen/) directory.
+- for the manual SDK in the [manual](./docs/) directory.
 
-According to [Node.js OpenSSL Strategy](https://github.com/nodejs/TSC/blob/main/OpenSSL-Strategy.md) document, you can use the OpenSSL 3.0 from Node.js v16 or later.
+# Migration guides
 
-## Versions
+Migration guides which help you to migrate to supported major SDK versions can be found [here](./migration-guides/).
 
-We use a modified version of [Semantic Versioning](https://semver.org/) for all changes. See [version strategy](VERSIONS.md) for details which is effective from 30 July 2022.
+# Versioning
 
-### Supported Version
+We use a modified version of [Semantic Versioning](https://semver.org/) for all changes. See [version strategy](VERSIONS.md) for details which is effective from 30 July 2022.
 
-Only the current MAJOR version of SDK is supported. New features, functionality, bug fixes, and security updates will only be added to the current MAJOR version.
+Currently, we support versions v10 and v4 of the SDK. New features and functionality are added to v10, while the manually written portion of v4 receives bug fixes and security updates only.
 
 A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features.  
 Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often).
-At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to
-allow customers to plan for the upgrade. We always recommend that all users run the latest available minor release for whatever major version is in use.
-We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.
+At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade.
 
-### Version schedule
-
-| Version | Supported Environments  | State      | First Release | EOL/Terminated |
-| ------- | ----------------------- | ---------- | ------------- | -------------- |
-| 3       | Node.js >= 14 and <= 20 | Supported  | 23 May 2023   | TBD            |
-| 2       | Node.js >= 8 and <= 14  | Maintained | 29 Sep 2021   | 23 Jul 2023    |
-| 1       |                         | EOL        | 28 Mar 2019   | 29 Sep 2021    |
-
-## Questions, Bugs, and Feature Requests?
-
-[Browse the issues tickets](https://github.com/box/box-node-sdk/issues)! Or, if that doesn't work, [file a new one](https://github.com/box/box-node-sdk/issues/new) and someone will get back to you. If you have general questions about the
-Box API, you can post to the [Box Developer Forum](https://community.box.com/t5/Developer-Forum/bd-p/DeveloperForum).
-
-## Contributing to the Box Node.js SDK
+We always recommend that all users run the latest available minor release for whatever major version is in use.
+We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.
 
-1. Clone this repo.
-1. Run `npm install`.
-1. Run `npm test` to ensure everything is working.
-1. Make the changes you want in the `lib/` directory. Be sure to add corresponding tests
-   in the `tests/` directory!
-1. Run the unit tests by command `npm run test` and integration test as instructed [here](./tests/integration_test/README.md).
-1. Create a pull request with your changes — we'll review it and help you get it merged.
+## Version schedule
 
-Currently, the **Sign Request** module is generated automatically from OpenAPI specs. To re-generate this module, download the latest version of Box OpenAPI specs [here](https://raw.githubusercontent.com/box/box-openapi/en/openapi.json), save it to the root directory and run `npm run codegen`.
+| Version | Supported Environments  | State      | First Release | EOL/Terminated         |
+| ------- | ----------------------- | ---------- | ------------- | ---------------------- |
+| 10      | Node.js >= 18           | Supported  | 17 Sep 2025   | TBD                    |
+| 4       | Node.js >= 18           | Supported  | 23 Oct 2025   | 2027 or v5 is released |
+| 3       | Node.js >= 14 and <= 20 | Supported  | 23 May 2023   | 23 Oct 2025            |
+| 2       | Node.js >= 8 and <= 14  | Maintained | 29 Sep 2021   | 23 Jul 2023            |
+| 1       |                         | EOL        | 28 Mar 2019   | 29 Sep 2021            |
 
-For more information, please see [the Contribution guidelines](./CONTRIBUTING.md).
+# Contributing
 
-## Changelog
+For information on how to contribute to this project, please see [the Contribution guidelines](./CONTRIBUTING.md).
 
-See [CHANGELOG.md](./CHANGELOG.md).
+# FIPS 140-2 Compliance
 
-## Upgrades
+The Box Node SDK allows the use of FIPS 140-2 validated SSL libraries, such as OpenSSL 3.0.
+However, some actions are required to enable this functionality.
 
-You can read about how to migrate to the new version [here](./docs/upgrade/).
+By default, the version of OpenSSL Node.js includes is not FIPS enabled. Therefore, if you want to use OpenSSL 3.0 with FIPS, you need to [build OpenSSL 3.0 with FIPS enabled](https://github.com/openssl/openssl/blob/master/README-FIPS.md) and then build Node.js use the shared OpenSSL 3.0 library.
 
-## Documentation
+According to [Node.js OpenSSL Strategy](https://github.com/nodejs/TSC/blob/main/OpenSSL-Strategy.md) document, you can use the OpenSSL 3.0 from Node.js v16 or later.
 
-You can find guides and tutorials in the `docs` directory.
+# Questions, Bugs, and Feature Requests?
 
-- [Configuration](docs/configuration.md)
+Need to contact us directly? [Browse the issues tickets](https://github.com/box/box-node-sdk/issues)! Or, if that
+doesn't work, [file a new one](https://github.com/box/box-node-sdk/issues/new) and we will get
+back to you. If you have general questions about the Box API, you can post to the [Box Developer Forum](https://community.box.com/box-platform-5).
 
-## Copyright and License
+# Copyright and License
 
-Copyright 2018 Box, Inc. All rights reserved.
+Copyright 2025 Box, Inc. All rights reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/lib/api-request-manager.d.ts

@@ -33,4 +33,5 @@ declare class APIRequestManager {
  * @module box-node-sdk/lib/api-request-manager
  * @see {@Link APIRequestManager}
  */
-export = APIRequestManager;
+export default APIRequestManager;
+//# sourceMappingURL=api-request-manager.d.ts.map

package/lib/api-request-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-request-manager.d.ts","sourceRoot":"","sources":["../src/api-request-manager.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAUtC,KAAK,MAAM,GAAG,GAAG,CAAa;AAU9B;;;;;;GAMG;AACH,cAAM,iBAAiB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,YAAY,CAAC;gBAEX,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY;IAKlD;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,GAAG;IAaxB;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,GAAG;CA0BlC;AAED;;;GAGG;AACH,eAAe,iBAAiB,CAAC"}

package/lib/api-request-manager.js

@@ -5,13 +5,14 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+Object.defineProperty(exports, "__esModule", { value: true });
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-var bluebird_1 = require("bluebird");
-var errors_1 = __importDefault(require("./util/errors"));
-var stream_1 = require("stream");
-var APIRequest = require('./api-request');
+const bluebird_1 = require("bluebird");
+const errors_1 = __importDefault(require("./util/errors"));
+const stream_1 = require("stream");
+const api_request_1 = __importDefault(require("./api-request"));
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
@@ -25,8 +26,8 @@ var APIRequest = require('./api-request');
  * @param {EventEmitter} eventBus The event bus for SDK events
  * @constructor
  */
-var APIRequestManager = /** @class */ (function () {
-    function APIRequestManager(config, eventBus) {
+class APIRequestManager {
+    constructor(config, eventBus) {
         this.config = config;
         this.eventBus = eventBus;
     }
@@ -36,30 +37,28 @@ var APIRequestManager = /** @class */ (function () {
      * @param {Object} options The request options
      * @returns {Promise<Response>} A promise resolving to the response object
      */
-    APIRequestManager.prototype.makeRequest = function (options /* FIXME */) {
+    makeRequest(options /* FIXME */) {
         // Add default APIRequestManager options to each request
         var requestConfig = this.config.extend({
             request: options,
         });
         // Make the request
-        var apiRequest = new APIRequest(requestConfig, this.eventBus);
-        return bluebird_1.Promise.fromCallback(function (callback) {
-            return apiRequest.execute(callback);
-        }).catch(function (err) { return errors_1.default.unwrapAndThrow(err); });
-    };
+        var apiRequest = new api_request_1.default(requestConfig, this.eventBus);
+        return bluebird_1.Promise.fromCallback((callback) => apiRequest.execute(callback)).catch((err) => errors_1.default.unwrapAndThrow(err));
+    }
     /**
      * Make a request to the API, and return a read stream for the response.
      *
      * @param {Object} options The request options
      * @returns {Stream.Readable} The response stream
      */
-    APIRequestManager.prototype.makeStreamingRequest = function (options /* FIXME */) {
+    makeStreamingRequest(options /* FIXME */) {
         // Add default APIRequestManager options to each request
         var requestConfig = this.config.extend({
             request: options,
         });
         // Make the request
-        var apiRequest = new APIRequest(requestConfig, this.eventBus);
+        var apiRequest = new api_request_1.default(requestConfig, this.eventBus);
         apiRequest.execute();
         var stream = apiRequest.getResponseStream();
         // The request is asynchronous, so we need to wait for the stream to be
@@ -74,8 +73,11 @@ var APIRequestManager = /** @class */ (function () {
             return passThrough;
         }
         return stream;
-    };
-    return APIRequestManager;
-}());
-module.exports = APIRequestManager;
+    }
+}
+/**
+ * @module box-node-sdk/lib/api-request-manager
+ * @see {@Link APIRequestManager}
+ */
+exports.default = APIRequestManager;
 //# sourceMappingURL=api-request-manager.js.map

package/lib/api-request-manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-request-manager.js","sourceRoot":"","sources":["../src/api-request-manager.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,qCAAmC;AAEnC,yDAAmC;AACnC,iCAAqC;AAErC,IAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAQ5C,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH;IAIE,2BAAY,MAAc,EAAE,QAAsB;QAChD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,uCAAW,GAAX,UAAY,OAAY,CAAC,WAAW;QAClC,wDAAwD;QACxD,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YACrC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QAEH,mBAAmB;QACnB,IAAI,UAAU,GAAG,IAAI,UAAU,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9D,OAAO,kBAAO,CAAC,YAAY,CAAC,UAAC,QAAQ;YACnC,OAAA,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;QAA5B,CAA4B,CAC7B,CAAC,KAAK,CAAC,UAAC,GAAG,IAAK,OAAA,gBAAM,CAAC,cAAc,CAAC,GAAG,CAAC,EAA1B,CAA0B,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,gDAAoB,GAApB,UAAqB,OAAY,CAAC,WAAW;QAC3C,wDAAwD;QACxD,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YACrC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QAEH,mBAAmB;QACnB,IAAI,UAAU,GAAG,IAAI,UAAU,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9D,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAAE,CAAC;QAE5C,uEAAuE;QACvE,8DAA8D;QAC9D,oEAAoE;QACpE,uBAAuB;QACvB,IACE,MAAM;YACN,aAAa,CAAC,wBAAwB,KAAK,IAAI;YAC/C,OAAO,CAAC,wBAAwB,KAAK,IAAI,EACzC,CAAC;YACD,IAAI,WAAW,GAAG,IAAI,oBAAW,EAAE,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzB,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACH,wBAAC;AAAD,CAAC,AA5DD,IA4DC;AAMD,iBAAS,iBAAiB,CAAC"}
+{"version":3,"file":"api-request-manager.js","sourceRoot":"","sources":["../src/api-request-manager.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,uCAAmC;AAEnC,2DAAmC;AACnC,mCAAqC;AAErC,gEAAuC;AAQvC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,iBAAiB;IAIrB,YAAY,MAAc,EAAE,QAAsB;QAChD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,OAAY,CAAC,WAAW;QAClC,wDAAwD;QACxD,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YACrC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QAEH,mBAAmB;QACnB,IAAI,UAAU,GAAG,IAAI,qBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9D,OAAO,kBAAO,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,EAAE,CACvC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC7B,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,gBAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,OAAY,CAAC,WAAW;QAC3C,wDAAwD;QACxD,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YACrC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QAEH,mBAAmB;QACnB,IAAI,UAAU,GAAG,IAAI,qBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9D,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAAE,CAAC;QAE5C,uEAAuE;QACvE,8DAA8D;QAC9D,oEAAoE;QACpE,uBAAuB;QACvB,IACE,MAAM;YACN,aAAa,CAAC,wBAAwB,KAAK,IAAI;YAC/C,OAAO,CAAC,wBAAwB,KAAK,IAAI,EACzC,CAAC;YACD,IAAI,WAAW,GAAG,IAAI,oBAAW,EAAE,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzB,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;GAGG;AACH,kBAAe,iBAAiB,CAAC"}

package/lib/api-request.d.ts

@@ -132,4 +132,5 @@ declare class APIRequest {
  * @module box-node-sdk/lib/api-request
  * @see {@Link APIRequest}
  */
-export = APIRequest;
+export default APIRequest;
+//# sourceMappingURL=api-request.d.ts.map

package/lib/api-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-request.d.ts","sourceRoot":"","sources":["../src/api-request.ts"],"names":[],"mappings":"AAAA;;GAEG;AAWH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,MAAM,MAAM,eAAe,CAAC;AAWnC;;;;;;;;;;;;GAYG;AACH,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,uBAAuB,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACjC,CAAC;AAIF;;;;;;;;;GASG;AAEH,KAAK,uBAAuB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC,CAAC;AAEF;;;;;;;;;GASG;AAEH,KAAK,eAAe,GAAG;IACrB,OAAO,EAAE,uBAAuB,CAAC;IACjC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;GASG;AACH,KAAK,kBAAkB,GAAG,CACxB,GAAG,CAAC,EAAE,eAAe,GAAG,IAAI,EAC5B,QAAQ,CAAC,EAAE,wBAAwB,KAChC,IAAI,CAAC;AA8GV;;;;;;;;GAQG;AACH,cAAM,UAAU;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,YAAY,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IAErB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;gBAER,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY;IAclD;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,CAAC,EAAE,kBAAkB;IA6BrC;;;;;OAKG;IACH,iBAAiB;IAIjB;;;;;;;;OAQG;IACH,eAAe,CAAC,GAAG,CAAC,EAAE,GAAG,EAAc,QAAQ,CAAC,EAAE,GAAG;IA6CrD;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG;IAmDhB;;;;;;;OAOG;IACH,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,wBAAwB;CAWvD;AAED;;;GAGG;AACH,eAAe,UAAU,CAAC"}