@esri/solution-simple-types 5.2.3 → 5.2.4

package/dist/cjs/helpers/simple-type-helpers.d.ts

@@ -0,0 +1,18 @@
+/** @license
+ * Copyright 2020 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 { convertItemToTemplate } from "./convert-item-to-template";
+import { createItemFromTemplate } from "./create-item-from-template";
+export { createItemFromTemplate, convertItemToTemplate };

package/dist/cjs/helpers/simple-type-helpers.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertItemToTemplate = exports.createItemFromTemplate = void 0;
+/** @license
+ * Copyright 2020 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.
+ */
+const convert_item_to_template_1 = require("./convert-item-to-template");
+Object.defineProperty(exports, "convertItemToTemplate", { enumerable: true, get: function () { return convert_item_to_template_1.convertItemToTemplate; } });
+const create_item_from_template_1 = require("./create-item-from-template");
+Object.defineProperty(exports, "createItemFromTemplate", { enumerable: true, get: function () { return create_item_from_template_1.createItemFromTemplate; } });
+//# sourceMappingURL=simple-type-helpers.js.map

package/dist/cjs/helpers/simple-type-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-type-helpers.js","sourceRoot":"","sources":["../../../src/helpers/simple-type-helpers.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,yEAAmE;AAIlC,sGAJxB,gDAAqB,OAIwB;AAHtD,2EAAqE;AAG5D,uGAHA,kDAAsB,OAGA"}

package/dist/cjs/helpers/update-notebook-data.d.ts

@@ -0,0 +1,17 @@
+/** @license
+ * Copyright 2020 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 { UserSession } from "@esri/solution-common";
+export declare function updateNotebookData(itemId: string, data: any, authentication: UserSession): Promise<any>;

package/dist/cjs/helpers/update-notebook-data.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateNotebookData = void 0;
+/** @license
+ * Copyright 2020 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.
+ */
+const solution_common_1 = require("@esri/solution-common");
+function updateNotebookData(itemId, data, authentication) {
+    const updateOptions = {
+        id: itemId,
+        data: (0, solution_common_1.jsonToBlob)(data)
+    };
+    return (0, solution_common_1.updateItem)(updateOptions, authentication);
+}
+exports.updateNotebookData = updateNotebookData;
+//# sourceMappingURL=update-notebook-data.js.map

package/dist/cjs/helpers/update-notebook-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-notebook-data.js","sourceRoot":"","sources":["../../../src/helpers/update-notebook-data.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,2DAK+B;AAE/B,SAAgB,kBAAkB,CAChC,MAAc,EACd,IAAS,EACT,cAA2B;IAE3B,MAAM,aAAa,GAAgB;QACjC,EAAE,EAAE,MAAM;QACV,IAAI,EAAE,IAAA,4BAAU,EAAC,IAAI,CAAC;KACvB,CAAC;IACF,OAAO,IAAA,4BAAU,EAAC,aAAa,EAAE,cAAc,CAAC,CAAC;AACnD,CAAC;AAVD,gDAUC"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,27 @@
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of simple item types.
+ *
+ * @module simple-types
+ */
+import * as simpleTypeHelpers from "./helpers/simple-type-helpers";
+import * as notebookHelpers from "./helpers/notebook-helpers";
+import * as quickcaptureHelpers from "./helpers/quickcapture-helpers";
+import * as simpleTypes from "./simple-types";
+import * as notebookProcessor from "./notebook";
+import * as quickcaptureProcessor from "./quickcapture";
+export { simpleTypes, notebookProcessor, notebookHelpers, simpleTypeHelpers, quickcaptureHelpers, quickcaptureProcessor };

package/dist/cjs/index.js

@@ -0,0 +1,37 @@
+"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.quickcaptureProcessor = exports.quickcaptureHelpers = exports.simpleTypeHelpers = exports.notebookHelpers = exports.notebookProcessor = exports.simpleTypes = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Manages the creation and deployment of simple item types.
+ *
+ * @module simple-types
+ */
+const simpleTypeHelpers = tslib_1.__importStar(require("./helpers/simple-type-helpers"));
+exports.simpleTypeHelpers = simpleTypeHelpers;
+const notebookHelpers = tslib_1.__importStar(require("./helpers/notebook-helpers"));
+exports.notebookHelpers = notebookHelpers;
+const quickcaptureHelpers = tslib_1.__importStar(require("./helpers/quickcapture-helpers"));
+exports.quickcaptureHelpers = quickcaptureHelpers;
+const simpleTypes = tslib_1.__importStar(require("./simple-types"));
+exports.simpleTypes = simpleTypes;
+const notebookProcessor = tslib_1.__importStar(require("./notebook"));
+exports.notebookProcessor = notebookProcessor;
+const quickcaptureProcessor = tslib_1.__importStar(require("./quickcapture"));
+exports.quickcaptureProcessor = quickcaptureProcessor;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH;;;;GAIG;AACH,yFAAmE;AAWjE,8CAAiB;AAVnB,oFAA8D;AAS5D,0CAAe;AARjB,4FAAsE;AAUpE,kDAAmB;AATrB,oEAA8C;AAK5C,kCAAW;AAJb,sEAAgD;AAK9C,8CAAiB;AAJnB,8EAAwD;AAQtD,sDAAqB"}

package/dist/cjs/notebook.d.ts

@@ -0,0 +1,65 @@
+/** @license
+ * Copyright 2020 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 notebook item into a 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(itemInfo: any, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
+export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;
+/**
+ * Converts a Python Notebook item to a template.
+ *
+ * @param itemTemplate template for the Python Notebook
+ * @returns templatized itemTemplate
+ */
+export declare function convertNotebookToTemplate(itemTemplate: common.IItemTemplate): common.IItemTemplate;
+/**
+ * Remove interpreter and papermill props
+ *
+ * This function will update the data passed in by removing key props
+ *
+ * @param data The notebooks data object
+ *
+ */
+export declare function deleteProps(data: any): void;
+/**
+ * Update the notebooks data
+ *
+ * @param originalTemplate The original template item
+ * @param newlyCreatedItem The current item that may have unswapped variables
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param authentication Credentials for the requests to the destination
+ *
+ * @returns A promise that will resolve once any updates have been made
+ */
+export declare function fineTuneCreatedItem(originalTemplate: common.IItemTemplate, newlyCreatedItem: common.IItemTemplate, templateDictionary: any, authentication: common.UserSession): Promise<void>;
+/**
+ * Notebook specific 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<any>}
+ */
+export declare function postProcess(itemId: string, type: string, itemInfos: any[], template: common.IItemTemplate, templates: common.IItemTemplate[], templateDictionary: any, authentication: common.UserSession): Promise<any>;

package/dist/cjs/notebook.js

@@ -0,0 +1,133 @@
+"use strict";
+/** @license
+ * Copyright 2020 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.postProcess = exports.fineTuneCreatedItem = exports.deleteProps = exports.convertNotebookToTemplate = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
+const tslib_1 = require("tslib");
+const common = tslib_1.__importStar(require("@esri/solution-common"));
+// Need to import collectively to enable spying
+const notebookHelpers = tslib_1.__importStar(require("./helpers/notebook-helpers"));
+/**
+ * Converts a notebook item into a 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
+ */
+function convertItemToTemplate(itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
+    // Delegate back to simple-types, which will in-turn delegate
+    // to convertNotebookToTemplate at the correct point in the process
+    // This is a temporary refactor step
+    return notebookHelpers.convertItemToTemplate(itemInfo, destAuthentication, srcAuthentication, templateDictionary);
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+// Delegate back to simple-types
+// This is a temporary refactor step
+function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    return notebookHelpers.createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback);
+}
+exports.createItemFromTemplate = createItemFromTemplate;
+/**
+ * Converts a Python Notebook item to a template.
+ *
+ * @param itemTemplate template for the Python Notebook
+ * @returns templatized itemTemplate
+ */
+function convertNotebookToTemplate(itemTemplate) {
+    // The templates data to process
+    const data = itemTemplate.data;
+    deleteProps(data);
+    let dataString = JSON.stringify(data);
+    const idTest = /[0-9A-F]{32}/gim;
+    if (data && idTest.test(dataString)) {
+        const ids = dataString.match(idTest);
+        const verifiedIds = [];
+        ids.forEach(id => {
+            if (verifiedIds.indexOf(id) === -1) {
+                verifiedIds.push(id);
+                // templatize the itemId--but only once per unique id
+                const regEx = new RegExp(id, "gm");
+                dataString = dataString.replace(regEx, "{{" + id + ".itemId}}");
+                // update the dependencies
+                if (itemTemplate.dependencies.indexOf(id) === -1) {
+                    itemTemplate.dependencies.push(id);
+                }
+            }
+        });
+        itemTemplate.data = JSON.parse(dataString);
+    }
+    return itemTemplate;
+}
+exports.convertNotebookToTemplate = convertNotebookToTemplate;
+/**
+ * Remove interpreter and papermill props
+ *
+ * This function will update the data passed in by removing key props
+ *
+ * @param data The notebooks data object
+ *
+ */
+function deleteProps(data) {
+    /* istanbul ignore else */
+    if (data) {
+        const props = ["metadata.interpreter", "metadata.papermill"];
+        common.deleteProps(data, props);
+        (data.cells || []).forEach((cell) => {
+            common.deleteProps(cell, props);
+        });
+    }
+}
+exports.deleteProps = deleteProps;
+/**
+ * Update the notebooks data
+ *
+ * @param originalTemplate The original template item
+ * @param newlyCreatedItem The current item that may have unswapped variables
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param authentication Credentials for the requests to the destination
+ *
+ * @returns A promise that will resolve once any updates have been made
+ */
+function fineTuneCreatedItem(originalTemplate, newlyCreatedItem, templateDictionary, authentication) {
+    return new Promise((resolve, reject) => {
+        const updateOptions = {
+            id: newlyCreatedItem.itemId,
+            url: newlyCreatedItem.item.url,
+            data: common.jsonToFile(newlyCreatedItem.data, newlyCreatedItem.itemId + ".ipynb")
+        };
+        common
+            .updateItem(updateOptions, authentication)
+            .then(() => resolve(null), reject);
+    });
+}
+exports.fineTuneCreatedItem = fineTuneCreatedItem;
+/**
+ * Notebook specific 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<any>}
+ */
+function postProcess(itemId, type, itemInfos, template, templates, templateDictionary, authentication) {
+    return common.updateItemTemplateFromDictionary(itemId, templateDictionary, authentication);
+}
+exports.postProcess = postProcess;
+//# sourceMappingURL=notebook.js.map

package/dist/cjs/notebook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notebook.js","sourceRoot":"","sources":["../../src/notebook.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH,sEAAgD;AAChD,+CAA+C;AAC/C,oFAA8D;AAE9D;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,QAAa,EACb,kBAAsC,EACtC,iBAAqC,EACrC,kBAAuB;IAEvB,6DAA6D;IAC7D,mEAAmE;IACnE,oCAAoC;IACpC,OAAO,eAAe,CAAC,qBAAqB,CAC1C,QAAQ,EACR,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAfD,sDAeC;AAED,gCAAgC;AAChC,oCAAoC;AACpC,SAAgB,sBAAsB,CACpC,QAA8B,EAC9B,kBAAuB,EACvB,yBAA6C,EAC7C,oBAAkD;IAElD,OAAO,eAAe,CAAC,sBAAsB,CAC3C,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,oBAAoB,CACrB,CAAC;AACJ,CAAC;AAZD,wDAYC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CACvC,YAAkC;IAElC,gCAAgC;IAChC,MAAM,IAAI,GAAQ,YAAY,CAAC,IAAI,CAAC;IACpC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClB,IAAI,UAAU,GAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAW,iBAAiB,CAAC;IAEzC,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QACnC,MAAM,GAAG,GAAa,UAAU,CAAC,KAAK,CAAC,MAAM,CAAa,CAAC;QAC3D,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACf,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE;gBAClC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAErB,qDAAqD;gBACrD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;gBACnC,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,GAAG,EAAE,GAAG,WAAW,CAAC,CAAC;gBAEhE,0BAA0B;gBAC1B,IAAI,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE;oBAChD,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;iBACpC;aACF;QACH,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;KAC5C;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA/BD,8DA+BC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,IAAQ;IAER,0BAA0B;IAC1B,IAAI,IAAI,EAAE;QACR,MAAM,KAAK,GAAa,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;QACvE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;YACvC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAXD,kCAWC;AAED;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CACjC,gBAAsC,EACtC,gBAAsC,EACtC,kBAAuB,EACvB,cAAkC;IAElC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,aAAa,GAAuB;YACxC,EAAE,EAAE,gBAAgB,CAAC,MAAM;YAC3B,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG;YAC9B,IAAI,EAAE,MAAM,CAAC,UAAU,CACrB,gBAAgB,CAAC,IAAI,EACrB,gBAAgB,CAAC,MAAM,GAAG,QAAQ,CACnC;SACF,CAAC;QACF,MAAM;aACH,UAAU,CAAC,aAAa,EAAE,cAAc,CAAC;aACzC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC;AAnBD,kDAmBC;AAED;;;;;;;;;GASG;AACH,SAAgB,WAAW,CACzB,MAAc,EACd,IAAY,EACZ,SAAgB,EAChB,QAA8B,EAC9B,SAAiC,EACjC,kBAAuB,EACvB,cAAkC;IAElC,OAAO,MAAM,CAAC,gCAAgC,CAC5C,MAAM,EACN,kBAAkB,EAClB,cAAc,CACf,CAAC;AACJ,CAAC;AAdD,kCAcC"}

package/dist/cjs/oic.d.ts

@@ -0,0 +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;

package/dist/cjs/oic.js

@@ -0,0 +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;
+//# sourceMappingURL=oic.js.map

package/dist/cjs/oic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oic.js","sourceRoot":"","sources":["../../src/oic.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH,sEAAgD;AAEhD,wHAAwH;AAExH;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,YAAkC,EAClC,kBAAsC,EACtC,iBAAqC;IAErC,OAAO,IAAI,OAAO,CAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3D,uBAAuB;QACvB,oBAAoB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC,IAAI,CACxD,CAAC,OAAY,EAAE,EAAE;YACf,YAAY,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;YAEjD,0EAA0E;YAC1E,0BAA0B;YAC1B,IAAI,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE;gBACjC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,sBAAsB,CAC9D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EACvC,OAAO,CAAC,OAAO,CAChB,CAAC;gBACF,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,GAAG,sBAAsB,CAC/D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EACxC,OAAO,CAAC,OAAO,CAChB,CAAC;aACH;YAED,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,CAAC,EACD,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAC5B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AA7BD,sDA6BC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,YAAkC,EAClC,cAAkC;IAElC,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,IAAI,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE;YACjC,MAAM,SAAS,GAAG,EAAE,CAAC;YACrB,0BAA0B;YAC1B,IAAI,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;gBAC3C,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;aACzD;YACD,0BAA0B;YAC1B,IACE,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW;gBACxC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW;oBACtC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EACzC;gBACA,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aAC1D;YACD,YAAY,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC,IAAI,CACxD,OAAO,CAAC,EAAE;gBACR,OAAO,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC,EACD,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAC5B,CAAC;SACH;aAAM;YACL,OAAO,CAAC;gBACN,YAAY,EAAE,YAAY;gBAC1B,OAAO,EAAE,EAAE;aACZ,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAjCD,oDAiCC;AAED;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAC1B,SAAmB,EACnB,YAAsB,EACtB,cAAkC;IAElC,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,MAAM,OAAO,GAAQ,EAAE,CAAC;QAExB,MAAM,OAAO,GAAQ;YACnB,CAAC,EAAE,MAAM;YACT,cAAc,EAAE,cAAc;SAC/B,CAAC;QACF,MAAM,aAAa,GAAwB,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAQ,EAAE,CAAC;QAC5B,MAAM,iBAAiB,GAAU,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC3D,IAAI,QAAQ,EAAE;gBACZ,MAAM,OAAO,GAAQ,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvD,MAAM,OAAO,GACX,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACxE,IAAI,OAAO,EAAE;oBACX,6DAA6D;oBAC7D,0BAA0B;oBAC1B,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;wBACjD,WAAW,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;qBAC/D;oBACD,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;oBACzC,OAAO,IAAI,CAAC;iBACb;qBAAM;oBACL,OAAO,KAAK,CAAC;iBACd;aACF;iBAAM;gBACL,OAAO,KAAK,CAAC;aACd;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAC7B,gBAAgB,CAAC,EAAE;gBACjB,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,CAAC,EAAE,EAAE;oBAC9C,0BAA0B;oBAC1B,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,eAAe,CAAC,EAAE;wBACpD,MAAM,EAAE,GAAW,eAAe,CAAC,aAAa,CAAC;wBACjD,0BAA0B;wBAC1B,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;4BAChC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;yBACvB;wBACD,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;qBACpC;gBACH,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC;oBACN,YAAY,EAAE,YAAY;oBAC1B,OAAO,EAAE,OAAO;iBACjB,CAAC,CAAC;YACL,CAAC,EACD,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAC5B,CAAC;SACH;aAAM;YACL,OAAO,CAAC;gBACN,YAAY,EAAE,YAAY;gBAC1B,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AA/DD,oCA+DC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,QAAgB,EAAE,OAAY;IACnE,IAAI,cAAc,GAAG,QAAQ,CAAC;IAC9B,IAAI,QAAQ,EAAE;QACZ,MAAM,EAAE,GAAQ,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,EAAE,EAAE;YACN,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/D,cAAc,GAAG,MAAM,CAAC,cAAc,CACpC,EAAE,EACF,EAAE,EACF,QAAQ,GAAG,OAAO,GAAG,MAAM,CAC5B,CAAC;SACH;QAED,qFAAqF;QACrF,cAAc,GAAG,MAAM,CAAC,aAAa,CACnC,cAAc,CAAC,OAAO,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAC7D,CAAC;KACH;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAnBD,wDAmBC"}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}