@esri/solution-common 4.1.2 → 5.0.0

package/dist/cjs/resources/getItemResourcesPaths.js

@@ -1,73 +1,73 @@
-"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.getItemResourcesPaths = void 0;
-const restHelpersGet_1 = require("../restHelpersGet");
-const resourceHelpers_1 = require("../resourceHelpers");
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Updates the solution item with resources from the itemTemplate
- *
- * @param itemTemplate Template for AGOL item
- * @param solutionItemId item id for the solution
- * @param authentication Credentials for the request to the storage
- * @param storageVersion Version of the Solution template
- * @returns A promise which resolves with an array of paths to resources for the item
- */
-function getItemResourcesPaths(itemTemplate, solutionItemId, authentication, storageVersion = 0) {
-    // get the resources for the item
-    return (0, restHelpersGet_1.getItemResources)(itemTemplate.itemId, authentication).then(resourceResponse => {
-        // map out the resource names and filter for things we
-        // don't want transferred at this time
-        const itemResources = resourceResponse.resources
-            .map((r) => r.resource)
-            .filter((res) => {
-            let result = true;
-            // Certain types have resources that must be interpolated or removed and can not be
-            // directly copied, so they must be filtered out. Sub-optimal as it spreads
-            // type specific logic around the app, but until we refactor how resources
-            // are handled, this is necessary
-            // Hub Sites
-            if (itemTemplate.type === "Hub Site Application") {
-                if (res.match(/^draft-(\d+).json$/)) {
-                    result = false;
-                }
-            }
-            // Storymaps
-            if (itemTemplate.type === "StoryMap") {
-                if (["oembed.json", "oembed.xml"].indexOf(res) !== -1) {
-                    result = false;
-                }
-                if (res.match(/^draft_[\s\S]*.json$/)) {
-                    result = false;
-                }
-            }
-            // Web Experiences
-            if (itemTemplate.type === "Web Experience") {
-                if (res === "config/config.json") {
-                    result = false;
-                }
-            }
-            return result;
-        });
-        // create the filePaths
-        const resourceItemFilePaths = (0, resourceHelpers_1.generateSourceFilePaths)(authentication.portal, itemTemplate.itemId, itemTemplate.item.thumbnail, itemResources, itemTemplate.type === "Group", storageVersion);
-        return Promise.resolve(resourceItemFilePaths);
-    });
-}
-exports.getItemResourcesPaths = getItemResourcesPaths;
+"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.getItemResourcesPaths = void 0;
+const restHelpersGet_1 = require("../restHelpersGet");
+const resourceHelpers_1 = require("../resourceHelpers");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Updates the solution item with resources from the itemTemplate
+ *
+ * @param itemTemplate Template for AGOL item
+ * @param solutionItemId item id for the solution
+ * @param authentication Credentials for the request to the storage
+ * @param storageVersion Version of the Solution template
+ * @returns A promise which resolves with an array of paths to resources for the item
+ */
+function getItemResourcesPaths(itemTemplate, solutionItemId, authentication, storageVersion = 0) {
+    // get the resources for the item
+    return (0, restHelpersGet_1.getItemResources)(itemTemplate.itemId, authentication).then(resourceResponse => {
+        // map out the resource names and filter for things we
+        // don't want transferred at this time
+        const itemResources = resourceResponse.resources
+            .map((r) => r.resource)
+            .filter((res) => {
+            let result = true;
+            // Certain types have resources that must be interpolated or removed and can not be
+            // directly copied, so they must be filtered out. Sub-optimal as it spreads
+            // type specific logic around the app, but until we refactor how resources
+            // are handled, this is necessary
+            // Hub Sites
+            if (itemTemplate.type === "Hub Site Application") {
+                if (res.match(/^draft-(\d+).json$/)) {
+                    result = false;
+                }
+            }
+            // Storymaps
+            if (itemTemplate.type === "StoryMap") {
+                if (["oembed.json", "oembed.xml"].indexOf(res) !== -1) {
+                    result = false;
+                }
+                if (res.match(/^draft_[\s\S]*.json$/)) {
+                    result = false;
+                }
+            }
+            // Web Experiences
+            if (itemTemplate.type === "Web Experience") {
+                if (res === "config/config.json") {
+                    result = false;
+                }
+            }
+            return result;
+        });
+        // create the filePaths
+        const resourceItemFilePaths = (0, resourceHelpers_1.generateSourceFilePaths)(authentication.portal, itemTemplate.itemId, itemTemplate.item.thumbnail, itemResources, itemTemplate.type === "Group", storageVersion);
+        return Promise.resolve(resourceItemFilePaths);
+    });
+}
+exports.getItemResourcesPaths = getItemResourcesPaths;
 //# sourceMappingURL=getItemResourcesPaths.js.map

package/dist/cjs/resources/index.d.ts

@@ -1,29 +1,29 @@
-/** @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.
- */
-export * from "./addMetadataFromBlob";
-export * from "./add-resource-from-blob";
-export * from "./convert-item-resource-to-storage-resource";
-export * from "./convert-storage-resource-to-item-resource";
-export * from "./copyAssociatedFiles";
-export * from "./copyDataIntoItem";
-export * from "./copyMetadataIntoItem";
-export * from "./copyResourceIntoZip";
-export * from "./copyZipIntoItem";
-export * from "./createCopyResults";
-export * from "./get-blob";
-export * from "./getItemResourcesFilesFromPaths";
-export * from "./getItemResourcesPaths";
-export * from "./solution-resource";
+/** @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.
+ */
+export * from "./addMetadataFromBlob";
+export * from "./add-resource-from-blob";
+export * from "./convert-item-resource-to-storage-resource";
+export * from "./convert-storage-resource-to-item-resource";
+export * from "./copyAssociatedFiles";
+export * from "./copyDataIntoItem";
+export * from "./copyMetadataIntoItem";
+export * from "./copyResourceIntoZip";
+export * from "./copyZipIntoItem";
+export * from "./createCopyResults";
+export * from "./get-blob";
+export * from "./getItemResourcesFilesFromPaths";
+export * from "./getItemResourcesPaths";
+export * from "./solution-resource";

package/dist/cjs/resources/index.js

@@ -1,33 +1,33 @@
-"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 });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./addMetadataFromBlob"), exports);
-tslib_1.__exportStar(require("./add-resource-from-blob"), exports);
-tslib_1.__exportStar(require("./convert-item-resource-to-storage-resource"), exports);
-tslib_1.__exportStar(require("./convert-storage-resource-to-item-resource"), exports);
-tslib_1.__exportStar(require("./copyAssociatedFiles"), exports);
-tslib_1.__exportStar(require("./copyDataIntoItem"), exports);
-tslib_1.__exportStar(require("./copyMetadataIntoItem"), exports);
-tslib_1.__exportStar(require("./copyResourceIntoZip"), exports);
-tslib_1.__exportStar(require("./copyZipIntoItem"), exports);
-tslib_1.__exportStar(require("./createCopyResults"), exports);
-tslib_1.__exportStar(require("./get-blob"), exports);
-tslib_1.__exportStar(require("./getItemResourcesFilesFromPaths"), exports);
-tslib_1.__exportStar(require("./getItemResourcesPaths"), exports);
-tslib_1.__exportStar(require("./solution-resource"), exports);
+"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 });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./addMetadataFromBlob"), exports);
+tslib_1.__exportStar(require("./add-resource-from-blob"), exports);
+tslib_1.__exportStar(require("./convert-item-resource-to-storage-resource"), exports);
+tslib_1.__exportStar(require("./convert-storage-resource-to-item-resource"), exports);
+tslib_1.__exportStar(require("./copyAssociatedFiles"), exports);
+tslib_1.__exportStar(require("./copyDataIntoItem"), exports);
+tslib_1.__exportStar(require("./copyMetadataIntoItem"), exports);
+tslib_1.__exportStar(require("./copyResourceIntoZip"), exports);
+tslib_1.__exportStar(require("./copyZipIntoItem"), exports);
+tslib_1.__exportStar(require("./createCopyResults"), exports);
+tslib_1.__exportStar(require("./get-blob"), exports);
+tslib_1.__exportStar(require("./getItemResourcesFilesFromPaths"), exports);
+tslib_1.__exportStar(require("./getItemResourcesPaths"), exports);
+tslib_1.__exportStar(require("./solution-resource"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1,35 +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;
-}
+/** @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

@@ -1,31 +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 || (exports.SolutionResourceType = {}));
+"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

@@ -1 +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,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B"}
+{"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

@@ -1,56 +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;
+/** @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;