@esri/solution-web-experience 3.0.0 → 3.1.0

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

@@ -1,126 +0,0 @@
-"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 arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-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 solutionItemId
- * @param itemInfo
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param isGroup
- */
-function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication) {
-    // use the itemInfo to setup a model
-    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_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)(arcgis_rest_portal_1.removeItem, { 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,
-                    ...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/node/web-experience-processor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"web-experience-processor.js","sourceRoot":"","sources":["../../src/web-experience-processor.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AAEH,2DAS+B;AAC/B,iDAAoD;AACpD,iEAAmE;AACnE,mHAA2G;AAC3G,2EAAsE;AACtE,qGAA8F;AAE9F;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,cAAsB,EACtB,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,gCAAW,EAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACjF,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;AAlBD,sDAkBC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,QAAuB,EACvB,kBAAuB,EACvB,yBAAsC,EACtC,oBAA2C;IAE3C,gDAAgD;IAChD,MAAM,WAAW,GAAG,oBAAoB,CACtC,QAAQ,CAAC,MAAM,EACf,qCAAmB,CAAC,OAAO,EAC3B,CAAC,CACF,CAAC;IAEF,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,EACzC,QAAQ,EACR,kBAAkB,EAClB,EAAE,EACF,yBAAyB,CAC1B;SACE,IAAI,CAAC,KAAK,CAAC,EAAE;QACZ,QAAQ,GAAG,KAAK,CAAC;QACjB,OAAO,IAAA,2CAAmB,EACxB,KAAK,EACL,kBAAkB,CAAC,QAAQ,EAC3B,EAAE,EACF,yBAAyB,CAC1B,CAAC;IACJ,CAAC,CAAC;SACD,IAAI,CAAC,YAAY,CAAC,EAAE;QACnB,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,+BAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAC/D,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,QAAQ;iBACZ;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;AA1ED,wDA0EC;AAED;;;;;;;;;GASG;AACH,SAAgB,WAAW,CACzB,MAAc,EACd,IAAY,EACZ,SAAgB,EAChB,QAAuB,EACvB,SAA0B,EAC1B,kBAAuB,EACvB,cAA2B;IAE3B,OAAO,IAAA,kDAAgC,EACrC,MAAM,EACN,kBAAkB,EAClB,cAAc,CACf,CAAC;AACJ,CAAC;AAdD,kCAcC"}

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

@@ -1,27 +0,0 @@
-/** @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/umd/web-experience/src/helpers/create-web-experience-model-from-template.d.ts

@@ -1,26 +0,0 @@
-/** @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/umd/web-experience/src/helpers/create-web-experience.d.ts

@@ -1,25 +0,0 @@
-/** @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/umd/web-experience/src/helpers/get-experience-subdomain.d.ts

@@ -1,23 +0,0 @@
-/** @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/umd/web-experience/src/helpers/get-web-experience-dependencies.d.ts

@@ -1,23 +0,0 @@
-/** @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/umd/web-experience/src/helpers/get-web-experience-url-template.d.ts

@@ -1,23 +0,0 @@
-/** @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/umd/web-experience/src/index.d.ts

@@ -1,17 +0,0 @@
-/** @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/umd/web-experience/src/web-experience-processor.d.ts

@@ -1,51 +0,0 @@
-/** @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 web-experience item types.
- *
- * @module solution-web-experience
- */
-import { UserSession, IItemProgressCallback, IItemTemplate, ICreateItemFromTemplateResponse, IUpdateItemResponse } from "@esri/solution-common";
-/**
- * Convert a Web Experience item into a Template
- *
- * @param solutionItemId
- * @param itemInfo
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param isGroup
- */
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession): Promise<IItemTemplate>;
-/**
- * Create a Web Experience from a Template
- *
- * @param template
- * @param templateDictionary
- * @param destinationAuthentication
- * @param itemProgressCallback
- */
-export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
-/**
- * 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
- */
-export declare function postProcess(itemId: string, type: string, itemInfos: any[], template: IItemTemplate, templates: IItemTemplate[], templateDictionary: any, authentication: UserSession): Promise<IUpdateItemResponse>;