@esri/solution-form 4.1.2 → 5.0.0

package/dist/cjs/helpers/create-item-from-hub-template.js

@@ -1,80 +1,80 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createItemFromHubTemplate = void 0;
-const solution_common_1 = require("@esri/solution-common");
-const create_survey_1 = require("./create-survey");
-const build_create_params_1 = require("./build-create-params");
-/**
- * Manages the creation of Surveys from Hub Templates
- * via the Survey123 API
- *
- * @module create-item-from-hub-template
- */
-/**
- * Orchestrates creation of Surveys from Hub templates
- *
- * @param {IItemTemplate} template The template
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} destinationAuthentication The destination session info
- * @param {Function} itemProgressCallback A progress callback
- * @returns {Promise<ICreateItemFromTemplateResponse>}
- */
-function createItemFromHubTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    const interpolatedTemplate = (0, solution_common_1.replaceInTemplate)(template, templateDictionary);
-    const { survey123Url } = templateDictionary;
-    return (0, build_create_params_1.buildCreateParams)(interpolatedTemplate, templateDictionary, destinationAuthentication)
-        .then((params) => {
-        return (0, create_survey_1.createSurvey)(params, survey123Url);
-    })
-        .then((createSurveyResponse) => {
-        const { formId, featureServiceId } = createSurveyResponse;
-        // Update the item with its thumbnail
-        let thumbDef = Promise.resolve(null);
-        /* istanbul ignore else */
-        if (template.item.thumbnail) {
-            thumbDef = (0, solution_common_1.updateItemExtended)({ id: formId }, null, destinationAuthentication, template.item.thumbnail);
-        }
-        return thumbDef
-            .then(() => (0, solution_common_1.getItemBase)(formId, destinationAuthentication))
-            .then(item => {
-            templateDictionary[interpolatedTemplate.itemId] = {
-                itemId: formId
-            };
-            templateDictionary[interpolatedTemplate.properties.info.serviceInfo.itemId] = {
-                itemId: featureServiceId
-            };
-            itemProgressCallback(interpolatedTemplate.itemId, solution_common_1.EItemProgressStatus.Finished, interpolatedTemplate.estimatedDeploymentCostFactor, formId);
-            return {
-                item: {
-                    ...template,
-                    item,
-                    itemId: formId
-                },
-                id: formId,
-                type: "Form",
-                postProcess: true
-            };
-        });
-    })
-        .catch(e => {
-        itemProgressCallback(interpolatedTemplate.itemId, solution_common_1.EItemProgressStatus.Failed, 0);
-        throw e;
-    });
-}
-exports.createItemFromHubTemplate = createItemFromHubTemplate;
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createItemFromHubTemplate = void 0;
+const solution_common_1 = require("@esri/solution-common");
+const create_survey_1 = require("./create-survey");
+const build_create_params_1 = require("./build-create-params");
+/**
+ * Manages the creation of Surveys from Hub Templates
+ * via the Survey123 API
+ *
+ * @module create-item-from-hub-template
+ */
+/**
+ * Orchestrates creation of Surveys from Hub templates
+ *
+ * @param {IItemTemplate} template The template
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} destinationAuthentication The destination session info
+ * @param {Function} itemProgressCallback A progress callback
+ * @returns {Promise<ICreateItemFromTemplateResponse>}
+ */
+function createItemFromHubTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    const interpolatedTemplate = (0, solution_common_1.replaceInTemplate)(template, templateDictionary);
+    const { survey123Url } = templateDictionary;
+    return (0, build_create_params_1.buildCreateParams)(interpolatedTemplate, templateDictionary, destinationAuthentication)
+        .then((params) => {
+        return (0, create_survey_1.createSurvey)(params, survey123Url);
+    })
+        .then((createSurveyResponse) => {
+        const { formId, featureServiceId } = createSurveyResponse;
+        // Update the item with its thumbnail
+        let thumbDef = Promise.resolve(null);
+        /* istanbul ignore else */
+        if (template.item.thumbnail) {
+            thumbDef = (0, solution_common_1.updateItemExtended)({ id: formId }, null, destinationAuthentication, template.item.thumbnail);
+        }
+        return thumbDef
+            .then(() => (0, solution_common_1.getItemBase)(formId, destinationAuthentication))
+            .then(item => {
+            templateDictionary[interpolatedTemplate.itemId] = {
+                itemId: formId
+            };
+            templateDictionary[interpolatedTemplate.properties.info.serviceInfo.itemId] = {
+                itemId: featureServiceId
+            };
+            itemProgressCallback(interpolatedTemplate.itemId, solution_common_1.EItemProgressStatus.Finished, interpolatedTemplate.estimatedDeploymentCostFactor, formId);
+            return {
+                item: {
+                    ...template,
+                    item,
+                    itemId: formId
+                },
+                id: formId,
+                type: "Form",
+                postProcess: true
+            };
+        });
+    })
+        .catch(e => {
+        itemProgressCallback(interpolatedTemplate.itemId, solution_common_1.EItemProgressStatus.Failed, 0);
+        throw e;
+    });
+}
+exports.createItemFromHubTemplate = createItemFromHubTemplate;
 //# sourceMappingURL=create-item-from-hub-template.js.map

package/dist/cjs/helpers/create-survey.d.ts

@@ -1,30 +1,30 @@
-/** @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 { ISurvey123CreateParams, ISurvey123CreateResult } from "@esri/solution-common";
-/**
- * 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 declare function createSurvey(params: ISurvey123CreateParams, survey123Url?: string): Promise<ISurvey123CreateResult>;
+/** @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 { ISurvey123CreateParams, ISurvey123CreateResult } from "@esri/solution-common";
+/**
+ * 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 declare function createSurvey(params: ISurvey123CreateParams, survey123Url?: string): Promise<ISurvey123CreateResult>;

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

@@ -1,60 +1,60 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSurvey = void 0;
-const arcgis_rest_request_1 = require("@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>}
- */
-function createSurvey(params, survey123Url = "https://survey123.arcgis.com") {
-    const createUrl = `${survey123Url}/api/survey/create`;
-    const ro = {
-        credentials: "same-origin",
-        method: "POST",
-        body: (0, arcgis_rest_request_1.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
-        };
-    });
-}
-exports.createSurvey = createSurvey;
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSurvey = void 0;
+const arcgis_rest_request_1 = require("@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>}
+ */
+function createSurvey(params, survey123Url = "https://survey123.arcgis.com") {
+    const createUrl = `${survey123Url}/api/survey/create`;
+    const ro = {
+        credentials: "same-origin",
+        method: "POST",
+        body: (0, arcgis_rest_request_1.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
+        };
+    });
+}
+exports.createSurvey = createSurvey;
 //# sourceMappingURL=create-survey.js.map

package/dist/cjs/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/cjs/helpers/encode-survey-form.js

@@ -1,59 +1,59 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeSurveyForm = void 0;
-const solution_common_1 = require("@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
- */
-const encodeSurveyForm = function encodeForm(form) {
-    const clone = (0, solution_common_1.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;
-};
-exports.encodeSurveyForm = encodeSurveyForm;
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeSurveyForm = void 0;
+const solution_common_1 = require("@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
+ */
+const encodeSurveyForm = function encodeForm(form) {
+    const clone = (0, solution_common_1.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;
+};
+exports.encodeSurveyForm = encodeSurveyForm;
 //# sourceMappingURL=encode-survey-form.js.map

package/dist/cjs/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/cjs/helpers/is-hub-form-template.js

@@ -1,33 +1,33 @@
-"use strict";
-/** @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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isHubFormTemplate = void 0;
-const tslib_1 = require("tslib");
-const common = tslib_1.__importStar(require("@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}
- */
-function isHubFormTemplate(template) {
-    // relying on basic duck typing vs adding extraneous props during migration
-    return !!common.getProp(template, "properties.services");
-}
-exports.isHubFormTemplate = isHubFormTemplate;
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHubFormTemplate = void 0;
+const tslib_1 = require("tslib");
+const common = tslib_1.__importStar(require("@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}
+ */
+function isHubFormTemplate(template) {
+    // relying on basic duck typing vs adding extraneous props during migration
+    return !!common.getProp(template, "properties.services");
+}
+exports.isHubFormTemplate = isHubFormTemplate;
 //# sourceMappingURL=is-hub-form-template.js.map