Skip to content

CHANGELOG.md

Latest commit

 

History

History
815 lines (456 loc) · 50.3 KB

CHANGELOG.md

File metadata and controls

815 lines (456 loc) · 50.3 KB

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

10.10.0 (2026-05-15)

Bug Fixes

New Features and Enhancements

10.9.0 (2026-05-06)

⚠ BREAKING CHANGES

  • Mark id field of AIAgentReference required (box/box-openapi#1629) (box/box-openapi#595) (#1440) (3082fc3)

Bug Fixes

10.8.0 (2026-04-30)

New Features and Enhancements

10.7.0 (2026-04-22)

Bug Fixes

  • Update retentionLength field to accept both string and number (box/box-codegen#932) (#1397) (e589c63)

New Features and Enhancements

  • Add max_extension_length field to Retention Policies (box/box-openapi#593) (#1413) (28d1a71)

10.6.0 (2026-04-01)

⚠ BREAKING CHANGES

  • Align LegalHoldPolicyAssignedItem with API (box/box-openapi#1554) (box/box-openapi#590) (#1378)

Bug Fixes

  • Align LegalHoldPolicyAssignedItem with API (box/box-openapi#1554) (box/box-openapi#590) (#1378) (466d6cf)
  • Correct search content type 'tags' to match API (box/box-openapi#591) (#1382) (6f5d307)

New Features and Enhancements

10.5.0 (2026-03-18)

Bug Fixes

  • Convert retryAfter seconds to milliseconds for setTimeout (box/box-codegen#926) (#1356) (fca811e)

New Features and Enhancements

10.4.0 (2026-02-11)

Bug Fixes

  • Correct enum value for legal hold policy changes (box/box-openapi#581) (#1319) (c14bb0d)
  • Fix config to make esm build esm compatible (box/box-codegen#915) (#1315) (ecb8967)

New Features and Enhancements

  • add confidence scores for structured extract (box/box-openapi#582) (#1321) (e7738ba)
  • add signer language, cancel sign request reason (box/box-openapi#584) (#1343) (f4def35)
  • Add watermarking permissions and sources information (box/box-openapi#579) (#1312) (92a3ed4)

10.3.0 (2025-12-19)

Bug Fixes

  • add taxonomy to Metadata Field (read) definition (box/box-openapi#572) (#1275) (0935d71)
  • fix RetryAfter function when there's no Retry-After header (box/box-codegen#903) (#1251) (a334d81)

New Features and Enhancements

10.2.0 (2025-12-10)

Bug Fixes

New Features and Enhancements

  • Remove confidence_score and include_confidence_score from AI extract (box/box-openapi#567) (#1243) (55d6cd0)
  • support includeConfidenceScore and includeConfidenceScore fields in AI extract structured (box/box-openapi#566) (#1228) (4bf9f46)
  • Support new sign request metadata (box/box-openapi#565) (#1226) (8dfc1cc)
  • update error message on exception (box/box-codegen#896) (#1233) (b298afa)

10.1.0 (2025-11-10)

Bug Fixes

New Features and Enhancements

10.0.1 (2025-10-06)

Bug Fixes

  • Allow flexible key-value data in AiExtractResponse.answer and Event.additionalDetails (box/box-openapi#556) (#1051) (70a2275)
  • Make role parameter of update collaboration optional (box/box-openapi#557) (#1068) (3992171)
  • Relax JSON deserialization guard by removing strict content-type check (box/box-codegen#844) (#1033) (1eb2c32)

10.0.0 (2025-09-17)

Introducing Box Node SDK v10, a major release designed to elevate your developer experience and streamline integration with Box Content Cloud. Currently available as a separate sdk-gen branch, v10 will ultimately become the main branch.

Breaking Changes

  • This SDK version is auto-generated and introduces a new interface for all methods. Extensive documentation is available here.

What's New in v10

  • Full API Support — Complete coverage of the Box API ecosystem, giving you access to all the latest features and functionalities to build feature-rich applications.

  • Rapid API Updates — Our new auto-generation approach enables Box API additions within days, ensuring you can leverage the most up-to-date features without delay.

  • Embedded Documentation — All objects and parameters are documented directly in the SDK source code, keeping essential information in one place.

  • Enhanced Convenience Methods — New methods for authentication, chunk uploads, automatic retries, retry strategy, and more.

Important Notes

This version includes the Box Next Generation SDK artifact, previously developed in parallel to core Box SDKs. To facilitate migration and provide access to the newest features, we'll soon release an additional major version combining both artifacts. Migration to v10 includes breaking changes, please review the migration guide for details. For more information, see the SDK versioning strategy document. Follow developer changelog for future updates.

What’s New Compared to Typescript SDK Gen v1.19.1

⚠ BREAKING CHANGES

Bug Fixes

New Features and Enhancements

For more details check migration guide from box-typescript-sdk-gen v1 to box-node-sdk v10.

3.8.1 (2025-06-11)

Bug Fixes

  • Use constant-time comparison for HMAC signatures (#893) (d819efe)

3.8.0 (2025-04-09)

New Features and Enhancements

3.7.1 (2024-08-06)

Bug Fixes

  • add version to copy file options annotation (#885) (4f9312c)

3.7.0 (2024-07-16)

New Features and Enhancements

3.6.0 (2024-05-20)

New Features and Enhancements

3.5.1 (2024-05-02)

Bug Fixes

  • Fix options parameter in metadata query method (#878) (7943420)

3.5.0 (2024-02-19)

New Features and Enhancements

Bug Fixes

3.4.2 (2023-11-08)

Bug Fixes

3.4.1 (2023-11-03)

Bug Fixes

  • Update proxy-agent usage, drop support Node 12 (#865) (e229d3f)

3.4.0 (2023-11-03)

New Features and Enhancements

  • Add request option to skip PassThrough (#863) (726db45)

3.3.0 (2023-10-26)

New Features and Enhancements

  • Replace request library with @cypress/request (#860) (d365ae8)

Bug Fixes

  • mark auth funs callbacks as optional (#858) (55f22fe)

3.2.1 (2023-10-06)

Bug Fixes

3.2.0 (2023-09-07)

New Features and Enhancements

3.1.1 (2023-07-19)

3.1.0 (2023-06-01)

New Features and Enhancements

  • Added support for integration mappings API (#831) (a525327)

Bug Fixes

  • Correct types of userId and groupId for creating collaboration (#833) (f803ff8), closes #832

3.0.0 (2023-05-23)

The most important change in this release is dropping support for Node versions below 12 and changing the support environments from Node 12 to Node 16.

Breaking Changes

  • Removed use_index usage. (#812) (d56799a)
  • Removed deprecated BoxClient.batch() and BoxClient.batchExec() method.
  • Removed deprecated CollaborationWhitelist class, use CollaborationAllowlist instead.
  • Removed deprecated CollaborationAllowlist.getWhitelistedDomain() method, use CollaborationAllowlist.getAllowlistedDomain() instead.
  • Removed deprecated CollaborationAllowlist.getAllWhitelistedDomains() method, use CollaborationAllowlist.getAllAllowlistedDomains() instead.
  • Remove deprecated Files.getThumbnail(fileID: string, options?: Record<string, any>, callback?: Function) method, use Files.getRepresentationContent( fileID, representationType, options, callback) instead.

Migration details can be found here

Dependency Upgrades

2.10.0 (2023-05-11)

New Features and Enhancements

  • Added support for ethical wall API (#822) (4814af3)
  • Added name and signature_color fields to SignRequest and SignRequestCreateRequest types and login_required field to SignRequestCreateSigner type (#822) (4814af3)

2.9.0 (2023-04-19)

New Features and Enhancements

  • New fields in retention-policy and retention-policy-assignment (#803) (f14ba84)

Bug Fixes

  • return empty object when tos status is not present (#797) (12fd9b0)

2.8.1 (2023-01-05)

Bug Fixes

2.8.0 (2022-12-21)

New Features and Enhancements

2.7.2 (2022-11-10)

Bug Fixes

  • Add fields query parameter to file and folder update (#776) (a327deb)

2.7.1 (2022-10-28)

Bug Fixes

2.7.0 (2022-10-27)

New Features and Enhancements

  • Add support for modifiable retention policies & enable deleting retention policy assignment (#769) (5e8c776)

2.6.0 (2022-09-23)

New Features and Enhancements

  • Add content_type, redirect_url field to Sign Request (#758) (8abb9b6)
  • Add sign request webhook (#760) (e92d1ab)
  • Added support for Access Only Collaboration (#759) (dd8261f)

2.5.0 (2022-08-09)

New Features and Enhancements

  • Added support update and remove user avatar (#744) (aaf6175)

Bug Fixes

2.4.0 (2022-07-13)

New Features and Enhancements

  • Added support for file requests (#742) (30b2e76)
  • Added support of admin_logs_streaming stream type (#740) (406950a)

Bug Fixes

  • properly handle client errors in streams (#736) (12378d6)

2.3.0 (2022-04-28)

New Features and Enhancements

  • Add description parameter to uploadFile methods (#730) (2596584)

Bug Fixes

  • added missing js-docs on shared links (#731) (3554d41)

2.2.0 (2022-04-20)

New Features and Enhancements

2.1.0 (2022-03-28)

New Features and Enhancements

  • Client Credentials Grant authentication method (#709) (fbf4e80)
  • Deprecating index_name when executing metadata query (#686) (e01cc65)
  • test: add support for testing with Jest (#676) (1a11759)

Bug Fixes

  • Client Credentials Grant authentication method supports token down-scoping (#710) (730368f)
  • Fix JWT expiration field being float instead of integer (#715) (7e950f1), closes #713

2.0.0 (2021-09-29)

⚠ BREAKING CHANGES

  • Drop support for Node 6,7 (#670)

New Features and Enhancements:

  • Add support for is_external_collab_restricted User property (#668)
  • Bump proxy-agent from 4.0.0 to 5.0.0 (#664)

1.39.0 (2021-08-30)

New Features and Enhancements:

  • Add support for Box Sign API (#658)
  • Enhance TS Imports (#656)

1.38.0 (2021-08-05)

New Features and Enhancements:

  • Add sensitive-language event types for admin invites (#648)
  • Use BetterDocs to adapt JSDocs to TypeScript (#646)
  • Change ProxyAgent import to be dynamic (#641)
  • New API for get files and file versions under retention (#585)

Bug Fixes:

  • Deeply freeze Config except Buffers and Readable streams (#651)
  • Fix a typo in docs of src/managers/search.ts (#649)
  • Update broken documentation link (#647)
  • fix type annotations for exchangeToken functions (#645)
  • Deprecate files getThumbnail API in favor of getRepresentationContent (#627)

1.37.2 (2021-05-20)

Bug Fixes:

  • Fix backwards compatibility issue by moving some TypeScript @types as direct dependencies (#630)

1.37.1 (2021-05-19)

Bug Fixes:

  • Insensitive language: replace whitelist with allowlist (#625)

1.37.0 (2021-04-16)

New Features and Enhancements:

  • Add support for copyInstanceOnItemCopy field for metadata templates (#572)

Bug Fixes:

  • Fix webhook signature validation (#568)
  • Update dependencies to patch security vulnerabilities (#578)

1.36.0 (2021-01-27)

New Features and Enhancements:

  • Add folder lock functionality (#560)
  • Add support for filtering groups by name (#561)

Bug Fixes:

  • Update proxy-agent to patch proxy support issue (#563)
  • Update dependencies to patch security vulnerabilities (#566)

1.35.0 (2020-11-02)

New Features and Enhancements:

  • Add support for search param to get shared link items (#547)

1.34.3 (2020-10-02)

Bug Fixes:

  • Upgrade ajv dependency (#545)

1.34.2 (2020-08-20)

  • Make iterator bug fix for uploading files non breaking (#534)

1.34.1 (2020-08-17)

  • Fix iterator bug for uploading new file versions (#531)

1.34.0 (2020-08-04)

  • Add zip functionality (#525)
  • Add proxy support for http, https, socks and pac protocols (#529)

1.33.0 (2020-06-25)

  • Add path parameter sanitization (#505)
  • Add support for all streams for uploading files (#519)

1.32.0 (2020-04-01)

  • Temporarily removed Node 4 and Node 5 builds from Travis, due to tests not passing. Will investigate, going forward (#495).
  • Fixed an issue where an error is thrown during a retry when a response is not returned by the previous call (#477).
  • Added the ability to query Box items based on their metadata (#487).

1.31.0 (2020-02-13)

  • Fixed Authentication Request Retries
  • Added marker-based paging for users endpoints
  • Added getNextMarker() to PagingIterator to get the next marker

1.30.0 (2019-11-21)

  • Deprecated Batch API methods
  • Added support for token exchange using shared links

1.29.1 (2019-08-22)

  • Fixed an issue where JWT authentication requests could fail after being rate limited

1.29.0 (2019-04-25)

1.28.0 (2019-03-28)

1.27.0 (2019-02-28)

  • Added the trace ID from API response headers to error messages for easier debugging
  • Added more safety checks in the error flow to protect against throwing when handling a malformed request
  • Added support for retrieving a user's avatar image

1.26.2 (2019-02-22)

  • Fixed an error where under high request rates, code in the error handling logic could throw when handling a malformed request

1.26.1 (2019-02-12)

  • Fixed an error where some methods could throw an error when constructing an iterator

1.26.0 (2019-02-12)

  • Added support for replying to a comment (thanks @jpan-box!)
  • Fixed an issue where calling client.events.get() could return an iterator that would only iterate over the first chunk of events. This method will now always return the raw JSON data in order to enable manual paging. For automatic paging through events, client.events.getEventStream() or client.events.getEnterpriseEventStream() should be used instead.

1.25.0 (2019-01-24)

  • Added the retryStrategy config parameter to allow customizing how the SDK retries failing requests

1.24.1 (2019-01-11)

  • Fixed an issue where token expiration was not being correctly handled

1.24.0 (2018-12-10)

  • Added a configuration option for populating the first-party client analytics header information

1.23.0 (2018-11-21)

1.22.1 (2018-11-15)

  • Fixed an issue where retrying JWT auth token requests would sometimes fail due to a non-unique jti claim

1.22.0 (2018-09-17)

1.21.0 (2018-09-13)

  • Added the ability to close an Event Stream by calling eventStream.destroy() (thanks @boneskull!)
  • Improved error messages related to certain authentication failure cases

1.20.0 (2018-08-09)

  • Added missing values to the client.webhooks.triggerTypes enum (thanks @MathersMax!)
  • Added support for Metadata Cascade Policies

1.19.0 (2018-06-14)

1.18.0 (2018-05-24)

  • Updated dependencies to resolve potential security issues:
    • request@2.87.0
    • Transitive dependencies of jsonwebtoken@8.2.1
  • Added a static BoxSDK.getBasicClient() method to enable creating a client without needing to specify a client ID and secret (thanks to @cbetta)

1.17.0 (2018-05-10)

  • Updated dependencies: request@2.85.0, jsonwebtoken@8.2.1
  • Added support for Storage Policies
  • Added the option to use a Token Store for caching tokens with App Auth using JWT

1.16.1 (2018-04-26)

  • Fixed a bug where metadata template deletion would not properly return results via callback

1.16.0 (2018-04-10)

1.15.0 (2018-03-29)

  • Fixed [client.webhooks.validateMessage() and sdk.validateWebhookMessage()](https://github.com/box/box-node-sdk/blob/main/docs/webhooks.md#validate-a-webhook-message) to accept the request body as an Object`
  • Fixed sdk.configure() to correct reconfigure all options
  • Improved error messages for API errors and added the request object as error.request for easier debugging

1.14.1 (2018-03-13)

  • Fixed a bug when files.getReadStream() was called with null options

1.14.0 (2018-03-12)

1.13.0 (2018-03-01)

1.12.1 (2018-01-25)

  • Fixed an issue where chunked uploader would not work with response streams from the request library (0e7014561f9cd0f7f38f98536b3f0c3946231d2e)

1.12.0 (2018-01-11)

1.11.0 (2017-12-12)

  • Added options to preserve file timestamps on file upload and to rename a file or preserve modification timestamp on new version upload
  • Added Collaboration Whitelist functionality to allow enterprise admins to control which external users can collaborate on their content
  • Added an option to Token Exchange to generate annotator tokens for use with Box View

1.10.1 (2017-11-28)

  • Updated to jsonwebtoken@8.1.0 to fix an issue where some users were getting an error when using App Auth

1.10.0 (2017-01-14)

  • Added support for Terms of Service endpoints
  • Fixed a bug where receiving a collection without paging parameters from the API would cause the SDK to throw an exception when using the iterators SDK option. Now, this will return an iterator over the items returned by the API.
  • Fixed a bug in Token Exchange where passing multiple scopes would result in an error
  • Added support for getting Representations info on a file

1.9.0 (2017-09-12)

  • Fixed token methods to return bluebird Promises instead of native Promises
  • Added support for the notify and can_view_path options on Collaborations

1.8.0 (2017-08-21)

  • Added support for Batch API
  • Fixed a bug where the Event Stream would make more API calls than necessary, potentially hitting Box API rate limits
  • Added Promise support to methods on the SDK object
  • Added Node.js version to the User-Agent header that the SDK sends
  • Fixed a bug where using multiple Persistent Clients instances could cause some clients to end up with expired tokens

1.7.0 (2017-07-19)

  • Add support for passing IP to all token methods, and fixed a bug where a client's IP was not being correctly reported on token refreshes

1.6.0 (2017-06-23)

  • Added Recent Items support
  • Updated app auth expiration time default value and validation

1.5.1 (2017-06-15)

  • Revert deep-freezing Config properties, since it was causing errors

1.5.0 (2017-06-15)

  • Added support for Token Exchange, which allows a client to get downscoped tokens suitable for passing to a browser app or worker process.
  • Ensured deeply-nested Config properties are immutable

1.4.2 (2017-05-22)

  • Fixed BoxSDK.getPreconfiguredInstance() to configure webhook keys

1.4.1 (2017-05-22)

  • Fixed BoxSDK.getPreconfiguredInstance() when app auth setttings are not populated

1.4.0 (2017-05-19)

  • Added support for file collaborations. Users can now invite others to collaborate on single files. See the blog post for more information.
  • Fixed an issue where users were unable to use JWT Server Auth when their computers' clocks were not synchronized with the Box API servers.
  • All asynchronous client methods now return Promises in addition to taking a (now-optional) callback parameter, so you can write more modern JS with the SDK.
  • The SDK can now be preconfigured using a JSON blob that can be downloaded in the Box Dev Console for JWT Server Authentication apps, making it easier to get started developing!
  • Added support for chunked upload, where a large file can be uploaded one piece at a time. This makes large file uploads much faster and more reliable, since parts can be uploaded in parallel and failed parts can be retried in isolation.
  • Added an is_confirmed option to email alias creation for admins to auto-confirm the alias.
  • Added support for the Enterprise Events stream.
  • Added an option to have collections methods (e.g. folders.getItems(), enterprise.getUsers(), etc) return async iterators that will automatically page through the collection. This conforms to the proposed async iteration spec, which will eventually allow them to be used in ergonomic for-await-of loop syntax.

1.3.0 (2017-01-24)

  • Added BoxSDK.validateWebhookMessage() and client.webhooks.validateMessage() for validating webhook messages from Box

1.2.0 (2016-12-12)

  • Added methods for all API endpoints; we now have full API coverage 🎉
  • Added support for renaming a file or folder on copy
  • Added client.asUser(userID) and client.asSelf() to support making calls on behalf of managed users
  • Fixed event streams so they don't go into an infinite error loop when auth expires
  • Fixed an error where App Auth clients would not be able to authorize due to clock skew
  • Fixed the mdfilters parameter in client.search.query() to support metadata search
  • Cloned options objects to prevent modification of passed-in objects by the SDK
  • Added better error messaging to the sample app

1.1.0 (2016-09-27)

  • Added endpoint to get a file's tasks
  • Fixed issues with stream uploads
  • Improved performance of file uploads
  • Added endpoints to delete files and folders from trash
  • Added endpoint to get a trashed folder
  • Upgraded request dependency to fix ReDoS vulnerability

[1.0.0] (2016-07-13)

Initial release.