@esri/solution-simple-types 4.1.2 → 5.0.1

package/dist/cjs/oic.d.ts

@@ -1,53 +1,53 @@
-/** @license
- * Copyright 2018 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.
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts an AGOL OIC (Oriented Imagery Catalog) item to a template.
- *
- * @param itemTemplate Template for the OIC (Oriented Imagery Catalog) item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @returns Template for the solution item that contains key details for item reconstruction
- */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
-/**
- * Gets the ids of the dependencies of an AGOL OIC (Oriented Imagery Catalog) item.
- *
- * @param itemTemplate A OIC (Oriented Imagery Catalog) item whose dependencies are sought
- * @param authentication Credentials for any requests
- * @returns List of dependencies ids and url/itemId hash
- * @private
- */
-export declare function _extractDependencies(itemTemplate: common.IItemTemplate, authentication: common.UserSession): Promise<any>;
-/**
- * Extracts the AGOL itemId for each layer in a list using the url.
- *
- * @param layerURLs List of OIC layer URLs
- * @param dependencies Current list of dependencies
- * @param authentication Credentials for any requests
- * @returns List of dependencies ids and url/itemId hash
- * @private
- */
-export declare function _getLayerIds(layerURLs: string[], dependencies: string[], authentication: common.UserSession): Promise<any>;
-/**
- * Templatizes the url and item id for a layer.
- *
- * @param layerURL OIC layer URL
- * @param urlHash Lookup object for analysis layers
- * @returns Templatized URL if layerURL is in the urlHash
- * @private
- */
-export declare function _templatizeOicLayerUrl(layerURL: string, urlHash: any): string;
+/** @license
+ * Copyright 2018 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.
+ */
+import * as common from "@esri/solution-common";
+/**
+ * Converts an AGOL OIC (Oriented Imagery Catalog) item to a template.
+ *
+ * @param itemTemplate Template for the OIC (Oriented Imagery Catalog) item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @returns Template for the solution item that contains key details for item reconstruction
+ */
+export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession): Promise<common.IItemTemplate>;
+/**
+ * Gets the ids of the dependencies of an AGOL OIC (Oriented Imagery Catalog) item.
+ *
+ * @param itemTemplate A OIC (Oriented Imagery Catalog) item whose dependencies are sought
+ * @param authentication Credentials for any requests
+ * @returns List of dependencies ids and url/itemId hash
+ * @private
+ */
+export declare function _extractDependencies(itemTemplate: common.IItemTemplate, authentication: common.UserSession): Promise<any>;
+/**
+ * Extracts the AGOL itemId for each layer in a list using the url.
+ *
+ * @param layerURLs List of OIC layer URLs
+ * @param dependencies Current list of dependencies
+ * @param authentication Credentials for any requests
+ * @returns List of dependencies ids and url/itemId hash
+ * @private
+ */
+export declare function _getLayerIds(layerURLs: string[], dependencies: string[], authentication: common.UserSession): Promise<any>;
+/**
+ * Templatizes the url and item id for a layer.
+ *
+ * @param layerURL OIC layer URL
+ * @param urlHash Lookup object for analysis layers
+ * @returns Templatized URL if layerURL is in the urlHash
+ * @private
+ */
+export declare function _templatizeOicLayerUrl(layerURL: string, urlHash: any): string;

package/dist/cjs/oic.js

@@ -1,171 +1,171 @@
-"use strict";
-/** @license
- * Copyright 2018 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._templatizeOicLayerUrl = exports._getLayerIds = exports._extractDependencies = exports.convertItemToTemplate = void 0;
-const tslib_1 = require("tslib");
-const common = tslib_1.__importStar(require("@esri/solution-common"));
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Converts an AGOL OIC (Oriented Imagery Catalog) item to a template.
- *
- * @param itemTemplate Template for the OIC (Oriented Imagery Catalog) item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @returns Template for the solution item that contains key details for item reconstruction
- */
-function convertItemToTemplate(itemTemplate, destAuthentication, srcAuthentication) {
-    return new Promise((resolve, reject) => {
-        // Extract dependencies
-        _extractDependencies(itemTemplate, srcAuthentication).then((results) => {
-            itemTemplate.dependencies = results.dependencies;
-            // Templatize the map layer ids after we've extracted them as dependencies
-            /* istanbul ignore else */
-            if (itemTemplate.data?.properties) {
-                itemTemplate.data.properties.ServiceURL = _templatizeOicLayerUrl(itemTemplate.data.properties.ServiceURL, results.urlHash);
-                itemTemplate.data.properties.OverviewURL = _templatizeOicLayerUrl(itemTemplate.data.properties.OverviewURL, results.urlHash);
-            }
-            resolve(itemTemplate);
-        }, e => reject(common.fail(e)));
-    });
-}
-exports.convertItemToTemplate = convertItemToTemplate;
-/**
- * Gets the ids of the dependencies of an AGOL OIC (Oriented Imagery Catalog) item.
- *
- * @param itemTemplate A OIC (Oriented Imagery Catalog) item whose dependencies are sought
- * @param authentication Credentials for any requests
- * @returns List of dependencies ids and url/itemId hash
- * @private
- */
-function _extractDependencies(itemTemplate, authentication) {
-    return new Promise((resolve, reject) => {
-        const dependencies = [];
-        if (itemTemplate.data?.properties) {
-            const layerURLs = [];
-            /* istanbul ignore else */
-            if (itemTemplate.data.properties.ServiceURL) {
-                layerURLs.push(itemTemplate.data.properties.ServiceURL);
-            }
-            /* istanbul ignore else */
-            if (itemTemplate.data.properties.OverviewURL &&
-                itemTemplate.data.properties.OverviewURL !==
-                    itemTemplate.data.properties.ServiceURL) {
-                layerURLs.push(itemTemplate.data.properties.OverviewURL);
-            }
-            _getLayerIds(layerURLs, dependencies, authentication).then(results => {
-                resolve(results);
-            }, e => reject(common.fail(e)));
-        }
-        else {
-            resolve({
-                dependencies: dependencies,
-                urlHash: {}
-            });
-        }
-    });
-}
-exports._extractDependencies = _extractDependencies;
-/**
- * Extracts the AGOL itemId for each layer in a list using the url.
- *
- * @param layerURLs List of OIC layer URLs
- * @param dependencies Current list of dependencies
- * @param authentication Credentials for any requests
- * @returns List of dependencies ids and url/itemId hash
- * @private
- */
-function _getLayerIds(layerURLs, dependencies, authentication) {
-    return new Promise((resolve, reject) => {
-        const urlHash = {};
-        const options = {
-            f: "json",
-            authentication: authentication
-        };
-        const layerPromises = [];
-        const layerChecks = {};
-        const filteredLayerURLs = layerURLs.filter(layerURL => {
-            if (layerURL) {
-                const results = /.+FeatureServer/g.exec(layerURL);
-                const baseUrl = Array.isArray(results) && results.length > 0 ? results[0] : undefined;
-                if (baseUrl) {
-                    // avoid redundant checks when we have a layer with subLayers
-                    /* istanbul ignore else */
-                    if (Object.keys(layerChecks).indexOf(baseUrl) < 0) {
-                        layerChecks[baseUrl] = common.rest_request(layerURL, options);
-                    }
-                    layerPromises.push(layerChecks[baseUrl]);
-                    return true;
-                }
-                else {
-                    return false;
-                }
-            }
-            else {
-                return false;
-            }
-        });
-        if (layerPromises.length > 0) {
-            Promise.all(layerPromises).then(serviceResponses => {
-                serviceResponses.forEach((serviceResponse, i) => {
-                    /* istanbul ignore else */
-                    if (common.getProp(serviceResponse, "serviceItemId")) {
-                        const id = serviceResponse.serviceItemId;
-                        /* istanbul ignore else */
-                        if (dependencies.indexOf(id) < 0) {
-                            dependencies.push(id);
-                        }
-                        urlHash[filteredLayerURLs[i]] = id;
-                    }
-                });
-                resolve({
-                    dependencies: dependencies,
-                    urlHash: urlHash
-                });
-            }, e => reject(common.fail(e)));
-        }
-        else {
-            resolve({
-                dependencies: dependencies,
-                urlHash: urlHash
-            });
-        }
-    });
-}
-exports._getLayerIds = _getLayerIds;
-/**
- * Templatizes the url and item id for a layer.
- *
- * @param layerURL OIC layer URL
- * @param urlHash Lookup object for analysis layers
- * @returns Templatized URL if layerURL is in the urlHash
- * @private
- */
-function _templatizeOicLayerUrl(layerURL, urlHash) {
-    let templatizedURL = layerURL;
-    if (layerURL) {
-        const id = urlHash[layerURL];
-        if (id) {
-            const layerId = layerURL.substr(layerURL.lastIndexOf("/") + 1);
-            templatizedURL = common.templatizeTerm(id, id, ".layer" + layerId + ".url");
-        }
-        // replace everything up until /home with portalBaseUrl var and templatize the itemId
-        templatizedURL = common.templatizeIds(templatizedURL.replace(/.+?(?=\/home)/, "{{portalBaseUrl}}"));
-    }
-    return templatizedURL;
-}
-exports._templatizeOicLayerUrl = _templatizeOicLayerUrl;
+"use strict";
+/** @license
+ * Copyright 2018 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._templatizeOicLayerUrl = exports._getLayerIds = exports._extractDependencies = exports.convertItemToTemplate = void 0;
+const tslib_1 = require("tslib");
+const common = tslib_1.__importStar(require("@esri/solution-common"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Converts an AGOL OIC (Oriented Imagery Catalog) item to a template.
+ *
+ * @param itemTemplate Template for the OIC (Oriented Imagery Catalog) item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @returns Template for the solution item that contains key details for item reconstruction
+ */
+function convertItemToTemplate(itemTemplate, destAuthentication, srcAuthentication) {
+    return new Promise((resolve, reject) => {
+        // Extract dependencies
+        _extractDependencies(itemTemplate, srcAuthentication).then((results) => {
+            itemTemplate.dependencies = results.dependencies;
+            // Templatize the map layer ids after we've extracted them as dependencies
+            /* istanbul ignore else */
+            if (itemTemplate.data?.properties) {
+                itemTemplate.data.properties.ServiceURL = _templatizeOicLayerUrl(itemTemplate.data.properties.ServiceURL, results.urlHash);
+                itemTemplate.data.properties.OverviewURL = _templatizeOicLayerUrl(itemTemplate.data.properties.OverviewURL, results.urlHash);
+            }
+            resolve(itemTemplate);
+        }, e => reject(common.fail(e)));
+    });
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+/**
+ * Gets the ids of the dependencies of an AGOL OIC (Oriented Imagery Catalog) item.
+ *
+ * @param itemTemplate A OIC (Oriented Imagery Catalog) item whose dependencies are sought
+ * @param authentication Credentials for any requests
+ * @returns List of dependencies ids and url/itemId hash
+ * @private
+ */
+function _extractDependencies(itemTemplate, authentication) {
+    return new Promise((resolve, reject) => {
+        const dependencies = [];
+        if (itemTemplate.data?.properties) {
+            const layerURLs = [];
+            /* istanbul ignore else */
+            if (itemTemplate.data.properties.ServiceURL) {
+                layerURLs.push(itemTemplate.data.properties.ServiceURL);
+            }
+            /* istanbul ignore else */
+            if (itemTemplate.data.properties.OverviewURL &&
+                itemTemplate.data.properties.OverviewURL !==
+                    itemTemplate.data.properties.ServiceURL) {
+                layerURLs.push(itemTemplate.data.properties.OverviewURL);
+            }
+            _getLayerIds(layerURLs, dependencies, authentication).then(results => {
+                resolve(results);
+            }, e => reject(common.fail(e)));
+        }
+        else {
+            resolve({
+                dependencies: dependencies,
+                urlHash: {}
+            });
+        }
+    });
+}
+exports._extractDependencies = _extractDependencies;
+/**
+ * Extracts the AGOL itemId for each layer in a list using the url.
+ *
+ * @param layerURLs List of OIC layer URLs
+ * @param dependencies Current list of dependencies
+ * @param authentication Credentials for any requests
+ * @returns List of dependencies ids and url/itemId hash
+ * @private
+ */
+function _getLayerIds(layerURLs, dependencies, authentication) {
+    return new Promise((resolve, reject) => {
+        const urlHash = {};
+        const options = {
+            f: "json",
+            authentication: authentication
+        };
+        const layerPromises = [];
+        const layerChecks = {};
+        const filteredLayerURLs = layerURLs.filter(layerURL => {
+            if (layerURL) {
+                const results = /.+FeatureServer/g.exec(layerURL);
+                const baseUrl = Array.isArray(results) && results.length > 0 ? results[0] : undefined;
+                if (baseUrl) {
+                    // avoid redundant checks when we have a layer with subLayers
+                    /* istanbul ignore else */
+                    if (Object.keys(layerChecks).indexOf(baseUrl) < 0) {
+                        layerChecks[baseUrl] = common.rest_request(layerURL, options);
+                    }
+                    layerPromises.push(layerChecks[baseUrl]);
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            }
+            else {
+                return false;
+            }
+        });
+        if (layerPromises.length > 0) {
+            Promise.all(layerPromises).then(serviceResponses => {
+                serviceResponses.forEach((serviceResponse, i) => {
+                    /* istanbul ignore else */
+                    if (common.getProp(serviceResponse, "serviceItemId")) {
+                        const id = serviceResponse.serviceItemId;
+                        /* istanbul ignore else */
+                        if (dependencies.indexOf(id) < 0) {
+                            dependencies.push(id);
+                        }
+                        urlHash[filteredLayerURLs[i]] = id;
+                    }
+                });
+                resolve({
+                    dependencies: dependencies,
+                    urlHash: urlHash
+                });
+            }, e => reject(common.fail(e)));
+        }
+        else {
+            resolve({
+                dependencies: dependencies,
+                urlHash: urlHash
+            });
+        }
+    });
+}
+exports._getLayerIds = _getLayerIds;
+/**
+ * Templatizes the url and item id for a layer.
+ *
+ * @param layerURL OIC layer URL
+ * @param urlHash Lookup object for analysis layers
+ * @returns Templatized URL if layerURL is in the urlHash
+ * @private
+ */
+function _templatizeOicLayerUrl(layerURL, urlHash) {
+    let templatizedURL = layerURL;
+    if (layerURL) {
+        const id = urlHash[layerURL];
+        if (id) {
+            const layerId = layerURL.substr(layerURL.lastIndexOf("/") + 1);
+            templatizedURL = common.templatizeTerm(id, id, ".layer" + layerId + ".url");
+        }
+        // replace everything up until /home with portalBaseUrl var and templatize the itemId
+        templatizedURL = common.templatizeIds(templatizedURL.replace(/.+?(?=\/home)/, "{{portalBaseUrl}}"));
+    }
+    return templatizedURL;
+}
+exports._templatizeOicLayerUrl = _templatizeOicLayerUrl;
 //# sourceMappingURL=oic.js.map

package/dist/cjs/quickcapture.d.ts

@@ -1,87 +1,76 @@
-/** @license
- * Copyright 2018 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.
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts a Quick Capture item into a template.
- *
- * @param solutionItemId The solution to contain the template
- * @param itemInfo Info about the item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @returns A promise that will resolve when the template has been created
- */
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
-/**
- * Converts an quick capture item to a template.
- *
- * @param itemTemplate template for the quick capture project item
- * @returns templatized itemTemplate
- */
-export declare function convertQuickCaptureToTemplate(itemTemplate: common.IItemTemplate): Promise<common.IItemTemplate>;
-/**
- * Templatizes key properties for a quick capture project and gathers item dependencies
- *
- * @param data the projects json
- * @param itemTemplate template for the quick capture project item
- * @returns templatized itemTemplate
- * @private
- */
-export declare function _templatizeApplication(data: any, itemTemplate: common.IItemTemplate): any;
-/**
- * Templatize the email property
- *
- * @param data the quick capture application
- * @private
- */
-export declare function _templatizeAdminEmail(data: any): void;
-/**
- * Updates the templates dependencies list with unique item ids
- *
- * @param id the item id of the dependency
- * @param itemTemplate template for the quick capture project item
- * @returns templatized itemTemplate
- */
-export declare function _updateDependencies(id: string, itemTemplate: common.IItemTemplate): void;
-/**
- * Templatize a url property
- *
- * @param obj the datasource object
- * @param idPath the path to the id property
- * @param urlPath the path to the url property
- * @private
- */
-export declare function _templatizeUrl(obj: any, idPath: string, urlPath: string): void;
-/**
- * Templatize the item id property
- *
- * @param obj the datasource or object that contains the item id property
- * @param path the path to the id property
- * @private
- */
-export declare function _templatizeId(obj: any, path: string): void;
-export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;
-/**
- * QuickCapture post-processing actions
- *
- * @param {string} itemId The item ID
- * @param {string} type The template type
- * @param {any[]} itemInfos Array of \{id: 'ef3', type: 'Web Map'\} objects
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} authentication The destination session info
- * @returns Promise resolving to successfulness of update
- */
-export declare function postProcess(itemId: string, type: string, itemInfos: any[], template: common.IItemTemplate, templates: common.IItemTemplate[], templateDictionary: any, authentication: common.UserSession): Promise<any>;
+/** @license
+ * Copyright 2018 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.
+ */
+import * as common from "@esri/solution-common";
+/**
+ * Converts a Quick Capture item into a template.
+ *
+ * @param solutionItemId The solution to contain the template
+ * @param itemInfo Info about the item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ * @returns A promise that will resolve when the template has been created
+ */
+export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
+/**
+ * Converts an quick capture item to a template.
+ *
+ * @param itemTemplate template for the quick capture project item
+ * @returns templatized itemTemplate
+ */
+export declare function convertQuickCaptureToTemplate(itemTemplate: common.IItemTemplate): common.IItemTemplate;
+/**
+ * Templatizes key properties for a quick capture project and gathers item dependencies
+ *
+ * @param data the projects json
+ * @param itemTemplate template for the quick capture project item
+ * @returns templatized itemTemplate
+ * @private
+ */
+export declare function _templatizeApplication(data: any, itemTemplate: common.IItemTemplate): any;
+/**
+ * Templatize the email property
+ *
+ * @param data the quick capture application
+ * @private
+ */
+export declare function _templatizeAdminEmail(data: any): void;
+/**
+ * Updates the templates dependencies list with unique item ids
+ *
+ * @param id the item id of the dependency
+ * @param itemTemplate template for the quick capture project item
+ * @returns templatized itemTemplate
+ */
+export declare function _updateDependencies(id: string, itemTemplate: common.IItemTemplate): void;
+/**
+ * Templatize a url property
+ *
+ * @param obj the datasource object
+ * @param idPath the path to the id property
+ * @param urlPath the path to the url property
+ * @private
+ */
+export declare function _templatizeUrl(obj: any, idPath: string, urlPath: string): void;
+/**
+ * Templatize the item id property
+ *
+ * @param obj the datasource or object that contains the item id property
+ * @param path the path to the id property
+ * @private
+ */
+export declare function _templatizeId(obj: any, path: string): void;
+export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;