@esri/solution-hub-types 3.0.1 → 4.0.0-alpha.0

package/dist/umd/hub-types.umd.js

@@ -1,653 +0,0 @@
-/* @preserve
-* @esri/solution-hub-types - v1.7.0 - Apache-2.0
-* Copyright (c) 2018-2023 Esri, Inc.
-* Fri Apr 28 2023 11:21:40 GMT-0700 (Pacific Daylight Time)
-*
-* 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.
-*/
-(function (global, factory) {
-  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@esri/solution-common'), require('@esri/arcgis-rest-portal'), require('@esri/hub-common'), require('@esri/hub-sites')) :
-  typeof define === 'function' && define.amd ? define(['exports', '@esri/solution-common', '@esri/arcgis-rest-portal', '@esri/hub-common', '@esri/hub-sites'], factory) :
-  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.arcgisSolution = global.arcgisSolution || {}, global.arcgisSolution, global.arcgisRest, global.arcgisHub, global.arcgisHub));
-})(this, (function (exports, solutionCommon, arcgisRestPortal, hubCommon, hubSites) { '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.
-   */
-  //???
-  function _postProcessPage(pageModel, itemInfos, templateDictionary, hubRequestOptions) {
-      // re-interpolate the siteModel using the itemInfos; no patches supplied
-      pageModel = hubCommon.interpolate(pageModel, templateDictionary, {});
-      return hubSites.updatePage(pageModel, {
-          ...hubRequestOptions,
-          allowList: []
-      }).then(() => {
-          return true;
-      });
-  }
-
-  /** @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.
-   */
-  function replaceItemIds(template) {
-      const clone = hubCommon.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 = hubCommon.deepStringReplace(clone.item, re, replacement);
-          clone.data = hubCommon.deepStringReplace(clone.data, re, replacement);
-          if (template.properties) {
-              clone.properties = hubCommon.deepStringReplace(clone.properties, re, replacement);
-          }
-      });
-      return clone;
-  }
-
-  /** @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.
-   */
-  /**
-   * Move the created site item, and optionally the Initiative, into
-   * the solution folder
-   *
-   * @param siteModel
-   * @param folderId
-   * @param authentication
-   */
-  function moveModelToFolder(siteModel, folderId, authentication) {
-      // Fail-Safe the move call as it's not critical if it fails
-      const failSafeMove = hubCommon.failSafe(arcgisRestPortal.moveItem, { success: true });
-      const movePromises = [
-          failSafeMove({
-              itemId: siteModel.item.id,
-              folderId,
-              authentication
-          })
-      ];
-      // if an initiative was created...
-      if (hubCommon.getProp(siteModel, "item.properties.parentInitiativeId")) {
-          movePromises.push(failSafeMove({
-              itemId: siteModel.item.properties.parentInitiativeId,
-              folderId,
-              authentication
-          }));
-      }
-      return Promise.all(movePromises);
-  }
-
-  /** @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.
-   */
-  /**
-   * 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
-   */
-  function convertItemToTemplate$1(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([
-          hubCommon.getModel(itemInfo.id, { authentication: destAuthentication }),
-          solutionCommon.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 hubSites.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 = hubCommon.without(tmpl.item.typeKeywords, "doNotDelete");
-          tmpl.groups = [];
-          tmpl.estimatedDeploymentCostFactor = 2;
-          tmpl.resources = [];
-          if (!hubCommon.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>}
-   */
-  function createItemFromTemplate$1(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-      // let the progress system know we've started...
-      const startStatus = itemProgressCallback(template.itemId, solutionCommon.EItemProgressStatus.Started, 0);
-      // and if it returned false, just resolve out
-      if (!startStatus) {
-          return Promise.resolve(solutionCommon.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 solutionCommon.createHubRequestOptions(destinationAuthentication, templateDictionary)
-          .then(ro => {
-          hubRo = ro;
-          return hubSites.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 hubSites.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 arcgisRestPortal.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, solutionCommon.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, pageModel.item.id);
-          if (!finalStatus) {
-              // clean up the site we just created
-              const failSafeRemove = hubCommon.failSafe(hubSites.removePage, { success: true });
-              return failSafeRemove(pageModel, hubRo).then(() => {
-                  return Promise.resolve(solutionCommon.generateEmptyCreationResponse(template.type));
-              });
-          }
-          else {
-              // finally, return ICreateItemFromTemplateResponse
-              const response = {
-                  item: {
-                      ...template,
-                      ...pageModel
-                  },
-                  id: pageModel.item.id,
-                  type: template.type,
-                  postProcess: true
-              };
-              response.item.itemId = pageModel.item.id;
-              return response;
-          }
-      })
-          .catch(ex => {
-          itemProgressCallback(template.itemId, solutionCommon.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
-   */
-  function postProcess$1(id, type, itemInfos, template, templates, templateDictionary, authentication) {
-      // create the requestOptions
-      let hubRo;
-      // get hubRequestOptions
-      return solutionCommon.createHubRequestOptions(authentication)
-          .then(ro => {
-          hubRo = ro;
-          // get the site model
-          return hubCommon.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
-   */
-  function isAPage(itemType) {
-      let result = false;
-      if (itemType === "Hub Page" || itemType === "Site Page") {
-          result = true;
-      }
-      return result;
-  }
-
-  var hubPageProcessor = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    convertItemToTemplate: convertItemToTemplate$1,
-    createItemFromTemplate: createItemFromTemplate$1,
-    postProcess: postProcess$1,
-    isAPage: isAPage
-  });
-
-  /** @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.
-   */
-  /**
-   *
-   * @param siteModel
-   * @param itemInfos
-   * @param hubRequestOptions
-   * @private
-   */
-  function _updateSitePages(siteModel, itemInfos, hubRequestOptions) {
-      const pageIds = itemInfos
-          .filter(e => {
-          return e.type.indexOf("Page") > -1;
-      })
-          .map(e => e.id);
-      // now get all those models
-      return Promise.all(pageIds.map(id => {
-          return hubCommon.getModel(id, hubRequestOptions);
-      })).then((pageModels) => {
-          // now delegate back to hub.js internal _updatePages fn
-          return hubSites._updatePages(siteModel, pageModels, hubRequestOptions);
-      });
-  }
-
-  /**
-   * Post Process a Site
-   * - share all items to the Hub teams created as part of the site
-   * - link any created page to the site item
-   * - re-interpolate any remaining item ids that were not direct deps of the site
-   *
-   * @param siteModel
-   * @param itemInfos
-   * @param templateDictionary
-   * @param hubRequestOptions
-   * @private
-   */
-  function _postProcessSite(siteModel, itemInfos, templateDictionary, hubRequestOptions) {
-      const infosWithoutSite = itemInfos.filter(info => info.id !== siteModel.item.id);
-      // convert the itemInfo's into things that look enough like a model
-      // that we can call shareItemsToSiteGroups
-      const pseudoModels = infosWithoutSite.map(e => {
-          return {
-              item: {
-                  id: e.id,
-                  type: e.type
-              }
-          };
-      });
-      let secondPassPromises = [];
-      secondPassPromises = secondPassPromises.concat(hubSites.shareItemsToSiteGroups(siteModel, pseudoModels, hubRequestOptions));
-      // we can't use that same trick w/ the page sharing
-      // because we really need the models themselves
-      // so we delegate to a local function
-      secondPassPromises = secondPassPromises.concat(_updateSitePages(siteModel, infosWithoutSite, hubRequestOptions));
-      // need to get all the child items and add into site.item.properties.children
-      const childItemIds = infosWithoutSite.map(i => i.id);
-      siteModel.item.properties.children = childItemIds;
-      // re-interpolate the siteModel using the itemInfos
-      siteModel = hubSites.interpolateSite(siteModel, templateDictionary, {});
-      // and update the model
-      secondPassPromises.push(hubSites.updateSite(siteModel, {
-          ...hubRequestOptions,
-          allowList: null
-      }));
-      return Promise.all(secondPassPromises).then(() => {
-          return true;
-      });
-  }
-
-  /** @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.
-   */
-  /**
-   * Converts a Site 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
-   */
-  function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication = null // eslint-disable-line @typescript-eslint/no-unused-vars
-  ) {
-      let created = 0;
-      let modified = 0;
-      let hubRo;
-      // get hubRequestOptions
-      return solutionCommon.createHubRequestOptions(destAuthentication)
-          .then(ro => {
-          hubRo = ro;
-          return hubSites.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;
-          return hubSites.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.typeKeywords = hubCommon.without(tmpl.item.typeKeywords, "doNotDelete");
-          tmpl.groups = [];
-          tmpl.estimatedDeploymentCostFactor = 2;
-          tmpl.resources = [];
-          if (!solutionCommon.getProp(tmpl, "properties")) {
-              tmpl.properties = {};
-          }
-          // swap out dependency id's to {{<depid>.itemId}}
-          // so it will be re-interpolated
-          tmpl.dependencies = solutionCommon.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>}
-   */
-  function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-      // let the progress system know we've started...
-      const startStatus = itemProgressCallback(template.itemId, solutionCommon.EItemProgressStatus.Started, 0);
-      // if it returned false, just resolve out
-      if (!startStatus) {
-          return Promise.resolve(solutionCommon.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 solutionCommon.createHubRequestOptions(destinationAuthentication, templateDictionary)
-          .then(ro => {
-          hubRo = ro;
-          return hubSites.createSiteModelFromTemplate(template, templateDictionary, transforms, hubRo);
-      })
-          .then(interpolated => {
-          const options = {
-              assets: interpolated.assets || []
-          };
-          // Now create the item, register for oAuth, register domain etc
-          return hubSites.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 arcgisRestPortal.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: siteModel.item.id
-          };
-          // call the progress callback, which also mutates templateDictionary
-          const finalStatus = itemProgressCallback(template.itemId, solutionCommon.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, siteModel.item.id);
-          if (!finalStatus) {
-              // clean up the site we just created
-              const failSafeRemove = hubCommon.failSafe(hubSites.removeSite, { success: true });
-              return failSafeRemove(siteModel, hubRo).then(() => {
-                  return Promise.resolve(solutionCommon.generateEmptyCreationResponse(template.type));
-              });
-          }
-          else {
-              // finally, return ICreateItemFromTemplateResponse
-              const response = {
-                  item: {
-                      ...template,
-                      ...siteModel
-                  },
-                  id: siteModel.item.id,
-                  type: template.type,
-                  postProcess: true
-              };
-              response.item.itemId = siteModel.item.id;
-              return response;
-          }
-      })
-          .catch(ex => {
-          itemProgressCallback(template.itemId, solutionCommon.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
-   */
-  function postProcess(id, type, itemInfos, template, templates, templateDictionary, authentication) {
-      let hubRo;
-      return solutionCommon.createHubRequestOptions(authentication, templateDictionary)
-          .then(ro => {
-          hubRo = ro;
-          // get the site model
-          return hubSites.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
-   */
-  function isASite(itemType) {
-      let result = false;
-      if (itemType === "Hub Site Application" || itemType === "Site Application") {
-          result = true;
-      }
-      return result;
-  }
-
-  var hubSiteProcessor = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    convertItemToTemplate: convertItemToTemplate,
-    createItemFromTemplate: createItemFromTemplate,
-    postProcess: postProcess,
-    isASite: isASite
-  });
-
-  exports.HubPageProcessor = hubPageProcessor;
-  exports.HubSiteProcessor = hubSiteProcessor;
-
-  Object.defineProperty(exports, '__esModule', { value: true });
-
-}));
-//# sourceMappingURL=hub-types.umd.js.map