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