@esri/solution-common 3.0.0 → 3.1.0

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

@@ -1,95 +0,0 @@
-"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/node/migrations/upgrade-two-dot-zero.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"upgrade-two-dot-zero.js","sourceRoot":"","sources":["../../../src/migrations/upgrade-two-dot-zero.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,iDAAwD;AAExD;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,KAAU;IAC3C,IAAI,IAAA,oBAAO,EAAC,KAAK,EAAE,+BAA+B,CAAC,IAAI,CAAC,EAAE;QACxD,OAAO,KAAK,CAAC;KACd;IACD,wDAAwD;IACxD,MAAM,KAAK,GAAG,IAAA,wBAAW,EAAC,KAAK,CAAC,CAAC;IACjC,MAAM,cAAc,GAAG,IAAA,oBAAO,EAAC,KAAK,EAAE,4BAA4B,CAAC,IAAI,EAAE,CAAC;IAE1E,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CACxC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,YAAY,CACxC,CAAC;IACF,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;AAlBD,gDAkBC;AAED;;;;;GAKG;AACH,SAAgB,+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,qCAA6B,CAAC,CAAC;IACtE,+DAA+D;IAC/D,OAAO,IAAI,CAAC;AACd,CAAC;AARD,0EAQC;AAED;;;;GAIG;AACI,MAAM,6BAA6B,GAAG,UAAS,GAAQ;IAC5D,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,8BAAsB,CAAC;SAC/C;KACF,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAdW,QAAA,6BAA6B,iCAcxC;AAEF;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,UAAS,KAAU;IACvD,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;AARW,QAAA,sBAAsB,0BAQjC"}

package/dist/node/migrator.d.ts

@@ -1,25 +0,0 @@
-/** @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/node/migrator.js

@@ -1,77 +0,0 @@
-"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.migrateSchema = exports.CURRENT_SCHEMA_VERSION = void 0;
-const is_legacy_solution_1 = require("./migrations/is-legacy-solution");
-const apply_schema_1 = require("./migrations/apply-schema");
-const upgrade_two_dot_zero_1 = require("./migrations/upgrade-two-dot-zero");
-const upgrade_two_dot_one_1 = require("./migrations/upgrade-two-dot-one");
-const upgrade_two_dot_two_1 = require("./migrations/upgrade-two-dot-two");
-const upgrade_two_dot_three_1 = require("./migrations/upgrade-two-dot-three");
-const upgrade_two_dot_four_1 = require("./migrations/upgrade-two-dot-four");
-const upgrade_two_dot_five_1 = require("./migrations/upgrade-two-dot-five");
-const upgrade_two_dot_six_1 = require("./migrations/upgrade-two-dot-six");
-const upgrade_two_dot_seven_1 = require("./migrations/upgrade-two-dot-seven");
-const upgrade_three_dot_zero_1 = require("./migrations/upgrade-three-dot-zero");
-const hub_common_1 = require("@esri/hub-common");
-// Starting at 3.0 because Hub has been versioning Solution items up to 2.x
-exports.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
- */
-function migrateSchema(model) {
-    // ensure properties
-    if (!(0, hub_common_1.getProp)(model, "item.properties")) {
-        model.item.properties = {};
-    }
-    const modelVersion = (0, hub_common_1.getProp)(model, "item.properties.schemaVersion");
-    // if it's already on the current version, return it
-    if (modelVersion === exports.CURRENT_SCHEMA_VERSION) {
-        return Promise.resolve(model);
-    }
-    else {
-        // check if this is a legacy solution created by Hub
-        const isLegacy = (0, is_legacy_solution_1._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(upgrade_three_dot_zero_1._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(apply_schema_1._applySchema, upgrade_two_dot_zero_1._upgradeTwoDotZero, upgrade_two_dot_one_1._upgradeTwoDotOne, upgrade_two_dot_two_1._upgradeTwoDotTwo, upgrade_two_dot_three_1._upgradeTwoDotThree, upgrade_two_dot_four_1._upgradeTwoDotFour, upgrade_two_dot_five_1._upgradeTwoDotFive, upgrade_two_dot_six_1._upgradeTwoDotSix, upgrade_two_dot_seven_1._upgradeTwoDotSeven);
-            // Apply the 3.x upgrades
-            schemaUpgrades.push(upgrade_three_dot_zero_1._upgradeThreeDotZero
-            // _upgradeThreeDotOne // Not ready for prod yet
-            );
-        }
-        // 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));
-    }
-}
-exports.migrateSchema = migrateSchema;
-//# sourceMappingURL=migrator.js.map

package/dist/node/migrator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"migrator.js","sourceRoot":"","sources":["../../src/migrator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAGH,wEAAoE;AACpE,4DAAyD;AACzD,4EAAuE;AACvE,0EAAqE;AACrE,0EAAqE;AACrE,8EAAyE;AACzE,4EAAuE;AACvE,4EAAuE;AACvE,0EAAqE;AACrE,8EAAyE;AACzE,gFAA2E;AAI3E,iDAA2C;AAE3C,2EAA2E;AAC9D,QAAA,sBAAsB,GAAG,GAAG,CAAC;AAE1C;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,KAAoB;IAChD,oBAAoB;IACpB,IAAI,CAAC,IAAA,oBAAO,EAAC,KAAK,EAAE,iBAAiB,CAAC,EAAE;QACtC,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;KAC5B;IAED,MAAM,YAAY,GAAG,IAAA,oBAAO,EAAC,KAAK,EAAE,+BAA+B,CAAC,CAAC;IACrE,oDAAoD;IACpD,IAAI,YAAY,KAAK,8BAAsB,EAAE;QAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC/B;SAAM;QACL,oDAAoD;QACpD,MAAM,QAAQ,GAAG,IAAA,sCAAiB,EAAC,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,6CAAoB,CAAC,CAAC;YAC1C,kEAAkE;SACnE;aAAM;YACL,mEAAmE;YACnE,iCAAiC;YACjC,cAAc,CAAC,IAAI,CACjB,2BAAY,EACZ,yCAAkB,EAClB,uCAAiB,EACjB,uCAAiB,EACjB,2CAAmB,EACnB,yCAAkB,EAClB,yCAAkB,EAClB,uCAAiB,EACjB,2CAAmB,CACpB,CAAC;YACF,yBAAyB;YACzB,cAAc,CAAC,IAAI,CACjB,6CAAoB;YACpB,gDAAgD;aACjD,CAAC;SACH;QACD,8DAA8D;QAC9D,gEAAgE;QAChE,4BAA4B;QAC5B,OAAO,cAAc,CAAC,MAAM,CAC1B,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CACrB,OAAO,CAAC,IAAI,CAAC,CAAC,YAA2B,EAAE,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,EACxE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CACvB,CAAC;KACH;AACH,CAAC;AAlDD,sCAkDC"}

package/dist/node/polyfills.d.ts

@@ -1,40 +0,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.
- */
-/**
- * Provides polyfill helper functions.
- *
- * @module polyfills
- */
-/**
- * Supplies Blob.text for Microsoft Legacy Edge
- *
- * @param blob Blob to read
- * @returns Promise resolving to blob's text
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
- * @see https://developer.mozilla.org/en-US/docs/Web/API/FileReader
- */
-export declare function getBlobText(blob: Blob): Promise<string>;
-/**
- * Supplies the File constructor for Microsoft Legacy Edge.
- *
- * @param fileBits Contents for file
- * @param fileName Name for file
- * @param options Bucket of options, euch as `type` for the MIME type; defaults to empty string for `type`
- * @returns File or, for Microsoft Legacy Edge, Blob
- * @see https://developer.mozilla.org/en-US/docs/Web/API/File/File
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
- */
-export declare function new_File(fileBits: BlobPart[], fileName: string, options?: FilePropertyBag): File;

package/dist/node/polyfills.js

@@ -1,98 +0,0 @@
-"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.new_File = exports.getBlobText = void 0;
-/**
- * Provides polyfill helper functions.
- *
- * @module polyfills
- */
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Supplies Blob.text for Microsoft Legacy Edge
- *
- * @param blob Blob to read
- * @returns Promise resolving to blob's text
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
- * @see https://developer.mozilla.org/en-US/docs/Web/API/FileReader
- */
-function getBlobText(blob) {
-    let textPromise;
-    /* istanbul ignore else */
-    if (typeof blob.text !== "undefined") {
-        // Modern browser
-        textPromise = blob.text();
-    }
-    else {
-        // Microsoft Legacy Edge
-        textPromise = new Promise((resolve, reject) => {
-            const reader = new FileReader();
-            reader.onload = function (event) {
-                if (event.target && event.target.result) {
-                    // event.target.result is typed as "string | ArrayBuffer | null", but for the readAsText function,
-                    // the result is a string
-                    resolve(event.target.result);
-                }
-                else {
-                    resolve("");
-                }
-            };
-            reader.onerror = function (event) {
-                reject(event);
-            };
-            reader.readAsText(blob);
-        });
-    }
-    return textPromise;
-}
-exports.getBlobText = getBlobText;
-/**
- * Supplies the File constructor for Microsoft Legacy Edge.
- *
- * @param fileBits Contents for file
- * @param fileName Name for file
- * @param options Bucket of options, euch as `type` for the MIME type; defaults to empty string for `type`
- * @returns File or, for Microsoft Legacy Edge, Blob
- * @see https://developer.mozilla.org/en-US/docs/Web/API/File/File
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
- */
-function new_File(fileBits, fileName, options) {
-    let file;
-    try {
-        // Modern browser
-        file = new File(fileBits, fileName, options);
-    }
-    catch (error) {
-        // Microsoft Legacy Edge
-        /* istanbul ignore next */
-        file = (function () {
-            if (typeof options === "undefined") {
-                // Microsoft Legacy Edge fails in karma if options is not defined
-                options = {
-                    type: ""
-                };
-            }
-            const blob = new Blob(fileBits, options);
-            blob.lastModified = new Date();
-            blob.name = fileName;
-            return blob;
-        })();
-    }
-    return file;
-}
-exports.new_File = new_File;
-//# sourceMappingURL=polyfills.js.map

package/dist/node/polyfills.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"polyfills.js","sourceRoot":"","sources":["../../src/polyfills.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AAEH,wHAAwH;AAExH;;;;;;;GAOG;AACH,SAAgB,WAAW,CAAC,IAAU;IACpC,IAAI,WAA4B,CAAC;IAEjC,0BAA0B;IAC1B,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE;QACpC,iBAAiB;QACjB,WAAW,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;KAC3B;SAAM;QACL,wBAAwB;QACxB,WAAW,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAChC,MAAM,CAAC,MAAM,GAAG,UAAS,KAAK;gBAC5B,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE;oBACvC,kGAAkG;oBAClG,yBAAyB;oBACzB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC;iBACxC;qBAAM;oBACL,OAAO,CAAC,EAAE,CAAC,CAAC;iBACb;YACH,CAAC,CAAC;YACF,MAAM,CAAC,OAAO,GAAG,UAAS,KAAK;gBAC7B,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;YACF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AA5BD,kCA4BC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CACtB,QAAoB,EACpB,QAAgB,EAChB,OAAyB;IAEzB,IAAI,IAAU,CAAC;IAEf,IAAI;QACF,iBAAiB;QACjB,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;KAC9C;IAAC,OAAO,KAAK,EAAE;QACd,wBAAwB;QACxB,0BAA0B;QAC1B,IAAI,GAAG,CAAC;YACN,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE;gBAClC,iEAAiE;gBACjE,OAAO,GAAG;oBACR,IAAI,EAAE,EAAE;iBACT,CAAC;aACH;YACD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAQ,CAAC;YAChD,IAAI,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC;YACrB,OAAO,IAAY,CAAC;QACtB,CAAC,CAAC,EAAE,CAAC;KACN;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AA5BD,4BA4BC"}

package/dist/node/resourceHelpers.d.ts

@@ -1,190 +0,0 @@
-/** @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, UserSession } from "./interfaces";
-import { IItemResourceResponse } from "@esri/arcgis-rest-portal";
-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 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 Template for using its itemId and properties for fine-tuning the filename for Hub
- * @returns A promise which resolves to a boolean indicating if the copies were successful
- */
-export declare function copyFilesFromStorageItem(storageAuthentication: UserSession, filePaths: IDeployFileCopyPath[], destinationFolderId: string, destinationItemId: string, destinationAuthentication: UserSession, template?: 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 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>;
-/**
- * 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
- * @param content 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 updateItemResourceText(itemId: string, filename: string, content: string, authentication: UserSession): Promise<IItemResourceResponse>;