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

package/dist/cjs/helpers/remap-webmap-keys.js

@@ -1,44 +1,44 @@
-"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.remapWebmapKeys = void 0;
-const hub_common_1 = require("@esri/hub-common");
-/**
- * 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 ((0, hub_common_1.getProp)(resources, `${key}.type`) === "webmap") {
-            if (key !== `webmap${webmapCounter}`) {
-                acc.push({
-                    original: key,
-                    updated: `webmap${webmapCounter}`
-                });
-                webmapCounter++;
-            }
-        }
-        return acc;
-    }, []);
-}
-exports.remapWebmapKeys = remapWebmapKeys;
+"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.remapWebmapKeys = void 0;
+const hub_common_1 = require("@esri/hub-common");
+/**
+ * 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 ((0, hub_common_1.getProp)(resources, `${key}.type`) === "webmap") {
+            if (key !== `webmap${webmapCounter}`) {
+                acc.push({
+                    original: key,
+                    updated: `webmap${webmapCounter}`
+                });
+                webmapCounter++;
+            }
+        }
+        return acc;
+    }, []);
+}
+exports.remapWebmapKeys = remapWebmapKeys;
 //# sourceMappingURL=remap-webmap-keys.js.map

package/dist/cjs/index.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.
- */
-/**
- * Manages the creation and deployment of Story Map item types.
- *
- * @module storymap
- */
-import * as StoryMapProcessor from "./storymap-processor";
-import * as ClassicStoryMapProcessor from "./classic-storymap-processor";
-export { StoryMapProcessor, ClassicStoryMapProcessor };
+/** @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 Story Map item types.
+ *
+ * @module storymap
+ */
+import * as StoryMapProcessor from "./storymap-processor";
+import * as ClassicStoryMapProcessor from "./classic-storymap-processor";
+export { StoryMapProcessor, ClassicStoryMapProcessor };

package/dist/cjs/index.js

@@ -1,29 +1,29 @@
-"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.ClassicStoryMapProcessor = exports.StoryMapProcessor = void 0;
-const tslib_1 = require("tslib");
-/**
- * Manages the creation and deployment of Story Map item types.
- *
- * @module storymap
- */
-const StoryMapProcessor = tslib_1.__importStar(require("./storymap-processor"));
-exports.StoryMapProcessor = StoryMapProcessor;
-const ClassicStoryMapProcessor = tslib_1.__importStar(require("./classic-storymap-processor"));
-exports.ClassicStoryMapProcessor = ClassicStoryMapProcessor;
+"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.ClassicStoryMapProcessor = exports.StoryMapProcessor = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Manages the creation and deployment of Story Map item types.
+ *
+ * @module storymap
+ */
+const StoryMapProcessor = tslib_1.__importStar(require("./storymap-processor"));
+exports.StoryMapProcessor = StoryMapProcessor;
+const ClassicStoryMapProcessor = tslib_1.__importStar(require("./classic-storymap-processor"));
+exports.ClassicStoryMapProcessor = ClassicStoryMapProcessor;
 //# sourceMappingURL=index.js.map

package/dist/cjs/storymap-processor.d.ts

@@ -1,40 +1,40 @@
-/** @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 Story Map item types.
- *
- * @module storymap
- */
-import { IItemTemplate, IItemProgressCallback, ICreateItemFromTemplateResponse, UserSession } from "@esri/solution-common";
-/**
- * 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
- */
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession): Promise<IItemTemplate>;
-/**
- * Create a StoryMap from the passed in template
- *
- * @param template
- * @param templateDictionary
- * @param destinationAuthentication
- * @param itemProgressCallback
- */
-export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
-export declare function isAStoryMap(itemType: string): boolean;
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Manages the creation and deployment of Story Map item types.
+ *
+ * @module storymap
+ */
+import { IItemTemplate, IItemProgressCallback, ICreateItemFromTemplateResponse, UserSession } from "@esri/solution-common";
+/**
+ * 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
+ */
+export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession): Promise<IItemTemplate>;
+/**
+ * Create a StoryMap from the passed in template
+ *
+ * @param template
+ * @param templateDictionary
+ * @param destinationAuthentication
+ * @param itemProgressCallback
+ */
+export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
+export declare function isAStoryMap(itemType: string): boolean;

package/dist/cjs/storymap-processor.js

@@ -1,141 +1,141 @@
-"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.isAStoryMap = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
-/**
- * Manages the creation and deployment of Story Map item types.
- *
- * @module storymap
- */
-const solution_common_1 = require("@esri/solution-common");
-const hub_common_1 = require("@esri/hub-common");
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-const convert_storymap_to_template_1 = require("./helpers/convert-storymap-to-template");
-const create_storymap_model_from_template_1 = require("./helpers/create-storymap-model-from-template");
-const create_storymap_1 = require("./helpers/create-storymap");
-/**
- * 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(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
-    const model = {
-        item: itemInfo,
-        data: {}
-    };
-    // fetch the data.json
-    return (0, arcgis_rest_portal_1.getItemData)(itemInfo.id, { authentication: srcAuthentication })
-        .then(data => {
-        // append into the model
-        model.data = data;
-        // and use that to create a template
-        return (0, convert_storymap_to_template_1.convertStoryMapToTemplate)(model);
-    })
-        .then(tmpl => {
-        return tmpl;
-    });
-}
-exports.convertItemToTemplate = convertItemToTemplate;
-/**
- * Create a StoryMap from the passed in template
- *
- * @param template
- * @param templateDictionary
- * @param destinationAuthentication
- * @param itemProgressCallback
- */
-function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    // let the progress system know we've started...
-    const startStatus = itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Started, 0);
-    // and if it returned false, just resolve out
-    if (!startStatus) {
-        return Promise.resolve((0, solution_common_1.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 (0, create_storymap_model_from_template_1.createStoryMapModelFromTemplate)(template, templateDictionary, transforms, destinationAuthentication)
-        .then(interpolated => {
-        const options = {
-            assets: interpolated.assets || []
-        };
-        return (0, create_storymap_1.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, solution_common_1.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, model.item.id);
-        if (!finalStatus) {
-            // clean up the site we just created
-            const failSafeRemove = (0, hub_common_1.failSafe)(arcgis_rest_portal_1.removeItem, { success: true });
-            return failSafeRemove({
-                id: model.item.id,
-                authentication: destinationAuthentication
-            }).then(() => {
-                return Promise.resolve((0, solution_common_1.generateEmptyCreationResponse)(template.type));
-            });
-        }
-        else {
-            // finally, return ICreateItemFromTemplateResponse
-            const response = {
-                item: {
-                    ...template,
-                    ...(0, solution_common_1.convertIModel)(model)
-                },
-                id: model.item.id,
-                type: template.type,
-                postProcess: false
-            };
-            response.item.itemId = model.item.id;
-            return response;
-        }
-    })
-        .catch(ex => {
-        itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Failed, 0);
-        throw ex;
-    });
-}
-exports.createItemFromTemplate = createItemFromTemplate;
-function isAStoryMap(itemType) {
-    let result = false;
-    if (itemType === "StoryMap") {
-        result = true;
-    }
-    return result;
-}
-exports.isAStoryMap = isAStoryMap;
+"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.isAStoryMap = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
+/**
+ * Manages the creation and deployment of Story Map item types.
+ *
+ * @module storymap
+ */
+const solution_common_1 = require("@esri/solution-common");
+const hub_common_1 = require("@esri/hub-common");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const convert_storymap_to_template_1 = require("./helpers/convert-storymap-to-template");
+const create_storymap_model_from_template_1 = require("./helpers/create-storymap-model-from-template");
+const create_storymap_1 = require("./helpers/create-storymap");
+/**
+ * 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(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
+    const model = {
+        item: itemInfo,
+        data: {}
+    };
+    // fetch the data.json
+    return (0, arcgis_rest_portal_1.getItemData)(itemInfo.id, { authentication: srcAuthentication })
+        .then(data => {
+        // append into the model
+        model.data = data;
+        // and use that to create a template
+        return (0, convert_storymap_to_template_1.convertStoryMapToTemplate)(model);
+    })
+        .then(tmpl => {
+        return tmpl;
+    });
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+/**
+ * Create a StoryMap from the passed in template
+ *
+ * @param template
+ * @param templateDictionary
+ * @param destinationAuthentication
+ * @param itemProgressCallback
+ */
+function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    // let the progress system know we've started...
+    const startStatus = itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Started, 0);
+    // and if it returned false, just resolve out
+    if (!startStatus) {
+        return Promise.resolve((0, solution_common_1.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 (0, create_storymap_model_from_template_1.createStoryMapModelFromTemplate)(template, templateDictionary, transforms, destinationAuthentication)
+        .then(interpolated => {
+        const options = {
+            assets: interpolated.assets || []
+        };
+        return (0, create_storymap_1.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, solution_common_1.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, model.item.id);
+        if (!finalStatus) {
+            // clean up the site we just created
+            const failSafeRemove = (0, hub_common_1.failSafe)(arcgis_rest_portal_1.removeItem, { success: true });
+            return failSafeRemove({
+                id: model.item.id,
+                authentication: destinationAuthentication
+            }).then(() => {
+                return Promise.resolve((0, solution_common_1.generateEmptyCreationResponse)(template.type));
+            });
+        }
+        else {
+            // finally, return ICreateItemFromTemplateResponse
+            const response = {
+                item: {
+                    ...template,
+                    ...(0, solution_common_1.convertIModel)(model)
+                },
+                id: model.item.id,
+                type: template.type,
+                postProcess: false
+            };
+            response.item.itemId = model.item.id;
+            return response;
+        }
+    })
+        .catch(ex => {
+        itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Failed, 0);
+        throw ex;
+    });
+}
+exports.createItemFromTemplate = createItemFromTemplate;
+function isAStoryMap(itemType) {
+    let result = false;
+    if (itemType === "StoryMap") {
+        result = true;
+    }
+    return result;
+}
+exports.isAStoryMap = isAStoryMap;
 //# sourceMappingURL=storymap-processor.js.map

package/dist/esm/classic-storymap-processor.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.
- */
-/**
- * Manages the creation and deployment of Story Map item types.
- *
- * @module storymap
- */
-import * as common from "@esri/solution-common";
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any): Promise<common.IItemTemplate>;
-export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;
-export declare function isAStoryMap(itemType: string, itemUrl?: string): boolean;
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Manages the creation and deployment of Story Map item types.
+ *
+ * @module storymap
+ */
+import * as common from "@esri/solution-common";
+export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any): Promise<common.IItemTemplate>;
+export declare function createItemFromTemplate(template: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession, itemProgressCallback: common.IItemProgressCallback): Promise<common.ICreateItemFromTemplateResponse>;
+export declare function isAStoryMap(itemType: string, itemUrl?: string): boolean;