@esri/solution-form 4.1.2 → 5.0.0

package/dist/esm/helpers/create-survey.js

@@ -1,56 +1,56 @@
-/** @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 { encodeFormData } from "@esri/arcgis-rest-request";
-/**
- * Provides utility method to call Survey123 create endpoint
- *
- * @module create-survey
- */
-/**
- * Calls the Survey123 create API with the given parameters
- *
- * @param {ISurvey123CreateParams} params
- * @param {string} [survey123Url=https://survey123.arcgis.com] An optional, Survey123 base URL override
- * @throws Will throw if the Survey123 API returns an error response
- * @returns {Promise<ISurvey123CreateResult>}
- */
-export function createSurvey(params, survey123Url = "https://survey123.arcgis.com") {
-    const createUrl = `${survey123Url}/api/survey/create`;
-    const ro = {
-        credentials: "same-origin",
-        method: "POST",
-        body: encodeFormData({
-            f: "json",
-            ...params
-        }, true)
-    };
-    // Using @esri/arcgis-request "request" method was resulting in a 404 for
-    // a CORS preflight request related to this request, but calling fetch directly
-    // circumvents the issue.
-    return fetch(createUrl, ro)
-        .then(response => response.json())
-        .then(response => {
-        if (!response.success) {
-            throw new Error(`Failed to create survey: ${response.error.message}`);
-        }
-        return {
-            formId: response.id,
-            featureServiceId: response.featureService.source.itemId,
-            folderId: response.formItemInfo.ownerFolder
-        };
-    });
-}
+/** @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 { encodeFormData } from "@esri/arcgis-rest-request";
+/**
+ * Provides utility method to call Survey123 create endpoint
+ *
+ * @module create-survey
+ */
+/**
+ * Calls the Survey123 create API with the given parameters
+ *
+ * @param {ISurvey123CreateParams} params
+ * @param {string} [survey123Url=https://survey123.arcgis.com] An optional, Survey123 base URL override
+ * @throws Will throw if the Survey123 API returns an error response
+ * @returns {Promise<ISurvey123CreateResult>}
+ */
+export function createSurvey(params, survey123Url = "https://survey123.arcgis.com") {
+    const createUrl = `${survey123Url}/api/survey/create`;
+    const ro = {
+        credentials: "same-origin",
+        method: "POST",
+        body: encodeFormData({
+            f: "json",
+            ...params
+        }, true)
+    };
+    // Using @esri/arcgis-request "request" method was resulting in a 404 for
+    // a CORS preflight request related to this request, but calling fetch directly
+    // circumvents the issue.
+    return fetch(createUrl, ro)
+        .then(response => response.json())
+        .then(response => {
+        if (!response.success) {
+            throw new Error(`Failed to create survey: ${response.error.message}`);
+        }
+        return {
+            formId: response.id,
+            featureServiceId: response.featureService.source.itemId,
+            folderId: response.formItemInfo.ownerFolder
+        };
+    });
+}
 //# sourceMappingURL=create-survey.js.map

package/dist/esm/helpers/encode-survey-form.d.ts

@@ -1,28 +1,28 @@
-/** @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.
- */
-/**
- * Manages Survey123 parameter encoding
- *
- * @module encode-survey-form
- */
-/**
- * URI Encodes Survey123 form content parameter
- * values
- *
- * @param {any} form Unencoded form data
- * @returns {any} Encoded form data
- */
-export declare const encodeSurveyForm: (form: any) => 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.
+ */
+/**
+ * Manages Survey123 parameter encoding
+ *
+ * @module encode-survey-form
+ */
+/**
+ * URI Encodes Survey123 form content parameter
+ * values
+ *
+ * @param {any} form Unencoded form data
+ * @returns {any} Encoded form data
+ */
+export declare const encodeSurveyForm: (form: any) => any;

package/dist/esm/helpers/encode-survey-form.js

@@ -1,55 +1,55 @@
-/** @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 } from "@esri/solution-common";
-/**
- * Manages Survey123 parameter encoding
- *
- * @module encode-survey-form
- */
-/**
- * URI Encodes Survey123 form content parameter
- * values
- *
- * @param {any} form Unencoded form data
- * @returns {any} Encoded form data
- */
-export const encodeSurveyForm = function encodeForm(form) {
-    const clone = cloneObject(form);
-    const props = [
-        ["header", "content"],
-        ["subHeader", "content"],
-        ["footer", "content"],
-        ["settings", "thankYouScreenContent"]
-    ];
-    const encode = (obj, key) => {
-        if (obj && obj[key]) {
-            obj[key] = encodeURIComponent(obj[key]);
-        }
-        return obj;
-    };
-    // encode props from array above
-    props.forEach(([objKey, propKey]) => encode(clone[objKey], propKey));
-    const encodeQuestion = (question) => encode(question, "description");
-    // encode question descriptions
-    clone.questions = (clone.questions || []).map((question) => !question.questions
-        ? encodeQuestion(question)
-        : {
-            ...question,
-            questions: question.questions.map(encodeQuestion)
-        });
-    return clone;
-};
+/** @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 } from "@esri/solution-common";
+/**
+ * Manages Survey123 parameter encoding
+ *
+ * @module encode-survey-form
+ */
+/**
+ * URI Encodes Survey123 form content parameter
+ * values
+ *
+ * @param {any} form Unencoded form data
+ * @returns {any} Encoded form data
+ */
+export const encodeSurveyForm = function encodeForm(form) {
+    const clone = cloneObject(form);
+    const props = [
+        ["header", "content"],
+        ["subHeader", "content"],
+        ["footer", "content"],
+        ["settings", "thankYouScreenContent"]
+    ];
+    const encode = (obj, key) => {
+        if (obj && obj[key]) {
+            obj[key] = encodeURIComponent(obj[key]);
+        }
+        return obj;
+    };
+    // encode props from array above
+    props.forEach(([objKey, propKey]) => encode(clone[objKey], propKey));
+    const encodeQuestion = (question) => encode(question, "description");
+    // encode question descriptions
+    clone.questions = (clone.questions || []).map((question) => !question.questions
+        ? encodeQuestion(question)
+        : {
+            ...question,
+            questions: question.questions.map(encodeQuestion)
+        });
+    return clone;
+};
 //# sourceMappingURL=encode-survey-form.js.map

package/dist/esm/helpers/is-hub-form-template.d.ts

@@ -1,24 +1,24 @@
-/** @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 * as common from "@esri/solution-common";
-/**
- * Determines if the given template is a Hub Survey
- * template vs Solutions.js Survey template.
- *
- * @param {IITemTemplate} template A template
- * @returns {boolean}
- */
-export declare function isHubFormTemplate(template: common.IItemTemplate): boolean;
+/** @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 * as common from "@esri/solution-common";
+/**
+ * Determines if the given template is a Hub Survey
+ * template vs Solutions.js Survey template.
+ *
+ * @param {IITemTemplate} template A template
+ * @returns {boolean}
+ */
+export declare function isHubFormTemplate(template: common.IItemTemplate): boolean;

package/dist/esm/helpers/is-hub-form-template.js

@@ -1,28 +1,28 @@
-/** @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 * as common from "@esri/solution-common";
-/**
- * Determines if the given template is a Hub Survey
- * template vs Solutions.js Survey template.
- *
- * @param {IITemTemplate} template A template
- * @returns {boolean}
- */
-export function isHubFormTemplate(template) {
-    // relying on basic duck typing vs adding extraneous props during migration
-    return !!common.getProp(template, "properties.services");
-}
+/** @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 * as common from "@esri/solution-common";
+/**
+ * Determines if the given template is a Hub Survey
+ * template vs Solutions.js Survey template.
+ *
+ * @param {IITemTemplate} template A template
+ * @returns {boolean}
+ */
+export function isHubFormTemplate(template) {
+    // relying on basic duck typing vs adding extraneous props during migration
+    return !!common.getProp(template, "properties.services");
+}
 //# sourceMappingURL=is-hub-form-template.js.map

package/dist/esm/helpers/post-process-survey.d.ts

@@ -1,33 +1,33 @@
-/** @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, IItemTemplate } from "@esri/solution-common";
-/**
- * Provides utility method to post process Hub surveys
- *
- * @module post-process-survey
- */
-/**
- * Performs Survey post processing actions
- *
- * @param {string} itemId The item ID
- * @param {string} type The template/item type
- * @param {any[]} itemInfos An Array of item details
- * @param {IItemTemplate} template The template
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} authentication The destination session info
- * @returns {Promise<any>}
- */
-export declare function postProcessHubSurvey(itemId: string, type: string, itemInfos: any[], template: IItemTemplate, templates: IItemTemplate[], templateDictionary: any, authentication: UserSession): Promise<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 { UserSession, IItemTemplate } from "@esri/solution-common";
+/**
+ * Provides utility method to post process Hub surveys
+ *
+ * @module post-process-survey
+ */
+/**
+ * Performs Survey post processing actions
+ *
+ * @param {string} itemId The item ID
+ * @param {string} type The template/item type
+ * @param {any[]} itemInfos An Array of item details
+ * @param {IItemTemplate} template The template
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} authentication The destination session info
+ * @returns {Promise<any>}
+ */
+export declare function postProcessHubSurvey(itemId: string, type: string, itemInfos: any[], template: IItemTemplate, templates: IItemTemplate[], templateDictionary: any, authentication: UserSession): Promise<any>;

package/dist/esm/helpers/post-process-survey.js

@@ -1,78 +1,78 @@
-/** @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 { updateItem, replaceInTemplate, getItemBase, createInitializedItemTemplate, removeFolder } from "@esri/solution-common";
-import { moveItem } from "@esri/arcgis-rest-portal";
-/**
- * Provides utility method to post process Hub surveys
- *
- * @module post-process-survey
- */
-/**
- * Performs Survey post processing actions
- *
- * @param {string} itemId The item ID
- * @param {string} type The template/item type
- * @param {any[]} itemInfos An Array of item details
- * @param {IItemTemplate} template The template
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} authentication The destination session info
- * @returns {Promise<any>}
- */
-export function postProcessHubSurvey(itemId, type, itemInfos, template, templates, templateDictionary, authentication) {
-    const featureServiceSourceId = template.properties.info.serviceInfo.itemId;
-    const { itemId: featureServiceResultId } = templateDictionary[featureServiceSourceId];
-    const interpolated = replaceInTemplate(template, templateDictionary);
-    return getItemBase(featureServiceResultId, authentication).then(featureServiceResultBase => {
-        const itemUpdates = [
-            // fix/update form properties we couldn't control via the API
-            {
-                id: itemId,
-                title: interpolated.item.title,
-                snippet: interpolated.item.snippet,
-                extent: interpolated.item.extent,
-                culture: interpolated.item.culture
-            },
-            // fix/update feature service properties we couldn't control via the API
-            {
-                id: featureServiceResultId,
-                extent: interpolated.item.extent,
-                typeKeywords: [`source-${featureServiceSourceId}`].concat(featureServiceResultBase.typeKeywords)
-            }
-        ];
-        const toUpdatePromise = (updatedItem) => updateItem(updatedItem, authentication);
-        const updatePromises = itemUpdates.map(toUpdatePromise);
-        return Promise.all(updatePromises)
-            .then(() => {
-            const itemIdsToMove = [itemId, featureServiceResultId];
-            const toMovePromise = (id) => moveItem({
-                itemId: id,
-                folderId: templateDictionary.folderId,
-                authentication: authentication
-            });
-            const movePromises = itemIdsToMove.map(toMovePromise);
-            return Promise.all(movePromises);
-        })
-            .then(() => removeFolder(featureServiceResultBase.ownerFolder, authentication))
-            .then(() => {
-            // Create a template item for the Feature Service that was created by the API
-            const featureServiceTemplate = createInitializedItemTemplate(featureServiceResultBase);
-            templates.push(featureServiceTemplate);
-            template.dependencies.push(featureServiceResultBase.id);
-            return true;
-        });
-    });
-}
+/** @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 { updateItem, replaceInTemplate, getItemBase, createInitializedItemTemplate, removeFolder } from "@esri/solution-common";
+import { moveItem } from "@esri/arcgis-rest-portal";
+/**
+ * Provides utility method to post process Hub surveys
+ *
+ * @module post-process-survey
+ */
+/**
+ * Performs Survey post processing actions
+ *
+ * @param {string} itemId The item ID
+ * @param {string} type The template/item type
+ * @param {any[]} itemInfos An Array of item details
+ * @param {IItemTemplate} template The template
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} authentication The destination session info
+ * @returns {Promise<any>}
+ */
+export function postProcessHubSurvey(itemId, type, itemInfos, template, templates, templateDictionary, authentication) {
+    const featureServiceSourceId = template.properties.info.serviceInfo.itemId;
+    const { itemId: featureServiceResultId } = templateDictionary[featureServiceSourceId];
+    const interpolated = replaceInTemplate(template, templateDictionary);
+    return getItemBase(featureServiceResultId, authentication).then(featureServiceResultBase => {
+        const itemUpdates = [
+            // fix/update form properties we couldn't control via the API
+            {
+                id: itemId,
+                title: interpolated.item.title,
+                snippet: interpolated.item.snippet,
+                extent: interpolated.item.extent,
+                culture: interpolated.item.culture
+            },
+            // fix/update feature service properties we couldn't control via the API
+            {
+                id: featureServiceResultId,
+                extent: interpolated.item.extent,
+                typeKeywords: [`source-${featureServiceSourceId}`].concat(featureServiceResultBase.typeKeywords)
+            }
+        ];
+        const toUpdatePromise = (updatedItem) => updateItem(updatedItem, authentication);
+        const updatePromises = itemUpdates.map(toUpdatePromise);
+        return Promise.all(updatePromises)
+            .then(() => {
+            const itemIdsToMove = [itemId, featureServiceResultId];
+            const toMovePromise = (id) => moveItem({
+                itemId: id,
+                folderId: templateDictionary.folderId,
+                authentication: authentication
+            });
+            const movePromises = itemIdsToMove.map(toMovePromise);
+            return Promise.all(movePromises);
+        })
+            .then(() => removeFolder(featureServiceResultBase.ownerFolder, authentication))
+            .then(() => {
+            // Create a template item for the Feature Service that was created by the API
+            const featureServiceTemplate = createInitializedItemTemplate(featureServiceResultBase);
+            templates.push(featureServiceTemplate);
+            template.dependencies.push(featureServiceResultBase.id);
+            return true;
+        });
+    });
+}
 //# sourceMappingURL=post-process-survey.js.map

package/dist/esm/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 form item types.
- *
- * @module solution-form
- */
-export * from "./convert-item-to-template";
-export * from "./create-item-from-template";
-export * from "./post-process";
+/** @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 form item types.
+ *
+ * @module solution-form
+ */
+export * from "./convert-item-to-template";
+export * from "./create-item-from-template";
+export * from "./post-process";