@esri/solution-storymap 3.0.1 → 4.0.0-alpha.0

package/dist/umd/storymap.umd.js

@@ -1,593 +0,0 @@
-/* @preserve
-* @esri/solution-storymap - v1.7.0 - Apache-2.0
-* Copyright (c) 2018-2023 Esri, Inc.
-* Fri Apr 28 2023 11:21:59 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/hub-common'), require('@esri/arcgis-rest-portal')) :
-  typeof define === 'function' && define.amd ? define(['exports', '@esri/solution-common', '@esri/hub-common', '@esri/arcgis-rest-portal'], factory) :
-  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.arcgisSolution = global.arcgisSolution || {}, global.arcgisSolution, global.arcgisHub, global.arcgisRest));
-})(this, (function (exports, common, hubCommon, arcgisRestPortal) { 'use strict';
-
-  function _interopNamespace(e) {
-    if (e && e.__esModule) return e;
-    var n = Object.create(null);
-    if (e) {
-      Object.keys(e).forEach(function (k) {
-        if (k !== 'default') {
-          var d = Object.getOwnPropertyDescriptor(e, k);
-          Object.defineProperty(n, k, d.get ? d : {
-            enumerable: true,
-            get: function () { return e[k]; }
-          });
-        }
-      });
-    }
-    n["default"] = e;
-    return Object.freeze(n);
-  }
-
-  var common__namespace = /*#__PURE__*/_interopNamespace(common);
-
-  /** @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.
-   */
-  /**
-   * For some reason, the webmap resource key names are fancier than other resource keys
-   * They look like this: r-<webmap-item-id>-<timestamp>
-   * This interpolation is hard to accomplish given our current setup, so we're just overwriting
-   * them with "webmap0", "webmap1" and so forth. This _seems_ to make no difference.
-   *
-   * @param model
-   */
-  function remapWebmapKeys(resources = {}) {
-      let webmapCounter = 0;
-      return Object.keys(resources).reduce((acc, key) => {
-          if (hubCommon.getProp(resources, `${key}.type`) === "webmap") {
-              if (key !== `webmap${webmapCounter}`) {
-                  acc.push({
-                      original: key,
-                      updated: `webmap${webmapCounter}`
-                  });
-                  webmapCounter++;
-              }
-          }
-          return acc;
-      }, []);
-  }
-
-  /** @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.
-   */
-  /**
-   * Extract a list of Items this storymap depends on
-   * At this point we are just extracting webmaps
-   *
-   * @param model IModel
-   */
-  function getStoryMapDependencies(model) {
-      const resources = hubCommon.getProp(model, "data.resources") || {};
-      return Object.keys(resources).reduce((acc, key) => {
-          if (hubCommon.getProp(resources, `${key}.type`) === "webmap") {
-              acc.push(hubCommon.getProp(resources, `${key}.data.itemId`));
-          }
-          return acc;
-      }, []);
-  }
-
-  /** @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.
-   */
-  /**
-   * Convert a StoryMap IModel to an IItemTemplate
-   *
-   * @param model
-   * @param authentication
-   */
-  function convertStoryMapToTemplate(model) {
-      const tmpl = common.createPlaceholderTemplate(model.item.id, model.item.type);
-      tmpl.key = `${hubCommon.propifyString(model.item.title)}_${hubCommon.createId("i")}`;
-      const clone = hubCommon.cloneObject(model);
-      tmpl.data = clone.data;
-      // We need to save these properties in order to restore them after hub.js deletes them
-      const created = clone.item.created;
-      const modified = clone.item.modified;
-      tmpl.item = hubCommon.normalizeSolutionTemplateItem(clone.item);
-      tmpl.item.created = created;
-      tmpl.item.modified = modified;
-      // templatize the url
-      tmpl.item.url = "{{storyMapTemplateUrl}}";
-      // Storymap Webmap Resources have complex keys that we need to remap
-      const webmapRemaps = remapWebmapKeys(tmpl.data.resources);
-      // and then replace in the rest of the structure
-      webmapRemaps.forEach(remap => {
-          tmpl.data.resources[remap.updated] = hubCommon.cloneObject(tmpl.data.resources[remap.original]);
-          delete tmpl.data.resources[remap.original];
-          tmpl.data.nodes = hubCommon.deepStringReplace(tmpl.data.nodes, remap.original, remap.updated);
-      });
-      // use typeKeyword to mark item as published
-      // Note: Hub team decided to discard unpublished drafts when creating a template
-      const typeKeywords = tmpl.item.typeKeywords;
-      if (typeKeywords.indexOf(unPublishedChangesKW) !== -1) {
-          tmpl.item.typeKeywords = [publishedChangesKW].concat(tmpl.item.typeKeywords.filter((word) => word !== unPublishedChangesKW));
-      }
-      tmpl.properties = {};
-      tmpl.properties.draftFileName = "draft_{{timestamp}}.json";
-      Object.assign(tmpl.properties, oEmbedTemplates);
-      tmpl.dependencies = getStoryMapDependencies(model);
-      return Promise.resolve(tmpl);
-      // TODO: For now, we let the generic process handle item resources
-      // However, many newer item types have complex type-specific resource handling
-      // requirements so this code may be useful in the future
-      // ------------------------------------------------------
-      // return getItemResources(tmpl.itemId, hubRequestOptions)
-      //   .then((response) => {
-      //     tmpl.resources = response.resources.map(e => e.resource)
-      //       // Don't directly copy oembed resources because we need to template these
-      //       // Also, discard draft version of the storymap itself
-      //       .filter(filename => !filename.includes('oembed') && filename.search(/draft_[0-9]+.json/) === -1);
-      //     return tmpl;
-      //   });
-  }
-  // Internal constants
-  const unPublishedChangesKW = "smstatusunpublishedchanges";
-  const publishedChangesKW = "smstatuspublished";
-  /**
-   * Template for oEmbed
-   */
-  const oEmbedTemplates = {
-      oembed: {
-          version: "1.0",
-          type: "rich",
-          title: "Example StoryMap",
-          url: "{{storyMapTemplateUrl}}",
-          provider_name: "ArcGIS StoryMaps",
-          provider_url: "{{storyMapBaseUrl}}",
-          width: 800,
-          height: 600,
-          thumbnail_url: "{{storyMapThumbnailUrl}}",
-          thumbnail_height: "100.5",
-          thumbnail_width: "400",
-          html: '<iframe src="{{storyMapTemplateUrl}}" width="800" height="600" scrolling="yes" frameborder="0" allowfullscreen></iframe>',
-          cache_age: 86400
-      },
-      oembedXML: '<?xml version="1.0" encoding="utf-8" standalone="yes"?>\n <oembed>\n <version>1.0</version>\n <type>rich</type>\n <title>Example StoryMap</title>\n <url>{{storyMapTemplateUrl}}</url>\n <author_name>undefined</author_name>\n <provider_name>ArcGIS StoryMaps</provider_name>\n <provider_url>{{storyMapBaseUrl}}</provider_url>\n <width>800</width>\n <height>600</height>\n <thumbnail_url>{{storyMapThumbnailUrl}}</thumbnail_url>\n <thumbnail_height>100.5</thumbnail_height>\n <thumbnail_width>400</thumbnail_width>\n <html><iframe src="{{storyMapTemplateUrl}}" width="800" height="600" scrolling="yes" frameborder="0" allowfullscreen="true"></iframe></html>\n <cache_age>86400</cache_age>\n </oembed>'
-  };
-
-  function getPortalEnv(authentication) {
-      const portalUrl = authentication.portal || "https://www.arcgis.com/sharing/rest";
-      let result = "portal";
-      if (portalUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
-          result = "qaext";
-      }
-      else if (portalUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
-          result = "devext";
-      }
-      else if (portalUrl.match(/(www|\.maps)\.arcgis.com/)) {
-          result = "www";
-      }
-      return result;
-  }
-
-  function getStoryMapSubdomain(authentication) {
-      const portalUrl = authentication.portal || "https://www.arcgis.com/sharing/rest";
-      // TODO: Sort out how we locate storymaps on portal?
-      let result;
-      if (portalUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
-          result = "storymapsqa";
-      }
-      else if (portalUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
-          result = "storymapsdev";
-      }
-      else if (portalUrl.match(/(www|\.maps)\.arcgis.com/)) {
-          result = "storymaps";
-      }
-      return result;
-  }
-
-  /**
-   * For a given environment Prod/qa/dev/portal
-   * return the correct storymaps base url
-   *
-   * @param authentication
-   */
-  function getStoryMapBaseUrl(authentication) {
-      let baseUrl = "";
-      const subdomain = getStoryMapSubdomain(authentication);
-      if (subdomain) {
-          baseUrl = `https://${subdomain}.arcgis.com`;
-      }
-      else {
-          // we're on portal
-          // chop off the /sharing/rest to get the baseUrl
-          const portalBaseUrl = authentication.portal.replace("/sharing/rest", "");
-          baseUrl = `${portalBaseUrl}/apps/storymaps`;
-      }
-      return baseUrl;
-  }
-
-  /** @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 createStoryMapModelFromTemplate(templateModel, settings, transforms, authentication) {
-      const timestamp = new Date().getTime();
-      // Keep these around in case we encounter some old templates
-      settings.agoenv = getPortalEnv(authentication);
-      settings.smBase = getStoryMapSubdomain(authentication);
-      settings.timestamp = new Date().getTime();
-      // These are used in the oembed resource, as well as the item url
-      // they have `{{appid}}` in them so that the id of the created item
-      // will be interpolated into it after the item is created
-      settings.storyMapBaseUrl = getStoryMapBaseUrl(authentication);
-      settings.storyMapTemplateUrl = `${settings.storyMapBaseUrl}/stories/{{appid}}`;
-      settings.storyMapThumnailUrl = `${authentication.portal}/content/items/{{appid}}/info/thumbnail/thumbnail.jpg/?w=400&d=${timestamp}`;
-      const model = hubCommon.interpolate(templateModel, settings, transforms);
-      return Promise.resolve(model);
-  }
-
-  /** @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.
-   */
-  /**
-   * Create a StoryMap from an interpolated template
-   *
-   * @param model
-   * @param options
-   * @param authentication
-   */
-  function createStoryMap(model, folderId, options, authentication) {
-      // create an array to hold well-known resources
-      // that we have to generate from the passed in model
-      const resources = [];
-      // For unknown reasons we can not seem to spy on createItemInFolder
-      // so we will create-then-move for now
-      const createOptions = {
-          // need to serialize
-          item: hubCommon.serializeModel(model),
-          authentication
-      };
-      /* istanbul ignore else */
-      if (model.item.thumbnail) {
-          createOptions.params = {
-              // Pass thumbnail file in via params because item property is serialized, which discards a blob
-              thumbnail: model.item.thumbnail
-          };
-          delete createOptions.item.thumbnail;
-      }
-      // Create the item
-      return arcgisRestPortal.createItem(createOptions)
-          .then((createResponse) => {
-          // hold the id in the model
-          model.item.id = createResponse.id;
-          // and re-interpolate the item id
-          model = hubCommon.interpolateItemId(model);
-          // Compute the item url based on current environment
-          // Storymaps store draft data in a timestamped resource attached to the item
-          // We'll just use the published data for the first "draft"
-          resources.push({
-              name: model.properties.draftFileName,
-              file: hubCommon.stringToBlob(JSON.stringify(model.data))
-          });
-          resources.push({
-              name: "oembed.json",
-              file: hubCommon.stringToBlob(JSON.stringify(model.properties.oembed))
-          });
-          resources.push({
-              name: "oembed.xml",
-              file: hubCommon.stringToBlob(model.properties.oembedXML)
-          });
-          // remove the properties hash now that we've gotten what we need
-          delete model.properties;
-          // update the item with the newly re-interpolated model
-          return Promise.all([
-              arcgisRestPortal.updateItem({
-                  item: hubCommon.serializeModel(model),
-                  authentication
-              }),
-              authentication.getUsername()
-          ]);
-      })
-          .then((responses) => {
-          const username = responses[1];
-          // add the resources
-          const failSafeAddItemResource = hubCommon.failSafe(arcgisRestPortal.addItemResource, {
-              success: true
-          });
-          const resourcePromises = resources.map(resource => {
-              return failSafeAddItemResource({
-                  id: model.item.id,
-                  owner: username,
-                  resource: resource.file,
-                  name: resource.name,
-                  authentication
-              });
-          });
-          // Fire and forget as these are not critical-path
-          return Promise.all(resourcePromises);
-      })
-          .then(() => {
-          // Move it
-          return arcgisRestPortal.moveItem({
-              itemId: model.item.id,
-              folderId,
-              authentication
-          });
-      })
-          .then(() => {
-          return model;
-      });
-  }
-
-  /** @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.
-   */
-  /**
-   * Convert a StoryMap to a template
-   *
-   * @param solutionItemId
-   * @param itemInfo
-   * @param destAuthentication Credentials for requests to the destination organization
-   * @param srcAuthentication Credentials for requests to source items
-   */
-  function convertItemToTemplate$1(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
-      const model = {
-          item: itemInfo,
-          data: {}
-      };
-      // fetch the data.json
-      return arcgisRestPortal.getItemData(itemInfo.id, { authentication: srcAuthentication })
-          .then(data => {
-          // append into the model
-          model.data = data;
-          // and use that to create a template
-          return convertStoryMapToTemplate(model);
-      })
-          .then(tmpl => {
-          return tmpl;
-      });
-  }
-  /**
-   * Create a StoryMap from the passed in template
-   *
-   * @param template
-   * @param templateDictionary
-   * @param destinationAuthentication
-   * @param itemProgressCallback
-   */
-  function createItemFromTemplate$1(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-      // let the progress system know we've started...
-      const startStatus = itemProgressCallback(template.itemId, common.EItemProgressStatus.Started, 0);
-      // and if it returned false, just resolve out
-      if (!startStatus) {
-          return Promise.resolve(common.generateEmptyCreationResponse(template.type));
-      }
-      // 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 model;
-      // 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.
-      return createStoryMapModelFromTemplate(template, templateDictionary, transforms, destinationAuthentication)
-          .then(interpolated => {
-          const options = {
-              assets: interpolated.assets || []
-          };
-          return createStoryMap(interpolated, templateDictionary.folderId, options, destinationAuthentication);
-      })
-          .then(createdModel => {
-          model = createdModel;
-          // Update the template dictionary
-          // TODO: This should be done in whatever receives
-          // the outcome of this promise chain
-          templateDictionary[template.itemId] = {
-              itemId: model.item.id
-          };
-          // call the progress callback, which also mutates templateDictionary
-          const finalStatus = itemProgressCallback(template.itemId, common.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, model.item.id);
-          if (!finalStatus) {
-              // clean up the site we just created
-              const failSafeRemove = hubCommon.failSafe(arcgisRestPortal.removeItem, { success: true });
-              return failSafeRemove({
-                  id: model.item.id,
-                  authentication: destinationAuthentication
-              }).then(() => {
-                  return Promise.resolve(common.generateEmptyCreationResponse(template.type));
-              });
-          }
-          else {
-              // finally, return ICreateItemFromTemplateResponse
-              const response = {
-                  item: {
-                      ...template,
-                      ...model
-                  },
-                  id: model.item.id,
-                  type: template.type,
-                  postProcess: false
-              };
-              response.item.itemId = model.item.id;
-              return response;
-          }
-      })
-          .catch(ex => {
-          itemProgressCallback(template.itemId, common.EItemProgressStatus.Failed, 0);
-          throw ex;
-      });
-  }
-  function isAStoryMap$1(itemType) {
-      let result = false;
-      if (itemType === "StoryMap") {
-          result = true;
-      }
-      return result;
-  }
-
-  var storymapProcessor = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    convertItemToTemplate: convertItemToTemplate$1,
-    createItemFromTemplate: createItemFromTemplate$1,
-    isAStoryMap: isAStoryMap$1
-  });
-
-  /** @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.
-   */
-  // ------------------------------------------------------------------------------------------------------------------ //
-  function convertItemToTemplate(solutionItemId, itemInfo) {
-      return new Promise((resolve, reject) => {
-          if (isAStoryMap(itemInfo.type, itemInfo.url)) {
-              reject(common__namespace.fail("Classic StoryMap is not yet implemented"));
-          }
-          else {
-              reject(common__namespace.fail(itemInfo.id + " is not a StoryMap"));
-          }
-      });
-  }
-  function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-      return new Promise(resolve => {
-          if (isAStoryMap(template.type, template.item.url)) {
-              // Not yet implemented
-              itemProgressCallback(template.itemId, common__namespace.EItemProgressStatus.Failed, 0);
-              resolve(common__namespace.generateEmptyCreationResponse(template.type));
-          }
-          else {
-              // Not valid
-              itemProgressCallback(template.itemId, common__namespace.EItemProgressStatus.Failed, 0);
-              resolve(common__namespace.generateEmptyCreationResponse(template.type));
-          }
-      });
-  }
-  function isAStoryMap(itemType, itemUrl) {
-      if (itemUrl) {
-          return [
-              /\/apps\/Cascade\//i,
-              /\/apps\/MapJournal\//i,
-              /\/apps\/MapSeries\//i,
-              /\/apps\/MapTour\//i,
-              /\/apps\/Shortlist\//i,
-              /\/apps\/StoryMap\//i,
-              /\/apps\/StoryMapBasic\//i,
-              /\/apps\/StorytellingSwipe\//i
-          ].some(pattern => pattern.test(itemUrl));
-      }
-      return false;
-  }
-
-  var classicStorymapProcessor = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    convertItemToTemplate: convertItemToTemplate,
-    createItemFromTemplate: createItemFromTemplate,
-    isAStoryMap: isAStoryMap
-  });
-
-  exports.ClassicStoryMapProcessor = classicStorymapProcessor;
-  exports.StoryMapProcessor = storymapProcessor;
-
-  Object.defineProperty(exports, '__esModule', { value: true });
-
-}));
-//# sourceMappingURL=storymap.umd.js.map