forked from Esri/application-base-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ApplicationBase.js
497 lines (488 loc) · 23.7 KB
/
ApplicationBase.js
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
/*
Copyright 2017 Esri
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
var __assign = (this && this.__assign) || Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
define(["require", "exports", "dojo/_base/kernel", "esri/config", "esri/core/promiseUtils", "esri/identity/IdentityManager", "esri/identity/OAuthInfo", "esri/portal/Portal", "esri/portal/PortalItem", "esri/portal/PortalQueryParams"], function (require, exports, kernel, esriConfig, promiseUtils, IdentityManager, OAuthInfo, Portal, PortalItem, PortalQueryParams) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var defaultConfig = {
portalUrl: "https://www.arcgis.com",
helperServices: {
geometry: {},
printTask: {},
elevationSync: {},
geocode: []
}
};
var defaultSettings = {
environment: {},
group: {},
localStorage: {},
portal: {},
urlParams: [],
webmap: {},
webscene: {}
};
var ApplicationBase = (function () {
//--------------------------------------------------------------------------
//
// Lifecycle
//
//--------------------------------------------------------------------------
function ApplicationBase(applicationConfig, applicationBaseSettings) {
//--------------------------------------------------------------------------
//
// Properties
//
//--------------------------------------------------------------------------
//----------------------------------
// settings
//----------------------------------
this.settings = defaultSettings;
//----------------------------------
// config
//----------------------------------
this.config = defaultConfig;
//----------------------------------
// results
//----------------------------------
this.results = {};
//----------------------------------
// portal
//----------------------------------
this.portal = null;
//----------------------------------
// direction
//----------------------------------
this.direction = null;
//----------------------------------
// locale
//----------------------------------
this.locale = kernel.locale;
//----------------------------------
// units
//----------------------------------
this.units = null;
if (typeof applicationConfig === "string") {
applicationConfig = JSON.parse(applicationConfig);
}
if (typeof applicationBaseSettings === "string") {
applicationBaseSettings = JSON.parse(applicationBaseSettings);
}
var config = __assign({}, defaultConfig, applicationConfig);
var settings = __assign({}, defaultSettings, applicationBaseSettings);
this._mixinSettingsDefaults(settings);
this.settings = settings;
this.config = config;
}
//--------------------------------------------------------------------------
//
// Public Methods
//
//--------------------------------------------------------------------------
ApplicationBase.prototype.queryGroupItems = function (groupId, itemParams, portal) {
if (!portal) {
portal = this.portal;
}
var defaultGroup = this.settings.group.default;
groupId = this._getDefaultId(groupId, defaultGroup);
var paramOptions = __assign({ query: "group:\"" + groupId + "\" AND -type:\"Code Attachment\"", sortField: "modified", sortOrder: "desc", num: 9, start: 1 }, itemParams);
var params = new PortalQueryParams(paramOptions);
return portal.queryItems(params);
};
ApplicationBase.prototype.load = function () {
var _this = this;
var settings = this.settings;
var environmentSettings = settings.environment;
var isEsri = environmentSettings.isEsri, webTierSecurity = environmentSettings.webTierSecurity;
var localStorageSettings = settings.localStorage;
var groupSettings = settings.group;
var portalSettings = settings.portal;
var webmapSettings = settings.webmap;
var websceneSettings = settings.webscene;
var urlParamsSettings = settings.urlParams;
var urlParams = this._getUrlParamValues(urlParamsSettings);
this.results.urlParams = urlParams;
this.config = this._mixinAllConfigs({
config: this.config,
url: urlParams
});
if (isEsri) {
var esriPortalUrl = this._getEsriEnvironmentPortalUrl();
this.config.portalUrl = esriPortalUrl;
this.config.proxyUrl = this._getEsriEnvironmentProxyUrl(esriPortalUrl);
}
var _a = this.config, portalUrl = _a.portalUrl, proxyUrl = _a.proxyUrl, oauthappid = _a.oauthappid, appid = _a.appid;
this._setPortalUrl(portalUrl);
this._setProxyUrl(proxyUrl);
this.direction = this._getLanguageDirection();
var checkSignIn = this._checkSignIn(oauthappid, portalUrl);
return checkSignIn.always(function () {
var queryApplicationItem = appid ?
_this._queryItem(appid) : promiseUtils.resolve();
var queryApplicationData = appid ?
queryApplicationItem.then(function (itemInfo) {
return itemInfo instanceof PortalItem ?
itemInfo.fetchData() :
undefined;
}) :
promiseUtils.resolve();
var queryPortal = portalSettings.fetch ?
_this._queryPortal() :
promiseUtils.resolve();
return promiseUtils.eachAlways([
queryApplicationItem,
queryApplicationData,
queryPortal
]).always(function (applicationArgs) {
var applicationItemResponse = applicationArgs[0], applicationDataResponse = applicationArgs[1], portalResponse = applicationArgs[2];
var applicationItem = applicationItemResponse ?
applicationItemResponse.value :
null;
var applicationData = applicationDataResponse ?
applicationDataResponse.value :
null;
var localStorage = localStorageSettings.fetch ?
_this._getLocalConfig(appid) :
null;
_this.results.localStorage = localStorage;
_this.results.applicationItem = applicationItemResponse;
_this.results.applicationData = applicationDataResponse;
var applicationConfig = applicationData ?
applicationData.values :
null;
var portal = portalResponse ? portalResponse.value : null;
_this.portal = portal;
_this.units = _this._getUnits(portal);
_this.config = _this._mixinAllConfigs({
config: _this.config,
url: urlParams,
local: localStorage,
application: applicationConfig
});
_this._setupCORS(portal.authorizedCrossOriginDomains, webTierSecurity);
_this._setGeometryService(_this.config, portal);
var _a = _this.config, webmap = _a.webmap, webscene = _a.webscene, group = _a.group;
var webmapPromises = [];
var webscenePromises = [];
var groupInfoPromises = [];
var groupItemsPromises = [];
var isWebMapEnabled = webmapSettings.fetch && webmap;
var isWebSceneEnabled = websceneSettings.fetch && webscene;
var isGroupInfoEnabled = groupSettings.fetchInfo && group;
var isGroupItemsEnabled = groupSettings.fetchItems && group;
var itemParams = groupSettings.itemParams;
var defaultWebMap = webmapSettings.default;
var defaultWebScene = websceneSettings.default;
var defaultGroup = groupSettings.default;
var fetchMultipleWebmaps = webmapSettings.fetchMultiple;
var fetchMultipleWebscenes = websceneSettings.fetchMultiple;
var fetchMultipleGroups = groupSettings.fetchMultiple;
if (isWebMapEnabled) {
var webmaps = _this._getPropertyArray(webmap);
var allowedWebmaps = _this._limitSize(webmaps, fetchMultipleWebmaps);
allowedWebmaps.forEach(function (id) {
var webMapId = _this._getDefaultId(id, defaultWebMap);
webmapPromises.push(_this._queryItem(webMapId));
});
}
if (isWebSceneEnabled) {
var webscenes = _this._getPropertyArray(webscene);
var allowedWebsenes = _this._limitSize(webscenes, fetchMultipleWebscenes);
allowedWebsenes.forEach(function (id) {
var webSceneId = _this._getDefaultId(id, defaultWebScene);
webscenePromises.push(_this._queryItem(webSceneId));
});
}
if (isGroupInfoEnabled) {
var groups = _this._getPropertyArray(group);
var allowedGroups = _this._limitSize(groups, fetchMultipleGroups);
allowedGroups.forEach(function (id) {
var groupId = _this._getDefaultId(id, defaultGroup);
groupInfoPromises.push(_this._queryGroupInfo(groupId, portal));
});
}
if (isGroupItemsEnabled) {
var groups = _this._getPropertyArray(group);
groups.forEach(function (id) {
groupItemsPromises.push(_this.queryGroupItems(id, itemParams, portal));
});
}
var promises = {
webmap: webmapPromises.length ?
promiseUtils.eachAlways(webmapPromises) :
promiseUtils.resolve(),
webscene: webscenePromises.length ?
promiseUtils.eachAlways(webscenePromises) :
promiseUtils.resolve(),
groupInfo: groupInfoPromises.length ?
promiseUtils.eachAlways(groupInfoPromises) :
promiseUtils.resolve(),
groupItems: groupItemsPromises.length ?
promiseUtils.eachAlways(groupItemsPromises) :
promiseUtils.resolve()
};
return promiseUtils.eachAlways(promises).always(function (itemArgs) {
var webmapResponses = itemArgs.webmap.value || [];
var websceneResponses = itemArgs.webscene.value || [];
var groupInfoResponses = itemArgs.groupInfo.value || [];
var groupItemsResponses = itemArgs.groupItems.value || [];
var itemInfo = applicationItem ? applicationItem.itemInfo : null;
_this._overwriteItems(webmapResponses, itemInfo);
_this._overwriteItems(websceneResponses, itemInfo);
_this.results.webMapItems = webmapResponses;
_this.results.webSceneItems = websceneResponses;
_this.results.groupInfos = groupInfoResponses;
_this.results.groupItems = groupItemsResponses;
return _this;
});
});
});
};
//--------------------------------------------------------------------------
//
// Private Methods
//
//--------------------------------------------------------------------------
ApplicationBase.prototype._mixinSettingsDefaults = function (settings) {
var userEnvironmentSettings = settings.environment;
var userLocalStorageSettings = settings.localStorage;
var userGroupSettings = settings.group;
var userPortalSettings = settings.portal;
var userWebmapSettings = settings.webmap;
var userWebsceneSettings = settings.webscene;
settings.environment = __assign({ isEsri: false, webTierSecurity: false }, userEnvironmentSettings);
settings.localStorage = __assign({ fetch: true }, userLocalStorageSettings);
settings.group = __assign({ default: "908dd46e749d4565a17d2b646ace7b1a", fetchInfo: true, fetchItems: true, fetchMultiple: true, itemParams: {
"sortField": "modified",
"sortOrder": "desc",
"num": 9,
"start": 0
} }, userGroupSettings);
settings.portal = __assign({ fetch: true }, userPortalSettings);
settings.webmap = __assign({ default: "1970c1995b8f44749f4b9b6e81b5ba45", fetch: true, fetchMultiple: true }, userWebmapSettings);
settings.webscene = __assign({ default: "e8f078ba0c1546b6a6e0727f877742a5", fetch: true, fetchMultiple: true }, userWebsceneSettings);
};
ApplicationBase.prototype._limitSize = function (items, allowMultiple) {
return allowMultiple || items.length < 2 ? items : [items[0]];
};
ApplicationBase.prototype._getPropertyArray = function (property) {
if (typeof property === "string") {
return property.split(",");
}
if (Array.isArray(property)) {
return property;
}
return [];
};
ApplicationBase.prototype._getUnits = function (portal) {
var user = portal.user;
var userRegion = user && user.region;
var userUnits = user && user.units;
var responseUnits = portal.units;
var responseRegion = portal.region;
var ipCountryCode = portal.ipCntryCode;
var isEnglishUnits = (userRegion === "US") ||
(userRegion && responseRegion === "US") ||
(userRegion && !responseRegion) ||
(!user && ipCountryCode === "US") ||
(!user && !ipCountryCode && kernel.locale === "en-us");
var units = userUnits ? userUnits : responseUnits ? responseUnits : isEnglishUnits ? "english" : "metric";
return units;
};
ApplicationBase.prototype._getLocalConfig = function (appid) {
if (!(window.localStorage && appid)) {
return;
}
var localStoragePrefix = "application_base_config_";
var lsItem = localStorage.getItem(localStoragePrefix + appid);
var localConfig = lsItem && JSON.parse(lsItem);
return localConfig;
};
ApplicationBase.prototype._queryItem = function (id) {
var item = new PortalItem({
id: id
});
return item.load();
};
ApplicationBase.prototype._queryGroupInfo = function (groupId, portal) {
var params = new PortalQueryParams({
query: "id:\"" + groupId + "\""
});
return portal.queryGroups(params);
};
ApplicationBase.prototype._setupCORS = function (authorizedDomains, webTierSecurity) {
if (!webTierSecurity || !authorizedDomains || !authorizedDomains.length) {
return;
}
authorizedDomains.forEach(function (authorizedDomain) {
var isDefined = (authorizedDomain !== undefined) && (authorizedDomain !== null);
if (isDefined && authorizedDomain.length) {
esriConfig.request.corsEnabledServers.push({
host: authorizedDomain,
withCredentials: true
});
}
});
};
ApplicationBase.prototype._queryPortal = function () {
return new Portal().load();
};
ApplicationBase.prototype._overwriteItems = function (responses, applicationItem) {
var _this = this;
if (!responses) {
return;
}
responses.forEach(function (response) {
var value = response.value;
if (value) {
_this._overwriteItemExtent(value, applicationItem);
}
});
};
ApplicationBase.prototype._overwriteItemExtent = function (item, applicationItem) {
if (!item || !applicationItem) {
return;
}
var applicationExtent = applicationItem.extent;
item.extent = applicationExtent ? applicationExtent : item.extent;
};
ApplicationBase.prototype._setGeometryService = function (config, ptl) {
var portal = ptl; // todo: fix next api release. helperServices are not on portal currently.
var configHelperServices = config.helperServices;
var portalHelperServices = portal && portal.helperServices;
var configGeometryUrl = configHelperServices && configHelperServices.geometry && configHelperServices.geometry.url;
var portalGeometryUrl = portalHelperServices && portalHelperServices.geometry && portalHelperServices.geometry.url;
var geometryUrl = portalGeometryUrl || configGeometryUrl;
if (!geometryUrl) {
return;
}
esriConfig.geometryServiceUrl = geometryUrl;
};
ApplicationBase.prototype._getDefaultId = function (id, defaultId) {
var defaultUrlParam = "default";
var trimmedId = id ? id.trim() : "";
var useDefaultId = (!trimmedId || trimmedId === defaultUrlParam) && defaultId;
if (useDefaultId) {
return defaultId;
}
return id;
};
ApplicationBase.prototype._getLanguageDirection = function () {
var LTR = "ltr";
var RTL = "rtl";
var RTLLangs = ["ar", "he"];
var isRTL = RTLLangs.some(function (language) {
return kernel.locale.indexOf(language) !== -1;
});
return isRTL ? RTL : LTR;
};
ApplicationBase.prototype._mixinAllConfigs = function (params) {
var config = params.config || null;
var appConfig = params.application || null;
var localConfig = params.local || null;
var urlConfig = params.url || null;
return __assign({}, config, appConfig, localConfig, urlConfig);
};
ApplicationBase.prototype._setPortalUrl = function (portalUrl) {
esriConfig.portalUrl = portalUrl;
};
ApplicationBase.prototype._setProxyUrl = function (proxyUrl) {
esriConfig.request.proxyUrl = proxyUrl;
};
ApplicationBase.prototype._getEsriEnvironmentPortalUrl = function () {
var esriAppsPath = "/apps/";
var esriHomePath = "/home/";
var esriAppsPathIndex = location.pathname.indexOf(esriAppsPath);
var esriHomePathIndex = location.pathname.indexOf(esriHomePath);
var isEsriAppsPath = esriAppsPathIndex !== -1 ? true : false;
var isEsriHomePath = esriHomePathIndex !== -1 ? true : false;
var appLocationIndex = isEsriAppsPath ? esriAppsPathIndex : isEsriHomePath ? esriHomePathIndex : null;
if (!appLocationIndex) {
return;
}
var portalInstance = location.pathname.substr(0, appLocationIndex);
var host = location.host;
return "https://" + host + portalInstance;
};
ApplicationBase.prototype._getEsriEnvironmentProxyUrl = function (portalUrl) {
var esriProxyPath = "/sharing/proxy";
return "" + portalUrl + esriProxyPath;
};
ApplicationBase.prototype._checkSignIn = function (oauthappid, portalUrl) {
var sharingPath = "/sharing";
var info = oauthappid ?
new OAuthInfo({
appId: oauthappid,
portalUrl: portalUrl,
popup: true
}) : null;
if (info) {
IdentityManager.registerOAuthInfos([info]);
}
var signedIn = IdentityManager.checkSignInStatus(portalUrl + sharingPath);
return signedIn.always(promiseUtils.resolve);
};
ApplicationBase.prototype._getUrlParamValues = function (urlParams) {
var _this = this;
var urlObject = this._urlToObject();
var formattedUrlObject = {};
if (!urlObject || !urlParams || !urlParams.length) {
return;
}
urlParams.forEach(function (param) {
var urlParamValue = urlObject[param];
if (urlParamValue) {
formattedUrlObject[param] = _this._foramatUrlParamValue(urlParamValue);
}
});
return formattedUrlObject;
};
ApplicationBase.prototype._urlToObject = function () {
var _this = this;
var query = (window.location.search || "?").substr(1), map = {};
var urlRE = /([^&=]+)=?([^&]*)(?:&+|$)/g;
query.replace(urlRE, function (match, key, value) {
map[key] = _this._stripStringTags(decodeURIComponent(value));
return "";
});
return map;
};
ApplicationBase.prototype._foramatUrlParamValue = function (urlParamValue) {
if (typeof urlParamValue === "string") {
switch (urlParamValue.toLowerCase()) {
case "true":
return true;
case "false":
return false;
default:
return urlParamValue;
}
}
return urlParamValue;
};
ApplicationBase.prototype._stripStringTags = function (value) {
var tagsRE = /<\/?[^>]+>/g;
return value.replace(tagsRE, "");
};
return ApplicationBase;
}());
exports.default = ApplicationBase;
});
//# sourceMappingURL=ApplicationBase.js.map