@esri/solution-hub-types 6.0.4-alpha.0 → 6.1.0-alpha.0

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

@@ -1,228 +0,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.
- */
-/**
- * Manages the creation and deployment of Hub Site item types.
- *
- * @module hub-site-processor
- */
-import { EItemProgressStatus, convertIModel, createHubRequestOptions, dedupe, generateEmptyCreationResponse, getProp, restUpdateItem, } from "@esri/solution-common";
-import { createSiteModelFromTemplate, createSite, getSiteById, removeSite, convertSiteToTemplate, } from "@esri/hub-sites";
-import { failSafe, without } from "@esri/hub-common";
-import { moveModelToFolder } from "./helpers/move-model-to-folder";
-import { _postProcessSite } from "./helpers/_post-process-site";
-import { replaceItemIds } from "./helpers/replace-item-ids";
-/**
- * Converts a Site 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 (placeholder--not used)
- * @returns A promise that will resolve when the template has been created
- */
-export function convertItemToTemplate(itemInfo, destAuthentication, srcAuthentication = null) {
-    let created = 0;
-    let modified = 0;
-    let itemTitle;
-    let dataTitle;
-    let hubRo;
-    // get hubRequestOptions
-    return createHubRequestOptions(destAuthentication)
-        .then((ro) => {
-        hubRo = ro;
-        return getSiteById(itemInfo.id, hubRo);
-    })
-        .then((siteModel) => {
-        // We need to save these properties in order to restore them after hub.js deletes them
-        created = siteModel.item.created;
-        modified = siteModel.item.modified;
-        itemTitle = siteModel.item.title;
-        dataTitle = siteModel.data.values.title;
-        return convertSiteToTemplate(siteModel, hubRo);
-    })
-        .then((tmpl) => {
-        // add in some stuff Hub.js does not yet add
-        tmpl.item.created = created;
-        tmpl.item.modified = modified;
-        tmpl.item.title = itemTitle;
-        tmpl.item.typeKeywords = without(tmpl.item.typeKeywords, "doNotDelete");
-        tmpl.data.values.title = dataTitle;
-        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.dependencies = dedupe(tmpl.dependencies);
-        tmpl = replaceItemIds(tmpl);
-        // and return it
-        return tmpl;
-    });
-}
-/**
- * Handle deployment of Site 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);
-    // 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;
-    }
-    // ensure we have a solution object in the templateDictionary hash
-    if (!templateDictionary.solution) {
-        templateDictionary.solution = {};
-    }
-    // .title should always be set on the templateDictionary
-    templateDictionary.solution.title = templateDictionary.title;
-    // 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 siteModel;
-    // Create the "siteModel" from the template. Does not save the site item yet
-    // Note: depending on licensing and user privs, will also create the team groups
-    // and initiative item.
-    let hubRo;
-    const thumbnail = template.item.thumbnail; // createSiteModelFromTemplate trashes thumbnail
-    return createHubRequestOptions(destinationAuthentication, templateDictionary)
-        .then((ro) => {
-        hubRo = ro;
-        return createSiteModelFromTemplate(template, templateDictionary, transforms, hubRo);
-    })
-        .then((interpolated) => {
-        const options = {
-            assets: interpolated.assets || [],
-        };
-        // Now create the item, register for oAuth, register domain etc
-        return createSite(interpolated, options, hubRo);
-    })
-        .then((site) => {
-        // hold onto the site
-        siteModel = site;
-        // 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(site, templateDictionary.folderId, destinationAuthentication);
-    })
-        .then(() => {
-        // Fix the thumbnail
-        const updateOptions = {
-            item: {
-                id: siteModel.item.id,
-            },
-            params: {
-                // Pass thumbnail in via params because item property is serialized, which discards a blob
-                thumbnail,
-            },
-            authentication: destinationAuthentication,
-        };
-        return restUpdateItem(updateOptions);
-    })
-        .then(() => {
-        // Update the template dictionary
-        // TODO: This should be done in whatever recieves
-        // the outcome of this promise chain
-        templateDictionary[template.itemId] = {
-            itemId: siteModel.item.id,
-        };
-        // call the progress callback, which also mutates templateDictionary
-        const finalStatus = itemProgressCallback(template.itemId, EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, siteModel.item.id);
-        if (!finalStatus) {
-            // clean up the site we just created
-            const failSafeRemove = failSafe(removeSite, { success: true });
-            return failSafeRemove(siteModel, hubRo).then(() => {
-                return Promise.resolve(generateEmptyCreationResponse(template.type));
-            });
-        }
-        else {
-            // finally, return ICreateItemFromTemplateResponse
-            const response = {
-                item: {
-                    ...template,
-                    ...convertIModel(siteModel),
-                },
-                id: siteModel.item.id,
-                type: template.type,
-                postProcess: true,
-            };
-            response.item.itemId = siteModel.item.id;
-            return response;
-        }
-    })
-        .catch((ex) => {
-        itemProgressCallback(template.itemId, EItemProgressStatus.Failed, 0);
-        throw ex;
-    });
-}
-/**
- * Deployer life-cycle hook allowing the Site Processor
- * a chance to apply final processes to all the items that
- * were created as part of the solution.
- * Specifically this will:
- * - share all items to the content team, and (if created)
- *   the core team (depends on user privs)
- * - link all Page items that were created, to the Site
- *
- * @param model
- * @param items
- * @param authentication
- * @param templateDictionary
- */
-export function postProcess(id, type, itemInfos, template, templates, templateDictionary, authentication) {
-    let hubRo;
-    return createHubRequestOptions(authentication, templateDictionary)
-        .then((ro) => {
-        hubRo = ro;
-        // get the site model
-        return getSiteById(id, hubRo);
-    })
-        .then((siteModel) => {
-        // Hub.js does not expect the same structures, so we delegat to a local fn
-        return _postProcessSite(siteModel, itemInfos, templateDictionary, hubRo);
-    })
-        .then(() => {
-        // resolve w/ a boolean
-        return Promise.resolve(true);
-    });
-}
-/**
- * Check of an item type is a Site
- * Hub Site Application is for ArcGIS Online
- * Site Application is for ArcGIS Enterprise
- *
- * @param itemType
- */
-export function isASite(itemType) {
-    let result = false;
-    if (itemType === "Hub Site Application" || itemType === "Site Application") {
-        result = true;
-    }
-    return result;
-}
-//# sourceMappingURL=hub-site-processor.js.map

package/dist/esm/hub-site-processor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hub-site-processor.js","sourceRoot":"","sources":["../../src/hub-site-processor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;GAIG;AAEH,OAAO,EAKL,mBAAmB,EAEnB,aAAa,EACb,uBAAuB,EACvB,MAAM,EACN,6BAA6B,EAC7B,OAAO,EACP,cAAc,GACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,2BAA2B,EAC3B,UAAU,EACV,WAAW,EACX,UAAU,EACV,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAU,QAAQ,EAA0B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAErF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE5D;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAa,EACb,kBAA+B,EAC/B,oBAAiC,IAAI;IAErC,IAAI,OAAO,GAAW,CAAC,CAAC;IACxB,IAAI,QAAQ,GAAW,CAAC,CAAC;IACzB,IAAI,SAAiB,CAAC;IACtB,IAAI,SAAiB,CAAC;IAEtB,IAAI,KAA6B,CAAC;IAClC,wBAAwB;IACxB,OAAO,uBAAuB,CAAC,kBAAkB,CAAC;SAC/C,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;QACX,KAAK,GAAG,EAAE,CAAC;QACX,OAAO,WAAW,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QAClB,sFAAsF;QACtF,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC;QACjC,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;QACnC,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;QACjC,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QACxC,OAAO,qBAAqB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,4CAA4C;QAC5C,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QACxE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,6BAA6B,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE;YAChC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;SACtB;QACD,iDAAiD;QACjD,gCAAgC;QAChC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9C,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAE5B,gBAAgB;QAChB,OAAO,IAAqB,CAAC;IAC/B,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAuB,EACvB,kBAAuB,EACvB,yBAAsC,EACtC,oBAA2C;IAE3C,gDAAgD;IAChD,MAAM,WAAW,GAAG,oBAAoB,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAC1F,yCAAyC;IACzC,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,OAAO,CAAC,OAAO,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;KACtE;IAED,2CAA2C;IAC3C,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;QACzC,OAAO,QAAQ,CAAC,MAAM,CAAC;KACxB;IAED,kEAAkE;IAClE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE;QAChC,kBAAkB,CAAC,QAAQ,GAAG,EAAE,CAAC;KAClC;IACD,wDAAwD;IACxD,kBAAkB,CAAC,QAAQ,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC;IAE7D,4DAA4D;IAC5D,MAAM,UAAU,GAAG,EAAE,CAAC;IAEtB,oDAAoD;IACpD,2BAA2B;IAC3B,IAAI,SAAiB,CAAC;IAEtB,4EAA4E;IAC5E,gFAAgF;IAChF,uBAAuB;IACvB,IAAI,KAA6B,CAAC;IAClC,MAAM,SAAS,GAAS,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,gDAAgD;IACjG,OAAO,uBAAuB,CAAC,yBAAyB,EAAE,kBAAkB,CAAC;SAC1E,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;QACX,KAAK,GAAG,EAAE,CAAC;QACX,OAAO,2BAA2B,CAAC,QAAQ,EAAE,kBAAkB,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACtF,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;QACrB,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE;SAClC,CAAC;QACF,+DAA+D;QAC/D,OAAO,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,qBAAqB;QACrB,SAAS,GAAG,IAAI,CAAC;QACjB,sDAAsD;QACtD,wEAAwE;QACxE,8CAA8C;QAC9C,OAAO,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;IACzF,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,EAAE;QACT,oBAAoB;QACpB,MAAM,aAAa,GAAuB;YACxC,IAAI,EAAE;gBACJ,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE;aACtB;YACD,MAAM,EAAE;gBACN,0FAA0F;gBAC1F,SAAS;aACV;YACD,cAAc,EAAE,yBAAyB;SAC1C,CAAC;QACF,OAAO,cAAc,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,EAAE;QACT,iCAAiC;QACjC,iDAAiD;QACjD,oCAAoC;QACpC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG;YACpC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE;SAC1B,CAAC;QACF,oEAAoE;QACpE,MAAM,WAAW,GAAG,oBAAoB,CACtC,QAAQ,CAAC,MAAM,EACf,mBAAmB,CAAC,QAAQ,EAC5B,QAAQ,CAAC,6BAA6B,IAAI,CAAC,EAC3C,SAAS,CAAC,IAAI,CAAC,EAAE,CAClB,CAAC;QACF,IAAI,CAAC,WAAW,EAAE;YAChB,oCAAoC;YACpC,MAAM,cAAc,GAAG,QAAQ,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAC/D,OAAO,cAAc,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAChD,OAAO,OAAO,CAAC,OAAO,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACvE,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,kDAAkD;YAClD,MAAM,QAAQ,GAAoC;gBAChD,IAAI,EAAE;oBACJ,GAAG,QAAQ;oBACX,GAAG,aAAa,CAAC,SAAS,CAAC;iBAC5B;gBACD,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE;gBACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,WAAW,EAAE,IAAI;aAClB,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE;QACZ,oBAAoB,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACrE,MAAM,EAAE,CAAC;IACX,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CACzB,EAAU,EACV,IAAY,EACZ,SAAgB,EAChB,QAAa,EACb,SAA0B,EAC1B,kBAAuB,EACvB,cAA2B;IAE3B,IAAI,KAA6B,CAAC;IAClC,OAAO,uBAAuB,CAAC,cAAc,EAAE,kBAAkB,CAAC;SAC/D,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;QACX,KAAK,GAAG,EAAE,CAAC;QACX,qBAAqB;QACrB,OAAO,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QAClB,0EAA0E;QAC1E,OAAO,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;IAC3E,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,EAAE;QACT,uBAAuB;QACvB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,QAAgB;IACtC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,QAAQ,KAAK,sBAAsB,IAAI,QAAQ,KAAK,kBAAkB,EAAE;QAC1E,MAAM,GAAG,IAAI,CAAC;KACf;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/esm/index.d.ts

@@ -1,23 +0,0 @@
-/** @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 Site and Page item types.
- *
- * @module hubTypes
- */
-import * as HubPageProcessor from "./hub-page-processor";
-import * as HubSiteProcessor from "./hub-site-processor";
-export { HubPageProcessor, HubSiteProcessor };

package/dist/esm/index.js

@@ -1,25 +0,0 @@
-/** @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 Site and Page item types.
- *
- * @module hubTypes
- */
-import * as HubPageProcessor from "./hub-page-processor";
-import * as HubSiteProcessor from "./hub-site-processor";
-// Re-export as modules
-export { HubPageProcessor, HubSiteProcessor };
-//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;GAIG;AAEH,OAAO,KAAK,gBAAgB,MAAM,sBAAsB,CAAC;AACzD,OAAO,KAAK,gBAAgB,MAAM,sBAAsB,CAAC;AACzD,uBAAuB;AACvB,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC"}