@esri/solution-common 4.1.2 → 5.0.0

package/dist/esm/migrations/is-legacy-solution.js

@@ -1,36 +1,36 @@
-/** @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 { getProp } from "../generalHelpers";
-/**
- * Determine if the Solution is a legacy item created by Hub
- * vs one that is 100% compatible with Solution.js
- *
- * @param model ISolutionModel
- * @private
- */
-export function _isLegacySolution(model) {
-    let result = false;
-    // if it does not have the `Template` keyword BUT does have `hubSolutionTemplate` it is legacy
-    const keywords = getProp(model, "item.typeKeywords") || [];
-    if (!keywords.includes("Template")) {
-        if (keywords.includes("hubSolutionTemplate") &&
-            keywords.includes("solutionTemplate")) {
-            result = true;
-        }
-    }
-    return result;
-}
+/** @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 { getProp } from "../generalHelpers";
+/**
+ * Determine if the Solution is a legacy item created by Hub
+ * vs one that is 100% compatible with Solution.js
+ *
+ * @param model ISolutionModel
+ * @private
+ */
+export function _isLegacySolution(model) {
+    let result = false;
+    // if it does not have the `Template` keyword BUT does have `hubSolutionTemplate` it is legacy
+    const keywords = getProp(model, "item.typeKeywords") || [];
+    if (!keywords.includes("Template")) {
+        if (keywords.includes("hubSolutionTemplate") &&
+            keywords.includes("solutionTemplate")) {
+            result = true;
+        }
+    }
+    return result;
+}
 //# sourceMappingURL=is-legacy-solution.js.map

package/dist/esm/migrations/upgrade-three-dot-one.d.ts

@@ -1,27 +1,27 @@
-/** @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 { ISolutionItem } from "../interfaces";
-/**
- * Apply the initial schema
- * If the item was created by Solution.js, this will stamp it
- * with the initial Solution.js schama version number (3)
- * If it is a legacy hub solution, it will apply the transforms
- *
- * @param model ISolutionItem
- * @param authentication UserSession
- * @private
- */
-export declare function _upgradeThreeDotOne(model: ISolutionItem): ISolutionItem;
+/** @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 { ISolutionItem } from "../interfaces";
+/**
+ * Apply the initial schema
+ * If the item was created by Solution.js, this will stamp it
+ * with the initial Solution.js schama version number (3)
+ * If it is a legacy hub solution, it will apply the transforms
+ *
+ * @param model ISolutionItem
+ * @param authentication UserSession
+ * @private
+ */
+export declare function _upgradeThreeDotOne(model: ISolutionItem): ISolutionItem;

package/dist/esm/migrations/upgrade-three-dot-one.js

@@ -1,45 +1,45 @@
-/** @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 { getProp, cloneObject } from "../generalHelpers";
-import { transformResourcePathsToSolutionResources } from "../resources/transform-resource-paths-to-solution-resources";
-/**
- * Apply the initial schema
- * If the item was created by Solution.js, this will stamp it
- * with the initial Solution.js schama version number (3)
- * If it is a legacy hub solution, it will apply the transforms
- *
- * @param model ISolutionItem
- * @param authentication UserSession
- * @private
- */
-export function _upgradeThreeDotOne(model) {
-    if (getProp(model, "item.properties.schemaVersion") >= 3.1) {
-        return model;
-    }
-    else {
-        const clone = cloneObject(model);
-        // transform resource paths to ISolutionResource objects
-        clone.data.templates = clone.data.templates.map((tmpl) => {
-            const resources = tmpl.resources || [];
-            tmpl.resources = transformResourcePathsToSolutionResources(resources);
-            return tmpl;
-        });
-        // update the schema version
-        clone.item.properties.schemaVersion = 3.1;
-        return clone;
-    }
-}
+/** @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 { getProp, cloneObject } from "../generalHelpers";
+import { transformResourcePathsToSolutionResources } from "../resources/transform-resource-paths-to-solution-resources";
+/**
+ * Apply the initial schema
+ * If the item was created by Solution.js, this will stamp it
+ * with the initial Solution.js schama version number (3)
+ * If it is a legacy hub solution, it will apply the transforms
+ *
+ * @param model ISolutionItem
+ * @param authentication UserSession
+ * @private
+ */
+export function _upgradeThreeDotOne(model) {
+    if (getProp(model, "item.properties.schemaVersion") >= 3.1) {
+        return model;
+    }
+    else {
+        const clone = cloneObject(model);
+        // transform resource paths to ISolutionResource objects
+        clone.data.templates = clone.data.templates.map((tmpl) => {
+            const resources = tmpl.resources || [];
+            tmpl.resources = transformResourcePathsToSolutionResources(resources);
+            return tmpl;
+        });
+        // update the schema version
+        clone.item.properties.schemaVersion = 3.1;
+        return clone;
+    }
+}
 //# sourceMappingURL=upgrade-three-dot-one.js.map

package/dist/esm/migrations/upgrade-three-dot-zero.d.ts

@@ -1,27 +1,27 @@
-/** @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 { ISolutionItem } from "../interfaces";
-/**
- * Apply the initial schema
- * If the item was created by Solution.js, this will stamp it
- * with the initial Solution.js schama version number (3)
- * If it is a legacy hub solution, it will apply the transforms
- *
- * @param model ISolutionItem
- * @param authentication UserSession
- * @private
- */
-export declare function _upgradeThreeDotZero(model: ISolutionItem): ISolutionItem;
+/** @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 { ISolutionItem } from "../interfaces";
+/**
+ * Apply the initial schema
+ * If the item was created by Solution.js, this will stamp it
+ * with the initial Solution.js schama version number (3)
+ * If it is a legacy hub solution, it will apply the transforms
+ *
+ * @param model ISolutionItem
+ * @param authentication UserSession
+ * @private
+ */
+export declare function _upgradeThreeDotZero(model: ISolutionItem): ISolutionItem;

package/dist/esm/migrations/upgrade-three-dot-zero.js

@@ -1,39 +1,39 @@
-/** @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 { getProp, cloneObject } from "../generalHelpers";
-/**
- * Apply the initial schema
- * If the item was created by Solution.js, this will stamp it
- * with the initial Solution.js schama version number (3)
- * If it is a legacy hub solution, it will apply the transforms
- *
- * @param model ISolutionItem
- * @param authentication UserSession
- * @private
- */
-export function _upgradeThreeDotZero(model) {
-    if (getProp(model, "item.properties.schemaVersion") >= 3) {
-        return model;
-    }
-    else {
-        // There exist 3.0 schema solutions which simply lack the schemaVersion property
-        // so we just stamp in the version and do the actual work in the follow-on upgrades
-        const clone = cloneObject(model);
-        clone.item.properties.schemaVersion = 3;
-        return clone;
-    }
-}
+/** @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 { getProp, cloneObject } from "../generalHelpers";
+/**
+ * Apply the initial schema
+ * If the item was created by Solution.js, this will stamp it
+ * with the initial Solution.js schama version number (3)
+ * If it is a legacy hub solution, it will apply the transforms
+ *
+ * @param model ISolutionItem
+ * @param authentication UserSession
+ * @private
+ */
+export function _upgradeThreeDotZero(model) {
+    if (getProp(model, "item.properties.schemaVersion") >= 3) {
+        return model;
+    }
+    else {
+        // There exist 3.0 schema solutions which simply lack the schemaVersion property
+        // so we just stamp in the version and do the actual work in the follow-on upgrades
+        const clone = cloneObject(model);
+        clone.item.properties.schemaVersion = 3;
+        return clone;
+    }
+}
 //# sourceMappingURL=upgrade-three-dot-zero.js.map

package/dist/esm/migrations/upgrade-two-dot-five.d.ts

@@ -1,24 +1,24 @@
-/** @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 { ISolutionItem } from "../interfaces";
-/**
- * Applies Survey123 Form Config Schema migrations.
- *
- * @param {ISolutionItem} model A Solution model
- * @returns {ISolutionItem}
- * @private
- */
-export declare function _upgradeTwoDotFive(model: ISolutionItem): ISolutionItem;
+/** @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 { ISolutionItem } from "../interfaces";
+/**
+ * Applies Survey123 Form Config Schema migrations.
+ *
+ * @param {ISolutionItem} model A Solution model
+ * @returns {ISolutionItem}
+ * @private
+ */
+export declare function _upgradeTwoDotFive(model: ISolutionItem): ISolutionItem;

package/dist/esm/migrations/upgrade-two-dot-five.js

@@ -1,69 +1,69 @@
-/** @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 { getProp, cloneObject } from "../generalHelpers";
-/**
- * Applies Survey123 Form Config Schema migrations.
- *
- * @param {ISolutionItem} model A Solution model
- * @returns {ISolutionItem}
- * @private
- */
-export function _upgradeTwoDotFive(model) {
-    if (getProp(model, "item.properties.schemaVersion") >= 2.5) {
-        return model;
-    }
-    else {
-        const clone = cloneObject(model);
-        clone.data.templates.forEach(template => {
-            if (template.type === "Form") {
-                if (getProp(template, "properties.form.portalUrl")) {
-                    template.properties.form.portalUrl = "{{portalBaseUrl}}";
-                }
-                const ver = parseFloat(getProp(template, "properties.form.version") || "2.5");
-                const hasFormSchema = getProp(template, "properties.form");
-                if (!hasFormSchema || ver >= 3.8) {
-                    return template;
-                }
-                template.properties.form.layerName = "survey";
-                // nest the theme into themes
-                if (getProp(template, "properties.form.theme")) {
-                    template.properties.form.themes = [template.properties.form.theme];
-                    delete template.properties.form.theme;
-                }
-                const updateLayout = (question) => {
-                    if (question.appearance && question.appearance.layout) {
-                        question.appearance.layout = "vertical";
-                    }
-                    return question;
-                };
-                // replace whatever layout on all questions with vertical
-                template.properties.form.questions = template.properties.form.questions.map((question) => {
-                    return !question.questions
-                        ? updateLayout(question)
-                        : {
-                            ...question,
-                            questions: question.questions.map(updateLayout)
-                        };
-                });
-                template.properties.form.version = 3.8;
-            }
-        });
-        // update the schema version
-        clone.item.properties.schemaVersion = 2.5;
-        return clone;
-    }
-}
+/** @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 { getProp, cloneObject } from "../generalHelpers";
+/**
+ * Applies Survey123 Form Config Schema migrations.
+ *
+ * @param {ISolutionItem} model A Solution model
+ * @returns {ISolutionItem}
+ * @private
+ */
+export function _upgradeTwoDotFive(model) {
+    if (getProp(model, "item.properties.schemaVersion") >= 2.5) {
+        return model;
+    }
+    else {
+        const clone = cloneObject(model);
+        clone.data.templates.forEach(template => {
+            if (template.type === "Form") {
+                if (getProp(template, "properties.form.portalUrl")) {
+                    template.properties.form.portalUrl = "{{portalBaseUrl}}";
+                }
+                const ver = parseFloat(getProp(template, "properties.form.version") || "2.5");
+                const hasFormSchema = getProp(template, "properties.form");
+                if (!hasFormSchema || ver >= 3.8) {
+                    return template;
+                }
+                template.properties.form.layerName = "survey";
+                // nest the theme into themes
+                if (getProp(template, "properties.form.theme")) {
+                    template.properties.form.themes = [template.properties.form.theme];
+                    delete template.properties.form.theme;
+                }
+                const updateLayout = (question) => {
+                    if (question.appearance && question.appearance.layout) {
+                        question.appearance.layout = "vertical";
+                    }
+                    return question;
+                };
+                // replace whatever layout on all questions with vertical
+                template.properties.form.questions = template.properties.form.questions.map((question) => {
+                    return !question.questions
+                        ? updateLayout(question)
+                        : {
+                            ...question,
+                            questions: question.questions.map(updateLayout)
+                        };
+                });
+                template.properties.form.version = 3.8;
+            }
+        });
+        // update the schema version
+        clone.item.properties.schemaVersion = 2.5;
+        return clone;
+    }
+}
 //# sourceMappingURL=upgrade-two-dot-five.js.map

package/dist/esm/migrations/upgrade-two-dot-four.d.ts

@@ -1,24 +1,24 @@
-/** @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 { ISolutionItem } from "../interfaces";
-/**
- * Hub Solutions use the `key` property for follow on replacements
- * but the Solution.js ones use the
- *
- * @param model ISolutionItem
- * @private
- */
-export declare function _upgradeTwoDotFour(model: ISolutionItem): ISolutionItem;
+/** @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 { ISolutionItem } from "../interfaces";
+/**
+ * Hub Solutions use the `key` property for follow on replacements
+ * but the Solution.js ones use the
+ *
+ * @param model ISolutionItem
+ * @private
+ */
+export declare function _upgradeTwoDotFour(model: ISolutionItem): ISolutionItem;