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
383 lines (317 loc) · 13 KB
/
Copy pathGraphRequest.ts
File metadata and controls
383 lines (317 loc) · 13 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
import * as request from 'superagent';
import { Promise } from 'es6-promise'
import { Options, URLComponents, GraphError, oDataQueryNames, GraphRequestCallback, PACKAGE_VERSION } from "./common"
import { ResponseHandler } from "./ResponseHandler"
export class GraphRequest {
config: Options;
urlComponents: URLComponents;
_headers:{ [key: string] : string|number; } // other headers to pass through to superagent
_responseType: string;
constructor(config: Options, path:string) {
this.config = config;
this._headers = {};
this.urlComponents = {
host: this.config.baseUrl,
version: this.config.defaultVersion,
oDataQueryParams: {},
otherURLQueryParams: {}
};
this.parsePath(path);
}
public header(headerKey:string, headerValue:string) {
this._headers[headerKey] = headerValue;
return this;
}
public headers(headers:{ [key: string] : string|number }) {
for (let key in headers) {
this._headers[key] = headers[key];
}
return this;
}
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.addCsvQueryParamater("$select", properties, arguments);
return this;
}
expand(properties:string|string[]):GraphRequest {
this.addCsvQueryParamater("$expand", properties, arguments);
return this;
}
orderby(properties:string|string[]):GraphRequest {
this.addCsvQueryParamater("$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 addCsvQueryParamater(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 url = this.buildFullUrl();
return this.sendRequestAndRouteResponse(request.del(url), callback)
}
patch(content:any, callback?:GraphRequestCallback):Promise<any> {
let url = this.buildFullUrl();
return this.sendRequestAndRouteResponse(
request
.patch(url)
.send(content),
callback
);
}
post(content:any, callback?:GraphRequestCallback):Promise<any> {
let url = this.buildFullUrl();
return this.sendRequestAndRouteResponse(
request
.post(url)
.send(content),
callback
);
}
put(content:any, callback?:GraphRequestCallback):Promise<any> {
let url = this.buildFullUrl();
return this.sendRequestAndRouteResponse(
request
.put(url)
.type('application/octet-stream')
.send(content),
callback
);
}
// request aliases
// alias for post
create(content:any, callback?:GraphRequestCallback):Promise<any> {
return this.post(content, callback);
}
// alias for patch
update(content:any, callback?:GraphRequestCallback):Promise<any> {
return this.patch(content, callback);
}
del(callback?:GraphRequestCallback):Promise<any> {
return this.delete(callback);
}
get(callback?:GraphRequestCallback):Promise<any> {
let url = this.buildFullUrl();
return this.sendRequestAndRouteResponse(
request
.get(url),
callback
);
}
// Given the built SuperAgentRequest, get an auth token from the authProvider, make the request and return a promise
private routeResponseToPromise(requestBuilder:request.SuperAgentRequest) {
return new Promise((resolve, reject) => {
this.routeResponseToCallback(requestBuilder, (err, body) => {
if (err != null) {
reject(err);
} else {
resolve(body);
}
});
});
}
// Given the built SuperAgentRequest, get an auth token from the authProvider, make the request and invoke the callback
private routeResponseToCallback(requestBuilder:request.SuperAgentRequest, callback: GraphRequestCallback) {
this.config.authProvider((err, accessToken) => {
if (err == null && accessToken != null) {
let request = this.configureRequest(requestBuilder, accessToken);
request.end((err, res) => {
ResponseHandler.init(err, res, callback)
});
} else {
callback(err, null, null);
}
});
}
/*
* Help method that's called from the final actions( .get(), .post(), etc.) that after making the request either invokes
* routeResponseToCallback() or routeResponseToPromise()
*/
private sendRequestAndRouteResponse(requestBuilder:request.SuperAgentRequest, 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(requestBuilder);
} else {
this.routeResponseToCallback(requestBuilder, callback || function(){});
}
}
getStream(callback:GraphRequestCallback) {
this.config.authProvider((err, accessToken) => {
if (err === null && accessToken !== null) {
let url = this.buildFullUrl();
callback(null, this.configureRequest(request.get(url), accessToken));
} else {
callback(err, null);
}
});
}
putStream(stream:any, callback:Function) {
this.config.authProvider((err, accessToken) => {
if (err === null && accessToken !== null) {
let url = this.buildFullUrl();
let req:request.Request = this.configureRequest(request.put(url), accessToken);
req.type('application/octet-stream');
stream
.pipe(req)
.on('error', function(err) {
callback(err, null)
})
.on('end', function() {
callback(null)
});
}
});
}
private configureRequest(requestBuilder:request.SuperAgentRequest, accessToken:string):request.SuperAgentRequest {
let request = requestBuilder
.set('Authorization', 'Bearer ' + accessToken)
.set(this._headers)
.set('SdkVersion', "graph-js-" + PACKAGE_VERSION)
if (this._responseType !== undefined) {
request.responseType(this._responseType);
}
return request;
}
// 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;
//split .query("$select=displayName") into key and balue
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 "";
}
}