/
Version.ts
387 lines (354 loc) · 9.73 KB
/
Version.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
import Domain from "./Domain";
import Page, { TwilioResponsePayload } from "./Page";
import { RequestOpts } from "./BaseTwilio";
import RestException from "./RestException";
import { trim } from "./utility";
export interface PageLimitOptions {
/**
* The maximum number of items to fetch
*/
limit: number;
/**
* The maximum number of items to return with every request
*/
pageSize: number;
}
export interface PageLimit {
limit: number;
pageSize: number;
}
export default class Version {
_domain: Domain;
_version: Version | string;
/**
*
* Base version object
*
* @param domain - twilio domain
* @param version - api version
*/
constructor(domain: Domain, version: string | Version) {
this._domain = domain;
this._version = version;
}
get domain(): Domain {
return this._domain;
}
/**
* Generate absolute url from a uri
*
* @param uri - uri to transform
* @returns transformed url
*/
absoluteUrl(uri: string): string {
return this._domain.absoluteUrl(this.relativeUrl(uri));
}
/**
* Generate relative url from a uri
*
* @param uri - uri to transform
* @returns transformed url
*/
relativeUrl(uri: string): string {
var result = "";
if (typeof this._version === "string") {
const version = trim(this._version, "/");
result += version;
result += "/";
}
if (typeof uri === "string") {
uri = trim(uri, "/");
if (result === "") {
result += "/";
}
result += uri;
}
return result;
}
/**
* Make a request against the domain
*
* @param opts - request options
* @returns promise that resolves to request response
*/
request(opts: RequestOpts): Promise<any> {
return this._domain.request({
...opts,
uri: this.relativeUrl(opts.uri || ""),
});
}
/**
* Create a new record
*
* @param opts - request options
*
* @throws Error If response returns non 2xx or 201 status code
*
* @returns promise that resolves to created record
*/
create(opts: RequestOpts): Promise<any> {
var qResponse = this.request(opts);
qResponse = qResponse.then(function success(response) {
if (response.statusCode < 200 || response.statusCode >= 300) {
throw new RestException(response);
}
if (typeof response.body === "string") {
return JSON.parse(response.body);
}
return response.body;
});
return qResponse;
}
/**
* Fetch an instance of a record
*
* @param opts - request options
*
* @throws Error If response returns non 2xx or 3xx status code
*
* @returns promise that resolves to fetched result
*/
fetch(opts: RequestOpts): Promise<any> {
var qResponse = this.request(opts);
qResponse = qResponse.then(function success(response) {
if (response.statusCode < 200 || response.statusCode >= 400) {
throw new RestException(response);
}
if (typeof response.body === "string") {
return JSON.parse(response.body);
}
return response.body;
});
return qResponse;
}
/**
* Fetch a page of records
*
* @param opts - request options
* @returns promise that resolves to page of records
*/
page(opts: RequestOpts): Promise<any> {
return this.request(opts);
}
/**
* Update a record
*
* @param opts - request options
*
* @throws Error If response returns non 2xx status code
*
* @returns promise that resolves to updated result
*/
update(opts: RequestOpts): Promise<any> {
var qResponse = this.request(opts);
qResponse = qResponse.then(function success(response) {
if (response.statusCode < 200 || response.statusCode >= 300) {
throw new RestException(response);
}
if (typeof response.body === "string") {
return JSON.parse(response.body);
}
return response.body;
});
return qResponse;
}
/**
* Delete a record
*
* @param opts - request options
*
* @throws Error If response returns a 5xx status
*
* @returns promise that resolves to true if record was deleted
*/
remove(opts: RequestOpts): Promise<boolean> {
var qResponse = this.request(opts);
qResponse = qResponse.then(function success(response) {
if (response.statusCode < 200 || response.statusCode >= 300) {
throw new RestException(response);
}
return response.statusCode === 204;
});
return qResponse;
}
/**
* Process limits for list requests
*
* @param opts.limit - The maximum number of items to fetch
* @param opts.pageSize - The maximum number of items to return with every request
*
*/
readLimits(opts: PageLimitOptions): PageLimit {
var limit = opts.limit;
var pageSize = opts.pageSize;
if ((limit && !Number.isFinite(limit)) || limit <= 0) {
throw new TypeError("Parameter limit must be a positive integer");
}
if (pageSize && (!Number.isFinite(pageSize) || pageSize <= 0)) {
throw new TypeError("Parameter pageSize must be a positive integer");
}
if (limit && !pageSize) {
pageSize = limit;
}
return {
limit: limit,
pageSize: pageSize,
};
}
setPromiseCallback(operationPromise: any, callback: any): Promise<any> {
if (typeof callback === "function") {
operationPromise = operationPromise
.then((value: any) => callback(null, value))
.catch((error: any) => callback(error));
}
return operationPromise;
}
/**
* For each record instance, executes a provided callback function with that
* instance
*
* @param params - Parameters (Optional)
* @param params.limit - Optional maximum number of record instances to
* fetch
* @param params.pageSize - Optional maximum number of records to return
* with every request
* @param params.callback - Callback function to call with each
* record instance
* @param params.done - Optional done function to call when all
* records are processed, the limit is reached, or an error occurs.
* Receives an error argument if an error occurs.
* @param callback - Callback function to call with each record.
* Receives a done function argument that will short-circuit the for-each
* loop that may accept an error argument.
* @returns Returns a promise that resolves when all records
* processed or if the limit is reached, and rejects with an error if an
* error occurs and is not handled in the user provided done function.
*/
each<T>(
params?: any,
callback?: (item: T, done: (err?: Error) => void) => void
): Promise<void> {
if (typeof params === "function") {
callback = params;
params = {};
} else {
params = params || {};
}
if (params.callback) {
callback = params.callback;
}
if (typeof callback === "undefined") {
throw new Error("Callback function must be provided");
}
let done = false;
let doneCalled = false;
let currentPage = 1;
let currentResource = 0;
let limits = {} as PageLimit;
let pPending = true;
let pResolve: (value: void) => void;
let pReject: (reason?: any) => void;
if (this._version instanceof Version) {
limits = this._version.readLimits({
limit: params.limit,
pageSize: params.pageSize,
});
}
function onComplete(error?: any) {
let unhandledError = error;
done = true;
if (typeof params.done === "function" && !doneCalled) {
try {
params.done(unhandledError);
unhandledError = null;
} catch (e) {
unhandledError = e;
}
}
doneCalled = true;
if (pPending) {
if (unhandledError) {
pReject(unhandledError);
} else {
pResolve();
}
pPending = false;
}
}
function fetchNextPage(fn: () => Promise<any>) {
let promise = fn();
if (typeof promise === "undefined") {
onComplete();
return;
}
promise.then((page: any) => {
try {
page.instances.forEach(function (instance: any) {
if (
done ||
(typeof params.limit !== "undefined" &&
currentResource >= params.limit)
) {
done = true;
return false;
}
currentResource++;
callback?.(instance, onComplete);
});
} catch (e) {
return onComplete(e);
}
if (!done) {
currentPage++;
fetchNextPage(page.nextPage.bind(page));
} else {
onComplete();
}
});
promise.catch(onComplete);
}
return new Promise((resolve, reject) => {
pResolve = resolve;
pReject = reject;
fetchNextPage(this.page.bind(this, Object.assign(params, limits)));
});
}
list<T>(
params?: any,
callback?: (error: Error | null, items: T) => any
): Promise<any> {
if (typeof params === "function") {
callback = params;
params = {};
} else {
params = params || {};
}
let allResources: any[] = [];
params.callback = function (resource: any, done: any) {
allResources.push(resource);
if (
typeof params.limit !== "undefined" &&
allResources.length === params.limit
) {
done();
}
};
let operationPromise = new Promise((resolve, reject) => {
params.done = function (error: any) {
if (typeof error === "undefined") {
resolve(allResources);
} else {
reject(error);
}
};
});
if (this._version instanceof Version) {
operationPromise = this._version.setPromiseCallback(
operationPromise,
callback
);
}
this.each(params);
return operationPromise;
}
}