box-node-sdk 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +221 -205
- package/README.md +42 -18
- package/lib/box-node-sdk.d.ts +23 -10
- package/lib/box-node-sdk.js +40 -11
- package/lib/box-node-sdk.js.map +1 -1
- package/lib/managers/metadata.d.ts +4 -2
- package/lib/managers/metadata.js +17 -3
- package/lib/managers/metadata.js.map +1 -1
- package/lib/schemas/index.d.ts +3 -3
- package/lib/schemas/index.js +3 -3
- package/lib/schemas/index.js.map +1 -1
- package/lib/sessions/{anonymous-session.d.ts → ccg-session.d.ts} +18 -15
- package/lib/sessions/{anonymous-session.js → ccg-session.js} +23 -23
- package/lib/sessions/ccg-session.js.map +1 -0
- package/lib/token-manager.js +11 -10
- package/lib/token-manager.js.map +1 -1
- package/package.json +9 -7
- package/lib/sessions/anonymous-session.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,372 +1,388 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## [2.1.0](https://github.com/box/box-node-sdk/compare/v2.0.0...v2.1.0) (2022-03-28)
|
|
6
6
|
|
|
7
|
-
- Drop support for Node 6,7 ([#670](https://github.com/box/box-node-sdk/pull/670))
|
|
8
7
|
|
|
9
|
-
|
|
8
|
+
### New Features and Enhancements
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
* Client Credentials Grant authentication method ([#709](https://github.com/box/box-node-sdk/issues/709)) ([fbf4e80](https://github.com/box/box-node-sdk/commit/fbf4e80648821e38479b24bf489e7d222ae6c18f))
|
|
11
|
+
* Deprecating `index_name` when executing metadata query ([#686](https://github.com/box/box-node-sdk/issues/686)) ([e01cc65](https://github.com/box/box-node-sdk/commit/e01cc650e4e793955be543e93928ad82a3254492))
|
|
12
|
+
* **test:** add support for testing with Jest ([#676](https://github.com/box/box-node-sdk/issues/676)) ([1a11759](https://github.com/box/box-node-sdk/commit/1a11759db999510c69d6a27f7becd565620bb000))
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
### Bug Fixes
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
* Client Credentials Grant authentication method supports token down-scoping ([#710](https://github.com/box/box-node-sdk/issues/710)) ([730368f](https://github.com/box/box-node-sdk/commit/730368f410ff56e9a8c90feea2192b29c08df198))
|
|
17
|
+
* Fix JWT expiration field being float instead of integer ([#715](https://github.com/box/box-node-sdk/issues/715)) ([7e950f1](https://github.com/box/box-node-sdk/commit/7e950f1265a52ce251c42a186c8196089a9ed858)), closes [#713](https://github.com/box/box-node-sdk/issues/713)
|
|
17
18
|
|
|
18
|
-
|
|
19
|
-
- Enhance TS Imports ([#656](https://github.com/box/box-node-sdk/pull/656))
|
|
19
|
+
## [2.0.0](https://github.com/box/box-node-sdk/compare/v1.39.0...v2.0.0) (2021-09-29)
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
### ⚠ BREAKING CHANGES
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
* Drop support for Node 6,7 ([#670](https://github.com/box/box-node-sdk/pull/670))
|
|
24
24
|
|
|
25
|
-
|
|
26
|
-
- Use BetterDocs to adapt JSDocs to TypeScript ([#646](https://github.com/box/box-node-sdk/pull/646))
|
|
27
|
-
- Change ProxyAgent import to be dynamic ([#641](https://github.com/box/box-node-sdk/pull/641))
|
|
28
|
-
- New API for get files and file versions under retention ([#585](https://github.com/box/box-node-sdk/pull/585))
|
|
25
|
+
### New Features and Enhancements:
|
|
29
26
|
|
|
30
|
-
|
|
27
|
+
* Add support for is_external_collab_restricted User property ([#668](https://github.com/box/box-node-sdk/pull/668))
|
|
28
|
+
* Bump proxy-agent from 4.0.0 to 5.0.0 ([#664](https://github.com/box/box-node-sdk/pull/664))
|
|
31
29
|
|
|
32
|
-
|
|
33
|
-
- Fix a typo in docs of src/managers/search.ts ([#649](https://github.com/box/box-node-sdk/pull/649))
|
|
34
|
-
- Update broken documentation link ([#647](https://github.com/box/box-node-sdk/pull/647))
|
|
35
|
-
- fix type annotations for exchangeToken functions ([#645](https://github.com/box/box-node-sdk/pull/645))
|
|
36
|
-
- Deprecate files getThumbnail API in favor of getRepresentationContent ([#627](https://github.com/box/box-node-sdk/pull/627))
|
|
30
|
+
## [1.39.0](https://github.com/box/box-node-sdk/compare/v1.38.0...v1.39.0) (2021-08-30)
|
|
37
31
|
|
|
38
|
-
|
|
32
|
+
### New Features and Enhancements:
|
|
39
33
|
|
|
40
|
-
|
|
34
|
+
* Add support for Box Sign API ([#658](https://github.com/box/box-node-sdk/pull/658))
|
|
35
|
+
* Enhance TS Imports ([#656](https://github.com/box/box-node-sdk/pull/656))
|
|
41
36
|
|
|
42
|
-
|
|
37
|
+
## [1.38.0](https://github.com/box/box-node-sdk/compare/v1.37.2...v1.38.0) (2021-08-05)
|
|
43
38
|
|
|
44
|
-
|
|
39
|
+
### New Features and Enhancements:
|
|
45
40
|
|
|
46
|
-
|
|
41
|
+
* Add sensitive-language event types for admin invites ([#648](https://github.com/box/box-node-sdk/pull/648))
|
|
42
|
+
* Use BetterDocs to adapt JSDocs to TypeScript ([#646](https://github.com/box/box-node-sdk/pull/646))
|
|
43
|
+
* Change ProxyAgent import to be dynamic ([#641](https://github.com/box/box-node-sdk/pull/641))
|
|
44
|
+
* New API for get files and file versions under retention ([#585](https://github.com/box/box-node-sdk/pull/585))
|
|
47
45
|
|
|
48
|
-
|
|
46
|
+
### Bug Fixes:
|
|
49
47
|
|
|
50
|
-
|
|
48
|
+
* Deeply freeze Config except Buffers and Readable streams ([#651](https://github.com/box/box-node-sdk/pull/651))
|
|
49
|
+
* Fix a typo in docs of src/managers/search.ts ([#649](https://github.com/box/box-node-sdk/pull/649))
|
|
50
|
+
* Update broken documentation link ([#647](https://github.com/box/box-node-sdk/pull/647))
|
|
51
|
+
* fix type annotations for exchangeToken functions ([#645](https://github.com/box/box-node-sdk/pull/645))
|
|
52
|
+
* Deprecate files getThumbnail API in favor of getRepresentationContent ([#627](https://github.com/box/box-node-sdk/pull/627))
|
|
51
53
|
|
|
52
|
-
|
|
54
|
+
## [1.37.2](https://github.com/box/box-node-sdk/compare/v1.37.1...v1.37.2) (2021-05-20)
|
|
53
55
|
|
|
54
|
-
|
|
56
|
+
### Bug Fixes:
|
|
55
57
|
|
|
56
|
-
|
|
58
|
+
* Fix backwards compatibility issue by moving some TypeScript @types as direct dependencies ([#630](https://github.com/box/box-node-sdk/pull/630))
|
|
57
59
|
|
|
58
|
-
|
|
59
|
-
- Update dependencies to patch security vulnerabilities ([#578](https://github.com/box/box-node-sdk/pull/578))
|
|
60
|
+
## [1.37.1](https://github.com/box/box-node-sdk/compare/v1.37.0..v1.37.1) (2021-05-19)
|
|
60
61
|
|
|
61
|
-
|
|
62
|
+
### Bug Fixes:
|
|
62
63
|
|
|
63
|
-
|
|
64
|
+
* Insensitive language: replace whitelist with allowlist ([#625](https://github.com/box/box-node-sdk/pull/625))
|
|
64
65
|
|
|
65
|
-
|
|
66
|
-
- Add support for filtering groups by name ([#561](https://github.com/box/box-node-sdk/pull/561))
|
|
66
|
+
## [1.37.0](https://github.com/box/box-node-sdk/compare/v1.36.0...v1.37.0) (2021-04-16)
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
### New Features and Enhancements:
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
- Update dependencies to patch security vulnerabilities ([#566](https://github.com/box/box-node-sdk/pull/566))
|
|
70
|
+
* Add support for copyInstanceOnItemCopy field for metadata templates ([#572](https://github.com/box/box-node-sdk/pull/572))
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
### Bug Fixes:
|
|
74
73
|
|
|
75
|
-
|
|
74
|
+
* Fix webhook signature validation ([#568](https://github.com/box/box-node-sdk/pull/568))
|
|
75
|
+
* Update dependencies to patch security vulnerabilities ([#578](https://github.com/box/box-node-sdk/pull/578))
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
## [1.36.0](https://github.com/box/box-node-sdk/compare/v1.35.0...v1.36.0) (2021-01-27)
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
### New Features and Enhancements:
|
|
80
80
|
|
|
81
|
-
|
|
81
|
+
* Add folder lock functionality ([#560](https://github.com/box/box-node-sdk/pull/560))
|
|
82
|
+
* Add support for filtering groups by name ([#561](https://github.com/box/box-node-sdk/pull/561))
|
|
82
83
|
|
|
83
|
-
|
|
84
|
+
### Bug Fixes:
|
|
84
85
|
|
|
85
|
-
|
|
86
|
+
* Update proxy-agent to patch proxy support issue ([#563](https://github.com/box/box-node-sdk/pull/563))
|
|
87
|
+
* Update dependencies to patch security vulnerabilities ([#566](https://github.com/box/box-node-sdk/pull/566))
|
|
86
88
|
|
|
87
|
-
|
|
89
|
+
## [1.35.0](https://github.com/box/box-node-sdk/compare/v1.34.3...v1.35.0) (2020-11-02)
|
|
88
90
|
|
|
89
|
-
|
|
91
|
+
### New Features and Enhancements:
|
|
90
92
|
|
|
91
|
-
|
|
93
|
+
* Add support for search param to get shared link items ([#547](https://github.com/box/box-node-sdk/pull/547))
|
|
92
94
|
|
|
93
|
-
## 1.34.
|
|
95
|
+
## [1.34.3](https://github.com/box/box-node-sdk/compare/v1.34.2...v1.34.3) (2020-10-02)
|
|
94
96
|
|
|
95
|
-
|
|
96
|
-
- Add proxy support for `http`, `https`, `socks` and `pac` protocols ([#529](https://github.com/box/box-node-sdk/pull/529))
|
|
97
|
+
### Bug Fixes:
|
|
97
98
|
|
|
98
|
-
|
|
99
|
+
* Upgrade ajv dependency ([#545](https://github.com/box/box-node-sdk/pull/545))
|
|
99
100
|
|
|
100
|
-
|
|
101
|
-
- Add support for all streams for uploading files ([#519](https://github.com/box/box-node-sdk/pull/519))
|
|
101
|
+
## [1.34.2](https://github.com/box/box-node-sdk/compare/v1.34.1...v1.34.2) (2020-08-20)
|
|
102
102
|
|
|
103
|
-
|
|
103
|
+
* Make iterator bug fix for uploading files non breaking ([#534](https://github.com/box/box-node-sdk/pull/534))
|
|
104
104
|
|
|
105
|
-
|
|
106
|
-
- Fixed an issue where an error is thrown during a retry when a response is not returned by the previous call ([#477](https://github.com/box/box-node-sdk/pull/477)).
|
|
107
|
-
- Added the ability to [query](./docs/metadata.md#query) Box items based on their metadata ([#487](https://github.com/box/box-node-sdk/pull/487)).
|
|
105
|
+
## [1.34.1](https://github.com/box/box-node-sdk/compare/v1.34.0...v1.34.1) (2020-08-17)
|
|
108
106
|
|
|
109
|
-
|
|
107
|
+
* Fix iterator bug for uploading new file versions ([#531](https://github.com/box/box-node-sdk/pull/531))
|
|
110
108
|
|
|
111
|
-
-
|
|
112
|
-
- Added marker-based paging for users endpoints
|
|
113
|
-
- Added `getNextMarker()` to PagingIterator to get the next marker
|
|
109
|
+
## [1.34.0](https://github.com/box/box-node-sdk/compare/v1.33.0...v1.34.0) (2020-08-04)
|
|
114
110
|
|
|
115
|
-
|
|
111
|
+
* Add zip functionality ([#525](https://github.com/box/box-node-sdk/pull/525))
|
|
112
|
+
* Add proxy support for `http`, `https`, `socks` and `pac` protocols ([#529](https://github.com/box/box-node-sdk/pull/529))
|
|
116
113
|
|
|
117
|
-
-
|
|
118
|
-
- Added support for [token exchange](./lib/box-client.js#L495) using shared links
|
|
114
|
+
## [1.33.0](https://github.com/box/box-node-sdk/compare/v1.32.0...v1.33.0) (2020-06-25)
|
|
119
115
|
|
|
120
|
-
|
|
116
|
+
* Add path parameter sanitization ([#505](https://github.com/box/box-node-sdk/pull/505))
|
|
117
|
+
* Add support for all streams for uploading files ([#519](https://github.com/box/box-node-sdk/pull/519))
|
|
121
118
|
|
|
122
|
-
-
|
|
119
|
+
## [1.32.0](https://github.com/box/box-node-sdk/compare/v1.31.0...v1.32.0) (2020-04-01)
|
|
123
120
|
|
|
124
|
-
|
|
121
|
+
* Temporarily removed Node 4 and Node 5 builds from Travis, due to tests not passing. Will investigate, going forward ([#495](https://github.com/box/box-node-sdk/pull/495)).
|
|
122
|
+
* Fixed an issue where an error is thrown during a retry when a response is not returned by the previous call ([#477](https://github.com/box/box-node-sdk/pull/477)).
|
|
123
|
+
* Added the ability to [query](./docs/metadata.md#query) Box items based on their metadata ([#487](https://github.com/box/box-node-sdk/pull/487)).
|
|
125
124
|
|
|
126
|
-
|
|
125
|
+
## [1.31.0](https://github.com/box/box-node-sdk/compare/v1.30.0...v1.31.0) (2020-02-13)
|
|
126
|
+
|
|
127
|
+
* Fixed Authentication Request Retries
|
|
128
|
+
* Added marker-based paging for users endpoints
|
|
129
|
+
* Added `getNextMarker()` to PagingIterator to get the next marker
|
|
130
|
+
|
|
131
|
+
## [1.30.0](https://github.com/box/box-node-sdk/compare/v1.29.1...v1.30.0) (2019-11-21)
|
|
132
|
+
|
|
133
|
+
* Deprecated Batch API methods
|
|
134
|
+
* Added support for [token exchange](./lib/box-client.js#L495) using shared links
|
|
135
|
+
|
|
136
|
+
## [1.29.1](https://github.com/box/box-node-sdk/compare/v1.29.0...v1.29.1) (2019-08-22)
|
|
137
|
+
|
|
138
|
+
* Fixed an issue where JWT authentication requests could fail after being rate limited
|
|
139
|
+
|
|
140
|
+
## [1.29.0](https://github.com/box/box-node-sdk/compare/v1.28.0...v1.29.0) (2019-04-25)
|
|
141
|
+
|
|
142
|
+
* Added convenience methods for setting metadata on [files](./docs/metadata.md#set-metadata-on-a-file)
|
|
127
143
|
and [folders](./docs/metadata.md#set-metadata-on-a-folder) ([#376](https://github.com/box/box-node-sdk/pull/376))
|
|
128
144
|
|
|
129
|
-
## 1.28.0
|
|
145
|
+
## [1.28.0](https://github.com/box/box-node-sdk/compare/v1.27.0...v1.28.0) (2019-03-28)
|
|
130
146
|
|
|
131
|
-
|
|
147
|
+
* Added methods for [moving](./docs/web-links.md#move-a-web-link) and [copying](./docs/web-links.md#move-a-web-link)
|
|
132
148
|
weblinks, as well as [adding or removing from a collection](./docs/web-links.md#add-web-link-to-a-collection)
|
|
133
149
|
|
|
134
|
-
## 1.27.0
|
|
150
|
+
## [1.27.0](https://github.com/box/box-node-sdk/compare/v1.26.2...v1.27.0) (2019-02-28)
|
|
135
151
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
152
|
+
* Added the trace ID from API response headers to error messages for easier debugging
|
|
153
|
+
* Added more safety checks in the error flow to protect against throwing when handling a malformed request
|
|
154
|
+
* Added support for [retrieving a user's avatar image](./docs/users.md#get-user-avatar)
|
|
139
155
|
|
|
140
|
-
## 1.26.2
|
|
156
|
+
## [1.26.2](https://github.com/box/box-node-sdk/compare/v1.26.1...v1.26.2) (2019-02-22)
|
|
141
157
|
|
|
142
|
-
|
|
158
|
+
* Fixed an error where under high request rates, code in the error handling logic could throw when handling a
|
|
143
159
|
malformed request
|
|
144
160
|
|
|
145
|
-
## 1.26.1
|
|
161
|
+
## [1.26.1](https://github.com/box/box-node-sdk/compare/v1.26.0...v1.26.1) (2019-02-12)
|
|
146
162
|
|
|
147
|
-
|
|
163
|
+
* Fixed an error where some methods could throw an error when constructing an iterator
|
|
148
164
|
|
|
149
|
-
## 1.26.0
|
|
165
|
+
## [1.26.0](https://github.com/box/box-node-sdk/compare/v1.25.0...v1.26.0) (2019-02-12)
|
|
150
166
|
|
|
151
|
-
|
|
152
|
-
|
|
167
|
+
* Added support for [replying to a comment](./docs/comments.md#reply-to-a-comment) (thanks @jpan-box!)
|
|
168
|
+
* Fixed an issue where calling `client.events.get()` could return an iterator that would only iterate over
|
|
153
169
|
the first chunk of events. This method will now always return the raw JSON data in order to enable manual
|
|
154
170
|
paging. For automatic paging through events, `client.events.getEventStream()` or
|
|
155
171
|
`client.events.getEnterpriseEventStream()` should be used instead.
|
|
156
172
|
|
|
157
|
-
## 1.25.0
|
|
173
|
+
## [1.25.0](https://github.com/box/box-node-sdk/compare/v1.24.1...v1.25.0) (2019-01-24)
|
|
158
174
|
|
|
159
|
-
|
|
175
|
+
* Added the `retryStrategy` config parameter to allow customizing how the SDK retries failing requests
|
|
160
176
|
|
|
161
|
-
## 1.24.1
|
|
177
|
+
## [1.24.1](https://github.com/box/box-node-sdk/compare/v1.24.0...v1.24.1) (2019-01-11)
|
|
162
178
|
|
|
163
|
-
|
|
179
|
+
* Fixed an issue where token expiration was not being correctly handled
|
|
164
180
|
|
|
165
|
-
## 1.24.0
|
|
181
|
+
## [1.24.0](https://github.com/box/box-node-sdk/compare/v1.23.0...v1.24.0) (2018-12-10)
|
|
166
182
|
|
|
167
|
-
|
|
183
|
+
* Added a configuration option for populating the first-party client analytics header information
|
|
168
184
|
|
|
169
|
-
## 1.23.0
|
|
185
|
+
## [1.23.0](https://github.com/box/box-node-sdk/compare/vA...v1.23.0) (2018-11-21)
|
|
170
186
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
187
|
+
* Added an `etag` option to common file and folder methods to allow handling race conditions
|
|
188
|
+
* [`client.files.update()`](./docs/files.md#update-a-files-information)
|
|
189
|
+
* [`client.files.delete()`](./docs/files.md#delete-a-file)
|
|
190
|
+
* [`client.files.deletePermanently()`](./docs/trash.md#delete-a-file-from-the-trash)
|
|
191
|
+
* [`client.files.deleteVersion()`](./docs/files.md#delete-a-previous-file-version)
|
|
192
|
+
* [`client.folders.update()`](./docs/folders.md#update-a-folders-information)
|
|
193
|
+
* [`client.folders.delete()`](./docs/folders.md#delete-a-folder)
|
|
194
|
+
* [`client.folders.deletePermanently()`](./docs/trash.md#delete-a-folder-from-the-trash)
|
|
179
195
|
|
|
180
|
-
## 1.22.1
|
|
196
|
+
## [1.22.1](https://github.com/box/box-node-sdk/compare/v1.22.0...v1.22.1) (2018-11-15)
|
|
181
197
|
|
|
182
|
-
|
|
198
|
+
* Fixed an issue where retrying JWT auth token requests would sometimes fail due to a non-unique `jti` claim
|
|
183
199
|
|
|
184
|
-
## 1.22.0
|
|
200
|
+
## [1.22.0](https://github.com/box/box-node-sdk/compare/v1.21.0...v1.22.0) (2018-09-17)
|
|
185
201
|
|
|
186
|
-
|
|
187
|
-
|
|
202
|
+
* Chunked Uploader methods now return promises for [simpler handling of chunked uploads](./docs/files.md#automatic-uploader)
|
|
203
|
+
* File attributes to set on the newly-uploaded file can now be
|
|
188
204
|
[passed via `options.fileAttributes`](./docs/files.md#automatic-uploader) when creating a Chunked Uploader
|
|
189
205
|
|
|
190
|
-
## 1.21.0
|
|
206
|
+
## [1.21.0](https://github.com/box/box-node-sdk/compare/v1.20.0...v1.21.0) (2018-09-13)
|
|
191
207
|
|
|
192
|
-
|
|
193
|
-
|
|
208
|
+
* Added the ability to close an Event Stream by calling `eventStream.destroy()` (thanks @boneskull!)
|
|
209
|
+
* Improved error messages related to certain authentication failure cases
|
|
194
210
|
|
|
195
|
-
## 1.20.0
|
|
211
|
+
## [1.20.0](https://github.com/box/box-node-sdk/compare/v1.19.0...v1.20.0) (2018-08-09)
|
|
196
212
|
|
|
197
|
-
|
|
198
|
-
|
|
213
|
+
* Added missing values to the `client.webhooks.triggerTypes` enum (thanks @MathersMax!)
|
|
214
|
+
* Added support for [Metadata Cascade Policies](./docs/metadata.md#create-cascade-policy)
|
|
199
215
|
|
|
200
|
-
## 1.19.0
|
|
216
|
+
## [1.19.0](https://github.com/box/box-node-sdk/compare/v1.18.0...v1.19.0) (2018-06-14)
|
|
201
217
|
|
|
202
|
-
|
|
218
|
+
* Added `generateRepresentations` option to [`files.getRepresentationContent()`](./docs/files.md#get-representation-content)
|
|
203
219
|
|
|
204
|
-
## 1.18.0
|
|
220
|
+
## [1.18.0](https://github.com/box/box-node-sdk/compare/v1.17.0...v1.18.0) (2018-05-24)
|
|
205
221
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
222
|
+
* Updated dependencies to resolve potential security issues:
|
|
223
|
+
* `request@2.87.0`
|
|
224
|
+
* Transitive dependencies of `jsonwebtoken@8.2.1`
|
|
225
|
+
* Added a static `BoxSDK.getBasicClient()` method to enable creating a client without needing
|
|
210
226
|
to specify a client ID and secret (thanks to @cbetta)
|
|
211
227
|
|
|
212
|
-
## 1.17.0
|
|
228
|
+
## [1.17.0](https://github.com/box/box-node-sdk/compare/v1.16.1...v1.17.0) (2018-05-10)
|
|
213
229
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
230
|
+
* Updated dependencies: `request@2.85.0`, `jsonwebtoken@8.2.1`
|
|
231
|
+
* Added support for [Storage Policies](./docs/storage-policies.md)
|
|
232
|
+
* Added the option to use a Token Store for caching tokens with App Auth using JWT
|
|
217
233
|
|
|
218
|
-
## 1.16.1
|
|
234
|
+
## [1.16.1](https://github.com/box/box-node-sdk/compare/v1.16.0...v1.16.1) (2018-04-26)
|
|
219
235
|
|
|
220
|
-
|
|
236
|
+
* Fixed a bug where metadata template deletion would not properly return results via callback
|
|
221
237
|
|
|
222
|
-
## 1.16.0
|
|
238
|
+
## [1.16.0](https://github.com/box/box-node-sdk/compare/v1.15.0...v1.16.0) (2018-04-10)
|
|
223
239
|
|
|
224
|
-
|
|
240
|
+
* Added support for [assigning Retention Policies to Metadata Templates](https://github.com/box/box-node-sdk/blob/main/docs/retention-policies.md#assign-retention-policy)
|
|
225
241
|
|
|
226
|
-
## 1.15.0
|
|
242
|
+
## [1.15.0](https://github.com/box/box-node-sdk/compare/v1.14.1...v1.15.0) (2018-03-29)
|
|
227
243
|
|
|
228
|
-
|
|
244
|
+
* Fixed [`client.webhooks.validateMessage() and `sdk.validateWebhookMessage()`](https://github.com/box/box-node-sdk/blob/main/docs/webhooks.md#validate-a-webhook-message)
|
|
229
245
|
to accept the request body as an `Object`
|
|
230
|
-
|
|
231
|
-
|
|
246
|
+
* Fixed `sdk.configure()` to correct reconfigure all options
|
|
247
|
+
* Improved error messages for API errors and added the request object as `error.request` for easier debugging
|
|
232
248
|
|
|
233
|
-
## 1.14.1
|
|
249
|
+
## [1.14.1](https://github.com/box/box-node-sdk/compare/v1.14.0...v1.14.1) (2018-03-13)
|
|
234
250
|
|
|
235
|
-
|
|
251
|
+
* Fixed a bug when `files.getReadStream()` was called with null options
|
|
236
252
|
|
|
237
|
-
## 1.14.0
|
|
253
|
+
## [1.14.0](https://github.com/box/box-node-sdk/compare/v1.13.0...v1.14.0) (2018-03-12)
|
|
238
254
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
255
|
+
* Added support for [getting a metadata template by ID](./docs/metadata.md#get-by-id)
|
|
256
|
+
* Added a `byteRange` option to [file download](./docs/files.md#download-a-file) to support partial file download
|
|
257
|
+
* Improved error messages when using promises and in authentication flows
|
|
242
258
|
|
|
243
|
-
## 1.13.0
|
|
259
|
+
## [1.13.0](https://github.com/box/box-node-sdk/compare/v1.12.1...v1.13.0) (2018-03-01)
|
|
244
260
|
|
|
245
|
-
|
|
246
|
-
|
|
261
|
+
* Added support for getting a [stream of file representation contents](./docs/files.md#get-representation-content)
|
|
262
|
+
* Switched to using exponential backoff for request retries
|
|
247
263
|
|
|
248
|
-
## 1.12.1
|
|
264
|
+
## [1.12.1](https://github.com/box/box-node-sdk/compare/v1.12.0...v1.12.1) (2018-01-25)
|
|
249
265
|
|
|
250
|
-
|
|
266
|
+
* Fixed an issue where chunked uploader would not work with response streams from the request library
|
|
251
267
|
(0e7014561f9cd0f7f38f98536b3f0c3946231d2e)
|
|
252
268
|
|
|
253
|
-
## 1.12.0
|
|
269
|
+
## [1.12.0](https://github.com/box/box-node-sdk/compare/v1.11.0...v1.12.0) (2018-01-11)
|
|
254
270
|
|
|
255
|
-
|
|
271
|
+
* Added support for [metadata template deletion](./docs/metadata.md#delete-metadata-template)
|
|
256
272
|
|
|
257
|
-
## 1.11.0
|
|
273
|
+
## [1.11.0](https://github.com/box/box-node-sdk/compare/v1.10.1...v1.11.0) (2017-12-12)
|
|
258
274
|
|
|
259
|
-
|
|
275
|
+
* Added options to preserve file timestamps on [file upload](./docs/files.md#upload-a-file)
|
|
260
276
|
and to rename a file or preserve modification timestamp on [new version upload](./docs/files.md#upload-a-new-version-of-a-file)
|
|
261
|
-
|
|
277
|
+
* Added [Collaboration Whitelist](./docs/collaboration-whitelist.md) functionality to allow enterprise admins
|
|
262
278
|
to control which external users can collaborate on their content
|
|
263
|
-
|
|
279
|
+
* Added an option to Token Exchange to generate [annotator tokens](./docs/authentication.md#annotator-tokens) for use with Box View
|
|
264
280
|
|
|
265
|
-
## 1.10.1
|
|
281
|
+
## [1.10.1](https://github.com/box/box-node-sdk/compare/v1.10.0...v1.10.1) (2017-11-28)
|
|
266
282
|
|
|
267
|
-
|
|
283
|
+
* Updated to jsonwebtoken@8.1.0 to fix an issue where some users were getting
|
|
268
284
|
an error when using App Auth
|
|
269
285
|
|
|
270
|
-
## 1.10.0
|
|
286
|
+
## [1.10.0](https://github.com/box/box-node-sdk/compare/v1.9.0...v1.10.0) (2017-01-14)
|
|
271
287
|
|
|
272
|
-
|
|
273
|
-
|
|
288
|
+
* Added support for [Terms of Service](./docs/terms-of-service.md) endpoints
|
|
289
|
+
* Fixed a bug where receiving a collection without paging parameters from the API
|
|
274
290
|
would cause the SDK to throw an exception when using the `iterators` SDK option.
|
|
275
291
|
Now, this will return an iterator over the items returned by the API.
|
|
276
|
-
|
|
277
|
-
|
|
292
|
+
* Fixed a bug in Token Exchange where passing multiple scopes would result in an error
|
|
293
|
+
* Added support for [getting Representations info on a file](./docs/files.md#get-representation-info)
|
|
278
294
|
|
|
279
|
-
## 1.9.0
|
|
295
|
+
## [1.9.0](https://github.com/box/box-node-sdk/compare/v1.8.0...v1.9.0) (2017-09-12)
|
|
280
296
|
|
|
281
|
-
|
|
282
|
-
|
|
297
|
+
* Fixed token methods to return bluebird Promises instead of native Promises
|
|
298
|
+
* Added support for the `notify` and `can_view_path` options on Collaborations
|
|
283
299
|
|
|
284
|
-
## 1.8.0
|
|
300
|
+
## [1.8.0](https://github.com/box/box-node-sdk/compare/v1.7.0...v1.8.0) (2017-08-21)
|
|
285
301
|
|
|
286
|
-
|
|
287
|
-
|
|
302
|
+
* Added support for [Batch API](./docs/client.md#batch-api)
|
|
303
|
+
* Fixed a bug where the Event Stream would make more API calls than necessary,
|
|
288
304
|
potentially hitting Box API rate limits
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
305
|
+
* Added Promise support to methods on the SDK object
|
|
306
|
+
* Added Node.js version to the User-Agent header that the SDK sends
|
|
307
|
+
* Fixed a bug where using multiple Persistent Clients instances could cause some
|
|
292
308
|
clients to end up with expired tokens
|
|
293
309
|
|
|
294
|
-
## 1.7.0
|
|
310
|
+
## [1.7.0](https://github.com/box/box-node-sdk/compare/v1.6.0...v1.7.0) (2017-07-19)
|
|
295
311
|
|
|
296
|
-
|
|
312
|
+
* 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
|
|
297
313
|
|
|
298
|
-
## 1.6.0
|
|
314
|
+
## [1.6.0](https://github.com/box/box-node-sdk/compare/v1.5.1...v1.6.0) (2017-06-23)
|
|
299
315
|
|
|
300
|
-
|
|
301
|
-
|
|
316
|
+
* Added [Recent Items](./docs/recent-items.md) support
|
|
317
|
+
* Updated app auth expiration time default value and validation
|
|
302
318
|
|
|
303
|
-
## 1.5.1
|
|
319
|
+
## [1.5.1](https://github.com/box/box-node-sdk/compare/v1.5.0...v1.5.1) (2017-06-15)
|
|
304
320
|
|
|
305
|
-
|
|
321
|
+
* Revert deep-freezing Config properties, since it was causing errors
|
|
306
322
|
|
|
307
|
-
## 1.5.0
|
|
323
|
+
## [1.5.0](https://github.com/box/box-node-sdk/compare/v1.4.2...v1.5.0) (2017-06-15)
|
|
308
324
|
|
|
309
|
-
|
|
325
|
+
* Added support for [Token Exchange](./docs/authentication.md#token-exchange),
|
|
310
326
|
which allows a client to get downscoped tokens suitable for passing to a browser
|
|
311
327
|
app or worker process.
|
|
312
|
-
|
|
328
|
+
* Ensured deeply-nested Config properties are immutable
|
|
313
329
|
|
|
314
|
-
## 1.4.2
|
|
330
|
+
## [1.4.2](https://github.com/box/box-node-sdk/compare/v1.4.1...v1.4.2) (2017-05-22)
|
|
315
331
|
|
|
316
|
-
|
|
332
|
+
* Fixed `BoxSDK.getPreconfiguredInstance()` to configure webhook keys
|
|
317
333
|
|
|
318
|
-
## 1.4.1
|
|
334
|
+
## [1.4.1](https://github.com/box/box-node-sdk/compare/v1.4.0...v1.4.1) (2017-05-22)
|
|
319
335
|
|
|
320
|
-
|
|
336
|
+
* Fixed `BoxSDK.getPreconfiguredInstance()` when app auth setttings are not populated
|
|
321
337
|
|
|
322
|
-
## 1.4.0
|
|
338
|
+
## [1.4.0](https://github.com/box/box-node-sdk/compare/v1.3.0...v1.4.0) (2017-05-19)
|
|
323
339
|
|
|
324
|
-
|
|
340
|
+
* Added support for [file collaborations](./docs/collaborations.md#add-a-collaboration).
|
|
325
341
|
Users can now invite others to collaborate on single files.
|
|
326
342
|
See [the blog post](https://blog.box.com/blog/file-collaboration-api/) for more information.
|
|
327
|
-
|
|
343
|
+
* Fixed an issue where users were unable to use JWT Server Auth when their computers' clocks
|
|
328
344
|
were not synchronized with the Box API servers.
|
|
329
|
-
|
|
345
|
+
* All asynchronous client methods now return Promises in addition to taking a
|
|
330
346
|
(now-optional) callback parameter, so you can write more modern JS with the SDK.
|
|
331
|
-
|
|
347
|
+
* The SDK can now be preconfigured using a JSON blob that can be downloaded in the
|
|
332
348
|
Box Dev Console for JWT Server Authentication apps, making it easier to get started
|
|
333
349
|
developing!
|
|
334
|
-
|
|
350
|
+
* Added support for [chunked upload](./docs/files.md#chunked-upload), where a large
|
|
335
351
|
file can be uploaded one piece at a time. This makes large file uploads much faster
|
|
336
352
|
and more reliable, since parts can be uploaded in parallel and failed parts can be
|
|
337
353
|
retried in isolation.
|
|
338
|
-
|
|
354
|
+
* Added an `is_confirmed` option to [email alias creation](./docs/users.md#add-email-alias) for
|
|
339
355
|
admins to auto-confirm the alias.
|
|
340
|
-
|
|
341
|
-
|
|
356
|
+
* Added support for the [Enterprise Events stream](./docs/events.md#enterprise-events).
|
|
357
|
+
* Added an option to have collections methods (e.g. `folders.getItems()`,
|
|
342
358
|
`enterprise.getUsers()`, etc) return [async iterators](./README.md#iterators) that will automatically
|
|
343
359
|
page through the collection. This conforms to the [proposed async iteration spec](https://github.com/tc39/proposal-async-iteration),
|
|
344
360
|
which will eventually allow them to be used in ergonomic for-await-of loop syntax.
|
|
345
361
|
|
|
346
|
-
## 1.3.0
|
|
362
|
+
## [1.3.0](https://github.com/box/box-node-sdk/compare/v1.2.0...v1.3.0) (2017-01-24)
|
|
347
363
|
|
|
348
|
-
|
|
364
|
+
* Added `BoxSDK.validateWebhookMessage()` and `client.webhooks.validateMessage()` for validating webhook messages from Box
|
|
349
365
|
|
|
350
|
-
## 1.2.0
|
|
366
|
+
## [1.2.0](https://github.com/box/box-node-sdk/compare/v1.1.0...v1.2.0) (2016-12-12)
|
|
351
367
|
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
368
|
+
* Added methods for all API endpoints; we now have full API coverage :tada:
|
|
369
|
+
* Added support for renaming a file or folder on copy
|
|
370
|
+
* Added `client.asUser(userID)` and `client.asSelf()` to support making calls on behalf of managed users
|
|
371
|
+
* Fixed event streams so they don't go into an infinite error loop when auth expires
|
|
372
|
+
* Fixed an error where App Auth clients would not be able to authorize due to clock skew
|
|
373
|
+
* Fixed the `mdfilters` parameter in `client.search.query()` to support metadata search
|
|
374
|
+
* Cloned options objects to prevent modification of passed-in objects by the SDK
|
|
375
|
+
* Added better error messaging to the sample app
|
|
360
376
|
|
|
361
|
-
## 1.1.0
|
|
377
|
+
## [1.1.0](https://github.com/box/box-node-sdk/compare/v1.0.0...v1.1.0) (2016-09-27)
|
|
362
378
|
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
379
|
+
* Added endpoint to get a file's tasks
|
|
380
|
+
* Fixed issues with stream uploads
|
|
381
|
+
* Improved performance of file uploads
|
|
382
|
+
* Added endpoints to delete files and folders from trash
|
|
383
|
+
* Added endpoint to get a trashed folder
|
|
384
|
+
* Upgraded request dependency to fix ReDoS vulnerability
|
|
369
385
|
|
|
370
|
-
## 1.0.0
|
|
386
|
+
## [1.0.0] (2016-07-13)
|
|
371
387
|
|
|
372
388
|
Initial release.
|