@esri/solution-common 6.1.3 → 6.1.5

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

@@ -0,0 +1,51 @@
+/** @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";
+import { cloneObject } from "@esri/hub-common";
+/**
+ * Migrate Hub assets structure to resource paths
+ *
+ * @param model
+ * @private
+ */
+export function _upgradeTwoDotThree(model) {
+    if (getProp(model, "item.properties.schemaVersion") >= 2.3) {
+        return model;
+    }
+    const clone = 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;
+}
+//# sourceMappingURL=upgrade-two-dot-three.js.map

package/dist/esm/migrations/upgrade-two-dot-three.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade-two-dot-three.js","sourceRoot":"","sources":["../../../src/migrations/upgrade-two-dot-three.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAoB;IACtD,IAAI,OAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,IAAI,GAAG,EAAE;QAC1D,OAAO,KAAK,CAAC;KACd;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAEjC,+CAA+C;IAC/C,+DAA+D;IAC/D,8DAA8D;IAC9D,kBAAkB;IAClB,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACvD,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACrC,OAAO;oBACL,IAAI,EAAE,CAAC;oBACP,IAAI,EAAE,UAAU;iBACjB,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC;SACvB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;SAClB;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;IAC1C,OAAO,KAAK,CAAC;AACf,CAAC"}

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

@@ -0,0 +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;

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

@@ -0,0 +1,54 @@
+/** @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";
+import { deepStringReplace, cloneObject } from "@esri/hub-common";
+/**
+ * Swap tokens from Hub Solutions
+ *
+ * @param model
+ * @private
+ */
+export function _upgradeTwoDotTwo(model) {
+    if (getProp(model, "item.properties.schemaVersion") >= 2.2) {
+        return model;
+    }
+    const clone = 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 = deepStringReplace(clone.data, swap.src, swap.val);
+    });
+    clone.item.properties.schemaVersion = 2.2;
+    return clone;
+}
+//# sourceMappingURL=upgrade-two-dot-two.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade-two-dot-two.js","sourceRoot":"","sources":["../../../src/migrations/upgrade-two-dot-two.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAoB;IACpD,IAAI,OAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,IAAI,GAAG,EAAE;QAC1D,OAAO,KAAK,CAAC;KACd;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACjC,mEAAmE;IACnE,MAAM,KAAK,GAAG;QACZ,EAAE,GAAG,EAAE,mBAAmB,EAAE,GAAG,EAAE,oBAAoB,EAAE;QACvD,EAAE,GAAG,EAAE,qBAAqB,EAAE,GAAG,EAAE,oBAAoB,EAAE;QACzD,EAAE,GAAG,EAAE,sBAAsB,EAAE,GAAG,EAAE,oBAAoB,EAAE;QAC1D,EAAE,GAAG,EAAE,uBAAuB,EAAE,GAAG,EAAE,oCAAoC,EAAE;QAC3E;YACE,GAAG,EAAE,mCAAmC;YACxC,GAAG,EAAE,8BAA8B;SACpC;QACD,EAAE,GAAG,EAAE,8BAA8B,EAAE,GAAG,EAAE,wBAAwB,EAAE;QACtE,EAAE,GAAG,EAAE,6BAA6B,EAAE,GAAG,EAAE,wBAAwB,EAAE;QACrE,EAAE,GAAG,EAAE,+BAA+B,EAAE,GAAG,EAAE,0BAA0B,EAAE;QACzE,EAAE,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAE,8BAA8B,EAAE;QACtE,EAAE,GAAG,EAAE,kBAAkB,EAAE,GAAG,EAAE,wBAAwB,EAAE;QAC1D,EAAE,GAAG,EAAE,oBAAoB,EAAE,GAAG,EAAE,0BAA0B,EAAE;QAC9D,EAAE,GAAG,EAAE,iBAAiB,EAAE,GAAG,EAAE,sBAAsB,EAAE;QACvD,EAAE,GAAG,EAAE,8BAA8B,EAAE,GAAG,EAAE,iBAAiB,EAAE;KAChE,CAAC;IACF,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,KAAK,CAAC,IAAI,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAsB,CAAC;IACtF,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;IAC1C,OAAO,KAAK,CAAC;AACf,CAAC"}

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

@@ -0,0 +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[];
+};

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

@@ -0,0 +1,88 @@
+/** @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 { getProp, cloneObject } from "@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
+ */
+export function _upgradeTwoDotZero(model) {
+    if (getProp(model, "item.properties.schemaVersion") >= 2) {
+        return model;
+    }
+    // get the indicators from the .configurationSettings...
+    const clone = cloneObject(model);
+    const configSettings = 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;
+}
+/**
+ * Given the Indicators entry from a CAS configurationSettings array,
+ * convert to an indicators object in the new schema
+ *
+ * @private
+ */
+export 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(_convertIndicatorToDefinition);
+    // now we need to create an object which has props for each def
+    return defs;
+}
+/**
+ * Convert a CAS formatted indicator to the .definition in the new schama
+ *
+ * @private
+ */
+export 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(_convertIndicatorField),
+        },
+    };
+    return def;
+};
+/**
+ * Convert the CAS formatted "field" into the new schema
+ *
+ * @private
+ */
+export const _convertIndicatorField = function (field) {
+    return {
+        id: field.fieldName,
+        name: field.label,
+        optional: field.optional || false,
+        description: field.tooltip,
+        supportedTypes: [].concat(field.supportedTypes),
+    };
+};
+//# sourceMappingURL=upgrade-two-dot-zero.js.map

package/dist/esm/migrations/upgrade-two-dot-zero.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade-two-dot-zero.js","sourceRoot":"","sources":["../../../src/migrations/upgrade-two-dot-zero.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAU;IAC3C,IAAI,OAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,IAAI,CAAC,EAAE;QACxD,OAAO,KAAK,CAAC;KACd;IACD,wDAAwD;IACxD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,4BAA4B,CAAC,IAAI,EAAE,CAAC;IAE1E,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC;IACpF,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,+BAA+B,CAAC,cAAc,CAAC,CAAC;IACxE,uBAAuB;IACvB,OAAO,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC;IAExC,2BAA2B;IAC3B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAAC,iBAAsB,EAAE;IACtE,8FAA8F;IAC9F,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;QACnE,cAAc,CAAC,MAAM,GAAG,EAAE,CAAC;KAC5B;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IACtE,+DAA+D;IAC/D,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,UAAU,GAAQ;IAC7D,MAAM,GAAG,GAAG;QACV,EAAE,EAAE,GAAG,CAAC,SAAS;QACjB,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,SAAS;QAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,KAAK;QAC/B,UAAU,EAAE;YACV,WAAW,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,SAAS;YACvC,cAAc,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,cAAc,CAAC;YAC1D,aAAa,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC;YACxD,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC;SAC/C;KACF,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,KAAU;IACxD,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,SAAS;QACnB,IAAI,EAAE,KAAK,CAAC,KAAK;QACjB,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK;QACjC,WAAW,EAAE,KAAK,CAAC,OAAO;QAC1B,cAAc,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;KAChD,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/migrator.d.ts

@@ -0,0 +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>;

package/dist/esm/migrator.js

@@ -0,0 +1,71 @@
+/** @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 { _isLegacySolution } from "./migrations/is-legacy-solution";
+import { _applySchema } from "./migrations/apply-schema";
+import { _upgradeTwoDotZero } from "./migrations/upgrade-two-dot-zero";
+import { _upgradeTwoDotOne } from "./migrations/upgrade-two-dot-one";
+import { _upgradeTwoDotTwo } from "./migrations/upgrade-two-dot-two";
+import { _upgradeTwoDotThree } from "./migrations/upgrade-two-dot-three";
+import { _upgradeTwoDotFour } from "./migrations/upgrade-two-dot-four";
+import { _upgradeTwoDotFive } from "./migrations/upgrade-two-dot-five";
+import { _upgradeTwoDotSix } from "./migrations/upgrade-two-dot-six";
+import { _upgradeTwoDotSeven } from "./migrations/upgrade-two-dot-seven";
+import { _upgradeThreeDotZero } from "./migrations/upgrade-three-dot-zero";
+import { getProp } from "@esri/hub-common";
+// Starting at 3.0 because Hub has been versioning Solution items up to 2.x
+export const CURRENT_SCHEMA_VERSION = 3.0;
+/**
+ * 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 function migrateSchema(model) {
+    // ensure properties
+    if (!getProp(model, "item.properties")) {
+        model.item.properties = {};
+    }
+    const modelVersion = getProp(model, "item.properties.schemaVersion");
+    // if it's already on the current version, return it
+    if (modelVersion === CURRENT_SCHEMA_VERSION) {
+        return Promise.resolve(model);
+    }
+    else {
+        // check if this is a legacy solution created by Hub
+        const isLegacy = _isLegacySolution(model);
+        const schemaUpgrades = [];
+        // if this is a Solution.js "native" item, it is already at 3.0
+        if (!modelVersion && !isLegacy) {
+            // apply the 3.0+ transforms
+            // TEMP to allow merge to develop w/o breaking things
+            schemaUpgrades.push(_upgradeThreeDotZero);
+            // schemaUpgrades.push(_upgradeThreeDotZero, _upgradeThreeDotOne);
+        }
+        else {
+            // Hub created a set of Solution items that are not 100% compatible
+            // with the Solution.js deployer.
+            schemaUpgrades.push(_applySchema, _upgradeTwoDotZero, _upgradeTwoDotOne, _upgradeTwoDotTwo, _upgradeTwoDotThree, _upgradeTwoDotFour, _upgradeTwoDotFive, _upgradeTwoDotSix, _upgradeTwoDotSeven);
+            // Apply the 3.x upgrades
+            schemaUpgrades.push(_upgradeThreeDotZero);
+        }
+        // Run any migrations serially. Since we start with a promise,
+        // individual migrations are free to return either ISolutionItem
+        // or Promise<ISolutionItem>
+        return schemaUpgrades.reduce((promise, upgradeFn) => promise.then((updatedModel) => upgradeFn(updatedModel)), Promise.resolve(model));
+    }
+}
+//# sourceMappingURL=migrator.js.map

package/dist/esm/migrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrator.js","sourceRoot":"","sources":["../../src/migrator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAI3E,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,2EAA2E;AAC3E,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,KAAoB;IAChD,oBAAoB;IACpB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,iBAAiB,CAAC,EAAE;QACtC,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;KAC5B;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,CAAC;IACrE,oDAAoD;IACpD,IAAI,YAAY,KAAK,sBAAsB,EAAE;QAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC/B;SAAM;QACL,oDAAoD;QACpD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,cAAc,GAAG,EAAE,CAAC;QAE1B,+DAA+D;QAC/D,IAAI,CAAC,YAAY,IAAI,CAAC,QAAQ,EAAE;YAC9B,4BAA4B;YAC5B,qDAAqD;YACrD,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAC1C,kEAAkE;SACnE;aAAM;YACL,mEAAmE;YACnE,iCAAiC;YACjC,cAAc,CAAC,IAAI,CACjB,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,CACpB,CAAC;YACF,yBAAyB;YACzB,cAAc,CAAC,IAAI,CACjB,oBAAoB,CAErB,CAAC;SACH;QACD,8DAA8D;QAC9D,gEAAgE;QAChE,4BAA4B;QAC5B,OAAO,cAAc,CAAC,MAAM,CAC1B,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,YAA2B,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,EAC9F,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CACvB,CAAC;KACH;AACH,CAAC"}

package/dist/esm/resourceHelpers.d.ts

@@ -0,0 +1,192 @@
+/** @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.
+ */
+/**
+ * Provides common functions involving the management of item and group resources.
+ *
+ * @module resourceHelpers
+ *
+ * How it works
+ *
+ * An item may have resources that are listed as a set of filenames and/or folder/filename combinations. It may have
+ * a thumbnail, listed in its item info as a filename or folder/filename combination. It may have metadata, which is
+ * not listed, but has a distinct URL. A group may have a thumbnail, but not the others.
+ *
+ * For storing these files in a common storage item, a new folder and filename combination is created for each. The
+ * filename is kept as-is. The folder consists of the source item's id and an optional suffix. For thumbnails, the
+ * suffix is "_info_thumbnail"; for metadata, the suffix is "_info_metadata"; for resources, the suffix is "_" plus
+ * the resource's folder's name; if the resource doesn't have a folder, there is no suffix.
+ *
+ * Note that "thumbnail" is included in an item's thumbnail property like a folder (e.g., "thumbnail/thumbnail.png"),
+ * and the item's thumbnail is accessed using a path such as "%lt;itemId>/info/thumbnail/thumbnail.png". Groups,
+ * on the other hand, have a property with a simple name (e.g., "thumbnail.png") and it is accessed using a path
+ * such as "%lt;groupId>/info/thumbnail.png".
+ *
+ * For copying these files from the common storage item to another item, one converts the unique names back into the
+ * original names (or the special cases for thumbnails and metadata).
+ *
+ * Routines are provided to
+ *   1. create full URLs to resources, thumbnails, and metadata.
+ *   2. create a folder and filename combination that uniquely identifies these files for
+ *      storing them in a single, shared storage item
+ *   3. copy a set of resources, thumbnails, and metadata for an item to a storage item
+ *   4. copy a file by URL to an item using specified folder and filename
+ *   5. undo the unique folder and filename into the original folder and filename
+ */
+import { IDeployFileCopyPath, IFileMimeTyped, ISourceFile, ISourceFileCopyPath } from "./interfaces";
+import { IItemResourceResponse, UserSession } from "./arcgisRestJS";
+export declare function addThumbnailFromBlob(blob: any, itemId: string, authentication: UserSession, isGroup?: boolean): Promise<any>;
+export declare function convertBlobToSupportableResource(blob: Blob, filename?: string): IFileMimeTyped;
+/**
+ * Copies the files described by a list of full URLs and folder/filename combinations for
+ * the resources and metadata of an item or group to an item.
+ *
+ * @param storageAuthentication Credentials for the request to the storage
+ * @param filePaths List of item files' URLs and folder/filenames for storing the files
+ * @param sourceItemId Id of item supplying resource/metadata
+ * @param destinationFolderId Id of folder
+ * @param destinationItemId Id of item to receive copy of resource/metadata
+ * @param destinationAuthentication Credentials for the request to the destination
+ * @param template Description of item that will receive files
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @returns A promise which resolves to a boolean indicating if the copies were successful
+ */
+export declare function copyFilesFromStorageItem(storageAuthentication: UserSession, filePaths: IDeployFileCopyPath[], sourceItemId: string, destinationFolderId: string, destinationItemId: string, destinationAuthentication: UserSession, template?: any, templateDictionary?: any): Promise<boolean>;
+/**
+ * Copies the files for storing the resources, metadata, and thumbnail of an item or group to a storage item
+ * with a specified path.
+ *
+ * @param files List of item files and paths for storing the files
+ * @param storageItemId Id of item to receive copy of resource/metadata
+ * @param storageAuthentication Credentials for the request to the storage
+ * @returns A promise which resolves to a list of the filenames under which the resource/metadata are stored
+ */
+export declare function copyFilesToStorageItem(files: ISourceFile[], storageItemId: string, storageAuthentication: UserSession): Promise<string[]>;
+/**
+ * Generates a folder and filename for storing a copy of an item's metadata in a storage item.
+ *
+ * @param itemId Id of item
+ * @returns Folder and filename for storage; folder is the itemID suffixed with "_info_metadata"
+ * @see convertStorageResourceToItemResource
+ */
+export declare function generateMetadataStorageFilename(itemId: string): {
+    folder: string;
+    filename: string;
+};
+/**
+ * Generates a list of full URLs and storage folder/filename combinations for storing the resources, metadata,
+ * and thumbnail of an item.
+ *
+ * @param portalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
+ * @param resourceFilenames List of resource filenames for an item, e.g., ["file1", "myFolder/file2"]
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @param storageVersion Version of the Solution template
+ * @returns List of item files' URLs and folder/filenames for storing the files
+ */
+export declare function generateSourceFilePaths(portalSharingUrl: string, itemId: string, thumbnailUrlPart: string, resourceFilenames: string[], isGroup?: boolean, storageVersion?: number): ISourceFileCopyPath[];
+/**
+ * Generates the full URL and storage folder/filename for storing an item's thumbnail.
+ *
+ * @param portalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @returns URL and folder/filename for storing the thumbnail
+ */
+export declare function generateSourceThumbnailPath(portalSharingUrl: string, itemId: string, thumbnailUrlPart: string, isGroup?: boolean): ISourceFileCopyPath;
+/**
+ * Generates the URL for reading an item's metadata.
+ *
+ * @param sourcePortalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @returns URL string
+ */
+export declare function generateSourceMetadataUrl(sourcePortalSharingUrl: string, itemId: string, isGroup?: boolean): string;
+/**
+ * Generates the URL for reading an item's resource given the filename of the resource.
+ *
+ * @param sourcePortalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param sourceResourceFilename Either filename or folder/filename to resource
+ * @returns URL string
+ */
+export declare function generateSourceResourceUrl(sourcePortalSharingUrl: string, itemId: string, sourceResourceFilename: string): string;
+/**
+ * Generates the URL for reading an item's thumbnail.
+ *
+ * @param sourcePortalSharingUrl Server/sharing
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
+ * @param isGroup Boolean to indicate if the files are associated with a group or item
+ * @returns URL string
+ */
+export declare function generateSourceThumbnailUrl(sourcePortalSharingUrl: string, itemId: string, thumbnailUrlPart: string, isGroup?: boolean): string;
+/**
+ * Generates a list of full URLs and folder/filename combinations used to store the resources, metadata,
+ * and thumbnail of an item.
+ *
+ * @param portalSharingUrl Server/sharing
+ * @param storageItemId Id of storage item
+ * @param resourceFilenames List of resource filenames for an item, e.g., ["file1", "myFolder/file2"]
+ * @param storageVersion Version of the Solution template
+ * @returns List of item files' URLs and folder/filenames for storing the files
+ */
+export declare function generateStorageFilePaths(portalSharingUrl: string, storageItemId: string, resourceFilenames?: string[], storageVersion?: number): IDeployFileCopyPath[];
+/**
+ * Generates a folder and filename for storing a copy of an item's thumbnail in a storage item.
+ *
+ * @param itemId Id of item
+ * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON; can also be a filename
+ * @returns Folder and filename for storage; folder is the itemID suffixed with "_info_thumbnail";
+ * file is URI-encoded thumbnailUrlPart
+ * @see convertStorageResourceToItemResource
+ */
+export declare function generateThumbnailStorageFilename(itemId: string, thumbnailurl: string): {
+    folder: string;
+    filename: string;
+};
+export declare function isSupportedFileType(filename: string): boolean;
+/**
+ * Gets the thumbnail of an item or group.
+ *
+ * @param authentication Credentials for the request to the storage
+ * @param filePaths List of item files' URLs and folder/filenames for storing the files
+ * @returns A promise which resolves to a boolean indicating if the copies were successful
+ */
+export declare function getThumbnailFromStorageItem(authentication: UserSession, filePaths: IDeployFileCopyPath[]): Promise<File>;
+/**
+ * Removes the item's resource that matches the filename with new content
+ *
+ * @param itemId Id of the item to remove
+ * @param filename Name of the resource file to remove
+ * @param authentication Credentials for the request to the storage
+ * @returns A promise which resolves with a success true/false response
+ */
+export declare function removeItemResourceFile(itemId: string, filename: string, authentication: UserSession): Promise<{
+    success: boolean;
+}>;
+/**
+ * Updates the item's resource that matches the filename with new content
+ *
+ * @param itemId Id of the item to update
+ * @param filename Name of the resource file to update; prefix optional (e.g., a/b/file.txt)
+ * @param resource The new content to update the resource with
+ * @param authentication Credentials for the request to the storage
+ * @returns A promise which resolves with a success true/false response
+ */
+export declare function updateItemResourceFile(itemId: string, filename: string, resource: File, authentication: UserSession): Promise<IItemResourceResponse>;