@esri/solution-common 4.1.2 → 5.0.0

package/dist/cjs/migrations/upgrade-two-dot-three.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.
- */
-import { ISolutionItem } from "../interfaces";
-/**
- * Migrate Hub assets structure to resource paths
- *
- * @param model
- * @private
- */
-export declare function _upgradeTwoDotThree(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";
+/**
+ * Migrate Hub assets structure to resource paths
+ *
+ * @param model
+ * @private
+ */
+export declare function _upgradeTwoDotThree(model: ISolutionItem): ISolutionItem;

package/dist/cjs/migrations/upgrade-two-dot-three.js

@@ -1,55 +1,55 @@
-"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._upgradeTwoDotThree = void 0;
-const generalHelpers_1 = require("../generalHelpers");
-const hub_common_1 = require("@esri/hub-common");
-/**
- * Migrate Hub assets structure to resource paths
- *
- * @param model
- * @private
- */
-function _upgradeTwoDotThree(model) {
-    if ((0, generalHelpers_1.getProp)(model, "item.properties.schemaVersion") >= 2.3) {
-        return model;
-    }
-    const clone = (0, hub_common_1.cloneObject)(model);
-    // rename template.resources => template.assets
-    // this has landed in Hub, so we have actual items like this :(
-    // we will have another schema upgrade that will re-create the
-    // resources array
-    clone.data.templates = clone.data.templates.map(tmpl => {
-        if (tmpl.resources) {
-            tmpl.assets = tmpl.resources.map(r => {
-                return {
-                    name: r,
-                    type: "resource"
-                };
-            });
-            delete tmpl.resources;
-        }
-        else {
-            tmpl.assets = [];
-        }
-        return tmpl;
-    });
-    clone.item.properties.schemaVersion = 2.3;
-    return clone;
-}
-exports._upgradeTwoDotThree = _upgradeTwoDotThree;
+"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._upgradeTwoDotThree = void 0;
+const generalHelpers_1 = require("../generalHelpers");
+const hub_common_1 = require("@esri/hub-common");
+/**
+ * Migrate Hub assets structure to resource paths
+ *
+ * @param model
+ * @private
+ */
+function _upgradeTwoDotThree(model) {
+    if ((0, generalHelpers_1.getProp)(model, "item.properties.schemaVersion") >= 2.3) {
+        return model;
+    }
+    const clone = (0, hub_common_1.cloneObject)(model);
+    // rename template.resources => template.assets
+    // this has landed in Hub, so we have actual items like this :(
+    // we will have another schema upgrade that will re-create the
+    // resources array
+    clone.data.templates = clone.data.templates.map(tmpl => {
+        if (tmpl.resources) {
+            tmpl.assets = tmpl.resources.map(r => {
+                return {
+                    name: r,
+                    type: "resource"
+                };
+            });
+            delete tmpl.resources;
+        }
+        else {
+            tmpl.assets = [];
+        }
+        return tmpl;
+    });
+    clone.item.properties.schemaVersion = 2.3;
+    return clone;
+}
+exports._upgradeTwoDotThree = _upgradeTwoDotThree;
 //# sourceMappingURL=upgrade-two-dot-three.js.map

package/dist/cjs/migrations/upgrade-two-dot-two.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.
- */
-import { ISolutionItem } from "../interfaces";
-/**
- * Swap tokens from Hub Solutions
- *
- * @param model
- * @private
- */
-export declare function _upgradeTwoDotTwo(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";
+/**
+ * Swap tokens from Hub Solutions
+ *
+ * @param model
+ * @private
+ */
+export declare function _upgradeTwoDotTwo(model: ISolutionItem): ISolutionItem;

package/dist/cjs/migrations/upgrade-two-dot-two.js

@@ -1,58 +1,58 @@
-"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._upgradeTwoDotTwo = void 0;
-const generalHelpers_1 = require("../generalHelpers");
-const hub_common_1 = require("@esri/hub-common");
-/**
- * Swap tokens from Hub Solutions
- *
- * @param model
- * @private
- */
-function _upgradeTwoDotTwo(model) {
-    if ((0, generalHelpers_1.getProp)(model, "item.properties.schemaVersion") >= 2.2) {
-        return model;
-    }
-    const clone = (0, hub_common_1.cloneObject)(model);
-    // NOTE: Not all of these have closing `}}` and that is intentional
-    const swaps = [
-        { src: "{{solution.name}}", val: "{{solution.title}}" },
-        { src: "{{initiative.name}}", val: "{{solution.title}}" },
-        { src: "{{initiative.title}}", val: "{{solution.title}}" },
-        { src: "{{initiative.extent}}", val: "{{organization.defaultExtentBBox}}" },
-        {
-            src: "{{initiative.collaborationGroupId",
-            val: "{{teams.collaborationGroupId"
-        },
-        { src: "{{initiative.openDataGroupId", val: "{{teams.contentGroupId" },
-        { src: "{{initiative.contentGroupId", val: "{{teams.contentGroupId" },
-        { src: "{{initiative.followersGroupId", val: "{{teams.followersGroupId" },
-        { src: "{{collaborationGroupId", val: "{{teams.collaborationGroupId" },
-        { src: "{{contentGroupId", val: "{{teams.contentGroupId" },
-        { src: "{{followersGroupId", val: "{{teams.followersGroupId" },
-        { src: "{{initiative.id", val: "{{initiative.item.id" },
-        { src: "{{organization.portalBaseUrl", val: "{{portalBaseUrl" }
-    ];
-    swaps.forEach(swap => {
-        clone.data = (0, hub_common_1.deepStringReplace)(clone.data, swap.src, swap.val);
-    });
-    clone.item.properties.schemaVersion = 2.2;
-    return clone;
-}
-exports._upgradeTwoDotTwo = _upgradeTwoDotTwo;
+"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._upgradeTwoDotTwo = void 0;
+const generalHelpers_1 = require("../generalHelpers");
+const hub_common_1 = require("@esri/hub-common");
+/**
+ * Swap tokens from Hub Solutions
+ *
+ * @param model
+ * @private
+ */
+function _upgradeTwoDotTwo(model) {
+    if ((0, generalHelpers_1.getProp)(model, "item.properties.schemaVersion") >= 2.2) {
+        return model;
+    }
+    const clone = (0, hub_common_1.cloneObject)(model);
+    // NOTE: Not all of these have closing `}}` and that is intentional
+    const swaps = [
+        { src: "{{solution.name}}", val: "{{solution.title}}" },
+        { src: "{{initiative.name}}", val: "{{solution.title}}" },
+        { src: "{{initiative.title}}", val: "{{solution.title}}" },
+        { src: "{{initiative.extent}}", val: "{{organization.defaultExtentBBox}}" },
+        {
+            src: "{{initiative.collaborationGroupId",
+            val: "{{teams.collaborationGroupId"
+        },
+        { src: "{{initiative.openDataGroupId", val: "{{teams.contentGroupId" },
+        { src: "{{initiative.contentGroupId", val: "{{teams.contentGroupId" },
+        { src: "{{initiative.followersGroupId", val: "{{teams.followersGroupId" },
+        { src: "{{collaborationGroupId", val: "{{teams.collaborationGroupId" },
+        { src: "{{contentGroupId", val: "{{teams.contentGroupId" },
+        { src: "{{followersGroupId", val: "{{teams.followersGroupId" },
+        { src: "{{initiative.id", val: "{{initiative.item.id" },
+        { src: "{{organization.portalBaseUrl", val: "{{portalBaseUrl" }
+    ];
+    swaps.forEach(swap => {
+        clone.data = (0, hub_common_1.deepStringReplace)(clone.data, swap.src, swap.val);
+    });
+    clone.item.properties.schemaVersion = 2.2;
+    return clone;
+}
+exports._upgradeTwoDotTwo = _upgradeTwoDotTwo;
 //# sourceMappingURL=upgrade-two-dot-two.js.map

package/dist/cjs/migrations/upgrade-two-dot-zero.d.ts

@@ -1,44 +1,44 @@
-/**
- * Convert indicator "definitions" from the CAS style to the Indicator schema
- * see https://github.com/ArcGIS/Hub/blob/master/indicators.md
- *
- * @param model
- * @private
- */
-export declare function _upgradeTwoDotZero(model: any): any;
-/**
- * Given the Indicators entry from a CAS configurationSettings array,
- * convert to an indicators object in the new schema
- *
- * @private
- */
-export declare function _convertIndicatorsToDefinitions(indicatorsHash?: any): any;
-/**
- * Convert a CAS formatted indicator to the .definition in the new schama
- *
- * @private
- */
-export declare const _convertIndicatorToDefinition: (ind: any) => {
-    id: any;
-    type: string;
-    name: any;
-    optional: any;
-    definition: {
-        description: any;
-        supportedTypes: any[];
-        geometryTypes: any[];
-        fields: any;
-    };
-};
-/**
- * Convert the CAS formatted "field" into the new schema
- *
- * @private
- */
-export declare const _convertIndicatorField: (field: any) => {
-    id: any;
-    name: any;
-    optional: any;
-    description: any;
-    supportedTypes: any[];
-};
+/**
+ * Convert indicator "definitions" from the CAS style to the Indicator schema
+ * see https://github.com/ArcGIS/Hub/blob/master/indicators.md
+ *
+ * @param model
+ * @private
+ */
+export declare function _upgradeTwoDotZero(model: any): any;
+/**
+ * Given the Indicators entry from a CAS configurationSettings array,
+ * convert to an indicators object in the new schema
+ *
+ * @private
+ */
+export declare function _convertIndicatorsToDefinitions(indicatorsHash?: any): any;
+/**
+ * Convert a CAS formatted indicator to the .definition in the new schama
+ *
+ * @private
+ */
+export declare const _convertIndicatorToDefinition: (ind: any) => {
+    id: any;
+    type: string;
+    name: any;
+    optional: any;
+    definition: {
+        description: any;
+        supportedTypes: any[];
+        geometryTypes: any[];
+        fields: any;
+    };
+};
+/**
+ * Convert the CAS formatted "field" into the new schema
+ *
+ * @private
+ */
+export declare const _convertIndicatorField: (field: any) => {
+    id: any;
+    name: any;
+    optional: any;
+    description: any;
+    supportedTypes: any[];
+};

package/dist/cjs/migrations/upgrade-two-dot-zero.js

@@ -1,95 +1,95 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._convertIndicatorField = exports._convertIndicatorToDefinition = exports._convertIndicatorsToDefinitions = exports._upgradeTwoDotZero = void 0;
-/** @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.
- */
-const hub_common_1 = require("@esri/hub-common");
-/**
- * Convert indicator "definitions" from the CAS style to the Indicator schema
- * see https://github.com/ArcGIS/Hub/blob/master/indicators.md
- *
- * @param model
- * @private
- */
-function _upgradeTwoDotZero(model) {
-    if ((0, hub_common_1.getProp)(model, "item.properties.schemaVersion") >= 2) {
-        return model;
-    }
-    // get the indicators from the .configurationSettings...
-    const clone = (0, hub_common_1.cloneObject)(model);
-    const configSettings = (0, hub_common_1.getProp)(clone, "data.configurationSettings") || [];
-    const indicatorsHash = configSettings.find((e) => e.category === "Indicators");
-    clone.data.indicators = _convertIndicatorsToDefinitions(indicatorsHash);
-    // remove CAS structure
-    delete clone.data.configurationSettings;
-    // set the schemaVersion...
-    clone.item.properties.schemaVersion = 2;
-    return clone;
-}
-exports._upgradeTwoDotZero = _upgradeTwoDotZero;
-/**
- * Given the Indicators entry from a CAS configurationSettings array,
- * convert to an indicators object in the new schema
- *
- * @private
- */
-function _convertIndicatorsToDefinitions(indicatorsHash = {}) {
-    // the incoming structure should have a .fields property, and what we want will be in there...
-    if (!indicatorsHash.fields || !Array.isArray(indicatorsHash.fields)) {
-        indicatorsHash.fields = [];
-    }
-    const defs = indicatorsHash.fields.map(exports._convertIndicatorToDefinition);
-    // now we need to create an object which has props for each def
-    return defs;
-}
-exports._convertIndicatorsToDefinitions = _convertIndicatorsToDefinitions;
-/**
- * Convert a CAS formatted indicator to the .definition in the new schama
- *
- * @private
- */
-const _convertIndicatorToDefinition = function (ind) {
-    const def = {
-        id: ind.fieldName,
-        type: "Data",
-        name: ind.label || ind.fieldName,
-        optional: ind.optional || false,
-        definition: {
-            description: ind.label || ind.fieldName,
-            supportedTypes: [].concat(ind.layerOptions.supportedTypes),
-            geometryTypes: [].concat(ind.layerOptions.geometryTypes),
-            fields: ind.fields.map(exports._convertIndicatorField)
-        }
-    };
-    return def;
-};
-exports._convertIndicatorToDefinition = _convertIndicatorToDefinition;
-/**
- * Convert the CAS formatted "field" into the new schema
- *
- * @private
- */
-const _convertIndicatorField = function (field) {
-    return {
-        id: field.fieldName,
-        name: field.label,
-        optional: field.optional || false,
-        description: field.tooltip,
-        supportedTypes: [].concat(field.supportedTypes)
-    };
-};
-exports._convertIndicatorField = _convertIndicatorField;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._convertIndicatorField = exports._convertIndicatorToDefinition = exports._convertIndicatorsToDefinitions = exports._upgradeTwoDotZero = void 0;
+/** @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.
+ */
+const hub_common_1 = require("@esri/hub-common");
+/**
+ * Convert indicator "definitions" from the CAS style to the Indicator schema
+ * see https://github.com/ArcGIS/Hub/blob/master/indicators.md
+ *
+ * @param model
+ * @private
+ */
+function _upgradeTwoDotZero(model) {
+    if ((0, hub_common_1.getProp)(model, "item.properties.schemaVersion") >= 2) {
+        return model;
+    }
+    // get the indicators from the .configurationSettings...
+    const clone = (0, hub_common_1.cloneObject)(model);
+    const configSettings = (0, hub_common_1.getProp)(clone, "data.configurationSettings") || [];
+    const indicatorsHash = configSettings.find((e) => e.category === "Indicators");
+    clone.data.indicators = _convertIndicatorsToDefinitions(indicatorsHash);
+    // remove CAS structure
+    delete clone.data.configurationSettings;
+    // set the schemaVersion...
+    clone.item.properties.schemaVersion = 2;
+    return clone;
+}
+exports._upgradeTwoDotZero = _upgradeTwoDotZero;
+/**
+ * Given the Indicators entry from a CAS configurationSettings array,
+ * convert to an indicators object in the new schema
+ *
+ * @private
+ */
+function _convertIndicatorsToDefinitions(indicatorsHash = {}) {
+    // the incoming structure should have a .fields property, and what we want will be in there...
+    if (!indicatorsHash.fields || !Array.isArray(indicatorsHash.fields)) {
+        indicatorsHash.fields = [];
+    }
+    const defs = indicatorsHash.fields.map(exports._convertIndicatorToDefinition);
+    // now we need to create an object which has props for each def
+    return defs;
+}
+exports._convertIndicatorsToDefinitions = _convertIndicatorsToDefinitions;
+/**
+ * Convert a CAS formatted indicator to the .definition in the new schama
+ *
+ * @private
+ */
+const _convertIndicatorToDefinition = function (ind) {
+    const def = {
+        id: ind.fieldName,
+        type: "Data",
+        name: ind.label || ind.fieldName,
+        optional: ind.optional || false,
+        definition: {
+            description: ind.label || ind.fieldName,
+            supportedTypes: [].concat(ind.layerOptions.supportedTypes),
+            geometryTypes: [].concat(ind.layerOptions.geometryTypes),
+            fields: ind.fields.map(exports._convertIndicatorField)
+        }
+    };
+    return def;
+};
+exports._convertIndicatorToDefinition = _convertIndicatorToDefinition;
+/**
+ * Convert the CAS formatted "field" into the new schema
+ *
+ * @private
+ */
+const _convertIndicatorField = function (field) {
+    return {
+        id: field.fieldName,
+        name: field.label,
+        optional: field.optional || false,
+        description: field.tooltip,
+        supportedTypes: [].concat(field.supportedTypes)
+    };
+};
+exports._convertIndicatorField = _convertIndicatorField;
 //# sourceMappingURL=upgrade-two-dot-zero.js.map

package/dist/cjs/migrator.d.ts

@@ -1,25 +1,25 @@
-/** @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";
-export declare const CURRENT_SCHEMA_VERSION = 3;
-/**
- * Apply schema migrations to a Solution item
- * This system allows the schema of the Solution item to change over time
- * while abstracting those changes into a single set of functional transforms
- *
- * @param model ISolutionItem
- */
-export declare function migrateSchema(model: ISolutionItem): Promise<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";
+export declare const CURRENT_SCHEMA_VERSION = 3;
+/**
+ * Apply schema migrations to a Solution item
+ * This system allows the schema of the Solution item to change over time
+ * while abstracting those changes into a single set of functional transforms
+ *
+ * @param model ISolutionItem
+ */
+export declare function migrateSchema(model: ISolutionItem): Promise<ISolutionItem>;