@esri/solution-web-experience 6.1.0-alpha.0 → 6.2.0-alpha.0

package/dist/cjs/web-experience-processor.js

@@ -0,0 +1,124 @@
+"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.postProcess = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
+/**
+ * Manages the creation and deployment of web-experience item types.
+ *
+ * @module solution-web-experience
+ */
+const solution_common_1 = require("@esri/solution-common");
+const hub_common_1 = require("@esri/hub-common");
+const create_web_experience_model_from_template_1 = require("./helpers/create-web-experience-model-from-template");
+const create_web_experience_1 = require("./helpers/create-web-experience");
+const convert_web_experience_to_template_1 = require("./helpers/convert-web-experience-to-template");
+/**
+ * Convert a Web Experience item into a Template
+ *
+ * @param itemInfo
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items
+ * @param isGroup
+ */
+function convertItemToTemplate(itemInfo, destAuthentication, srcAuthentication) {
+    // use the itemInfo to setup a model
+    const model = {
+        item: itemInfo,
+        data: {},
+    };
+    // fetch the data.json
+    return (0, solution_common_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_web_experience_to_template_1.convertWebExperienceToTemplate)(model);
+    });
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+/**
+ * Create a Web Experience from a 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));
+    }
+    let exbModel;
+    return (0, create_web_experience_model_from_template_1.createWebExperienceModelFromTemplate)(template, templateDictionary, {}, destinationAuthentication)
+        .then((model) => {
+        exbModel = model;
+        return (0, create_web_experience_1.createWebExperience)(model, templateDictionary.folderId, {}, destinationAuthentication);
+    })
+        .then((createdModel) => {
+        exbModel.item.id = createdModel.item.id;
+        exbModel.item.url = createdModel.item.url;
+        // Update the template dictionary
+        // TODO: This should be done in whatever recieves
+        // the outcome of this promise chain
+        templateDictionary[template.itemId] = {
+            itemId: createdModel.item.id,
+        };
+        const finalStatus = itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, createdModel.item.id);
+        if (!finalStatus) {
+            // clean up the site we just created
+            const failSafeRemove = (0, hub_common_1.failSafe)(solution_common_1.restRemoveItem, { success: true });
+            return failSafeRemove({
+                id: exbModel.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)(exbModel),
+                },
+                id: exbModel.item.id,
+                type: template.type,
+                postProcess: false,
+            };
+            response.item.itemId = exbModel.item.id;
+            return response;
+        }
+    });
+}
+exports.createItemFromTemplate = createItemFromTemplate;
+/**
+ * Post-Process an Experience
+ *
+ * @param {string} itemId The item ID
+ * @param {string} type The template type
+ * @param {any[]} itemInfos Array of \{id: 'ef3', type: 'Web Map'\} objects
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} authentication The destination session info
+ * @returns Promise resolving to successfulness of update
+ */
+function postProcess(itemId, type, itemInfos, template, templates, templateDictionary, authentication) {
+    return (0, solution_common_1.updateItemTemplateFromDictionary)(itemId, templateDictionary, authentication);
+}
+exports.postProcess = postProcess;
+//# sourceMappingURL=web-experience-processor.js.map

package/dist/cjs/web-experience-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-experience-processor.js","sourceRoot":"","sources":["../../src/web-experience-processor.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AAEH,2DAY+B;AAC/B,iDAAoD;AACpD,mHAA2G;AAC3G,2EAAsE;AACtE,qGAA8F;AAE9F;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,QAAa,EACb,kBAA+B,EAC/B,iBAA8B;IAE9B,oCAAoC;IACpC,MAAM,KAAK,GAAG;QACZ,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,EAAE;KACC,CAAC;IACZ,sBAAsB;IACtB,OAAO,IAAA,6BAAW,EAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACnF,wBAAwB;QACxB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,oCAAoC;QACpC,OAAO,IAAA,mEAA8B,EAAC,KAAK,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC;AAjBD,sDAiBC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,QAAuB,EACvB,kBAAuB,EACvB,yBAAsC,EACtC,oBAA2C;IAE3C,gDAAgD;IAChD,MAAM,WAAW,GAAG,oBAAoB,CAAC,QAAQ,CAAC,MAAM,EAAE,qCAAmB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAE1F,6CAA6C;IAC7C,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;KACtE;IAED,IAAI,QAAgB,CAAC;IACrB,OAAO,IAAA,gFAAoC,EAAC,QAAQ,EAAE,kBAAkB,EAAE,EAAE,EAAE,yBAAyB,CAAC;SACrG,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;QACd,QAAQ,GAAG,KAAK,CAAC;QACjB,OAAO,IAAA,2CAAmB,EAAC,KAAK,EAAE,kBAAkB,CAAC,QAAQ,EAAE,EAAE,EAAE,yBAAyB,CAAC,CAAC;IAChG,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;QACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,QAAQ,CAAC,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;QAC1C,iCAAiC;QACjC,iDAAiD;QACjD,oCAAoC;QACpC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG;YACpC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE;SAC7B,CAAC;QACF,MAAM,WAAW,GAAG,oBAAoB,CACtC,QAAQ,CAAC,MAAM,EACf,qCAAmB,CAAC,QAAQ,EAC5B,QAAQ,CAAC,6BAA6B,IAAI,CAAC,EAC3C,YAAY,CAAC,IAAI,CAAC,EAAE,CACrB,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE;YAChB,oCAAoC;YACpC,MAAM,cAAc,GAAG,IAAA,qBAAQ,EAAC,gCAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACnE,OAAO,cAAc,CAAC;gBACpB,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpB,cAAc,EAAE,yBAAyB;aAC1C,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBACX,OAAO,OAAO,CAAC,OAAO,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACvE,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,kDAAkD;YAClD,MAAM,QAAQ,GAAoC;gBAChD,IAAI,EAAE;oBACJ,GAAG,QAAQ;oBACX,GAAG,IAAA,+BAAa,EAAC,QAAQ,CAAC;iBAC3B;gBACD,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,WAAW,EAAE,KAAK;aACnB,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC,CAAC;AACP,CAAC;AA5DD,wDA4DC;AAED;;;;;;;;;GASG;AACH,SAAgB,WAAW,CACzB,MAAc,EACd,IAAY,EACZ,SAAgB,EAChB,QAAuB,EACvB,SAA0B,EAC1B,kBAAuB,EACvB,cAA2B;IAE3B,OAAO,IAAA,kDAAgC,EAAC,MAAM,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC;AACtF,CAAC;AAVD,kCAUC"}

package/dist/esm/helpers/convert-web-experience-to-template.d.ts

@@ -0,0 +1,27 @@
+/** @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 { IModel } from "@esri/hub-common";
+import { IItemTemplate } from "@esri/solution-common";
+/**
+ * Convert an Experience item into a template
+ *
+ * Pretty simpler conversion - remove extra item props, extract out
+ * items from the data.dataSources hash.
+ *
+ * @param model
+ * @param authentication
+ */
+export declare function convertWebExperienceToTemplate(model: IModel): Promise<IItemTemplate>;

package/dist/esm/helpers/convert-web-experience-to-template.js

@@ -0,0 +1,63 @@
+/** @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 { normalizeSolutionTemplateItem, cloneObject, propifyString, createId } from "@esri/hub-common";
+import { createPlaceholderTemplate } from "@esri/solution-common";
+import { getWebExperienceDependencies } from "./get-web-experience-dependencies";
+/**
+ * Convert an Experience item into a template
+ *
+ * Pretty simpler conversion - remove extra item props, extract out
+ * items from the data.dataSources hash.
+ *
+ * @param model
+ * @param authentication
+ */
+export function convertWebExperienceToTemplate(model) {
+    const tmpl = createPlaceholderTemplate(model.item.id, model.item.type);
+    tmpl.key = `${propifyString(model.item.title)}_${createId("i")}`;
+    const clone = 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 = normalizeSolutionTemplateItem(clone.item);
+    tmpl.item.created = created;
+    tmpl.item.modified = modified;
+    // templatize the url. This is updated during the createModelFromTemplate phase
+    // of the deployment process
+    tmpl.item.url = "{{experienceUrlTemplate}}";
+    // use typeKeyword to mark item as published (we decided to discard unpublished drafts)
+    const typeKeywords = tmpl.item.typeKeywords;
+    if (typeKeywords.indexOf(changedTypeKW) !== -1) {
+        tmpl.item.typeKeywords = [publishedTypeKW].concat(tmpl.item.typeKeywords.filter((word) => word !== changedTypeKW));
+    }
+    tmpl.dependencies = getWebExperienceDependencies(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, authentication)
+    //   .then((response) => {
+    //     tmpl.resources = response.resources.map(e => e.resource)
+    //       // Discard draft version
+    //       .filter(filename => filename !== 'config.json');
+    //     return tmpl;
+    //   });
+}
+const publishedTypeKW = "status: Published";
+const changedTypeKW = "status: Changed";
+//# sourceMappingURL=convert-web-experience-to-template.js.map

package/dist/esm/helpers/convert-web-experience-to-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-web-experience-to-template.js","sourceRoot":"","sources":["../../../src/helpers/convert-web-experience-to-template.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAU,6BAA6B,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE/G,OAAO,EAAwB,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAEjF;;;;;;;;GAQG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAAa;IAC1D,MAAM,IAAI,GAAG,yBAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvE,IAAI,CAAC,GAAG,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;IAEjE,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IAEvB,sFAAsF;IACtF,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;IACnC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;IACrC,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC,KAAK,CAAC,IAAI,CAAU,CAAC;IAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAE9B,+EAA+E;IAC/E,4BAA4B;IAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,2BAA2B,CAAC;IAE5C,uFAAuF;IACvF,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAC5C,IAAI,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE;QAC9C,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,CAAC;KACpH;IAED,IAAI,CAAC,YAAY,GAAG,4BAA4B,CAAC,KAAK,CAAC,CAAC;IAExD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,kEAAkE;IAClE,8EAA8E;IAC9E,wDAAwD;IACxD,yDAAyD;IACzD,uDAAuD;IACvD,0BAA0B;IAC1B,+DAA+D;IAC/D,iCAAiC;IACjC,yDAAyD;IACzD,mBAAmB;IACnB,QAAQ;AACV,CAAC;AAED,MAAM,eAAe,GAAG,mBAAmB,CAAC;AAC5C,MAAM,aAAa,GAAG,iBAAiB,CAAC"}

package/dist/esm/helpers/create-web-experience-model-from-template.d.ts

@@ -0,0 +1,26 @@
+/** @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 { IModelTemplate } from "@esri/hub-common";
+import { UserSession } from "@esri/solution-common";
+/**
+ * Convert a Web Experience template into a Model that can be persisted to the Portal API
+ *
+ * @param templateModel Template
+ * @param settings Hash of values to interpolate into the template
+ * @param transforms Hash of transform functions to use in the interpolation
+ * @param authentication UserSession
+ */
+export declare function createWebExperienceModelFromTemplate(templateModel: IModelTemplate, settings: any, transforms: any, authentication: UserSession): Promise<any>;

package/dist/esm/helpers/create-web-experience-model-from-template.js

@@ -0,0 +1,38 @@
+/** @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 { interpolate } from "@esri/hub-common";
+import { getWebExperiencepUrlTemplate } from "./get-web-experience-url-template";
+/**
+ * Convert a Web Experience template into a Model that can be persisted to the Portal API
+ *
+ * @param templateModel Template
+ * @param settings Hash of values to interpolate into the template
+ * @param transforms Hash of transform functions to use in the interpolation
+ * @param authentication UserSession
+ */
+export function createWebExperienceModelFromTemplate(templateModel, settings, transforms, authentication) {
+    // get the experience base url
+    settings.experienceUrlTemplate = getWebExperiencepUrlTemplate(authentication);
+    const model = interpolate(templateModel, settings, transforms);
+    // ensure this is set - there may be some templates w/o `{{experienceTemplateUrl}}
+    model.item.url = settings.experienceUrlTemplate;
+    /* istanbul ignore else */
+    if (templateModel.item.thumbnail) {
+        model.item.thumbnail = templateModel.item.thumbnail; // interpolation trashes thumbnail binary
+    }
+    return Promise.resolve(model);
+}
+//# sourceMappingURL=create-web-experience-model-from-template.js.map

package/dist/esm/helpers/create-web-experience-model-from-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-web-experience-model-from-template.js","sourceRoot":"","sources":["../../../src/helpers/create-web-experience-model-from-template.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,WAAW,EAAkB,MAAM,kBAAkB,CAAC;AAE/D,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AACjF;;;;;;;GAOG;AACH,MAAM,UAAU,oCAAoC,CAClD,aAA6B,EAC7B,QAAa,EACb,UAAe,EACf,cAA2B;IAE3B,8BAA8B;IAC9B,QAAQ,CAAC,qBAAqB,GAAG,4BAA4B,CAAC,cAAc,CAAC,CAAC;IAC9E,MAAM,KAAK,GAAG,WAAW,CAAC,aAAa,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC/D,kFAAkF;IAClF,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,qBAAqB,CAAC;IAChD,0BAA0B;IAC1B,IAAI,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE;QAChC,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,yCAAyC;KAC/F;IAED,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC"}

package/dist/esm/helpers/create-web-experience.d.ts

@@ -0,0 +1,25 @@
+/** @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 { IModel } from "@esri/hub-common";
+import { UserSession } from "@esri/solution-common";
+/**
+ * Given a Model for a Web Experience, create the item in the Portal API
+ *
+ * @param model
+ * @param options
+ * @param authentication
+ */
+export declare function createWebExperience(model: IModel, folderId: string, options: any, authentication: UserSession): Promise<IModel>;

package/dist/esm/helpers/create-web-experience.js

@@ -0,0 +1,115 @@
+/** @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 { cloneObject, failSafe, serializeModel, interpolateItemId, stringToBlob, objectToJsonBlob, } from "@esri/hub-common";
+import { addItemResource, createItem, moveItem, restUpdateItem, } from "@esri/solution-common";
+/**
+ * Given a Model for a Web Experience, create the item in the Portal API
+ *
+ * @param model
+ * @param options
+ * @param authentication
+ */
+export function createWebExperience(model, folderId, options, authentication) {
+    const resources = [];
+    // For unkown reasons we can not seem to spy on createItemInFolder
+    // so we will create-then-move for now
+    const createOptions = {
+        // need to serialize
+        item: 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 (createItem(createOptions)
+        .then((createResponse) => {
+        model.item.id = createResponse.id;
+        const savedThumbnail = model.item.thumbnail;
+        model = interpolateItemId(model);
+        model.item.thumbnail = savedThumbnail; // interpolation trashes thumbnail binary
+        // Experiences store draft data in a resource attached to the item
+        // We'll just use the published data for the first "draft"
+        // changed from stringToBlob to objectToJsonBlob for issue #742
+        const draftResourceModel = cloneObject(model.data);
+        resources.push({
+            name: "config.json",
+            prefix: "config",
+            file: objectToJsonBlob(draftResourceModel),
+        });
+        // there may also be this image resources list
+        const imageListModel = cloneObject(model.properties.imageResourcesList);
+        if (imageListModel) {
+            resources.push({
+                name: "image-resources-list.json",
+                prefix: "images",
+                file: stringToBlob(JSON.stringify(imageListModel)),
+            });
+        }
+        delete model.properties;
+        // update the experience with the newly interpolated model
+        const updateOptions = {
+            item: serializeModel(model),
+            authentication,
+        };
+        if (model.item.thumbnail) {
+            updateOptions.params = {
+                // Pass thumbnail file in via params because item property is serialized, which discards a blob
+                thumbnail: model.item.thumbnail,
+            };
+            delete updateOptions.item.thumbnail;
+        }
+        return Promise.all([restUpdateItem(updateOptions), authentication.getUsername()]);
+    })
+        .then((responses) => {
+        const username = responses[1];
+        const failSafeAddItemResource = failSafe(addItemResource, {
+            success: true,
+        });
+        // upload the data and oembed resources
+        const resourceUploadPromises = resources.map((resource) => failSafeAddItemResource({
+            id: model.item.id,
+            owner: username,
+            resource: resource.file,
+            name: resource.name,
+            prefix: resource.prefix,
+            authentication,
+        }));
+        // fire and forget
+        return Promise.all(resourceUploadPromises);
+    })
+        // .then(() => {
+        //   // TODO: Can we leave this to the main process?
+        //   return uploadResourcesFromUrl(model, options.assets || [], authentication);
+        // })
+        .then(() => {
+        // Move it
+        return moveItem({
+            itemId: model.item.id,
+            folderId,
+            authentication,
+        });
+    })
+        .then(() => {
+        return model;
+    }));
+}
+//# sourceMappingURL=create-web-experience.js.map

package/dist/esm/helpers/create-web-experience.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-web-experience.js","sourceRoot":"","sources":["../../../src/helpers/create-web-experience.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAEL,WAAW,EACX,QAAQ,EACR,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,GACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAIL,eAAe,EACf,UAAU,EACV,QAAQ,EACR,cAAc,GAEf,MAAM,uBAAuB,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAa,EACb,QAAgB,EAChB,OAAY,EACZ,cAA2B;IAE3B,MAAM,SAAS,GAAU,EAAE,CAAC;IAE5B,kEAAkE;IAClE,sCAAsC;IACtC,MAAM,aAAa,GAAuB;QACxC,oBAAoB;QACpB,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC;QAC3B,cAAc;KACf,CAAC;IAEF,0BAA0B;IAC1B,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE;QACxB,aAAa,CAAC,MAAM,GAAG;YACrB,+FAA+F;YAC/F,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS;SAChC,CAAC;QACF,OAAO,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;KACrC;IAED,kBAAkB;IAClB,OAAO,CACL,UAAU,CAAC,aAAa,CAAC;SACtB,IAAI,CAAC,CAAC,cAAmC,EAAE,EAAE;QAC5C,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,EAAE,CAAC;QAElC,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;QAC5C,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC,yCAAyC;QAEhF,kEAAkE;QAClE,0DAA0D;QAC1D,+DAA+D;QAC/D,MAAM,kBAAkB,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACnD,SAAS,CAAC,IAAI,CAAC;YACb,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;SAC3C,CAAC,CAAC;QACH,8CAA8C;QAC9C,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QACxE,IAAI,cAAc,EAAE;YAClB,SAAS,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,2BAA2B;gBACjC,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;aACnD,CAAC,CAAC;SACJ;QAED,OAAO,KAAK,CAAC,UAAU,CAAC;QACxB,0DAA0D;QAC1D,MAAM,aAAa,GAAuB;YACxC,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC;YAC3B,cAAc;SACf,CAAC;QACF,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE;YACxB,aAAa,CAAC,MAAM,GAAG;gBACrB,+FAA+F;gBAC/F,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS;aAChC,CAAC;YACF,OAAO,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;SACrC;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IACpF,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,SAAgB,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,uBAAuB,GAAG,QAAQ,CAAC,eAAe,EAAE;YACxD,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;QACH,uCAAuC;QACvC,MAAM,sBAAsB,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACxD,uBAAuB,CAAC;YACtB,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;YACjB,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,cAAc;SACf,CAAC,CACH,CAAC;QACF,kBAAkB;QAClB,OAAO,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAC7C,CAAC,CAAC;QACF,gBAAgB;QAChB,oDAAoD;QACpD,gFAAgF;QAChF,KAAK;SACJ,IAAI,CAAC,GAAG,EAAE;QACT,UAAU;QACV,OAAO,QAAQ,CAAC;YACd,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;YACrB,QAAQ;YACR,cAAc;SACf,CAAC,CAAC;IACL,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,EAAE;QACT,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CACL,CAAC;AACJ,CAAC"}

package/dist/esm/helpers/get-experience-subdomain.d.ts

@@ -0,0 +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";
+/**
+ * Returns the subdomain for an experience based on the  api the session is
+ * authenticated against
+ *
+ * @param authentication UserSession
+ */
+export declare function getExperienceSubdomain(authentication: UserSession): string;

package/dist/esm/helpers/get-experience-subdomain.js

@@ -0,0 +1,22 @@
+/**
+ * Returns the subdomain for an experience based on the  api the session is
+ * authenticated against
+ *
+ * @param authentication UserSession
+ */
+export function getExperienceSubdomain(authentication) {
+    const portalUrl = authentication.portal || "https://www.arcgis.com/sharing/rest";
+    // TODO: Sort out how we locate experiences on portal?
+    let result;
+    if (portalUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
+        result = "experienceqa";
+    }
+    else if (portalUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
+        result = "experiencedev";
+    }
+    else if (portalUrl.match(/(www|\.maps)\.arcgis.com/)) {
+        result = "experience";
+    }
+    return result;
+}
+//# sourceMappingURL=get-experience-subdomain.js.map

package/dist/esm/helpers/get-experience-subdomain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-experience-subdomain.js","sourceRoot":"","sources":["../../../src/helpers/get-experience-subdomain.ts"],"names":[],"mappings":"AAiBA;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,cAA2B;IAChE,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,IAAI,qCAAqC,CAAC;IACjF,sDAAsD;IACtD,IAAI,MAAM,CAAC;IACX,IAAI,SAAS,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE;QACnD,MAAM,GAAG,cAAc,CAAC;KACzB;SAAM,IAAI,SAAS,CAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;QAC/D,MAAM,GAAG,eAAe,CAAC;KAC1B;SAAM,IAAI,SAAS,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE;QACtD,MAAM,GAAG,YAAY,CAAC;KACvB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/esm/helpers/get-web-experience-dependencies.d.ts

@@ -0,0 +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 { IModel } from "@esri/hub-common";
+/**
+ * Given an Web Experience model, extract out all the
+ * items it depends on from the `dataSources` hash
+ *
+ * @param model IModel
+ */
+export declare function getWebExperienceDependencies(model: IModel): any[];

package/dist/esm/helpers/get-web-experience-dependencies.js

@@ -0,0 +1,29 @@
+/** @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 { getProp, maybePush } from "@esri/hub-common";
+/**
+ * Given an Web Experience model, extract out all the
+ * items it depends on from the `dataSources` hash
+ *
+ * @param model IModel
+ */
+export function getWebExperienceDependencies(model) {
+    const dataSources = getProp(model, "data.dataSources") || {};
+    return Object.keys(dataSources).reduce((acc, key) => {
+        return maybePush(getProp(dataSources, `${key}.itemId`), acc);
+    }, []);
+}
+//# sourceMappingURL=get-web-experience-dependencies.js.map

package/dist/esm/helpers/get-web-experience-dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-web-experience-dependencies.js","sourceRoot":"","sources":["../../../src/helpers/get-web-experience-dependencies.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAU,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,KAAa;IACxD,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,EAAE,kBAAkB,CAAC,IAAI,EAAE,CAAC;IAC7D,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAClD,OAAO,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,GAAG,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/D,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC"}

package/dist/esm/helpers/get-web-experience-url-template.d.ts

@@ -0,0 +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 getWebExperiencepUrlTemplate(authentication: UserSession): string;

package/dist/esm/helpers/get-web-experience-url-template.js

@@ -0,0 +1,22 @@
+import { getExperienceSubdomain } from "./get-experience-subdomain";
+/**
+ * For a given environment Prod/qa/dev/portal
+ * return the correct storymaps base url
+ *
+ * @param authentication
+ */
+export function getWebExperiencepUrlTemplate(authentication) {
+    let baseUrl = "";
+    const subdomain = getExperienceSubdomain(authentication);
+    if (subdomain) {
+        baseUrl = `https://${subdomain}.arcgis.com/experience/{{appid}}`;
+    }
+    else {
+        // we're on portal
+        // chop off the /sharing/rest to get the baseUrl
+        const portalBaseUrl = authentication.portal.replace("/sharing/rest", "");
+        baseUrl = `${portalBaseUrl}/apps/experiencebuilder/?id={{appid}}`;
+    }
+    return baseUrl;
+}
+//# sourceMappingURL=get-web-experience-url-template.js.map

package/dist/esm/helpers/get-web-experience-url-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-web-experience-url-template.js","sourceRoot":"","sources":["../../../src/helpers/get-web-experience-url-template.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,cAA2B;IACtE,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,MAAM,SAAS,GAAG,sBAAsB,CAAC,cAAc,CAAC,CAAC;IACzD,IAAI,SAAS,EAAE;QACb,OAAO,GAAG,WAAW,SAAS,kCAAkC,CAAC;KAClE;SAAM;QACL,kBAAkB;QAClB,gDAAgD;QAChD,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QACzE,OAAO,GAAG,GAAG,aAAa,uCAAuC,CAAC;KACnE;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,17 @@
+/** @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 * as WebExperienceProcessor from "./web-experience-processor";
+export { WebExperienceProcessor };

package/dist/esm/index.js

@@ -0,0 +1,18 @@
+/** @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 * as WebExperienceProcessor from "./web-experience-processor";
+export { WebExperienceProcessor };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

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