@esri/solution-common 6.1.3 → 6.1.5

package/dist/esm/resources/copyMetadataIntoItem.d.ts

@@ -0,0 +1,27 @@
+/** @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 { UserSession } from "../arcgisRestJS";
+import { IAssociatedFileCopyResults, IAssociatedFileInfo } from "../interfaces";
+/**
+ * Copies metadata into an AGO item.
+ *
+ * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
+ * @param sourceAuthentication Credentials for the request to the source
+ * @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
+ */
+export declare function copyMetadataIntoItem(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults>;

package/dist/esm/resources/copyMetadataIntoItem.js

@@ -0,0 +1,40 @@
+/** @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 { addMetadataFromBlob } from "./addMetadataFromBlob";
+import { createCopyResults } from "./createCopyResults";
+import { getBlob } from "./get-blob";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Copies metadata into an AGO item.
+ *
+ * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
+ * @param sourceAuthentication Credentials for the request to the source
+ * @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
+ */
+export function copyMetadataIntoItem(fileInfo, sourceAuthentication, destinationItemId, destinationAuthentication) {
+    return new Promise((resolve) => {
+        getBlob(fileInfo.url, sourceAuthentication).then((blob) => {
+            if (blob.type !== "text/xml" && blob.type !== "application/xml") {
+                resolve(createCopyResults(fileInfo, false)); // unable to get resource
+                return;
+            }
+            addMetadataFromBlob(blob, destinationItemId, destinationAuthentication).then(() => resolve(createCopyResults(fileInfo, true, true)), () => resolve(createCopyResults(fileInfo, true, false)));
+        }, () => resolve(createCopyResults(fileInfo, false)));
+    });
+}
+//# sourceMappingURL=copyMetadataIntoItem.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"copyMetadataIntoItem.js","sourceRoot":"","sources":["../../../src/resources/copyMetadataIntoItem.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,wHAAwH;AAExH;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAA6B,EAC7B,oBAAiC,EACjC,iBAAyB,EACzB,yBAAsC;IAEtC,OAAO,IAAI,OAAO,CAA6B,CAAC,OAAO,EAAE,EAAE;QACzD,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,IAAI,CAC9C,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBAC/D,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAA+B,CAAC,CAAC,CAAC,yBAAyB;gBACpG,OAAO;aACR;YACD,mBAAmB,CAAC,IAAI,EAAE,iBAAiB,EAAE,yBAAyB,CAAC,CAAC,IAAI,CAC1E,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAA+B,CAAC,EACpF,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAA+B,CAAC,CACtF,CAAC;QACJ,CAAC,EACD,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAA+B,CAAC,CAChF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/esm/resources/copyResourceIntoZip.d.ts

@@ -0,0 +1,34 @@
+/** @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 { UserSession } from "../arcgisRestJS";
+import { IAssociatedFileCopyResults, IAssociatedFileInfo, ISourceFile, IZipInfo } from "../interfaces";
+/**
+ * Copies a resource into a zipfile.
+ *
+ * @param file Information about the source and destination of the file such as its URL, folder, filename
+ * @param zipInfo Information about a zipfile such as its name and its zip object
+ * @returns The result of the copy
+ */
+export declare function copyResourceIntoZip(file: ISourceFile, zipInfo: IZipInfo): IAssociatedFileCopyResults;
+/**
+ * Copies a resource into a zipfile.
+ *
+ * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
+ * @param sourceAuthentication Credentials for the request to the source
+ * @param zipInfo Information about a zipfile such as its name and its zip object
+ * @returns A promise which resolves to the result of the copy
+ */
+export declare function copyResourceIntoZipFromInfo(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, zipInfo: IZipInfo): Promise<IAssociatedFileCopyResults>;

package/dist/esm/resources/copyResourceIntoZip.js

@@ -0,0 +1,69 @@
+/** @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 { createCopyResults } from "./createCopyResults";
+import { getBlobAsFile } from "../restHelpersGet";
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Copies a resource into a zipfile.
+ *
+ * @param file Information about the source and destination of the file such as its URL, folder, filename
+ * @param zipInfo Information about a zipfile such as its name and its zip object
+ * @returns The result of the copy
+ */
+export function copyResourceIntoZip(file, zipInfo) {
+    // Add it to the zip
+    if (file.folder) {
+        zipInfo.zip.folder(file.folder).file(file.filename, file.file, { binary: true });
+    }
+    else {
+        zipInfo.zip.file(file.filename, file.file, { binary: true });
+    }
+    zipInfo.filelist.push(file);
+    return createCopyResults(file, true);
+}
+/**
+ * Copies a resource into a zipfile.
+ *
+ * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
+ * @param sourceAuthentication Credentials for the request to the source
+ * @param zipInfo Information about a zipfile such as its name and its zip object
+ * @returns A promise which resolves to the result of the copy
+ */
+export function copyResourceIntoZipFromInfo(fileInfo, sourceAuthentication, zipInfo) {
+    return new Promise((resolve) => {
+        let filePromise;
+        if (fileInfo.file) {
+            filePromise = Promise.resolve(fileInfo.file);
+        }
+        else {
+            filePromise = getBlobAsFile(fileInfo.url, fileInfo.filename, sourceAuthentication);
+        }
+        filePromise.then((file) => {
+            // And add it to the zip
+            if (fileInfo.folder) {
+                zipInfo.zip.folder(fileInfo.folder).file(fileInfo.filename, file, { binary: true });
+            }
+            else {
+                zipInfo.zip.file(fileInfo.filename, file, { binary: true });
+            }
+            zipInfo.filelist.push(fileInfo);
+            resolve(createCopyResults(fileInfo, true));
+        }, () => resolve(
+        // unable to get resource
+        createCopyResults(fileInfo, false)));
+    });
+}
+//# sourceMappingURL=copyResourceIntoZip.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"copyResourceIntoZip.js","sourceRoot":"","sources":["../../../src/resources/copyResourceIntoZip.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,wHAAwH;AAExH;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAiB,EAAE,OAAiB;IACtE,oBAAoB;IACpB,IAAI,IAAI,CAAC,MAAM,EAAE;QACf,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAClF;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;KAC9D;IACD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAA+B,CAAC;AACrE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CACzC,QAA6B,EAC7B,oBAAiC,EACjC,OAAiB;IAEjB,OAAO,IAAI,OAAO,CAA6B,CAAC,OAAO,EAAE,EAAE;QACzD,IAAI,WAAyB,CAAC;QAC9B,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC9C;aAAM;YACL,WAAW,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;SACpF;QAED,WAAW,CAAC,IAAI,CACd,CAAC,IAAS,EAAE,EAAE;YACZ,wBAAwB;YACxB,IAAI,QAAQ,CAAC,MAAM,EAAE;gBACnB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;aACrF;iBAAM;gBACL,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;aAC7D;YACD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAA+B,CAAC,CAAC;QAC3E,CAAC,EACD,GAAG,EAAE,CACH,OAAO;QACL,yBAAyB;QACzB,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAA+B,CACjE,CACJ,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/esm/resources/copyZipIntoItem.d.ts

@@ -0,0 +1,26 @@
+/** @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 { IZipCopyResults, IZipInfo } from "../interfaces";
+import { UserSession } from "../arcgisRestJS";
+/**
+ * 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
+ */
+export declare function copyZipIntoItem(zipInfo: IZipInfo, destinationItemId: string, destinationAuthentication: UserSession): Promise<IZipCopyResults>;

package/dist/esm/resources/copyZipIntoItem.js

@@ -0,0 +1,49 @@
+/** @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 { addItemResource } from "../arcgisRestJS";
+import { blobToFile } from "../generalHelpers";
+import { createCopyResults } from "./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
+ */
+export function copyZipIntoItem(zipInfo, destinationItemId, destinationAuthentication) {
+    return new Promise((resolve) => {
+        zipInfo.zip
+            .generateAsync({ type: "blob" })
+            .then((content) => {
+            return blobToFile(content, zipInfo.filename, "application/zip");
+        })
+            .then((zipfile) => {
+            const addResourceOptions = {
+                id: destinationItemId,
+                resource: zipfile,
+                authentication: destinationAuthentication,
+                params: {
+                    archive: true,
+                },
+            };
+            return addItemResource(addResourceOptions);
+        })
+            .then(() => resolve(createCopyResults(zipInfo, true, true)), () => resolve(createCopyResults(zipInfo, true, false)));
+    });
+}
+//# sourceMappingURL=copyZipIntoItem.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"copyZipIntoItem.js","sourceRoot":"","sources":["../../../src/resources/copyZipIntoItem.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAwB,eAAe,EAAe,MAAM,iBAAiB,CAAC;AACrF,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,wHAAwH;AAExH;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAC7B,OAAiB,EACjB,iBAAyB,EACzB,yBAAsC;IAEtC,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,EAAE;QAC9C,OAAO,CAAC,GAAG;aACR,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAC/B,IAAI,CAAC,CAAC,OAAa,EAAE,EAAE;YACtB,OAAO,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;QAClE,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,OAAa,EAAE,EAAE;YACtB,MAAM,kBAAkB,GAAyB;gBAC/C,EAAE,EAAE,iBAAiB;gBACrB,QAAQ,EAAE,OAAO;gBACjB,cAAc,EAAE,yBAAyB;gBACzC,MAAM,EAAE;oBACN,OAAO,EAAE,IAAI;iBACd;aACF,CAAC;YACF,OAAO,eAAe,CAAC,kBAAkB,CAAC,CAAC;QAC7C,CAAC,CAAC;aACD,IAAI,CACH,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAoB,CAAC,EACxE,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAoB,CAAC,CAC1E,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +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;

package/dist/esm/resources/createCopyResults.js

@@ -0,0 +1,32 @@
+/** @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.
+ */
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * 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 function createCopyResults(fileInfo, fetchedFromSource, copiedToDestination) {
+    return {
+        ...fileInfo,
+        fetchedFromSource,
+        copiedToDestination,
+    };
+}
+//# sourceMappingURL=createCopyResults.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createCopyResults.js","sourceRoot":"","sources":["../../../src/resources/createCopyResults.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,wHAAwH;AAExH;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAa,EACb,iBAA0B,EAC1B,mBAA6B;IAE7B,OAAO;QACL,GAAG,QAAQ;QACX,iBAAiB;QACjB,mBAAmB;KACpB,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,25 @@
+/** @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 { IRequestOptions, UserSession } from "../arcgisRestJS";
+/**
+ * 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/esm/resources/get-blob.js

@@ -0,0 +1,38 @@
+/** @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 { request } from "../arcgisRestJS";
+/**
+ * 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 function getBlob(url, authentication, requestOptions = {}) {
+    if (!url) {
+        return Promise.reject("Url must be provided");
+    }
+    const blobRequestOptions = {
+        authentication: authentication,
+        rawResponse: true,
+        ...requestOptions,
+    };
+    return request(url, blobRequestOptions).then((response) => {
+        return response.blob();
+    });
+}
+//# sourceMappingURL=get-blob.js.map

package/dist/esm/resources/get-blob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-blob.js","sourceRoot":"","sources":["../../../src/resources/get-blob.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAmB,OAAO,EAAe,MAAM,iBAAiB,CAAC;AACxE;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,cAA2B,EAAE,iBAAkC,EAAE;IACpG,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;KAC/C;IAED,MAAM,kBAAkB,GAAG;QACzB,cAAc,EAAE,cAAc;QAC9B,WAAW,EAAE,IAAI;QACjB,GAAG,cAAc;KACC,CAAC;IAErB,OAAO,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACxD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +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 { UserSession } from "../arcgisRestJS";
+import { ISourceFile, ISourceFileCopyPath } 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/esm/resources/getItemResourcesFilesFromPaths.js

@@ -0,0 +1,45 @@
+/** @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 { getBlobAsFile } from "../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
+ */
+export function getItemResourcesFilesFromPaths(resourceItemFilePaths, authentication) {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    return Promise.all(resourceItemFilePaths.map((fileInfo) => {
+        return new Promise((resolve) => {
+            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);
+    });
+}
+//# sourceMappingURL=getItemResourcesFilesFromPaths.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getItemResourcesFilesFromPaths.js","sourceRoot":"","sources":["../../../src/resources/getItemResourcesFilesFromPaths.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,wHAAwH;AAExH;;;;;;GAMG;AACH,MAAM,UAAU,8BAA8B,CAC5C,qBAA4C,EAC5C,cAA2B;IAE3B,mEAAmE;IACnE,OAAO,OAAO,CAAC,GAAG,CAChB,qBAAqB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrC,OAAO,IAAI,OAAO,CAAc,CAAC,OAAO,EAAE,EAAE;YAC1C,aAAa,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,IAAI,CACjE,CAAC,IAAI,EAAE,EAAE;gBACP,OAAO,CAAC;oBACN,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,IAAI;oBACJ,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;iBACb,CAAC,CAAC;YACpB,CAAC,EACD,GAAG,EAAE;gBACH,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,KAAoB,EAAE,EAAE;QAC9B,mBAAmB;QACnB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,27 @@
+/** @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 { UserSession } from "../arcgisRestJS";
+import { IItemTemplate, ISourceFileCopyPath } 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[]>;

package/dist/esm/resources/getItemResourcesPaths.js

@@ -0,0 +1,76 @@
+/** @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 { getItemResources } from "../restHelpersGet";
+import { generateSourceFilePaths } from "../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
+ */
+export function getItemResourcesPaths(itemTemplate, solutionItemId, authentication, storageVersion = 0) {
+    // get the resources for the item
+    return 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;
+                }
+                if (res === "published_data.json") {
+                    result = false;
+                }
+            }
+            // Web Experiences
+            if (itemTemplate.type === "Web Experience") {
+                if (res === "config/config.json") {
+                    result = false;
+                }
+            }
+            // GP Services
+            if (itemTemplate.type === "Geoprocessing Service") {
+                return res.indexOf("webtool") > -1;
+            }
+            return result;
+        });
+        // create the filePaths
+        const resourceItemFilePaths = generateSourceFilePaths(authentication.portal, itemTemplate.itemId, itemTemplate.item.thumbnail, itemResources, itemTemplate.type === "Group", storageVersion);
+        return Promise.resolve(resourceItemFilePaths);
+    });
+}
+//# sourceMappingURL=getItemResourcesPaths.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getItemResourcesPaths.js","sourceRoot":"","sources":["../../../src/resources/getItemResourcesPaths.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAG7D,wHAAwH;AAExH;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CACnC,YAA2B,EAC3B,cAAsB,EACtB,cAA2B,EAC3B,cAAc,GAAG,CAAC;IAElB,iCAAiC;IACjC,OAAO,gBAAgB,CAAC,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE;QACrF,sDAAsD;QACtD,sCAAsC;QACtC,MAAM,aAAa,GAAG,gBAAgB,CAAC,SAAS;aAC7C,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aAC3B,MAAM,CAAC,CAAC,GAAQ,EAAE,EAAE;YACnB,IAAI,MAAM,GAAG,IAAI,CAAC;YAClB,mFAAmF;YACnF,2EAA2E;YAC3E,0EAA0E;YAC1E,iCAAiC;YAEjC,YAAY;YACZ,IAAI,YAAY,CAAC,IAAI,KAAK,sBAAsB,EAAE;gBAChD,IAAI,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE;oBACnC,MAAM,GAAG,KAAK,CAAC;iBAChB;aACF;YAED,YAAY;YACZ,IAAI,YAAY,CAAC,IAAI,KAAK,UAAU,EAAE;gBACpC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;oBACrD,MAAM,GAAG,KAAK,CAAC;iBAChB;gBACD,IAAI,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE;oBACrC,MAAM,GAAG,KAAK,CAAC;iBAChB;gBACD,IAAI,GAAG,KAAK,qBAAqB,EAAE;oBACjC,MAAM,GAAG,KAAK,CAAC;iBAChB;aACF;YAED,kBAAkB;YAClB,IAAI,YAAY,CAAC,IAAI,KAAK,gBAAgB,EAAE;gBAC1C,IAAI,GAAG,KAAK,oBAAoB,EAAE;oBAChC,MAAM,GAAG,KAAK,CAAC;iBAChB;aACF;YAED,cAAc;YACd,IAAI,YAAY,CAAC,IAAI,KAAK,uBAAuB,EAAE;gBACjD,OAAO,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;aACpC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACL,uBAAuB;QACvB,MAAM,qBAAqB,GAA0B,uBAAuB,CAC1E,cAAc,CAAC,MAAM,EACrB,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,IAAI,CAAC,SAAS,EAC3B,aAAa,EACb,YAAY,CAAC,IAAI,KAAK,OAAO,EAC7B,cAAc,CACf,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,30 @@
+/** @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 "./add-resource";
+export * from "./addMetadataFromBlob";
+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";
+export * from "./update-resource";

package/dist/esm/resources/index.js

@@ -0,0 +1,31 @@
+/** @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 "./add-resource";
+export * from "./addMetadataFromBlob";
+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";
+export * from "./update-resource";
+//# sourceMappingURL=index.js.map