forked from microsoftgraph/msgraph-sdk-javascript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGraphRequest.ts
More file actions
476 lines (414 loc) · 16.6 KB
/
Copy pathGraphRequest.ts
File metadata and controls
476 lines (414 loc) · 16.6 KB
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
import { Promise } from 'es6-promise'
import 'isomorphic-fetch';
import { Options, URLComponents, oDataQueryNames, GraphRequestCallback, PACKAGE_VERSION, DefaultRequestHeaders, FetchOptions } from "./common"
import { ResponseHandler } from "./ResponseHandler"
import { RequestMethod } from './RequestMethod';
import { ResponseType } from "./ResponseType";
import { GraphHelper } from './GraphHelper';
export class GraphRequest {
config: Options;
urlComponents: URLComponents;
_options: FetchOptions;
_headers: {
[key: string]: string;
};
_responseType: string;
constructor(config: Options, path: string) {
let self = this;
self.config = config;
self._options = {};
self._headers = {};
self.urlComponents = {
host: self.config.baseUrl,
version: self.config.defaultVersion,
oDataQueryParams: {},
otherURLQueryParams: {}
};
self.parsePath(path);
}
public header(headerKey: string, headerValue: string) {
let self = this;
self._headers[headerKey] = headerValue;
return self;
}
public headers(headers: { [key: string]: string | number }) {
let self = this;
for (let key in headers) {
self._headers[key] = <string>headers[key];
}
return self;
}
public option(key: string, value: any) {
let self = this;
self._options[key] = value;
return self;
}
public options(options: { [key: string]: any}) {
let self = this;
for (let key in options) {
self._options[key] = options[key];
}
return self;
}
public parsePath(rawPath: string) {
// break rawPath into this.urlComponents
// strip out the base url if they passed it in
if (rawPath.indexOf("https://") != -1) {
rawPath = rawPath.replace("https://", "");
// find where the host ends
let endOfHostStrPos = rawPath.indexOf("/");
this.urlComponents.host = "https://" + rawPath.substring(0, endOfHostStrPos); // parse out the host
// strip the host from rawPath
rawPath = rawPath.substring(endOfHostStrPos + 1, rawPath.length);
// then remove the following version
let endOfVersionStrPos = rawPath.indexOf("/");
// parse out the version
this.urlComponents.version = rawPath.substring(0, endOfVersionStrPos);
// strip version from rawPath
rawPath = rawPath.substring(endOfVersionStrPos + 1, rawPath.length);
}
// strip out any leading "/"
if (rawPath.charAt(0) == "/") {
rawPath = rawPath.substr(1);
}
let queryStrPos = rawPath.indexOf("?");
// let afterPath =
if (queryStrPos == -1) {
// no query string
this.urlComponents.path = rawPath;
} else {
this.urlComponents.path = rawPath.substr(0, queryStrPos);
// capture query string into
// this.urlComponents.oDataQueryParams
// and
// this.urlComponents.otherURLQueryParams
let queryParams = rawPath.substring(queryStrPos + 1, rawPath.length).split("&");
for (let queryParam of queryParams) {
//queryParam: a=b
let queryParams = queryParam.split("=");
let key = queryParams[0];
let value = queryParams[1];
if (oDataQueryNames.indexOf(key)) {
this.urlComponents.oDataQueryParams[key] = value;
} else {
this.urlComponents.otherURLQueryParams[key] = value;
}
}
}
}
private urlJoin(urlSegments: string[]): String {
const tr = (s) => s.replace(/\/+$/, '');
const tl = (s) => s.replace(/^\/+/, '');
const joiner = (pre, cur) => [tr(pre), tl(cur)].join('/');
const parts = Array.prototype.slice.call(urlSegments);
return parts.reduce(joiner);
}
public buildFullUrl(): string {
let url = this.urlJoin([this.urlComponents.host,
this.urlComponents.version,
this.urlComponents.path])
+ this.createQueryString();
if (this.config.debugLogging) {
console.log(url)
}
return url;
}
version(v: string): GraphRequest {
this.urlComponents.version = v;
return this;
}
/*
* Accepts .select("displayName,birthday")
* and .select(["displayName", "birthday"])
* and .select("displayName", "birthday")
*
*/
select(properties: string | string[]): GraphRequest {
this.addCsvQueryParameter("$select", properties, arguments);
return this;
}
expand(properties: string | string[]): GraphRequest {
this.addCsvQueryParameter("$expand", properties, arguments);
return this;
}
orderby(properties: string | string[]): GraphRequest {
this.addCsvQueryParameter("$orderby", properties, arguments);
return this;
}
filter(filterStr: string): GraphRequest {
this.urlComponents.oDataQueryParams["$filter"] = filterStr;
return this;
}
top(n: number): GraphRequest {
this.urlComponents.oDataQueryParams["$top"] = n;
return this;
}
skip(n: number): GraphRequest {
this.urlComponents.oDataQueryParams["$skip"] = n;
return this;
}
skipToken(token: string): GraphRequest {
this.urlComponents.oDataQueryParams["$skipToken"] = token;
return this;
}
count(count: boolean): GraphRequest {
this.urlComponents.oDataQueryParams["$count"] = count.toString();
return this;
}
responseType(responseType: string): GraphRequest {
this._responseType = responseType;
return this;
}
// helper for $select, $expand and $orderby (must be comma separated)
private addCsvQueryParameter(propertyName: string, propertyValue: string | string[], additionalProperties: IArguments) {
// if there are already $propertyName value there, append a ","
this.urlComponents.oDataQueryParams[propertyName] = this.urlComponents.oDataQueryParams[propertyName] ? this.urlComponents.oDataQueryParams[propertyName] + "," : "";
let allValues: string[] = [];
if (typeof propertyValue === "string") {
allValues.push(propertyValue);
} else { // propertyValue passed in as array
allValues = allValues.concat(propertyValue);
}
// merge in additionalProperties
if (additionalProperties.length > 1 && typeof propertyValue === "string") {
allValues = Array.prototype.slice.call(additionalProperties);
}
this.urlComponents.oDataQueryParams[propertyName] += allValues.join(",");
}
delete(callback?: GraphRequestCallback): Promise<any> {
let self = this,
url = self.buildFullUrl(),
options: FetchOptions = {
method: RequestMethod.DELETE
}
return self.sendRequestAndRouteResponse(url, options, callback);
}
/**
* Alias for delete call
*/
del(callback?: GraphRequestCallback): Promise<any> {
return this.delete(callback);
}
patch(content: any, callback?: GraphRequestCallback): Promise<any> {
let self = this,
url = self.buildFullUrl(),
options: FetchOptions = {
method: RequestMethod.PATCH,
body: GraphHelper.serializeContent(content),
headers: {
"Content-Type": "application/json"
}
};
return self.sendRequestAndRouteResponse(url, options, callback);
}
post(content: any, callback?: GraphRequestCallback): Promise<any> {
let self = this,
url = self.buildFullUrl(),
options: FetchOptions = {
method: RequestMethod.POST,
body: GraphHelper.serializeContent(content),
headers: (content.constructor !== undefined && content.constructor.name === "FormData") ? {} : {
"Content-Type": "application/json"
}
};
return self.sendRequestAndRouteResponse(url, options, callback);
}
/**
* Alias for Post call
*/
create(content: any, callback?: GraphRequestCallback): Promise<any> {
return this.post(content, callback);
}
put(content: any, callback?: GraphRequestCallback): Promise<any> {
let self = this,
url = self.buildFullUrl(),
options: FetchOptions = {
method: RequestMethod.PUT,
body: GraphHelper.serializeContent(content),
headers: {
"Content-Type": "application/octet-stream"
}
};
return self.sendRequestAndRouteResponse(url, options, callback);
}
/**
* Alias for update call
*/
update(content: any, callback?: GraphRequestCallback): Promise<any> {
return this.patch(content, callback);
}
get(callback?: GraphRequestCallback): Promise<any> {
let self = this,
url = self.buildFullUrl(),
options: FetchOptions = {
method: RequestMethod.GET
};
return self.sendRequestAndRouteResponse(url, options, callback);
}
getStream(callback: GraphRequestCallback): Promise<any> {
let self = this,
url = self.buildFullUrl(),
options = {
method: RequestMethod.GET
};
self.responseType(ResponseType.STREAM);
return self.sendRequestAndRouteResponse(url, options, callback);
}
putStream(stream: any, callback: GraphRequestCallback): Promise<any> {
let self = this,
url = self.buildFullUrl(),
options = {
method: RequestMethod.PUT,
headers: {
"Content-Type": "application/octet-stream",
},
body: stream
};
return self.sendRequestAndRouteResponse(url, options, callback);
}
/**
* @private
* Sends request and routes response to the callback or resolves to promise
* @param {RequestInfo} request - The Request object or url string value
* @param {FetchOptions} options - The options for the fetch api request
* @param {GraphRequestCallback} callback - The callback that needs to be called on response
* @return The promise in case if the callback param is empty
*/
private sendRequestAndRouteResponse(request: RequestInfo, options: FetchOptions, callback?: GraphRequestCallback): Promise<any> {
// return a promise when Promises are supported and no callback was provided
if (callback == null && typeof Promise !== "undefined") {
return this.routeResponseToPromise(request, options);
} else {
this.routeResponseToCallback(request, options, callback);
}
}
/**
* @private
* Gets the Promise that will resolve or reject with fetch api request
* @param {RequestInfo} request - The Request object or url string value
* @param {FetchOptions} options - The options for the fetch api request
* @return The Promise that resolves with Response
*/
private routeResponseToPromise(request: RequestInfo, options: FetchOptions): Promise<any> {
return new Promise((resolve, reject) => {
this.routeResponseToCallback(request, options, (err, body) => {
if (err != null) {
reject(err);
} else {
resolve(body);
}
});
});
}
/**
* @private
* Makes request to the service by getting auth token from the auth provider
* @param {RequestInfo} request - The Request object or url string value
* @param {FetchOptions} options - The options for the fetch api request
* @param {GraphRequestCallback} callback - The callback function
*/
private routeResponseToCallback(request: RequestInfo, options: FetchOptions, callback: GraphRequestCallback = function () { }) {
let self = this;
self.config.authProvider((err, accessToken) => {
if (err == null && accessToken != null) {
options = self.configureRequestOptions(options, accessToken);
fetch(request, options).then((response) => {
this.convertResponseType(response).then((responseValue) => {
ResponseHandler.init(response, undefined, responseValue, callback);
}).catch((error) => {
ResponseHandler.init(response, error, undefined, callback)
});
}).catch((error) => {
ResponseHandler.init(undefined, error, undefined, callback)
});
} else {
callback(err, null, null);
}
});
}
/**
* @private
* Customizes the fetch options with the Auth token, SDKVersion header and customization applied via init, .header, .headers, .option, .options etc
* @param {FetchOptions} options - The options for the fetch api request
* @param {string} accessToken - The access token value
* @return The fetch options with customization
*/
private configureRequestOptions(options: FetchOptions, accessToken: string): FetchOptions {
let self = this,
defaultHeaders = {
Authorization: `Bearer ${accessToken}`,
SdkVersion: `graph-js-${PACKAGE_VERSION}`
};
let configuredOptions: FetchOptions = {
headers: {}
};
Object.assign(configuredOptions, self.config.fetchOptions, self._options, options);
Object.assign(configuredOptions.headers, defaultHeaders, self._headers, options.headers);
return configuredOptions;
}
// append query strings to the url, accepts either a string like $select=displayName or a dictionary {"$select": "displayName"}
query(queryDictionaryOrString: string | { [key: string]: string | number; }): GraphRequest {
if (typeof queryDictionaryOrString === "string") { // is string
let queryStr = queryDictionaryOrString;
let queryKey = queryStr.split("=")[0];
let queryValue = queryStr.split("=")[1];
this.urlComponents.otherURLQueryParams[queryKey] = queryValue;
} else { // is dictionary
for (let key in queryDictionaryOrString) {
this.urlComponents.otherURLQueryParams[key] = queryDictionaryOrString[key];
}
}
return this;
}
// ex: ?$select=displayName&$filter=startsWith(displayName, 'A')
// does not include starting ?
private createQueryString(): string {
// need to combine first this.urlComponents.oDataQueryParams and this.urlComponents.otherURLQueryParams
let q: string[] = [];
if (Object.keys(this.urlComponents.oDataQueryParams).length != 0) {
for (let property in this.urlComponents.oDataQueryParams) {
q.push(property + "=" + this.urlComponents.oDataQueryParams[property]);
}
}
if (Object.keys(this.urlComponents.otherURLQueryParams).length != 0) {
for (let property in this.urlComponents.otherURLQueryParams) {
q.push(property + "=" + this.urlComponents.otherURLQueryParams[property]);
}
}
if (q.length > 0) {
return "?" + q.join("&");
}
return "";
}
private convertResponseType(response: Response): Promise<any> {
let responseValue: any;
if (!this._responseType) {
this._responseType = '';
}
switch (this._responseType.toLowerCase()) {
case ResponseType.ARRAYBUFFER:
responseValue = response.arrayBuffer();
break;
case ResponseType.BLOB:
responseValue = response.blob();
break;
case ResponseType.DOCUMENT:
// XMLHTTPRequest only :(
responseValue = response.json();
break;
case ResponseType.JSON:
responseValue = response.json();
break;
case ResponseType.STREAM:
responseValue = Promise.resolve(response.body);
break;
case ResponseType.TEXT:
responseValue = response.text();
break;
default:
responseValue = response.json();
break;
}
return responseValue;
}
}