@esri/solution-hub-types 4.1.2-alpha.0 → 5.0.0

package/dist/esm/helpers/replace-item-ids.js

@@ -1,33 +1,33 @@
-/** @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 { cloneObject, deepStringReplace } from "@esri/hub-common";
-export function replaceItemIds(template) {
-    const clone = cloneObject(template);
-    const deps = template.dependencies || [];
-    // iterate the dependencies
-    deps.forEach(depId => {
-        const re = new RegExp(depId, "g");
-        const replacement = `{{${depId}.itemId}}`;
-        // we have to do this property-by-property or we would replace the `itemId` prop itself
-        clone.item = deepStringReplace(clone.item, re, replacement);
-        clone.data = deepStringReplace(clone.data, re, replacement);
-        if (template.properties) {
-            clone.properties = deepStringReplace(clone.properties, re, replacement);
-        }
-    });
-    return clone;
-}
+/** @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 { cloneObject, deepStringReplace } from "@esri/hub-common";
+export function replaceItemIds(template) {
+    const clone = cloneObject(template);
+    const deps = template.dependencies || [];
+    // iterate the dependencies
+    deps.forEach(depId => {
+        const re = new RegExp(depId, "g");
+        const replacement = `{{${depId}.itemId}}`;
+        // we have to do this property-by-property or we would replace the `itemId` prop itself
+        clone.item = deepStringReplace(clone.item, re, replacement);
+        clone.data = deepStringReplace(clone.data, re, replacement);
+        if (template.properties) {
+            clone.properties = deepStringReplace(clone.properties, re, replacement);
+        }
+    });
+    return clone;
+}
 //# sourceMappingURL=replace-item-ids.js.map

package/dist/esm/hub-page-processor.d.ts

@@ -1,63 +1,63 @@
-/** @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 Hub Page item types.
- *
- * @module hub-page-processor
- */
-import { IItemTemplate, IItemProgressCallback, ICreateItemFromTemplateResponse, UserSession } from "@esri/solution-common";
-/**
- * Converts a Hub Page 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 (placeholder--not used)
- * @returns A promise that will resolve when the template has been created
- */
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication?: UserSession): Promise<IItemTemplate>;
-/**
- * Handle deployment of Page item templates
- *
- * @export
- * @param {IItemTemplate} template
- * @param {*} templateDictionary
- * @param {UserSession} destinationAuthentication
- * @param {IItemProgressCallback} itemProgressCallback
- * @returns {Promise<ICreateItemFromTemplateResponse>}
- */
-export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
-/**
- * Post-Process a Page
- * Re-interpolate the page item + data w/ the full template dictionary hash
- *
- * @param id
- * @param type
- * @param itemInfos
- * @param template
- * @param templates
- * @param templateDictionary
- * @param authentication
- */
-export declare function postProcess(id: string, type: string, itemInfos: any[], template: any, templates: IItemTemplate[], templateDictionary: any, authentication: UserSession): Promise<boolean>;
-/**
- * Check of an item type is a Page
- * Hub Page is for ArcGIS Online
- * Site Page is for ArcGIS Enterprise
- *
- * @param itemType
- */
-export declare function isAPage(itemType: string): boolean;
+/** @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 Hub Page item types.
+ *
+ * @module hub-page-processor
+ */
+import { IItemTemplate, IItemProgressCallback, ICreateItemFromTemplateResponse, UserSession } from "@esri/solution-common";
+/**
+ * Converts a Hub Page 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 (placeholder--not used)
+ * @returns A promise that will resolve when the template has been created
+ */
+export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication?: UserSession): Promise<IItemTemplate>;
+/**
+ * Handle deployment of Page item templates
+ *
+ * @export
+ * @param {IItemTemplate} template
+ * @param {*} templateDictionary
+ * @param {UserSession} destinationAuthentication
+ * @param {IItemProgressCallback} itemProgressCallback
+ * @returns {Promise<ICreateItemFromTemplateResponse>}
+ */
+export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
+/**
+ * Post-Process a Page
+ * Re-interpolate the page item + data w/ the full template dictionary hash
+ *
+ * @param id
+ * @param type
+ * @param itemInfos
+ * @param template
+ * @param templates
+ * @param templateDictionary
+ * @param authentication
+ */
+export declare function postProcess(id: string, type: string, itemInfos: any[], template: any, templates: IItemTemplate[], templateDictionary: any, authentication: UserSession): Promise<boolean>;
+/**
+ * Check of an item type is a Page
+ * Hub Page is for ArcGIS Online
+ * Site Page is for ArcGIS Enterprise
+ *
+ * @param itemType
+ */
+export declare function isAPage(itemType: string): boolean;

package/dist/esm/hub-page-processor.js

@@ -1,221 +1,221 @@
-/** @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 Hub Page item types.
- *
- * @module hub-page-processor
- */
-import { EItemProgressStatus, convertIModel, createHubRequestOptions, generateEmptyCreationResponse } from "@esri/solution-common";
-import { updateItem } from "@esri/arcgis-rest-portal";
-import { failSafe, getModel, getProp, without } from "@esri/hub-common";
-import { createPageModelFromTemplate, createPage, removePage, convertPageToTemplate } from "@esri/hub-sites";
-import { _postProcessPage } from "./helpers/_post-process-page";
-import { replaceItemIds } from "./helpers/replace-item-ids";
-import { moveModelToFolder } from "./helpers/move-model-to-folder";
-/**
- * Converts a Hub Page 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 (placeholder--not used)
- * @returns A promise that will resolve when the template has been created
- */
-export function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication = null // eslint-disable-line @typescript-eslint/no-unused-vars
-) {
-    let created = 0;
-    let modified = 0;
-    // get the page model and hubRequestOptions
-    return Promise.all([
-        getModel(itemInfo.id, { authentication: destAuthentication }),
-        createHubRequestOptions(destAuthentication)
-    ])
-        .then(([pageModel, ro]) => {
-        // We need to save these properties in order to restore them after hub.js deletes them
-        created = pageModel.item.created;
-        modified = pageModel.item.modified;
-        return convertPageToTemplate(pageModel, ro);
-    })
-        .then(tmpl => {
-        // add in some stuff Hub.js does not yet add
-        tmpl.item.created = created;
-        tmpl.item.modified = modified;
-        tmpl.item.typeKeywords = without(tmpl.item.typeKeywords, "doNotDelete");
-        tmpl.groups = [];
-        tmpl.estimatedDeploymentCostFactor = 2;
-        tmpl.resources = [];
-        if (!getProp(tmpl, "properties")) {
-            tmpl.properties = {};
-        }
-        // swap out dependency id's to {{<depid>.itemId}}
-        // so it will be re-interpolated
-        tmpl = replaceItemIds(tmpl);
-        // and return it
-        return tmpl;
-    });
-}
-/**
- * Handle deployment of Page item templates
- *
- * @export
- * @param {IItemTemplate} template
- * @param {*} templateDictionary
- * @param {UserSession} destinationAuthentication
- * @param {IItemProgressCallback} itemProgressCallback
- * @returns {Promise<ICreateItemFromTemplateResponse>}
- */
-export function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    // let the progress system know we've started...
-    const startStatus = itemProgressCallback(template.itemId, EItemProgressStatus.Started, 0);
-    // and if it returned false, just resolve out
-    if (!startStatus) {
-        return Promise.resolve(generateEmptyCreationResponse(template.type));
-    }
-    // TODO: Reassess with resource unification
-    if (template.assets && template.resources) {
-        delete template.assets;
-    }
-    // solutionItemExtent is in geographic, but it's a string, and we want/need a bbox
-    // and Hub templates expect it in organization.defaultExtentBBox
-    if (templateDictionary.solutionItemExtent) {
-        const parts = templateDictionary.solutionItemExtent.split(",");
-        templateDictionary.organization.defaultExtentBBox = [
-            [parts[0], parts[1]],
-            [parts[2], parts[3]]
-        ];
-    }
-    // TODO: Determine if we need any transforms in this new env
-    const transforms = {};
-    // create an object to hold the created site through
-    // subsequent promise calls
-    let pageModel;
-    let hubRo;
-    const thumbnail = template.item.thumbnail; // createPageModelFromTemplate trashes thumbnail
-    return createHubRequestOptions(destinationAuthentication, templateDictionary)
-        .then(ro => {
-        hubRo = ro;
-        return createPageModelFromTemplate(template, templateDictionary, transforms, hubRo);
-    })
-        .then((interpolated) => {
-        // --------------------------------------------
-        // TODO: Update hub.js to take an IModel in createPage
-        // then remove this silliness
-        const modelTmpl = interpolated;
-        const options = {
-            assets: modelTmpl.assets || []
-        };
-        // --------------------------------------------
-        return createPage(modelTmpl, options, hubRo);
-    })
-        .then(page => {
-        pageModel = page;
-        // Move the site and initiative to the solution folder
-        // this is essentially fire and forget. We fail-safe the actual moveItem
-        // call since it's not critical to the outcome
-        return moveModelToFolder(page, templateDictionary.folderId, destinationAuthentication);
-    })
-        .then(() => {
-        // Fix the thumbnail
-        const updateOptions = {
-            item: {
-                id: pageModel.item.id
-            },
-            params: {
-                // Pass thumbnail in via params because item property is serialized, which discards a blob
-                thumbnail
-            },
-            authentication: destinationAuthentication
-        };
-        return updateItem(updateOptions);
-    })
-        .then(() => {
-        // Update the template dictionary
-        // TODO: This should be done in whatever recieves
-        // the outcome of this promise chain
-        templateDictionary[template.itemId] = {
-            itemId: pageModel.item.id
-        };
-        // call the progress callback, which also mutates templateDictionary
-        const finalStatus = itemProgressCallback(template.itemId, EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, pageModel.item.id);
-        if (!finalStatus) {
-            // clean up the site we just created
-            const failSafeRemove = failSafe(removePage, { success: true });
-            return failSafeRemove(pageModel, hubRo).then(() => {
-                return Promise.resolve(generateEmptyCreationResponse(template.type));
-            });
-        }
-        else {
-            // finally, return ICreateItemFromTemplateResponse
-            const response = {
-                item: {
-                    ...template,
-                    ...convertIModel(pageModel)
-                },
-                id: pageModel.item.id,
-                type: template.type,
-                postProcess: true
-            };
-            response.item.itemId = pageModel.item.id;
-            return response;
-        }
-    })
-        .catch(ex => {
-        itemProgressCallback(template.itemId, EItemProgressStatus.Failed, 0);
-        throw ex;
-    });
-}
-/**
- * Post-Process a Page
- * Re-interpolate the page item + data w/ the full template dictionary hash
- *
- * @param id
- * @param type
- * @param itemInfos
- * @param template
- * @param templates
- * @param templateDictionary
- * @param authentication
- */
-export function postProcess(id, type, itemInfos, template, templates, templateDictionary, authentication) {
-    // create the requestOptions
-    let hubRo;
-    // get hubRequestOptions
-    return createHubRequestOptions(authentication)
-        .then(ro => {
-        hubRo = ro;
-        // get the site model
-        return getModel(id, { authentication });
-    })
-        .then(pageModel => {
-        // post process the page
-        return _postProcessPage(pageModel, itemInfos, templateDictionary, hubRo);
-    });
-}
-/**
- * Check of an item type is a Page
- * Hub Page is for ArcGIS Online
- * Site Page is for ArcGIS Enterprise
- *
- * @param itemType
- */
-export function isAPage(itemType) {
-    let result = false;
-    if (itemType === "Hub Page" || itemType === "Site Page") {
-        result = true;
-    }
-    return result;
-}
+/** @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 Hub Page item types.
+ *
+ * @module hub-page-processor
+ */
+import { EItemProgressStatus, convertIModel, createHubRequestOptions, generateEmptyCreationResponse } from "@esri/solution-common";
+import { updateItem } from "@esri/arcgis-rest-portal";
+import { failSafe, getModel, getProp, without } from "@esri/hub-common";
+import { createPageModelFromTemplate, createPage, removePage, convertPageToTemplate } from "@esri/hub-sites";
+import { _postProcessPage } from "./helpers/_post-process-page";
+import { replaceItemIds } from "./helpers/replace-item-ids";
+import { moveModelToFolder } from "./helpers/move-model-to-folder";
+/**
+ * Converts a Hub Page 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 (placeholder--not used)
+ * @returns A promise that will resolve when the template has been created
+ */
+export function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication = null // eslint-disable-line @typescript-eslint/no-unused-vars
+) {
+    let created = 0;
+    let modified = 0;
+    // get the page model and hubRequestOptions
+    return Promise.all([
+        getModel(itemInfo.id, { authentication: destAuthentication }),
+        createHubRequestOptions(destAuthentication)
+    ])
+        .then(([pageModel, ro]) => {
+        // We need to save these properties in order to restore them after hub.js deletes them
+        created = pageModel.item.created;
+        modified = pageModel.item.modified;
+        return convertPageToTemplate(pageModel, ro);
+    })
+        .then(tmpl => {
+        // add in some stuff Hub.js does not yet add
+        tmpl.item.created = created;
+        tmpl.item.modified = modified;
+        tmpl.item.typeKeywords = without(tmpl.item.typeKeywords, "doNotDelete");
+        tmpl.groups = [];
+        tmpl.estimatedDeploymentCostFactor = 2;
+        tmpl.resources = [];
+        if (!getProp(tmpl, "properties")) {
+            tmpl.properties = {};
+        }
+        // swap out dependency id's to {{<depid>.itemId}}
+        // so it will be re-interpolated
+        tmpl = replaceItemIds(tmpl);
+        // and return it
+        return tmpl;
+    });
+}
+/**
+ * Handle deployment of Page item templates
+ *
+ * @export
+ * @param {IItemTemplate} template
+ * @param {*} templateDictionary
+ * @param {UserSession} destinationAuthentication
+ * @param {IItemProgressCallback} itemProgressCallback
+ * @returns {Promise<ICreateItemFromTemplateResponse>}
+ */
+export function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    // let the progress system know we've started...
+    const startStatus = itemProgressCallback(template.itemId, EItemProgressStatus.Started, 0);
+    // and if it returned false, just resolve out
+    if (!startStatus) {
+        return Promise.resolve(generateEmptyCreationResponse(template.type));
+    }
+    // TODO: Reassess with resource unification
+    if (template.assets && template.resources) {
+        delete template.assets;
+    }
+    // solutionItemExtent is in geographic, but it's a string, and we want/need a bbox
+    // and Hub templates expect it in organization.defaultExtentBBox
+    if (templateDictionary.solutionItemExtent) {
+        const parts = templateDictionary.solutionItemExtent.split(",");
+        templateDictionary.organization.defaultExtentBBox = [
+            [parts[0], parts[1]],
+            [parts[2], parts[3]]
+        ];
+    }
+    // TODO: Determine if we need any transforms in this new env
+    const transforms = {};
+    // create an object to hold the created site through
+    // subsequent promise calls
+    let pageModel;
+    let hubRo;
+    const thumbnail = template.item.thumbnail; // createPageModelFromTemplate trashes thumbnail
+    return createHubRequestOptions(destinationAuthentication, templateDictionary)
+        .then(ro => {
+        hubRo = ro;
+        return createPageModelFromTemplate(template, templateDictionary, transforms, hubRo);
+    })
+        .then((interpolated) => {
+        // --------------------------------------------
+        // TODO: Update hub.js to take an IModel in createPage
+        // then remove this silliness
+        const modelTmpl = interpolated;
+        const options = {
+            assets: modelTmpl.assets || []
+        };
+        // --------------------------------------------
+        return createPage(modelTmpl, options, hubRo);
+    })
+        .then(page => {
+        pageModel = page;
+        // Move the site and initiative to the solution folder
+        // this is essentially fire and forget. We fail-safe the actual moveItem
+        // call since it's not critical to the outcome
+        return moveModelToFolder(page, templateDictionary.folderId, destinationAuthentication);
+    })
+        .then(() => {
+        // Fix the thumbnail
+        const updateOptions = {
+            item: {
+                id: pageModel.item.id
+            },
+            params: {
+                // Pass thumbnail in via params because item property is serialized, which discards a blob
+                thumbnail
+            },
+            authentication: destinationAuthentication
+        };
+        return updateItem(updateOptions);
+    })
+        .then(() => {
+        // Update the template dictionary
+        // TODO: This should be done in whatever recieves
+        // the outcome of this promise chain
+        templateDictionary[template.itemId] = {
+            itemId: pageModel.item.id
+        };
+        // call the progress callback, which also mutates templateDictionary
+        const finalStatus = itemProgressCallback(template.itemId, EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, pageModel.item.id);
+        if (!finalStatus) {
+            // clean up the site we just created
+            const failSafeRemove = failSafe(removePage, { success: true });
+            return failSafeRemove(pageModel, hubRo).then(() => {
+                return Promise.resolve(generateEmptyCreationResponse(template.type));
+            });
+        }
+        else {
+            // finally, return ICreateItemFromTemplateResponse
+            const response = {
+                item: {
+                    ...template,
+                    ...convertIModel(pageModel)
+                },
+                id: pageModel.item.id,
+                type: template.type,
+                postProcess: true
+            };
+            response.item.itemId = pageModel.item.id;
+            return response;
+        }
+    })
+        .catch(ex => {
+        itemProgressCallback(template.itemId, EItemProgressStatus.Failed, 0);
+        throw ex;
+    });
+}
+/**
+ * Post-Process a Page
+ * Re-interpolate the page item + data w/ the full template dictionary hash
+ *
+ * @param id
+ * @param type
+ * @param itemInfos
+ * @param template
+ * @param templates
+ * @param templateDictionary
+ * @param authentication
+ */
+export function postProcess(id, type, itemInfos, template, templates, templateDictionary, authentication) {
+    // create the requestOptions
+    let hubRo;
+    // get hubRequestOptions
+    return createHubRequestOptions(authentication)
+        .then(ro => {
+        hubRo = ro;
+        // get the site model
+        return getModel(id, { authentication });
+    })
+        .then(pageModel => {
+        // post process the page
+        return _postProcessPage(pageModel, itemInfos, templateDictionary, hubRo);
+    });
+}
+/**
+ * Check of an item type is a Page
+ * Hub Page is for ArcGIS Online
+ * Site Page is for ArcGIS Enterprise
+ *
+ * @param itemType
+ */
+export function isAPage(itemType) {
+    let result = false;
+    if (itemType === "Hub Page" || itemType === "Site Page") {
+        result = true;
+    }
+    return result;
+}
 //# sourceMappingURL=hub-page-processor.js.map