@esri/solution-storymap 4.1.2-alpha.0 → 5.0.0

package/dist/cjs/helpers/create-storymap.js

@@ -1,112 +1,112 @@
-"use strict";
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createStoryMap = void 0;
-// TODO ENSURE THIS CREATES IN THE TARGET FOLDER
-const hub_common_1 = require("@esri/hub-common");
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-/**
- * 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: (0, hub_common_1.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 (0, arcgis_rest_portal_1.createItem)(createOptions)
-        .then((createResponse) => {
-        // hold the id in the model
-        model.item.id = createResponse.id;
-        // and re-interpolate the item id
-        model = (0, hub_common_1.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: (0, hub_common_1.stringToBlob)(JSON.stringify(model.data))
-        });
-        resources.push({
-            name: "oembed.json",
-            file: (0, hub_common_1.stringToBlob)(JSON.stringify(model.properties.oembed))
-        });
-        resources.push({
-            name: "oembed.xml",
-            file: (0, hub_common_1.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([
-            (0, arcgis_rest_portal_1.updateItem)({
-                item: (0, hub_common_1.serializeModel)(model),
-                authentication
-            }),
-            authentication.getUsername()
-        ]);
-    })
-        .then((responses) => {
-        const username = responses[1];
-        // add the resources
-        const failSafeAddItemResource = (0, hub_common_1.failSafe)(arcgis_rest_portal_1.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 (0, arcgis_rest_portal_1.moveItem)({
-            itemId: model.item.id,
-            folderId,
-            authentication
-        });
-    })
-        .then(() => {
-        return model;
-    });
-}
-exports.createStoryMap = createStoryMap;
+"use strict";
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStoryMap = void 0;
+// TODO ENSURE THIS CREATES IN THE TARGET FOLDER
+const hub_common_1 = require("@esri/hub-common");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+/**
+ * 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: (0, hub_common_1.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 (0, arcgis_rest_portal_1.createItem)(createOptions)
+        .then((createResponse) => {
+        // hold the id in the model
+        model.item.id = createResponse.id;
+        // and re-interpolate the item id
+        model = (0, hub_common_1.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: (0, hub_common_1.stringToBlob)(JSON.stringify(model.data))
+        });
+        resources.push({
+            name: "oembed.json",
+            file: (0, hub_common_1.stringToBlob)(JSON.stringify(model.properties.oembed))
+        });
+        resources.push({
+            name: "oembed.xml",
+            file: (0, hub_common_1.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([
+            (0, arcgis_rest_portal_1.updateItem)({
+                item: (0, hub_common_1.serializeModel)(model),
+                authentication
+            }),
+            authentication.getUsername()
+        ]);
+    })
+        .then((responses) => {
+        const username = responses[1];
+        // add the resources
+        const failSafeAddItemResource = (0, hub_common_1.failSafe)(arcgis_rest_portal_1.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 (0, arcgis_rest_portal_1.moveItem)({
+            itemId: model.item.id,
+            folderId,
+            authentication
+        });
+    })
+        .then(() => {
+        return model;
+    });
+}
+exports.createStoryMap = createStoryMap;
 //# sourceMappingURL=create-storymap.js.map

package/dist/cjs/helpers/get-portal-env.d.ts

@@ -1,17 +1,17 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { UserSession } from "@esri/solution-common";
-export declare function getPortalEnv(authentication: UserSession): string;
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "@esri/solution-common";
+export declare function getPortalEnv(authentication: UserSession): string;

package/dist/cjs/helpers/get-portal-env.js

@@ -1,19 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPortalEnv = void 0;
-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;
-}
-exports.getPortalEnv = getPortalEnv;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPortalEnv = void 0;
+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;
+}
+exports.getPortalEnv = getPortalEnv;
 //# sourceMappingURL=get-portal-env.js.map

package/dist/cjs/helpers/get-storymap-base-url.d.ts

@@ -1,23 +1,23 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { UserSession } from "@esri/solution-common";
-/**
- * For a given environment Prod/qa/dev/portal
- * return the correct storymaps base url
- *
- * @param authentication
- */
-export declare function getStoryMapBaseUrl(authentication: UserSession): string;
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "@esri/solution-common";
+/**
+ * For a given environment Prod/qa/dev/portal
+ * return the correct storymaps base url
+ *
+ * @param authentication
+ */
+export declare function getStoryMapBaseUrl(authentication: UserSession): string;

package/dist/cjs/helpers/get-storymap-base-url.js

@@ -1,26 +1,26 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStoryMapBaseUrl = void 0;
-const get_storymap_subdomain_1 = require("./get-storymap-subdomain");
-/**
- * For a given environment Prod/qa/dev/portal
- * return the correct storymaps base url
- *
- * @param authentication
- */
-function getStoryMapBaseUrl(authentication) {
-    let baseUrl = "";
-    const subdomain = (0, get_storymap_subdomain_1.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;
-}
-exports.getStoryMapBaseUrl = getStoryMapBaseUrl;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStoryMapBaseUrl = void 0;
+const get_storymap_subdomain_1 = require("./get-storymap-subdomain");
+/**
+ * For a given environment Prod/qa/dev/portal
+ * return the correct storymaps base url
+ *
+ * @param authentication
+ */
+function getStoryMapBaseUrl(authentication) {
+    let baseUrl = "";
+    const subdomain = (0, get_storymap_subdomain_1.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;
+}
+exports.getStoryMapBaseUrl = getStoryMapBaseUrl;
 //# sourceMappingURL=get-storymap-base-url.js.map

package/dist/cjs/helpers/get-storymap-dependencies.d.ts

@@ -1,23 +1,23 @@
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { IModel } from "@esri/hub-common";
-/**
- * Extract a list of Items this storymap depends on
- * At this point we are just extracting webmaps
- *
- * @param model IModel
- */
-export declare function getStoryMapDependencies(model: IModel): any[];
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IModel } from "@esri/hub-common";
+/**
+ * Extract a list of Items this storymap depends on
+ * At this point we are just extracting webmaps
+ *
+ * @param model IModel
+ */
+export declare function getStoryMapDependencies(model: IModel): any[];

package/dist/cjs/helpers/get-storymap-dependencies.js

@@ -1,36 +1,36 @@
-"use strict";
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStoryMapDependencies = void 0;
-const hub_common_1 = require("@esri/hub-common");
-/**
- * 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 = (0, hub_common_1.getProp)(model, "data.resources") || {};
-    return Object.keys(resources).reduce((acc, key) => {
-        if ((0, hub_common_1.getProp)(resources, `${key}.type`) === "webmap") {
-            acc.push((0, hub_common_1.getProp)(resources, `${key}.data.itemId`));
-        }
-        return acc;
-    }, []);
-}
-exports.getStoryMapDependencies = getStoryMapDependencies;
+"use strict";
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStoryMapDependencies = void 0;
+const hub_common_1 = require("@esri/hub-common");
+/**
+ * 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 = (0, hub_common_1.getProp)(model, "data.resources") || {};
+    return Object.keys(resources).reduce((acc, key) => {
+        if ((0, hub_common_1.getProp)(resources, `${key}.type`) === "webmap") {
+            acc.push((0, hub_common_1.getProp)(resources, `${key}.data.itemId`));
+        }
+        return acc;
+    }, []);
+}
+exports.getStoryMapDependencies = getStoryMapDependencies;
 //# sourceMappingURL=get-storymap-dependencies.js.map

package/dist/cjs/helpers/get-storymap-subdomain.d.ts

@@ -1,17 +1,17 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { UserSession } from "@esri/solution-common";
-export declare function getStoryMapSubdomain(authentication: UserSession): string;
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "@esri/solution-common";
+export declare function getStoryMapSubdomain(authentication: UserSession): string;

package/dist/cjs/helpers/get-storymap-subdomain.js

@@ -1,20 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStoryMapSubdomain = void 0;
-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;
-}
-exports.getStoryMapSubdomain = getStoryMapSubdomain;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStoryMapSubdomain = void 0;
+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;
+}
+exports.getStoryMapSubdomain = getStoryMapSubdomain;
 //# sourceMappingURL=get-storymap-subdomain.js.map

package/dist/cjs/helpers/remap-webmap-keys.d.ts

@@ -1,24 +1,24 @@
-/** @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
- */
-export declare function remapWebmapKeys(resources?: any): any[];
+/** @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
+ */
+export declare function remapWebmapKeys(resources?: any): any[];