@esri/solution-common 4.1.2 → 5.0.0

package/dist/cjs/resources/copyZipIntoItem.js

@@ -1,54 +1,54 @@
-"use strict";
-/** @license
- * Copyright 2021 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.copyZipIntoItem = void 0;
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-const generalHelpers_1 = require("../generalHelpers");
-const createCopyResults_1 = require("./createCopyResults");
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Copies a zipfile into an AGO item.
- *
- * @param zipInfo Information about a zipfile such as its name and its zip object
- * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
- * @param destinationAuthentication Credentials for the request to the storage
- * @returns A promise which resolves to the result of the copy
- */
-function copyZipIntoItem(zipInfo, destinationItemId, destinationAuthentication) {
-    return new Promise(resolve => {
-        zipInfo.zip
-            .generateAsync({ type: "blob" })
-            .then((content) => {
-            return (0, generalHelpers_1.blobToFile)(content, zipInfo.filename, "application/zip");
-        })
-            .then((zipfile) => {
-            const addResourceOptions = {
-                id: destinationItemId,
-                resource: zipfile,
-                authentication: destinationAuthentication,
-                params: {
-                    archive: true
-                }
-            };
-            return (0, arcgis_rest_portal_1.addItemResource)(addResourceOptions);
-        })
-            .then(() => resolve((0, createCopyResults_1.createCopyResults)(zipInfo, true, true)), () => resolve((0, createCopyResults_1.createCopyResults)(zipInfo, true, false)) // unable to add resource
-        );
-    });
-}
-exports.copyZipIntoItem = copyZipIntoItem;
+"use strict";
+/** @license
+ * Copyright 2021 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.copyZipIntoItem = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const generalHelpers_1 = require("../generalHelpers");
+const createCopyResults_1 = require("./createCopyResults");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Copies a zipfile into an AGO item.
+ *
+ * @param zipInfo Information about a zipfile such as its name and its zip object
+ * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
+ * @param destinationAuthentication Credentials for the request to the storage
+ * @returns A promise which resolves to the result of the copy
+ */
+function copyZipIntoItem(zipInfo, destinationItemId, destinationAuthentication) {
+    return new Promise(resolve => {
+        zipInfo.zip
+            .generateAsync({ type: "blob" })
+            .then((content) => {
+            return (0, generalHelpers_1.blobToFile)(content, zipInfo.filename, "application/zip");
+        })
+            .then((zipfile) => {
+            const addResourceOptions = {
+                id: destinationItemId,
+                resource: zipfile,
+                authentication: destinationAuthentication,
+                params: {
+                    archive: true
+                }
+            };
+            return (0, arcgis_rest_portal_1.addItemResource)(addResourceOptions);
+        })
+            .then(() => resolve((0, createCopyResults_1.createCopyResults)(zipInfo, true, true)), () => resolve((0, createCopyResults_1.createCopyResults)(zipInfo, true, false)) // unable to add resource
+        );
+    });
+}
+exports.copyZipIntoItem = copyZipIntoItem;
 //# sourceMappingURL=copyZipIntoItem.js.map

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

@@ -1,25 +1,25 @@
-/** @license
- * Copyright 2021 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 { IAssociatedFileCopyResults, IZipCopyResults } from "../interfaces";
-/**
- * Generates IAssociatedFileCopyResults object.
- *
- * @param fileInfo Info about item that was to be copied
- * @param fetchedFromSource Status of fetching item from source
- * @param copiedToDestination Status of copying item to destination
- * @returns IAssociatedFileCopyResults object
- */
-export declare function createCopyResults(fileInfo: any, fetchedFromSource: boolean, copiedToDestination?: boolean): IAssociatedFileCopyResults | IZipCopyResults;
+/** @license
+ * Copyright 2021 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 { IAssociatedFileCopyResults, IZipCopyResults } from "../interfaces";
+/**
+ * Generates IAssociatedFileCopyResults object.
+ *
+ * @param fileInfo Info about item that was to be copied
+ * @param fetchedFromSource Status of fetching item from source
+ * @param copiedToDestination Status of copying item to destination
+ * @returns IAssociatedFileCopyResults object
+ */
+export declare function createCopyResults(fileInfo: any, fetchedFromSource: boolean, copiedToDestination?: boolean): IAssociatedFileCopyResults | IZipCopyResults;

package/dist/cjs/resources/createCopyResults.js

@@ -1,36 +1,36 @@
-"use strict";
-/** @license
- * Copyright 2021 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.createCopyResults = void 0;
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Generates IAssociatedFileCopyResults object.
- *
- * @param fileInfo Info about item that was to be copied
- * @param fetchedFromSource Status of fetching item from source
- * @param copiedToDestination Status of copying item to destination
- * @returns IAssociatedFileCopyResults object
- */
-function createCopyResults(fileInfo, fetchedFromSource, copiedToDestination) {
-    return {
-        ...fileInfo,
-        fetchedFromSource,
-        copiedToDestination
-    };
-}
-exports.createCopyResults = createCopyResults;
+"use strict";
+/** @license
+ * Copyright 2021 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.createCopyResults = void 0;
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Generates IAssociatedFileCopyResults object.
+ *
+ * @param fileInfo Info about item that was to be copied
+ * @param fetchedFromSource Status of fetching item from source
+ * @param copiedToDestination Status of copying item to destination
+ * @returns IAssociatedFileCopyResults object
+ */
+function createCopyResults(fileInfo, fetchedFromSource, copiedToDestination) {
+    return {
+        ...fileInfo,
+        fetchedFromSource,
+        copiedToDestination
+    };
+}
+exports.createCopyResults = createCopyResults;
 //# sourceMappingURL=createCopyResults.js.map

package/dist/cjs/resources/get-blob.d.ts

@@ -1,26 +1,26 @@
-/** @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 "../interfaces";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-/**
- * Gets a Blob from a web site.
- *
- * @param url Address of Blob
- * @param authentication Credentials for the request
- * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
- * @returns Promise that will resolve with Blob or an AGO-style JSON failure response
- */
-export declare function getBlob(url: string, authentication: UserSession, requestOptions?: IRequestOptions): Promise<Blob>;
+/** @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 "../interfaces";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Gets a Blob from a web site.
+ *
+ * @param url Address of Blob
+ * @param authentication Credentials for the request
+ * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
+ * @returns Promise that will resolve with Blob or an AGO-style JSON failure response
+ */
+export declare function getBlob(url: string, authentication: UserSession, requestOptions?: IRequestOptions): Promise<Blob>;

package/dist/cjs/resources/get-blob.js

@@ -1,27 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBlob = void 0;
-const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
-/**
- * Gets a Blob from a web site.
- *
- * @param url Address of Blob
- * @param authentication Credentials for the request
- * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
- * @returns Promise that will resolve with Blob or an AGO-style JSON failure response
- */
-function getBlob(url, authentication, requestOptions = {}) {
-    if (!url) {
-        return Promise.reject("Url must be provided");
-    }
-    const blobRequestOptions = {
-        authentication: authentication,
-        rawResponse: true,
-        ...requestOptions
-    };
-    return (0, arcgis_rest_request_1.request)(url, blobRequestOptions).then(response => {
-        return response.blob();
-    });
-}
-exports.getBlob = getBlob;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBlob = void 0;
+const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
+/**
+ * Gets a Blob from a web site.
+ *
+ * @param url Address of Blob
+ * @param authentication Credentials for the request
+ * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
+ * @returns Promise that will resolve with Blob or an AGO-style JSON failure response
+ */
+function getBlob(url, authentication, requestOptions = {}) {
+    if (!url) {
+        return Promise.reject("Url must be provided");
+    }
+    const blobRequestOptions = {
+        authentication: authentication,
+        rawResponse: true,
+        ...requestOptions
+    };
+    return (0, arcgis_rest_request_1.request)(url, blobRequestOptions).then(response => {
+        return response.blob();
+    });
+}
+exports.getBlob = getBlob;
 //# sourceMappingURL=get-blob.js.map

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

@@ -1,24 +1,24 @@
-/** @license
- * Copyright 2021 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 { ISourceFile, ISourceFileCopyPath, UserSession } from "../interfaces";
-/**
- * Fetches a set of resources defined by paths.
- *
- * @param resourceItemFilePaths Paths to resources in source
- * @param authentication Credentials for the request to the source
- * @returns A promise which resolves with an array of resource files
- */
-export declare function getItemResourcesFilesFromPaths(resourceItemFilePaths: ISourceFileCopyPath[], authentication: UserSession): Promise<ISourceFile[]>;
+/** @license
+ * Copyright 2021 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 { ISourceFile, ISourceFileCopyPath, UserSession } from "../interfaces";
+/**
+ * Fetches a set of resources defined by paths.
+ *
+ * @param resourceItemFilePaths Paths to resources in source
+ * @param authentication Credentials for the request to the source
+ * @returns A promise which resolves with an array of resource files
+ */
+export declare function getItemResourcesFilesFromPaths(resourceItemFilePaths: ISourceFileCopyPath[], authentication: UserSession): Promise<ISourceFile[]>;

package/dist/cjs/resources/getItemResourcesFilesFromPaths.js

@@ -1,49 +1,49 @@
-"use strict";
-/** @license
- * Copyright 2021 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.getItemResourcesFilesFromPaths = void 0;
-const restHelpersGet_1 = require("../restHelpersGet");
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Fetches a set of resources defined by paths.
- *
- * @param resourceItemFilePaths Paths to resources in source
- * @param authentication Credentials for the request to the source
- * @returns A promise which resolves with an array of resource files
- */
-function getItemResourcesFilesFromPaths(resourceItemFilePaths, authentication) {
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    return Promise.all(resourceItemFilePaths.map(fileInfo => {
-        return new Promise(resolve => {
-            (0, restHelpersGet_1.getBlobAsFile)(fileInfo.url, fileInfo.filename, authentication).then(file => {
-                resolve({
-                    itemId: fileInfo.itemId,
-                    file,
-                    folder: fileInfo.folder,
-                    filename: fileInfo.filename
-                });
-            }, () => {
-                resolve(null);
-            });
-        });
-    })).then((files) => {
-        // Discard failures
-        return files.filter(file => !!file);
-    });
-}
-exports.getItemResourcesFilesFromPaths = getItemResourcesFilesFromPaths;
+"use strict";
+/** @license
+ * Copyright 2021 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.getItemResourcesFilesFromPaths = void 0;
+const restHelpersGet_1 = require("../restHelpersGet");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Fetches a set of resources defined by paths.
+ *
+ * @param resourceItemFilePaths Paths to resources in source
+ * @param authentication Credentials for the request to the source
+ * @returns A promise which resolves with an array of resource files
+ */
+function getItemResourcesFilesFromPaths(resourceItemFilePaths, authentication) {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    return Promise.all(resourceItemFilePaths.map(fileInfo => {
+        return new Promise(resolve => {
+            (0, restHelpersGet_1.getBlobAsFile)(fileInfo.url, fileInfo.filename, authentication).then(file => {
+                resolve({
+                    itemId: fileInfo.itemId,
+                    file,
+                    folder: fileInfo.folder,
+                    filename: fileInfo.filename
+                });
+            }, () => {
+                resolve(null);
+            });
+        });
+    })).then((files) => {
+        // Discard failures
+        return files.filter(file => !!file);
+    });
+}
+exports.getItemResourcesFilesFromPaths = getItemResourcesFilesFromPaths;
 //# sourceMappingURL=getItemResourcesFilesFromPaths.js.map

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

@@ -1,26 +1,26 @@
-/** @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 { IItemTemplate, ISourceFileCopyPath, UserSession } from "../interfaces";
-/**
- * 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
- */
-export declare function getItemResourcesPaths(itemTemplate: IItemTemplate, solutionItemId: string, authentication: UserSession, storageVersion?: number): Promise<ISourceFileCopyPath[]>;
+/** @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 { IItemTemplate, ISourceFileCopyPath, UserSession } from "../interfaces";
+/**
+ * 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
+ */
+export declare function getItemResourcesPaths(itemTemplate: IItemTemplate, solutionItemId: string, authentication: UserSession, storageVersion?: number): Promise<ISourceFileCopyPath[]>;