@esri/solution-web-experience 4.1.2 → 5.0.0

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

@@ -1,118 +1,118 @@
-/** @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 { createItem, updateItem, addItemResource, moveItem } from "@esri/arcgis-rest-portal";
-/**
- * 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([
-            updateItem(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;
-    }));
-}
+/** @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 { createItem, updateItem, addItemResource, moveItem } from "@esri/arcgis-rest-portal";
+/**
+ * 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([
+            updateItem(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/get-experience-subdomain.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";
-/**
- * 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;
+/** @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

@@ -1,22 +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;
-}
+/**
+ * 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-web-experience-dependencies.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 { 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[];
+/** @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

@@ -1,29 +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);
-    }, []);
-}
+/** @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-url-template.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 getWebExperiencepUrlTemplate(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 getWebExperiencepUrlTemplate(authentication: UserSession): string;

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

@@ -1,22 +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;
-}
+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/index.d.ts

@@ -1,17 +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 };
+/** @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

@@ -1,18 +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 };
+/** @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