@esri/solution-common 5.2.3 → 5.2.4

package/dist/cjs/resources/solution-resource.d.ts

@@ -0,0 +1,35 @@
+/** @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.
+ */
+/**
+ * Denotes type information for a SolutionResource
+ */
+export declare enum SolutionResourceType {
+    thumbnail = 0,
+    metadata = 1,
+    resource = 2,
+    data = 3,
+    fakezip = 4,
+    info = 5
+}
+/**
+ * Solution Resource information
+ */
+export interface ISolutionResource {
+    filename: string;
+    type: SolutionResourceType;
+    path: string;
+    sourceUrl?: string;
+}

package/dist/cjs/resources/solution-resource.js

@@ -0,0 +1,31 @@
+"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.SolutionResourceType = void 0;
+/**
+ * Denotes type information for a SolutionResource
+ */
+var SolutionResourceType;
+(function (SolutionResourceType) {
+    SolutionResourceType[SolutionResourceType["thumbnail"] = 0] = "thumbnail";
+    SolutionResourceType[SolutionResourceType["metadata"] = 1] = "metadata";
+    SolutionResourceType[SolutionResourceType["resource"] = 2] = "resource";
+    SolutionResourceType[SolutionResourceType["data"] = 3] = "data";
+    SolutionResourceType[SolutionResourceType["fakezip"] = 4] = "fakezip";
+    SolutionResourceType[SolutionResourceType["info"] = 5] = "info";
+})(SolutionResourceType || (exports.SolutionResourceType = SolutionResourceType = {}));
+//# sourceMappingURL=solution-resource.js.map

package/dist/cjs/resources/solution-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solution-resource.js","sourceRoot":"","sources":["../../../src/resources/solution-resource.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AACH,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,yEAAS,CAAA;IACT,uEAAQ,CAAA;IACR,uEAAQ,CAAA;IACR,+DAAI,CAAA;IACJ,qEAAO,CAAA;IACP,+DAAI,CAAA;AACN,CAAC,EAPW,oBAAoB,oCAApB,oBAAoB,QAO/B"}

package/dist/cjs/resources/transform-resource-paths-to-solution-resources.d.ts

@@ -0,0 +1,56 @@
+/** @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 { ISolutionResource, SolutionResourceType } from "./solution-resource";
+/**
+ * Convert an array of resource strings into an array of ISolutionResources
+ *
+ * Used to migrate Solutions to a more extensible resource schema
+ *
+ * @param resourceStrings Array of resource paths
+ */
+export declare function transformResourcePathsToSolutionResources(resourceStrings?: string[]): ISolutionResource[];
+/**
+ * Convert a resource path to a ISolutionResource
+ *
+ * @param resourcePath String
+ */
+export declare function transformResourcePathToSolutionResource(resourcePath: string): ISolutionResource;
+/**
+ * Convert a resource path to a SolutionResourceType
+ *
+ * @param resourcePath String
+ * @private
+ */
+export declare function _getSolutionResourceTypeFromResourcePath(resourcePath: string): SolutionResourceType;
+/**
+ * Extract the filename from a path
+ *
+ * @param path String that is a path
+ * @private
+ */
+export declare function _extractFilenameFromResourcePath(path: string): string;
+/**
+ * Convert the resource path into the correct output path
+ * (aka resource prefix)
+ *
+ * Original resource paths encoded information in the path
+ * including actual sub-folders. The logic is kinda complex
+ * thus this function has extensive tests
+ *
+ * @param path
+ * @private
+ */
+export declare function _extractPathFromResourcePath(resourcePath: string): string;

package/dist/cjs/resources/transform-resource-paths-to-solution-resources.js

@@ -0,0 +1,146 @@
+"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._extractPathFromResourcePath = exports._extractFilenameFromResourcePath = exports._getSolutionResourceTypeFromResourcePath = exports.transformResourcePathToSolutionResource = exports.transformResourcePathsToSolutionResources = void 0;
+const solution_resource_1 = require("./solution-resource");
+const hub_common_1 = require("@esri/hub-common");
+/**
+ * Convert an array of resource strings into an array of ISolutionResources
+ *
+ * Used to migrate Solutions to a more extensible resource schema
+ *
+ * @param resourceStrings Array of resource paths
+ */
+function transformResourcePathsToSolutionResources(resourceStrings = []) {
+    return resourceStrings.map(transformResourcePathToSolutionResource);
+}
+exports.transformResourcePathsToSolutionResources = transformResourcePathsToSolutionResources;
+/**
+ * Convert a resource path to a ISolutionResource
+ *
+ * @param resourcePath String
+ */
+function transformResourcePathToSolutionResource(resourcePath) {
+    return {
+        filename: _extractFilenameFromResourcePath(resourcePath),
+        type: _getSolutionResourceTypeFromResourcePath(resourcePath),
+        path: _extractPathFromResourcePath(resourcePath),
+        sourceUrl: resourcePath
+    };
+}
+exports.transformResourcePathToSolutionResource = transformResourcePathToSolutionResource;
+/**
+ * Convert a resource path to a SolutionResourceType
+ *
+ * @param resourcePath String
+ * @private
+ */
+function _getSolutionResourceTypeFromResourcePath(resourcePath) {
+    let type = solution_resource_1.SolutionResourceType.resource;
+    const folder = resourcePath
+        .split("/")
+        .slice(0, -1)
+        .join("/") || "";
+    PATH_TO_TYPE_MAP.forEach(entry => {
+        if (folder.endsWith(entry.ending)) {
+            type = entry.type;
+        }
+    });
+    return type;
+}
+exports._getSolutionResourceTypeFromResourcePath = _getSolutionResourceTypeFromResourcePath;
+/**
+ * Mapping of strings that have been appended to the resource path to
+ * encode the resource type
+ */
+const PATH_TO_TYPE_MAP = [
+    { ending: "_info_thumbnail", type: solution_resource_1.SolutionResourceType.thumbnail },
+    { ending: "_info_metadata", type: solution_resource_1.SolutionResourceType.metadata },
+    { ending: "_info_data", type: solution_resource_1.SolutionResourceType.data },
+    { ending: "_info_dataz", type: solution_resource_1.SolutionResourceType.fakezip },
+    { ending: "_info", type: solution_resource_1.SolutionResourceType.info }
+];
+/**
+ * Extract the filename from a path
+ *
+ * @param path String that is a path
+ * @private
+ */
+function _extractFilenameFromResourcePath(path) {
+    // if we have path separators, split and grab last segment
+    if (path.indexOf("/") > -1) {
+        return path.split("/").reverse()[0];
+    }
+    else {
+        // Hub resources are {guid}-{filename.ext}
+        if (path.indexOf("-") === 32) {
+            // start at 33 to remove the `-` between the filename and the guid
+            return path.substr(33, path.length - 1);
+        }
+        else {
+            // path is the filename
+            return path;
+        }
+    }
+}
+exports._extractFilenameFromResourcePath = _extractFilenameFromResourcePath;
+/**
+ * Convert the resource path into the correct output path
+ * (aka resource prefix)
+ *
+ * Original resource paths encoded information in the path
+ * including actual sub-folders. The logic is kinda complex
+ * thus this function has extensive tests
+ *
+ * @param path
+ * @private
+ */
+function _extractPathFromResourcePath(resourcePath) {
+    // default case
+    let path = "";
+    // parse up the path by splittins on `/` and dropping the last segment
+    const parsedPath = resourcePath
+        .split("/")
+        .slice(0, -1)
+        .join("/") || "";
+    // if we got something...
+    if (parsedPath) {
+        // now we need to see if this has any of the well-known endings
+        const isWellKnownPath = PATH_TO_TYPE_MAP.reduce((acc, entry) => {
+            if (parsedPath.endsWith(entry.ending)) {
+                acc = true;
+            }
+            return acc;
+        }, false);
+        // if it does not match a well-known path...
+        if (!isWellKnownPath && parsedPath.indexOf("http") !== 0) {
+            // see if there is another folder encoded...
+            if (parsedPath.indexOf("_") > -1) {
+                path = parsedPath.split("_")[1];
+            }
+            else {
+                // if the path is not a naked guid, we return the parsed path
+                if (!(0, hub_common_1.isGuid)(parsedPath)) {
+                    path = parsedPath;
+                }
+            }
+        }
+    }
+    return path;
+}
+exports._extractPathFromResourcePath = _extractPathFromResourcePath;
+//# sourceMappingURL=transform-resource-paths-to-solution-resources.js.map

package/dist/cjs/resources/transform-resource-paths-to-solution-resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-resource-paths-to-solution-resources.js","sourceRoot":"","sources":["../../../src/resources/transform-resource-paths-to-solution-resources.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,2DAA8E;AAC9E,iDAA0C;AAC1C;;;;;;GAMG;AACH,SAAgB,yCAAyC,CACvD,kBAA4B,EAAE;IAE9B,OAAO,eAAe,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;AACtE,CAAC;AAJD,8FAIC;AAED;;;;GAIG;AACH,SAAgB,uCAAuC,CACrD,YAAoB;IAEpB,OAAO;QACL,QAAQ,EAAE,gCAAgC,CAAC,YAAY,CAAC;QACxD,IAAI,EAAE,wCAAwC,CAAC,YAAY,CAAC;QAC5D,IAAI,EAAE,4BAA4B,CAAC,YAAY,CAAC;QAChD,SAAS,EAAE,YAAY;KACH,CAAC;AACzB,CAAC;AATD,0FASC;AAED;;;;;GAKG;AACH,SAAgB,wCAAwC,CACtD,YAAoB;IAEpB,IAAI,IAAI,GAAG,wCAAoB,CAAC,QAAQ,CAAC;IAEzC,MAAM,MAAM,GACV,YAAY;SACT,KAAK,CAAC,GAAG,CAAC;SACV,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SACZ,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAErB,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC/B,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YACjC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC;AAlBD,4FAkBC;AAED;;;GAGG;AACH,MAAM,gBAAgB,GAAG;IACvB,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,wCAAoB,CAAC,SAAS,EAAE;IACnE,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,wCAAoB,CAAC,QAAQ,EAAE;IACjE,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,wCAAoB,CAAC,IAAI,EAAE;IACzD,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,wCAAoB,CAAC,OAAO,EAAE;IAC7D,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,wCAAoB,CAAC,IAAI,EAAE;CACrD,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,gCAAgC,CAAC,IAAY;IAC3D,0DAA0D;IAC1D,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;KACrC;SAAM;QACL,0CAA0C;QAC1C,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;YAC5B,kEAAkE;YAClE,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACzC;aAAM;YACL,uBAAuB;YACvB,OAAO,IAAI,CAAC;SACb;KACF;AACH,CAAC;AAdD,4EAcC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,4BAA4B,CAAC,YAAoB;IAC/D,eAAe;IACf,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,sEAAsE;IACtE,MAAM,UAAU,GACd,YAAY;SACT,KAAK,CAAC,GAAG,CAAC;SACV,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SACZ,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACrB,yBAAyB;IACzB,IAAI,UAAU,EAAE;QACd,+DAA+D;QAC/D,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC7D,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBACrC,GAAG,GAAG,IAAI,CAAC;aACZ;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,KAAK,CAAC,CAAC;QAEV,4CAA4C;QAC5C,IAAI,CAAC,eAAe,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YACxD,4CAA4C;YAC5C,IAAI,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;gBAChC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aACjC;iBAAM;gBACL,6DAA6D;gBAC7D,IAAI,CAAC,IAAA,mBAAM,EAAC,UAAU,CAAC,EAAE;oBACvB,IAAI,GAAG,UAAU,CAAC;iBACnB;aACF;SACF;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAlCD,oEAkCC"}