@esri/solution-form 4.1.2-alpha.0 → 5.0.0

package/dist/cjs/convert-item-to-template.d.ts

@@ -1,32 +1,32 @@
-/** @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 of Form templates
- *
- * @module convert-item-to-template
- */
-import { UserSession, IItemTemplate } from "@esri/solution-common";
-/**
- * Creates a template from a Form item
- *
- * @param {string} solutionItemId The solution item ID
- * @param {any} itemInfo: The base item info
- * @param {UserSession} destAuthentication Credentials for requests to the destination organization
- * @param {UserSession} srcAuthentication Credentials for requests to source items
- * @param {any} templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @returns {Promise<IItemTemplate>}
- */
-export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession, templateDictionary: any): Promise<IItemTemplate>;
+/** @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 of Form templates
+ *
+ * @module convert-item-to-template
+ */
+import { UserSession, IItemTemplate } from "@esri/solution-common";
+/**
+ * Creates a template from a Form item
+ *
+ * @param {string} solutionItemId The solution item ID
+ * @param {any} itemInfo: The base item info
+ * @param {UserSession} destAuthentication Credentials for requests to the destination organization
+ * @param {UserSession} srcAuthentication Credentials for requests to source items
+ * @param {any} templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ * @returns {Promise<IItemTemplate>}
+ */
+export declare function convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession, templateDictionary: any): Promise<IItemTemplate>;

package/dist/cjs/convert-item-to-template.js

@@ -1,35 +1,35 @@
-"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.convertItemToTemplate = void 0;
-const solution_simple_types_1 = require("@esri/solution-simple-types");
-/**
- * Creates a template from a Form item
- *
- * @param {string} solutionItemId The solution item ID
- * @param {any} itemInfo: The base item info
- * @param {UserSession} destAuthentication Credentials for requests to the destination organization
- * @param {UserSession} srcAuthentication Credentials for requests to source items
- * @param {any} templateDictionary Hash of facts: folder id, org URL, adlib replacements
- * @returns {Promise<IItemTemplate>}
- */
-function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
-    // Delegate to simple types
-    return solution_simple_types_1.simpleTypes.convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary);
-}
-exports.convertItemToTemplate = convertItemToTemplate;
+"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.convertItemToTemplate = void 0;
+const solution_simple_types_1 = require("@esri/solution-simple-types");
+/**
+ * Creates a template from a Form item
+ *
+ * @param {string} solutionItemId The solution item ID
+ * @param {any} itemInfo: The base item info
+ * @param {UserSession} destAuthentication Credentials for requests to the destination organization
+ * @param {UserSession} srcAuthentication Credentials for requests to source items
+ * @param {any} templateDictionary Hash of facts: folder id, org URL, adlib replacements
+ * @returns {Promise<IItemTemplate>}
+ */
+function convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary) {
+    // Delegate to simple types
+    return solution_simple_types_1.simpleTypes.convertItemToTemplate(solutionItemId, itemInfo, destAuthentication, srcAuthentication, templateDictionary);
+}
+exports.convertItemToTemplate = convertItemToTemplate;
 //# sourceMappingURL=convert-item-to-template.js.map

package/dist/cjs/create-item-from-template.d.ts

@@ -1,31 +1,31 @@
-/** @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 deployment items from Form templates.
- *
- * @module create-item-from-template
- */
-import { UserSession, IItemTemplate, IItemProgressCallback, ICreateItemFromTemplateResponse } from "@esri/solution-common";
-/**
- * Creates a Form item from a template
- *
- * @param {IItemTemplate} template The template
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} destinationAuthentication The destination user session info
- * @param itemProgressCallback An item progress callback
- * @returns {Promise<ICreateItemFromTemplateResponse>}
- */
-export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
+/** @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 deployment items from Form templates.
+ *
+ * @module create-item-from-template
+ */
+import { UserSession, IItemTemplate, IItemProgressCallback, ICreateItemFromTemplateResponse } from "@esri/solution-common";
+/**
+ * Creates a Form item from a template
+ *
+ * @param {IItemTemplate} template The template
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} destinationAuthentication The destination user session info
+ * @param itemProgressCallback An item progress callback
+ * @returns {Promise<ICreateItemFromTemplateResponse>}
+ */
+export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;

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

@@ -1,40 +1,40 @@
-"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.createItemFromTemplate = void 0;
-const solution_simple_types_1 = require("@esri/solution-simple-types");
-const is_hub_form_template_1 = require("./helpers/is-hub-form-template");
-const create_item_from_hub_template_1 = require("./helpers/create-item-from-hub-template");
-/**
- * Creates a Form item from a template
- *
- * @param {IItemTemplate} template The template
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} destinationAuthentication The destination user session info
- * @param itemProgressCallback An item progress callback
- * @returns {Promise<ICreateItemFromTemplateResponse>}
- */
-function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
-    // Hub Form template custom processing
-    if ((0, is_hub_form_template_1.isHubFormTemplate)(template)) {
-        return (0, create_item_from_hub_template_1.createItemFromHubTemplate)(template, templateDictionary, destinationAuthentication, itemProgressCallback);
-    }
-    // otherwise delegate to simple types
-    return solution_simple_types_1.simpleTypes.createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback);
-}
-exports.createItemFromTemplate = createItemFromTemplate;
+"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.createItemFromTemplate = void 0;
+const solution_simple_types_1 = require("@esri/solution-simple-types");
+const is_hub_form_template_1 = require("./helpers/is-hub-form-template");
+const create_item_from_hub_template_1 = require("./helpers/create-item-from-hub-template");
+/**
+ * Creates a Form item from a template
+ *
+ * @param {IItemTemplate} template The template
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} destinationAuthentication The destination user session info
+ * @param itemProgressCallback An item progress callback
+ * @returns {Promise<ICreateItemFromTemplateResponse>}
+ */
+function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    // Hub Form template custom processing
+    if ((0, is_hub_form_template_1.isHubFormTemplate)(template)) {
+        return (0, create_item_from_hub_template_1.createItemFromHubTemplate)(template, templateDictionary, destinationAuthentication, itemProgressCallback);
+    }
+    // otherwise delegate to simple types
+    return solution_simple_types_1.simpleTypes.createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback);
+}
+exports.createItemFromTemplate = createItemFromTemplate;
 //# sourceMappingURL=create-item-from-template.js.map

package/dist/cjs/helpers/build-create-params.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 { IItemTemplate, UserSession, ISurvey123CreateParams } from "@esri/solution-common";
-/**
- * Utility method for creating Survey123 parameters
- *
- * @module build-create-params
- */
-/**
- * Builds the Survey123 create API parameters
- *
- * @param {IItemTemplate} template The template
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} destinationAuthentication The destination session info
- * @returns {Promise<ISurvey123CreateParams>}
- */
-export declare function buildCreateParams(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession): Promise<ISurvey123CreateParams>;
+/** @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 { IItemTemplate, UserSession, ISurvey123CreateParams } from "@esri/solution-common";
+/**
+ * Utility method for creating Survey123 parameters
+ *
+ * @module build-create-params
+ */
+/**
+ * Builds the Survey123 create API parameters
+ *
+ * @param {IItemTemplate} template The template
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} destinationAuthentication The destination session info
+ * @returns {Promise<ISurvey123CreateParams>}
+ */
+export declare function buildCreateParams(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession): Promise<ISurvey123CreateParams>;

package/dist/cjs/helpers/build-create-params.js

@@ -1,78 +1,78 @@
-"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.buildCreateParams = void 0;
-const solution_common_1 = require("@esri/solution-common");
-const encode_survey_form_1 = require("./encode-survey-form");
-/**
- * Utility method for creating Survey123 parameters
- *
- * @module build-create-params
- */
-/**
- * Builds the Survey123 create API parameters
- *
- * @param {IItemTemplate} template The template
- * @param {any} templateDictionary The template dictionary
- * @param {UserSession} destinationAuthentication The destination session info
- * @returns {Promise<ISurvey123CreateParams>}
- */
-function buildCreateParams(template, templateDictionary, destinationAuthentication) {
-    const { item: { title: originalTitle, description, tags, typeKeywords }, properties: { form: unencodedForm } } = template;
-    const { user: { username }, portalBaseUrl: portalUrl, organization: { basemapGalleryGroupQuery, defaultBasemap: { title: basemapTitle } } } = templateDictionary;
-    const { token } = destinationAuthentication.toCredential();
-    return (0, solution_common_1.getPortalDefaultBasemap)(basemapGalleryGroupQuery, basemapTitle, destinationAuthentication).then(defaultBasemap => {
-        // The S123 API appends "Survey-" to the survey title when computing
-        // the folder name. We need to use the same prefix to successfully
-        // calculate a unique folder name. Afterwards, we can safely remove the
-        // prefix from the title
-        const folderPrefix = "Survey-";
-        const title = (0, solution_common_1.getUniqueTitle)(`${folderPrefix}${originalTitle}`, templateDictionary, "user.folders").replace(folderPrefix, "");
-        // set any map question's basemaps to default org basemap
-        if (unencodedForm.questions) {
-            const updateBasemap = (question) => {
-                if (question.maps) {
-                    question.maps = question.maps.map((map) => ({
-                        ...map,
-                        itemId: defaultBasemap.id
-                    }));
-                }
-                return question;
-            };
-            unencodedForm.questions = unencodedForm.questions.map((question) => !question.questions
-                ? updateBasemap(question)
-                : {
-                    ...question,
-                    questions: question.questions.map(updateBasemap)
-                });
-        }
-        const form = (0, encode_survey_form_1.encodeSurveyForm)(unencodedForm);
-        // intentionally undefined, handled downstream by core logic now
-        return {
-            description,
-            form,
-            portalUrl,
-            tags,
-            title,
-            token,
-            typeKeywords,
-            username
-        };
-    });
-}
-exports.buildCreateParams = buildCreateParams;
+"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.buildCreateParams = void 0;
+const solution_common_1 = require("@esri/solution-common");
+const encode_survey_form_1 = require("./encode-survey-form");
+/**
+ * Utility method for creating Survey123 parameters
+ *
+ * @module build-create-params
+ */
+/**
+ * Builds the Survey123 create API parameters
+ *
+ * @param {IItemTemplate} template The template
+ * @param {any} templateDictionary The template dictionary
+ * @param {UserSession} destinationAuthentication The destination session info
+ * @returns {Promise<ISurvey123CreateParams>}
+ */
+function buildCreateParams(template, templateDictionary, destinationAuthentication) {
+    const { item: { title: originalTitle, description, tags, typeKeywords }, properties: { form: unencodedForm } } = template;
+    const { user: { username }, portalBaseUrl: portalUrl, organization: { basemapGalleryGroupQuery, defaultBasemap: { title: basemapTitle } } } = templateDictionary;
+    const { token } = destinationAuthentication.toCredential();
+    return (0, solution_common_1.getPortalDefaultBasemap)(basemapGalleryGroupQuery, basemapTitle, destinationAuthentication).then(defaultBasemap => {
+        // The S123 API appends "Survey-" to the survey title when computing
+        // the folder name. We need to use the same prefix to successfully
+        // calculate a unique folder name. Afterwards, we can safely remove the
+        // prefix from the title
+        const folderPrefix = "Survey-";
+        const title = (0, solution_common_1.getUniqueTitle)(`${folderPrefix}${originalTitle}`, templateDictionary, "user.folders").replace(folderPrefix, "");
+        // set any map question's basemaps to default org basemap
+        if (unencodedForm.questions) {
+            const updateBasemap = (question) => {
+                if (question.maps) {
+                    question.maps = question.maps.map((map) => ({
+                        ...map,
+                        itemId: defaultBasemap.id
+                    }));
+                }
+                return question;
+            };
+            unencodedForm.questions = unencodedForm.questions.map((question) => !question.questions
+                ? updateBasemap(question)
+                : {
+                    ...question,
+                    questions: question.questions.map(updateBasemap)
+                });
+        }
+        const form = (0, encode_survey_form_1.encodeSurveyForm)(unencodedForm);
+        // intentionally undefined, handled downstream by core logic now
+        return {
+            description,
+            form,
+            portalUrl,
+            tags,
+            title,
+            token,
+            typeKeywords,
+            username
+        };
+    });
+}
+exports.buildCreateParams = buildCreateParams;
 //# sourceMappingURL=build-create-params.js.map

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

@@ -1,32 +1,32 @@
-/** @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 { IItemTemplate, UserSession, IItemProgressCallback, ICreateItemFromTemplateResponse } from "@esri/solution-common";
-/**
- * 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>}
- */
-export declare function createItemFromHubTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
+/** @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 { IItemTemplate, UserSession, IItemProgressCallback, ICreateItemFromTemplateResponse } from "@esri/solution-common";
+/**
+ * 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>}
+ */
+export declare function createItemFromHubTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;