@esri/solution-common 6.1.3 → 6.1.4

package/dist/esm/resources/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,kCAAkC,CAAC;AACjD,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}

package/dist/esm/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/esm/resources/solution-resource.js

@@ -0,0 +1,28 @@
+/** @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 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 || (SolutionResourceType = {}));
+//# sourceMappingURL=solution-resource.js.map

package/dist/esm/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,MAAM,CAAN,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,KAApB,oBAAoB,QAO/B"}

package/dist/esm/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/esm/resources/transform-resource-paths-to-solution-resources.js

@@ -0,0 +1,132 @@
+/** @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 { SolutionResourceType } from "./solution-resource";
+import { isGuid } from "@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
+ */
+export function transformResourcePathsToSolutionResources(resourceStrings = []) {
+    return resourceStrings.map(transformResourcePathToSolutionResource);
+}
+/**
+ * Convert a resource path to a ISolutionResource
+ *
+ * @param resourcePath String
+ */
+export function transformResourcePathToSolutionResource(resourcePath) {
+    return {
+        filename: _extractFilenameFromResourcePath(resourcePath),
+        type: _getSolutionResourceTypeFromResourcePath(resourcePath),
+        path: _extractPathFromResourcePath(resourcePath),
+        sourceUrl: resourcePath,
+    };
+}
+/**
+ * Convert a resource path to a SolutionResourceType
+ *
+ * @param resourcePath String
+ * @private
+ */
+export function _getSolutionResourceTypeFromResourcePath(resourcePath) {
+    let type = 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;
+}
+/**
+ * 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: SolutionResourceType.thumbnail },
+    { ending: "_info_metadata", type: SolutionResourceType.metadata },
+    { ending: "_info_data", type: SolutionResourceType.data },
+    { ending: "_info_dataz", type: SolutionResourceType.fakezip },
+    { ending: "_info", type: SolutionResourceType.info },
+];
+/**
+ * Extract the filename from a path
+ *
+ * @param path String that is a path
+ * @private
+ */
+export 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;
+        }
+    }
+}
+/**
+ * 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 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 (!isGuid(parsedPath)) {
+                    path = parsedPath;
+                }
+            }
+        }
+    }
+    return path;
+}
+//# sourceMappingURL=transform-resource-paths-to-solution-resources.js.map

package/dist/esm/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,OAAO,EAAqB,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C;;;;;;GAMG;AACH,MAAM,UAAU,yCAAyC,CAAC,kBAA4B,EAAE;IACtF,OAAO,eAAe,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;AACtE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uCAAuC,CAAC,YAAoB;IAC1E,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;AAED;;;;;GAKG;AACH,MAAM,UAAU,wCAAwC,CAAC,YAAoB;IAC3E,IAAI,IAAI,GAAG,oBAAoB,CAAC,QAAQ,CAAC;IAEzC,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAEpE,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACjC,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;AAED;;;GAGG;AACH,MAAM,gBAAgB,GAAG;IACvB,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,oBAAoB,CAAC,SAAS,EAAE;IACnE,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACjE,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,EAAE;IACzD,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,oBAAoB,CAAC,OAAO,EAAE;IAC7D,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,EAAE;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,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;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,4BAA4B,CAAC,YAAoB;IAC/D,eAAe;IACf,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,sEAAsE;IACtE,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACxE,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,MAAM,CAAC,UAAU,CAAC,EAAE;oBACvB,IAAI,GAAG,UAAU,CAAC;iBACnB;aACF;SACF;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/esm/resources/update-resource.d.ts

@@ -0,0 +1,27 @@
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "../arcgisRestJS";
+/**
+ * Adds a text resource.
+ *
+ * @param content Text to add as a resource
+ * @param itemId Id of the item to add the resource to
+ * @param folder A prefix string added to the filename in the storage; use null or undefined for no folder
+ * @param filename File name used to rename an existing file resource uploaded, or to be used together with
+ * text as file name for it. File name must have the file resource extension.
+ * @param authentication Credentials for the request
+ */
+export declare function updateTextResource(content: string, itemId: string, folder: string, filename: string, authentication: UserSession): Promise<any>;

package/dist/esm/resources/update-resource.js

@@ -0,0 +1,48 @@
+/** @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 { ArcGISAuthError, updateItemResource } from "../arcgisRestJS";
+/**
+ * Adds a text resource.
+ *
+ * @param content Text to add as a resource
+ * @param itemId Id of the item to add the resource to
+ * @param folder A prefix string added to the filename in the storage; use null or undefined for no folder
+ * @param filename File name used to rename an existing file resource uploaded, or to be used together with
+ * text as file name for it. File name must have the file resource extension.
+ * @param authentication Credentials for the request
+ */
+export function updateTextResource(content, itemId, folder, filename, authentication) {
+    // Check that the filename has an extension because it is required by the addResources call
+    if (filename && filename.indexOf(".") < 0) {
+        return new Promise((resolve, reject) => {
+            reject(new ArcGISAuthError("Filename must have an extension indicating its type"));
+        });
+    }
+    const requestOptions = {
+        id: itemId,
+        content,
+        name: filename,
+        authentication: authentication,
+        params: {},
+    };
+    if (folder) {
+        requestOptions.params = {
+            resourcesPrefix: folder,
+        };
+    }
+    return updateItemResource(requestOptions);
+}
+//# sourceMappingURL=update-resource.js.map

package/dist/esm/resources/update-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-resource.js","sourceRoot":"","sources":["../../../src/resources/update-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAwB,eAAe,EAAE,kBAAkB,EAAe,MAAM,iBAAiB,CAAC;AAEzG;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAe,EACf,MAAc,EACd,MAAc,EACd,QAAgB,EAChB,cAA2B;IAE3B,2FAA2F;IAC3F,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACzC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,IAAI,eAAe,CAAC,qDAAqD,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;KACJ;IAED,MAAM,cAAc,GAAyB;QAC3C,EAAE,EAAE,MAAM;QACV,OAAO;QACP,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE,cAAc;QAC9B,MAAM,EAAE,EAAE;KACX,CAAC;IACF,IAAI,MAAM,EAAE;QACV,cAAc,CAAC,MAAM,GAAG;YACtB,eAAe,EAAE,MAAM;SACxB,CAAC;KACH;IACD,OAAO,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAC5C,CAAC"}