@aws-amplify/storage 6.0.28 → 6.0.29-gen2-storage.e54bfa9.0

package/dist/esm/providers/s3/apis/server/getUrl.d.ts

@@ -1,3 +1,41 @@
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { GetUrlInput, GetUrlOutput } from '../../types';
-export declare const getUrl: (contextSpec: AmplifyServer.ContextSpec, input: GetUrlInput) => Promise<GetUrlOutput>;
+import { GetUrlInput, GetUrlOutput, GetUrlWithPathInput, GetUrlWithPathOutput } from '../../types';
+/**
+ * Get a temporary presigned URL to download the specified S3 object.
+ * The presigned URL expires when the associated role used to sign the request expires or
+ * the option  `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.
+ *
+ * By default, it will not validate the object that exists in S3. If you set the `options.validateObjectExistence`
+ * to true, this method will verify the given object already exists in S3 before returning a presigned
+ * URL, and will throw `StorageError` if the object does not exist.
+ *
+ * @param contextSpec - The isolated server context.
+ * @param input - The `GetUrlWithPathInput` object.
+ * @returns Presigned URL and timestamp when the URL may expire.
+ * @throws service: `S3Exception` - thrown when checking for existence of the object
+ * @throws validation: `StorageValidationErrorCode` - Validation errors
+ * thrown either username or key are not defined.
+ *
+ */
+export declare function getUrl(contextSpec: AmplifyServer.ContextSpec, input: GetUrlWithPathInput): Promise<GetUrlWithPathOutput>;
+/**
+ * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
+ * Please use {@link https://docs.amplify.aws/javascript/build-a-backend/storage/download/#generate-a-download-url | path} instead.
+ *
+ * Get a temporary presigned URL to download the specified S3 object.
+ * The presigned URL expires when the associated role used to sign the request expires or
+ * the option  `expiresIn` is reached. The `expiresAt` property in the output object indicates when the URL MAY expire.
+ *
+ * By default, it will not validate the object that exists in S3. If you set the `options.validateObjectExistence`
+ * to true, this method will verify the given object already exists in S3 before returning a presigned
+ * URL, and will throw `StorageError` if the object does not exist.
+ *
+ * @param contextSpec - The isolated server context.
+ * @param input - The `GetUrlInput` object.
+ * @returns Presigned URL and timestamp when the URL may expire.
+ * @throws service: `S3Exception` - thrown when checking for existence of the object
+ * @throws validation: `StorageValidationErrorCode` - Validation errors
+ * thrown either username or key are not defined.
+ *
+ */
+export declare function getUrl(contextSpec: AmplifyServer.ContextSpec, input: GetUrlInput): Promise<GetUrlOutput>;

package/dist/esm/providers/s3/apis/server/getUrl.mjs

@@ -3,9 +3,9 @@ import { getUrl as getUrl$1 } from '../internal/getUrl.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const getUrl = async (contextSpec, input) => {
+function getUrl(contextSpec, input) {
     return getUrl$1(getAmplifyServerContext(contextSpec).amplify, input);
-};
+}
 
 export { getUrl };
 //# sourceMappingURL=getUrl.mjs.map

package/dist/esm/providers/s3/apis/server/getUrl.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"getUrl.mjs","sources":["../../../../../../src/providers/s3/apis/server/getUrl.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { getUrl as getUrlInternal } from '../internal/getUrl';\nexport const getUrl = async (contextSpec, input) => {\n    return getUrlInternal(getAmplifyServerContext(contextSpec).amplify, input);\n};\n"],"names":["getUrlInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,MAAM,GAAG,OAAO,WAAW,EAAE,KAAK,KAAK;AACpD,IAAI,OAAOA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC/E;;;;"}
+{"version":3,"file":"getUrl.mjs","sources":["../../../../../../src/providers/s3/apis/server/getUrl.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { getUrl as getUrlInternal } from '../internal/getUrl';\nexport function getUrl(contextSpec, input) {\n    return getUrlInternal(getAmplifyServerContext(contextSpec).amplify, input);\n}\n"],"names":["getUrlInternal"],"mappings":";;;AAAA;AACA;AAGO,SAAS,MAAM,CAAC,WAAW,EAAE,KAAK,EAAE;AAC3C,IAAI,OAAOA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC/E;;;;"}

package/dist/esm/providers/s3/apis/server/list.d.ts

@@ -1,23 +1,42 @@
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { ListAllInput, ListAllOutput, ListPaginateInput, ListPaginateOutput } from '../../types';
-interface ListApi {
-    /**
-     * Lists bucket objects with pagination.
-     * @param {ListPaginateInput} input The input object
-     * @return {Promise<ListPaginateOutput>} - Promise resolves to list of keys and metadata with
-     * pageSize defaulting to 1000. Additionally the result will include a nextToken if there are more items to retrieve
-     * @throws service: {@link S3Exception} - S3 service errors thrown when checking for existence of bucket
-     * @throws validation: {@link StorageValidationErrorCode } - thrown when there are issues with credentials
-     */
-    (contextSpec: AmplifyServer.ContextSpec, input?: ListPaginateInput): Promise<ListPaginateOutput>;
-    /**
-     * Lists all bucket objects.
-     * @param {ListAllInput} input The input object
-     * @return {Promise<ListAllOutput>} - Promise resolves to list of keys and metadata for all objects in path
-     * @throws service: {@link S3Exception} - S3 service errors thrown when checking for existence of bucket
-     * @throws validation: {@link StorageValidationErrorCode } - thrown when there are issues with credentials
-     */
-    (contextSpec: AmplifyServer.ContextSpec, input?: ListAllInput): Promise<ListAllOutput>;
-}
-export declare const list: ListApi;
-export {};
+import { ListAllInput, ListAllOutput, ListAllWithPathInput, ListAllWithPathOutput, ListPaginateInput, ListPaginateOutput, ListPaginateWithPathInput, ListPaginateWithPathOutput } from '../../types';
+/**
+ * List files in pages with the given `path`.
+ * `pageSize` is defaulted to 1000. Additionally, the result will include a `nextToken` if there are more items to retrieve.
+ * @param input - The `ListPaginateWithPathInput` object.
+ * @param contextSpec - The context spec used to get the Amplify server context.
+ * @returns A list of objects with path and metadata
+ * @throws service: `S3Exception` - S3 service errors thrown when checking for existence of bucket
+ * @throws validation: `StorageValidationErrorCode` - thrown when there are issues with credentials
+ */
+export declare function list(contextSpec: AmplifyServer.ContextSpec, input: ListPaginateWithPathInput): Promise<ListPaginateWithPathOutput>;
+/**
+ * List all files from S3 for a given `path`. You can set `listAll` to true in `options` to get all the files from S3.
+ * @param input - The `ListAllWithPathInput` object.
+ * @param contextSpec - The context spec used to get the Amplify server context.
+ * @returns A list of all objects with path and metadata
+ * @throws service: `S3Exception` - S3 service errors thrown when checking for existence of bucket
+ * @throws validation: `StorageValidationErrorCode`  - thrown when there are issues with credentials
+ */
+export declare function list(contextSpec: AmplifyServer.ContextSpec, input: ListAllWithPathInput): Promise<ListAllWithPathOutput>;
+/**
+ * @deprecated The `prefix` and `accessLevel` parameters are deprecated and may be removed in the next major version.
+ * Please use {@link https://docs.amplify.aws/react/build-a-backend/storage/list | path} instead.
+ * List files in pages with the given `prefix`.
+ * `pageSize` is defaulted to 1000. Additionally, the result will include a `nextToken` if there are more items to retrieve.
+ * @param input - The `ListPaginateInput` object.
+ * @returns A list of objects with key and metadata
+ * @throws service: `S3Exception` - S3 service errors thrown when checking for existence of bucket
+ * @throws validation: `StorageValidationErrorCode` - thrown when there are issues with credentials
+ */
+export declare function list(contextSpec: AmplifyServer.ContextSpec, input?: ListPaginateInput): Promise<ListPaginateOutput>;
+/**
+ * @deprecated The `prefix` and `accessLevel` parameters are deprecated and may be removed in the next major version.
+ * Please use {@link https://docs.amplify.aws/react/build-a-backend/storage/list | path} instead.
+ * List all files from S3 for a given `prefix`. You can set `listAll` to true in `options` to get all the files from S3.
+ * @param input - The `ListAllInput` object.
+ * @returns A list of all objects with key and metadata
+ * @throws service: `S3Exception` - S3 service errors thrown when checking for existence of bucket
+ * @throws validation: `StorageValidationErrorCode`  - thrown when there are issues with credentials
+ */
+export declare function list(contextSpec: AmplifyServer.ContextSpec, input?: ListAllInput): Promise<ListAllOutput>;

package/dist/esm/providers/s3/apis/server/list.mjs

@@ -3,9 +3,9 @@ import { list as list$1 } from '../internal/list.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const list = (contextSpec, input) => {
+function list(contextSpec, input) {
     return list$1(getAmplifyServerContext(contextSpec).amplify, input ?? {});
-};
+}
 
 export { list };
 //# sourceMappingURL=list.mjs.map

package/dist/esm/providers/s3/apis/server/list.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"list.mjs","sources":["../../../../../../src/providers/s3/apis/server/list.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { list as listInternal } from '../internal/list';\nexport const list = (contextSpec, input) => {\n    return listInternal(getAmplifyServerContext(contextSpec).amplify, input ?? {});\n};\n"],"names":["listInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,KAAK;AAC5C,IAAI,OAAOA,MAAY,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;AACnF;;;;"}
+{"version":3,"file":"list.mjs","sources":["../../../../../../src/providers/s3/apis/server/list.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { list as listInternal } from '../internal/list';\nexport function list(contextSpec, input) {\n    return listInternal(getAmplifyServerContext(contextSpec).amplify, input ?? {});\n}\n"],"names":["listInternal"],"mappings":";;;AAAA;AACA;AAGO,SAAS,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE;AACzC,IAAI,OAAOA,MAAY,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;AACnF;;;;"}

package/dist/esm/providers/s3/apis/server/remove.d.ts

@@ -1,3 +1,25 @@
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-import { RemoveInput, RemoveOutput } from '../../types';
-export declare const remove: (contextSpec: AmplifyServer.ContextSpec, input: RemoveInput) => Promise<RemoveOutput>;
+import { RemoveInput, RemoveOutput, RemoveWithPathInput, RemoveWithPathOutput } from '../../types';
+/**
+ * Remove a file from your S3 bucket.
+ * @param input - The `RemoveWithPathInput` object.
+ * @param contextSpec - The context spec used to get the Amplify server context.
+ * @return Output containing the removed object path.
+ * @throws service: `S3Exception` - S3 service errors thrown while while removing the object.
+ * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
+ * when there is no path or path is empty or path has a leading slash.
+ */
+export declare function remove(contextSpec: AmplifyServer.ContextSpec, input: RemoveWithPathInput): Promise<RemoveWithPathOutput>;
+/**
+ * @deprecated The `key` and `accessLevel` parameters are deprecated and may be removed in the next major version.
+ * Please use {@link https://docs.amplify.aws/react/build-a-backend/storage/remove | path} instead.
+ *
+ * Remove a file from your S3 bucket.
+ * @param input - The `RemoveInput` object.
+ * @param contextSpec - The context spec used to get the Amplify server context.
+ * @return Output containing the removed object key
+ * @throws service: `S3Exception` - S3 service errors thrown while while removing the object
+ * @throws validation: `StorageValidationErrorCode` - Validation errors thrown
+ * when there is no key or its empty.
+ */
+export declare function remove(contextSpec: AmplifyServer.ContextSpec, input: RemoveInput): Promise<RemoveOutput>;

package/dist/esm/providers/s3/apis/server/remove.mjs

@@ -3,9 +3,9 @@ import { remove as remove$1 } from '../internal/remove.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const remove = (contextSpec, input) => {
+function remove(contextSpec, input) {
     return remove$1(getAmplifyServerContext(contextSpec).amplify, input);
-};
+}
 
 export { remove };
 //# sourceMappingURL=remove.mjs.map

package/dist/esm/providers/s3/apis/server/remove.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"remove.mjs","sources":["../../../../../../src/providers/s3/apis/server/remove.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { remove as removeInternal } from '../internal/remove';\nexport const remove = (contextSpec, input) => {\n    return removeInternal(getAmplifyServerContext(contextSpec).amplify, input);\n};\n"],"names":["removeInternal"],"mappings":";;;AAAA;AACA;AAGY,MAAC,MAAM,GAAG,CAAC,WAAW,EAAE,KAAK,KAAK;AAC9C,IAAI,OAAOA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC/E;;;;"}
+{"version":3,"file":"remove.mjs","sources":["../../../../../../src/providers/s3/apis/server/remove.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { getAmplifyServerContext, } from '@aws-amplify/core/internals/adapter-core';\nimport { remove as removeInternal } from '../internal/remove';\nexport function remove(contextSpec, input) {\n    return removeInternal(getAmplifyServerContext(contextSpec).amplify, input);\n}\n"],"names":["removeInternal"],"mappings":";;;AAAA;AACA;AAGO,SAAS,MAAM,CAAC,WAAW,EAAE,KAAK,EAAE;AAC3C,IAAI,OAAOA,QAAc,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAC/E;;;;"}

package/dist/esm/providers/s3/apis/uploadData/index.d.ts

@@ -1,17 +1,73 @@
-import { UploadDataInput, UploadDataOutput } from '../../types';
+import { UploadDataInput, UploadDataOutput, UploadDataWithPathInput, UploadDataWithPathOutput } from '../../types';
 /**
- * Upload data to specified S3 object. By default, it uses single PUT operation to upload if the data is less than 5MB.
- * Otherwise, it uses multipart upload to upload the data. If the data length is unknown, it uses multipart upload.
+ * Upload data to the specified S3 object path. By default uses single PUT operation to upload if the payload is less than 5MB.
+ * Otherwise, uses multipart upload to upload the payload. If the payload length cannot be determined, uses multipart upload.
  *
  * Limitations:
  * * Maximum object size is 5TB.
  * * Maximum object size if the size cannot be determined before upload is 50GB.
  *
- * @param input - The UploadDataInput object.
+ * @throws Service: `S3Exception` thrown when checking for existence of the object.
+ * @throws Validation: `StorageValidationErrorCode` thrown when a validation error occurs.
+ *
+ * @param input - A `UploadDataWithPathInput` object.
+ *
  * @returns A cancelable and resumable task exposing result promise from `result`
  * 	property.
- * @throws service: {@link S3Exception} - thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Validation errors.
+ *
+ * @example
+ * ```ts
+ * // Upload a file to s3 bucket
+ * await uploadData({ path, data: file, options: {
+ *   onProgress, // Optional progress callback.
+ * } }).result;
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Cancel a task
+ * const uploadTask = uploadData({ path, data: file });
+ * //...
+ * uploadTask.cancel();
+ * try {
+ *   await uploadTask.result;
+ * } catch (error) {
+ *   if(isCancelError(error)) {
+ *     // Handle error thrown by task cancelation.
+ *   }
+ * }
+ *```
+ *
+ * @example
+ * ```ts
+ * // Pause and resume a task
+ * const uploadTask = uploadData({ path, data: file });
+ * //...
+ * uploadTask.pause();
+ * //...
+ * uploadTask.resume();
+ * //...
+ * await uploadTask.result;
+ * ```
+ */
+export declare function uploadData(input: UploadDataWithPathInput): UploadDataWithPathOutput;
+/**
+ * Upload data to the specified S3 object key. By default uses single PUT operation to upload if the payload is less than 5MB.
+ * Otherwise, uses multipart upload to upload the payload. If the payload length cannot be determined, uses multipart upload.
+ *
+ * Limitations:
+ * * Maximum object size is 5TB.
+ * * Maximum object size if the size cannot be determined before upload is 50GB.
+ *
+ * @deprecated The `key` and `accessLevel` parameters are deprecated and will be removed in next major version.
+ * Please use {@link https://docs.amplify.aws/javascript/build-a-backend/storage/upload/#uploaddata | path} instead.
+ *
+ * @throws Service: `S3Exception` thrown when checking for existence of the object.
+ * @throws Validation: `StorageValidationErrorCode` thrown when a validation error occurs.
+ *
+ * @param input - A `UploadDataInput` object.
+ *
+ * @returns A cancelable and resumable task exposing result promise from the `result` property.
  *
  * @example
  * ```ts
@@ -20,6 +76,7 @@ import { UploadDataInput, UploadDataOutput } from '../../types';
  *   onProgress, // Optional progress callback.
  * } }).result;
  * ```
+ *
  * @example
  * ```ts
  * // Cancel a task
@@ -47,4 +104,4 @@ import { UploadDataInput, UploadDataOutput } from '../../types';
  * await uploadTask.result;
  * ```
  */
-export declare const uploadData: (input: UploadDataInput) => UploadDataOutput;
+export declare function uploadData(input: UploadDataInput): UploadDataOutput;

package/dist/esm/providers/s3/apis/uploadData/index.mjs

@@ -15,59 +15,12 @@ import { getMultipartUploadHandlers } from './multipart/uploadHandlers.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-/**
- * Upload data to specified S3 object. By default, it uses single PUT operation to upload if the data is less than 5MB.
- * Otherwise, it uses multipart upload to upload the data. If the data length is unknown, it uses multipart upload.
- *
- * Limitations:
- * * Maximum object size is 5TB.
- * * Maximum object size if the size cannot be determined before upload is 50GB.
- *
- * @param input - The UploadDataInput object.
- * @returns A cancelable and resumable task exposing result promise from `result`
- * 	property.
- * @throws service: {@link S3Exception} - thrown when checking for existence of the object
- * @throws validation: {@link StorageValidationErrorCode } - Validation errors.
- *
- * @example
- * ```ts
- * // Upload a file to s3 bucket
- * await uploadData({ key, data: file, options: {
- *   onProgress, // Optional progress callback.
- * } }).result;
- * ```
- * @example
- * ```ts
- * // Cancel a task
- * const uploadTask = uploadData({ key, data: file });
- * //...
- * uploadTask.cancel();
- * try {
- *   await uploadTask.result;
- * } catch (error) {
- *   if(isCancelError(error)) {
- *     // Handle error thrown by task cancelation.
- *   }
- * }
- *```
- *
- * @example
- * ```ts
- * // Pause and resume a task
- * const uploadTask = uploadData({ key, data: file });
- * //...
- * uploadTask.pause();
- * //...
- * uploadTask.resume();
- * //...
- * await uploadTask.result;
- * ```
- */
-const uploadData = (input) => {
+function uploadData(input) {
     const { data } = input;
     const dataByteLength = byteLength(data);
     assertValidationError(dataByteLength === undefined || dataByteLength <= MAX_OBJECT_SIZE, StorageValidationErrorCode.ObjectIsTooLarge);
     if (dataByteLength && dataByteLength <= DEFAULT_PART_SIZE) {
+        // Single part upload
         const abortController = new AbortController();
         return createUploadTask({
             isMultipartUpload: false,
@@ -78,6 +31,7 @@ const uploadData = (input) => {
         });
     }
     else {
+        // Multipart upload
         const { multipartUploadJob, onPause, onResume, onCancel } = getMultipartUploadHandlers(input, dataByteLength);
         return createUploadTask({
             isMultipartUpload: true,
@@ -89,7 +43,7 @@ const uploadData = (input) => {
             onResume,
         });
     }
-};
+}
 
 export { uploadData };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/providers/s3/apis/uploadData/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../../../../../../src/providers/s3/apis/uploadData/index.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { createUploadTask } from '../../utils';\nimport { assertValidationError } from '../../../../errors/utils/assertValidationError';\nimport { StorageValidationErrorCode } from '../../../../errors/types/validation';\nimport { DEFAULT_PART_SIZE, MAX_OBJECT_SIZE } from '../../utils/constants';\nimport { byteLength } from './byteLength';\nimport { putObjectJob } from './putObjectJob';\nimport { getMultipartUploadHandlers } from './multipart';\n/**\n * Upload data to specified S3 object. By default, it uses single PUT operation to upload if the data is less than 5MB.\n * Otherwise, it uses multipart upload to upload the data. If the data length is unknown, it uses multipart upload.\n *\n * Limitations:\n * * Maximum object size is 5TB.\n * * Maximum object size if the size cannot be determined before upload is 50GB.\n *\n * @param input - The UploadDataInput object.\n * @returns A cancelable and resumable task exposing result promise from `result`\n * \tproperty.\n * @throws service: {@link S3Exception} - thrown when checking for existence of the object\n * @throws validation: {@link StorageValidationErrorCode } - Validation errors.\n *\n * @example\n * ```ts\n * // Upload a file to s3 bucket\n * await uploadData({ key, data: file, options: {\n *   onProgress, // Optional progress callback.\n * } }).result;\n * ```\n * @example\n * ```ts\n * // Cancel a task\n * const uploadTask = uploadData({ key, data: file });\n * //...\n * uploadTask.cancel();\n * try {\n *   await uploadTask.result;\n * } catch (error) {\n *   if(isCancelError(error)) {\n *     // Handle error thrown by task cancelation.\n *   }\n * }\n *```\n *\n * @example\n * ```ts\n * // Pause and resume a task\n * const uploadTask = uploadData({ key, data: file });\n * //...\n * uploadTask.pause();\n * //...\n * uploadTask.resume();\n * //...\n * await uploadTask.result;\n * ```\n */\nexport const uploadData = (input) => {\n    const { data } = input;\n    const dataByteLength = byteLength(data);\n    assertValidationError(dataByteLength === undefined || dataByteLength <= MAX_OBJECT_SIZE, StorageValidationErrorCode.ObjectIsTooLarge);\n    if (dataByteLength && dataByteLength <= DEFAULT_PART_SIZE) {\n        const abortController = new AbortController();\n        return createUploadTask({\n            isMultipartUpload: false,\n            job: putObjectJob(input, abortController.signal, dataByteLength),\n            onCancel: (message) => {\n                abortController.abort(message);\n            },\n        });\n    }\n    else {\n        const { multipartUploadJob, onPause, onResume, onCancel } = getMultipartUploadHandlers(input, dataByteLength);\n        return createUploadTask({\n            isMultipartUpload: true,\n            job: multipartUploadJob,\n            onCancel: (message) => {\n                onCancel(message);\n            },\n            onPause,\n            onResume,\n        });\n    }\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;AACA;AAQA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,UAAU,GAAG,CAAC,KAAK,KAAK;AACrC,IAAI,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;AAC3B,IAAI,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;AAC5C,IAAI,qBAAqB,CAAC,cAAc,KAAK,SAAS,IAAI,cAAc,IAAI,eAAe,EAAE,0BAA0B,CAAC,gBAAgB,CAAC,CAAC;AAC1I,IAAI,IAAI,cAAc,IAAI,cAAc,IAAI,iBAAiB,EAAE;AAC/D,QAAQ,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AACtD,QAAQ,OAAO,gBAAgB,CAAC;AAChC,YAAY,iBAAiB,EAAE,KAAK;AACpC,YAAY,GAAG,EAAE,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC;AAC5E,YAAY,QAAQ,EAAE,CAAC,OAAO,KAAK;AACnC,gBAAgB,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC/C,aAAa;AACb,SAAS,CAAC,CAAC;AACX,KAAK;AACL,SAAS;AACT,QAAQ,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,0BAA0B,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;AACtH,QAAQ,OAAO,gBAAgB,CAAC;AAChC,YAAY,iBAAiB,EAAE,IAAI;AACnC,YAAY,GAAG,EAAE,kBAAkB;AACnC,YAAY,QAAQ,EAAE,CAAC,OAAO,KAAK;AACnC,gBAAgB,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClC,aAAa;AACb,YAAY,OAAO;AACnB,YAAY,QAAQ;AACpB,SAAS,CAAC,CAAC;AACX,KAAK;AACL;;;;"}
+{"version":3,"file":"index.mjs","sources":["../../../../../../src/providers/s3/apis/uploadData/index.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { createUploadTask } from '../../utils';\nimport { assertValidationError } from '../../../../errors/utils/assertValidationError';\nimport { StorageValidationErrorCode } from '../../../../errors/types/validation';\nimport { DEFAULT_PART_SIZE, MAX_OBJECT_SIZE } from '../../utils/constants';\nimport { byteLength } from './byteLength';\nimport { putObjectJob } from './putObjectJob';\nimport { getMultipartUploadHandlers } from './multipart';\nexport function uploadData(input) {\n    const { data } = input;\n    const dataByteLength = byteLength(data);\n    assertValidationError(dataByteLength === undefined || dataByteLength <= MAX_OBJECT_SIZE, StorageValidationErrorCode.ObjectIsTooLarge);\n    if (dataByteLength && dataByteLength <= DEFAULT_PART_SIZE) {\n        // Single part upload\n        const abortController = new AbortController();\n        return createUploadTask({\n            isMultipartUpload: false,\n            job: putObjectJob(input, abortController.signal, dataByteLength),\n            onCancel: (message) => {\n                abortController.abort(message);\n            },\n        });\n    }\n    else {\n        // Multipart upload\n        const { multipartUploadJob, onPause, onResume, onCancel } = getMultipartUploadHandlers(input, dataByteLength);\n        return createUploadTask({\n            isMultipartUpload: true,\n            job: multipartUploadJob,\n            onCancel: (message) => {\n                onCancel(message);\n            },\n            onPause,\n            onResume,\n        });\n    }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;AACA;AAQO,SAAS,UAAU,CAAC,KAAK,EAAE;AAClC,IAAI,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;AAC3B,IAAI,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;AAC5C,IAAI,qBAAqB,CAAC,cAAc,KAAK,SAAS,IAAI,cAAc,IAAI,eAAe,EAAE,0BAA0B,CAAC,gBAAgB,CAAC,CAAC;AAC1I,IAAI,IAAI,cAAc,IAAI,cAAc,IAAI,iBAAiB,EAAE;AAC/D;AACA,QAAQ,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AACtD,QAAQ,OAAO,gBAAgB,CAAC;AAChC,YAAY,iBAAiB,EAAE,KAAK;AACpC,YAAY,GAAG,EAAE,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC;AAC5E,YAAY,QAAQ,EAAE,CAAC,OAAO,KAAK;AACnC,gBAAgB,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC/C,aAAa;AACb,SAAS,CAAC,CAAC;AACX,KAAK;AACL,SAAS;AACT;AACA,QAAQ,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,0BAA0B,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;AACtH,QAAQ,OAAO,gBAAgB,CAAC;AAChC,YAAY,iBAAiB,EAAE,IAAI;AACnC,YAAY,GAAG,EAAE,kBAAkB;AACnC,YAAY,QAAQ,EAAE,CAAC,OAAO,KAAK;AACnC,gBAAgB,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClC,aAAa;AACb,YAAY,OAAO;AACnB,YAAY,QAAQ;AACpB,SAAS,CAAC,CAAC;AACX,KAAK;AACL;;;;"}

package/dist/esm/providers/s3/apis/uploadData/multipart/initialUpload.d.ts

@@ -6,8 +6,8 @@ interface LoadOrCreateMultipartUploadOptions {
     s3Config: ResolvedS3Config;
     data: StorageUploadDataPayload;
     bucket: string;
-    accessLevel: StorageAccessLevel;
-    keyPrefix: string;
+    accessLevel?: StorageAccessLevel;
+    keyPrefix?: string;
     key: string;
     contentType?: string;
     contentDisposition?: string;

package/dist/esm/providers/s3/apis/uploadData/multipart/initialUpload.mjs

@@ -24,7 +24,7 @@ import { getUploadsCacheKey, findCachedUploadParts, cacheMultipartUpload } from
  * @internal
  */
 const loadOrCreateMultipartUpload = async ({ s3Config, data, size, contentType, bucket, accessLevel, keyPrefix, key, contentDisposition, contentEncoding, metadata, abortSignal, }) => {
-    const finalKey = keyPrefix + key;
+    const finalKey = keyPrefix !== undefined ? keyPrefix + key : key;
     let cachedUpload;
     if (size === undefined) {
         logger.debug('uploaded data size cannot be determined, skipping cache.');

package/dist/esm/providers/s3/apis/uploadData/multipart/initialUpload.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"initialUpload.mjs","sources":["../../../../../../../src/providers/s3/apis/uploadData/multipart/initialUpload.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { createMultipartUpload } from '../../../utils/client';\nimport { logger } from '../../../../../utils';\nimport { cacheMultipartUpload, findCachedUploadParts, getUploadsCacheKey, } from './uploadCache';\n/**\n * Load the in-progress multipart upload from local storage or async storage(RN) if it exists, or create a new multipart\n * upload.\n *\n * @internal\n */\nexport const loadOrCreateMultipartUpload = async ({ s3Config, data, size, contentType, bucket, accessLevel, keyPrefix, key, contentDisposition, contentEncoding, metadata, abortSignal, }) => {\n    const finalKey = keyPrefix + key;\n    let cachedUpload;\n    if (size === undefined) {\n        logger.debug('uploaded data size cannot be determined, skipping cache.');\n        cachedUpload = undefined;\n    }\n    else {\n        const uploadCacheKey = getUploadsCacheKey({\n            size,\n            contentType,\n            file: data instanceof File ? data : undefined,\n            bucket,\n            accessLevel,\n            key,\n        });\n        const cachedUploadParts = await findCachedUploadParts({\n            s3Config,\n            cacheKey: uploadCacheKey,\n            bucket,\n            finalKey,\n        });\n        cachedUpload = cachedUploadParts\n            ? { ...cachedUploadParts, uploadCacheKey }\n            : undefined;\n    }\n    if (cachedUpload) {\n        return {\n            uploadId: cachedUpload.uploadId,\n            cachedParts: cachedUpload.parts,\n        };\n    }\n    else {\n        const { UploadId } = await createMultipartUpload({\n            ...s3Config,\n            abortSignal,\n        }, {\n            Bucket: bucket,\n            Key: finalKey,\n            ContentType: contentType,\n            ContentDisposition: contentDisposition,\n            ContentEncoding: contentEncoding,\n            Metadata: metadata,\n        });\n        if (size === undefined) {\n            logger.debug('uploaded data size cannot be determined, skipping cache.');\n            return {\n                uploadId: UploadId,\n                cachedParts: [],\n            };\n        }\n        const uploadCacheKey = getUploadsCacheKey({\n            size,\n            contentType,\n            file: data instanceof File ? data : undefined,\n            bucket,\n            accessLevel,\n            key,\n        });\n        await cacheMultipartUpload(uploadCacheKey, {\n            uploadId: UploadId,\n            bucket,\n            key,\n            fileName: data instanceof File ? data.name : '',\n        });\n        return {\n            uploadId: UploadId,\n            cachedParts: [],\n        };\n    }\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;AACA;AAIA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,2BAA2B,GAAG,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,WAAW,GAAG,KAAK;AAC9L,IAAI,MAAM,QAAQ,GAAG,SAAS,GAAG,GAAG,CAAC;AACrC,IAAI,IAAI,YAAY,CAAC;AACrB,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE;AAC5B,QAAQ,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;AACjF,QAAQ,YAAY,GAAG,SAAS,CAAC;AACjC,KAAK;AACL,SAAS;AACT,QAAQ,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAClD,YAAY,IAAI;AAChB,YAAY,WAAW;AACvB,YAAY,IAAI,EAAE,IAAI,YAAY,IAAI,GAAG,IAAI,GAAG,SAAS;AACzD,YAAY,MAAM;AAClB,YAAY,WAAW;AACvB,YAAY,GAAG;AACf,SAAS,CAAC,CAAC;AACX,QAAQ,MAAM,iBAAiB,GAAG,MAAM,qBAAqB,CAAC;AAC9D,YAAY,QAAQ;AACpB,YAAY,QAAQ,EAAE,cAAc;AACpC,YAAY,MAAM;AAClB,YAAY,QAAQ;AACpB,SAAS,CAAC,CAAC;AACX,QAAQ,YAAY,GAAG,iBAAiB;AACxC,cAAc,EAAE,GAAG,iBAAiB,EAAE,cAAc,EAAE;AACtD,cAAc,SAAS,CAAC;AACxB,KAAK;AACL,IAAI,IAAI,YAAY,EAAE;AACtB,QAAQ,OAAO;AACf,YAAY,QAAQ,EAAE,YAAY,CAAC,QAAQ;AAC3C,YAAY,WAAW,EAAE,YAAY,CAAC,KAAK;AAC3C,SAAS,CAAC;AACV,KAAK;AACL,SAAS;AACT,QAAQ,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,qBAAqB,CAAC;AACzD,YAAY,GAAG,QAAQ;AACvB,YAAY,WAAW;AACvB,SAAS,EAAE;AACX,YAAY,MAAM,EAAE,MAAM;AAC1B,YAAY,GAAG,EAAE,QAAQ;AACzB,YAAY,WAAW,EAAE,WAAW;AACpC,YAAY,kBAAkB,EAAE,kBAAkB;AAClD,YAAY,eAAe,EAAE,eAAe;AAC5C,YAAY,QAAQ,EAAE,QAAQ;AAC9B,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,IAAI,KAAK,SAAS,EAAE;AAChC,YAAY,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;AACrF,YAAY,OAAO;AACnB,gBAAgB,QAAQ,EAAE,QAAQ;AAClC,gBAAgB,WAAW,EAAE,EAAE;AAC/B,aAAa,CAAC;AACd,SAAS;AACT,QAAQ,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAClD,YAAY,IAAI;AAChB,YAAY,WAAW;AACvB,YAAY,IAAI,EAAE,IAAI,YAAY,IAAI,GAAG,IAAI,GAAG,SAAS;AACzD,YAAY,MAAM;AAClB,YAAY,WAAW;AACvB,YAAY,GAAG;AACf,SAAS,CAAC,CAAC;AACX,QAAQ,MAAM,oBAAoB,CAAC,cAAc,EAAE;AACnD,YAAY,QAAQ,EAAE,QAAQ;AAC9B,YAAY,MAAM;AAClB,YAAY,GAAG;AACf,YAAY,QAAQ,EAAE,IAAI,YAAY,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,EAAE;AAC3D,SAAS,CAAC,CAAC;AACX,QAAQ,OAAO;AACf,YAAY,QAAQ,EAAE,QAAQ;AAC9B,YAAY,WAAW,EAAE,EAAE;AAC3B,SAAS,CAAC;AACV,KAAK;AACL;;;;"}
+{"version":3,"file":"initialUpload.mjs","sources":["../../../../../../../src/providers/s3/apis/uploadData/multipart/initialUpload.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { createMultipartUpload } from '../../../utils/client';\nimport { logger } from '../../../../../utils';\nimport { cacheMultipartUpload, findCachedUploadParts, getUploadsCacheKey, } from './uploadCache';\n/**\n * Load the in-progress multipart upload from local storage or async storage(RN) if it exists, or create a new multipart\n * upload.\n *\n * @internal\n */\nexport const loadOrCreateMultipartUpload = async ({ s3Config, data, size, contentType, bucket, accessLevel, keyPrefix, key, contentDisposition, contentEncoding, metadata, abortSignal, }) => {\n    const finalKey = keyPrefix !== undefined ? keyPrefix + key : key;\n    let cachedUpload;\n    if (size === undefined) {\n        logger.debug('uploaded data size cannot be determined, skipping cache.');\n        cachedUpload = undefined;\n    }\n    else {\n        const uploadCacheKey = getUploadsCacheKey({\n            size,\n            contentType,\n            file: data instanceof File ? data : undefined,\n            bucket,\n            accessLevel,\n            key,\n        });\n        const cachedUploadParts = await findCachedUploadParts({\n            s3Config,\n            cacheKey: uploadCacheKey,\n            bucket,\n            finalKey,\n        });\n        cachedUpload = cachedUploadParts\n            ? { ...cachedUploadParts, uploadCacheKey }\n            : undefined;\n    }\n    if (cachedUpload) {\n        return {\n            uploadId: cachedUpload.uploadId,\n            cachedParts: cachedUpload.parts,\n        };\n    }\n    else {\n        const { UploadId } = await createMultipartUpload({\n            ...s3Config,\n            abortSignal,\n        }, {\n            Bucket: bucket,\n            Key: finalKey,\n            ContentType: contentType,\n            ContentDisposition: contentDisposition,\n            ContentEncoding: contentEncoding,\n            Metadata: metadata,\n        });\n        if (size === undefined) {\n            logger.debug('uploaded data size cannot be determined, skipping cache.');\n            return {\n                uploadId: UploadId,\n                cachedParts: [],\n            };\n        }\n        const uploadCacheKey = getUploadsCacheKey({\n            size,\n            contentType,\n            file: data instanceof File ? data : undefined,\n            bucket,\n            accessLevel,\n            key,\n        });\n        await cacheMultipartUpload(uploadCacheKey, {\n            uploadId: UploadId,\n            bucket,\n            key,\n            fileName: data instanceof File ? data.name : '',\n        });\n        return {\n            uploadId: UploadId,\n            cachedParts: [],\n        };\n    }\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;AACA;AAIA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,2BAA2B,GAAG,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,WAAW,GAAG,KAAK;AAC9L,IAAI,MAAM,QAAQ,GAAG,SAAS,KAAK,SAAS,GAAG,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC;AACrE,IAAI,IAAI,YAAY,CAAC;AACrB,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE;AAC5B,QAAQ,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;AACjF,QAAQ,YAAY,GAAG,SAAS,CAAC;AACjC,KAAK;AACL,SAAS;AACT,QAAQ,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAClD,YAAY,IAAI;AAChB,YAAY,WAAW;AACvB,YAAY,IAAI,EAAE,IAAI,YAAY,IAAI,GAAG,IAAI,GAAG,SAAS;AACzD,YAAY,MAAM;AAClB,YAAY,WAAW;AACvB,YAAY,GAAG;AACf,SAAS,CAAC,CAAC;AACX,QAAQ,MAAM,iBAAiB,GAAG,MAAM,qBAAqB,CAAC;AAC9D,YAAY,QAAQ;AACpB,YAAY,QAAQ,EAAE,cAAc;AACpC,YAAY,MAAM;AAClB,YAAY,QAAQ;AACpB,SAAS,CAAC,CAAC;AACX,QAAQ,YAAY,GAAG,iBAAiB;AACxC,cAAc,EAAE,GAAG,iBAAiB,EAAE,cAAc,EAAE;AACtD,cAAc,SAAS,CAAC;AACxB,KAAK;AACL,IAAI,IAAI,YAAY,EAAE;AACtB,QAAQ,OAAO;AACf,YAAY,QAAQ,EAAE,YAAY,CAAC,QAAQ;AAC3C,YAAY,WAAW,EAAE,YAAY,CAAC,KAAK;AAC3C,SAAS,CAAC;AACV,KAAK;AACL,SAAS;AACT,QAAQ,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,qBAAqB,CAAC;AACzD,YAAY,GAAG,QAAQ;AACvB,YAAY,WAAW;AACvB,SAAS,EAAE;AACX,YAAY,MAAM,EAAE,MAAM;AAC1B,YAAY,GAAG,EAAE,QAAQ;AACzB,YAAY,WAAW,EAAE,WAAW;AACpC,YAAY,kBAAkB,EAAE,kBAAkB;AAClD,YAAY,eAAe,EAAE,eAAe;AAC5C,YAAY,QAAQ,EAAE,QAAQ;AAC9B,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,IAAI,KAAK,SAAS,EAAE;AAChC,YAAY,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;AACrF,YAAY,OAAO;AACnB,gBAAgB,QAAQ,EAAE,QAAQ;AAClC,gBAAgB,WAAW,EAAE,EAAE;AAC/B,aAAa,CAAC;AACd,SAAS;AACT,QAAQ,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAClD,YAAY,IAAI;AAChB,YAAY,WAAW;AACvB,YAAY,IAAI,EAAE,IAAI,YAAY,IAAI,GAAG,IAAI,GAAG,SAAS;AACzD,YAAY,MAAM;AAClB,YAAY,WAAW;AACvB,YAAY,GAAG;AACf,SAAS,CAAC,CAAC;AACX,QAAQ,MAAM,oBAAoB,CAAC,cAAc,EAAE;AACnD,YAAY,QAAQ,EAAE,QAAQ;AAC9B,YAAY,MAAM;AAClB,YAAY,GAAG;AACf,YAAY,QAAQ,EAAE,IAAI,YAAY,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,EAAE;AAC3D,SAAS,CAAC,CAAC;AACX,QAAQ,OAAO;AACf,YAAY,QAAQ,EAAE,QAAQ;AAC9B,YAAY,WAAW,EAAE,EAAE;AAC3B,SAAS,CAAC;AACV,KAAK;AACL;;;;"}

package/dist/esm/providers/s3/apis/uploadData/multipart/uploadCache.d.ts

@@ -26,7 +26,7 @@ interface UploadsCacheKeyOptions {
     size: number;
     contentType?: string;
     bucket: string;
-    accessLevel: StorageAccessLevel;
+    accessLevel?: StorageAccessLevel;
     key: string;
     file?: File;
 }

package/dist/esm/providers/s3/apis/uploadData/multipart/uploadCache.mjs

@@ -65,8 +65,15 @@ const listCachedUploadTasks = async (kvStorage) => {
  * So the library always created a new multipart upload if the file is modified.
  */
 const getUploadsCacheKey = ({ file, size, contentType, bucket, accessLevel, key, }) => {
+    let levelStr;
     const resolvedContentType = contentType ?? file?.type ?? 'application/octet-stream';
-    const levelStr = accessLevel === 'guest' ? 'public' : accessLevel;
+    // If no access level is defined, we're using custom gen2 access rules
+    if (accessLevel === undefined) {
+        levelStr = 'custom';
+    }
+    else {
+        levelStr = accessLevel === 'guest' ? 'public' : accessLevel;
+    }
     const baseId = `${size}_${resolvedContentType}_${bucket}_${levelStr}_${key}`;
     if (file) {
         return `${file.name}_${file.lastModified}_${baseId}`;

package/dist/esm/providers/s3/apis/uploadData/multipart/uploadCache.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uploadCache.mjs","sources":["../../../../../../../src/providers/s3/apis/uploadData/multipart/uploadCache.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { defaultStorage, } from '@aws-amplify/core';\nimport { UPLOADS_STORAGE_KEY } from '../../../utils/constants';\nimport { listParts } from '../../../utils/client';\nimport { logger } from '../../../../../utils';\nconst ONE_HOUR = 1000 * 60 * 60;\n/**\n * Find the cached multipart upload id and get the parts that have been uploaded\n * with ListParts API. If the cached upload is expired(1 hour), return null.\n */\nexport const findCachedUploadParts = async ({ cacheKey, s3Config, bucket, finalKey, }) => {\n    const cachedUploads = await listCachedUploadTasks(defaultStorage);\n    if (!cachedUploads[cacheKey] ||\n        cachedUploads[cacheKey].lastTouched < Date.now() - ONE_HOUR // Uploads are cached for 1 hour\n    ) {\n        return null;\n    }\n    const cachedUpload = cachedUploads[cacheKey];\n    cachedUpload.lastTouched = Date.now();\n    await defaultStorage.setItem(UPLOADS_STORAGE_KEY, JSON.stringify(cachedUploads));\n    try {\n        const { Parts = [] } = await listParts(s3Config, {\n            Bucket: bucket,\n            Key: finalKey,\n            UploadId: cachedUpload.uploadId,\n        });\n        return {\n            parts: Parts,\n            uploadId: cachedUpload.uploadId,\n        };\n    }\n    catch (e) {\n        logger.debug('failed to list cached parts, removing cached upload.');\n        await removeCachedUpload(cacheKey);\n        return null;\n    }\n};\nconst listCachedUploadTasks = async (kvStorage) => {\n    try {\n        return JSON.parse((await kvStorage.getItem(UPLOADS_STORAGE_KEY)) ?? '{}');\n    }\n    catch (e) {\n        logger.debug('failed to parse cached uploads record.');\n        return {};\n    }\n};\n/**\n * Get the cache key of a multipart upload. Data source cached by different: size, content type, bucket, access level,\n * key. If the data source is a File instance, the upload is additionally indexed by file name and last modified time.\n * So the library always created a new multipart upload if the file is modified.\n */\nexport const getUploadsCacheKey = ({ file, size, contentType, bucket, accessLevel, key, }) => {\n    const resolvedContentType = contentType ?? file?.type ?? 'application/octet-stream';\n    const levelStr = accessLevel === 'guest' ? 'public' : accessLevel;\n    const baseId = `${size}_${resolvedContentType}_${bucket}_${levelStr}_${key}`;\n    if (file) {\n        return `${file.name}_${file.lastModified}_${baseId}`;\n    }\n    else {\n        return baseId;\n    }\n};\nexport const cacheMultipartUpload = async (cacheKey, fileMetadata) => {\n    const cachedUploads = await listCachedUploadTasks(defaultStorage);\n    cachedUploads[cacheKey] = {\n        ...fileMetadata,\n        lastTouched: Date.now(),\n    };\n    await defaultStorage.setItem(UPLOADS_STORAGE_KEY, JSON.stringify(cachedUploads));\n};\nexport const removeCachedUpload = async (cacheKey) => {\n    const cachedUploads = await listCachedUploadTasks(defaultStorage);\n    delete cachedUploads[cacheKey];\n    await defaultStorage.setItem(UPLOADS_STORAGE_KEY, JSON.stringify(cachedUploads));\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AACA;AAKA,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC;AAChC;AACA;AACA;AACA;AACY,MAAC,qBAAqB,GAAG,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;AAC1F,IAAI,MAAM,aAAa,GAAG,MAAM,qBAAqB,CAAC,cAAc,CAAC,CAAC;AACtE,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;AAChC,QAAQ,aAAa,CAAC,QAAQ,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ;AACnE,MAAM;AACN,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK;AACL,IAAI,MAAM,YAAY,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AACjD,IAAI,YAAY,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;AAC1C,IAAI,MAAM,cAAc,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AACrF,IAAI,IAAI;AACR,QAAQ,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE;AACzD,YAAY,MAAM,EAAE,MAAM;AAC1B,YAAY,GAAG,EAAE,QAAQ;AACzB,YAAY,QAAQ,EAAE,YAAY,CAAC,QAAQ;AAC3C,SAAS,CAAC,CAAC;AACX,QAAQ,OAAO;AACf,YAAY,KAAK,EAAE,KAAK;AACxB,YAAY,QAAQ,EAAE,YAAY,CAAC,QAAQ;AAC3C,SAAS,CAAC;AACV,KAAK;AACL,IAAI,OAAO,CAAC,EAAE;AACd,QAAQ,MAAM,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;AAC7E,QAAQ,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAC3C,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK;AACL,EAAE;AACF,MAAM,qBAAqB,GAAG,OAAO,SAAS,KAAK;AACnD,IAAI,IAAI;AACR,QAAQ,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,IAAI,CAAC,CAAC;AAClF,KAAK;AACL,IAAI,OAAO,CAAC,EAAE;AACd,QAAQ,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC/D,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,CAAC,CAAC;AACF;AACA;AACA;AACA;AACA;AACY,MAAC,kBAAkB,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,GAAG,KAAK;AAC9F,IAAI,MAAM,mBAAmB,GAAG,WAAW,IAAI,IAAI,EAAE,IAAI,IAAI,0BAA0B,CAAC;AACxF,IAAI,MAAM,QAAQ,GAAG,WAAW,KAAK,OAAO,GAAG,QAAQ,GAAG,WAAW,CAAC;AACtE,IAAI,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACjF,IAAI,IAAI,IAAI,EAAE;AACd,QAAQ,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAC7D,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK;AACL,EAAE;AACU,MAAC,oBAAoB,GAAG,OAAO,QAAQ,EAAE,YAAY,KAAK;AACtE,IAAI,MAAM,aAAa,GAAG,MAAM,qBAAqB,CAAC,cAAc,CAAC,CAAC;AACtE,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG;AAC9B,QAAQ,GAAG,YAAY;AACvB,QAAQ,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;AAC/B,KAAK,CAAC;AACN,IAAI,MAAM,cAAc,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AACrF,EAAE;AACU,MAAC,kBAAkB,GAAG,OAAO,QAAQ,KAAK;AACtD,IAAI,MAAM,aAAa,GAAG,MAAM,qBAAqB,CAAC,cAAc,CAAC,CAAC;AACtE,IAAI,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;AACnC,IAAI,MAAM,cAAc,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AACrF;;;;"}
+{"version":3,"file":"uploadCache.mjs","sources":["../../../../../../../src/providers/s3/apis/uploadData/multipart/uploadCache.ts"],"sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\nimport { defaultStorage, } from '@aws-amplify/core';\nimport { UPLOADS_STORAGE_KEY } from '../../../utils/constants';\nimport { listParts } from '../../../utils/client';\nimport { logger } from '../../../../../utils';\nconst ONE_HOUR = 1000 * 60 * 60;\n/**\n * Find the cached multipart upload id and get the parts that have been uploaded\n * with ListParts API. If the cached upload is expired(1 hour), return null.\n */\nexport const findCachedUploadParts = async ({ cacheKey, s3Config, bucket, finalKey, }) => {\n    const cachedUploads = await listCachedUploadTasks(defaultStorage);\n    if (!cachedUploads[cacheKey] ||\n        cachedUploads[cacheKey].lastTouched < Date.now() - ONE_HOUR // Uploads are cached for 1 hour\n    ) {\n        return null;\n    }\n    const cachedUpload = cachedUploads[cacheKey];\n    cachedUpload.lastTouched = Date.now();\n    await defaultStorage.setItem(UPLOADS_STORAGE_KEY, JSON.stringify(cachedUploads));\n    try {\n        const { Parts = [] } = await listParts(s3Config, {\n            Bucket: bucket,\n            Key: finalKey,\n            UploadId: cachedUpload.uploadId,\n        });\n        return {\n            parts: Parts,\n            uploadId: cachedUpload.uploadId,\n        };\n    }\n    catch (e) {\n        logger.debug('failed to list cached parts, removing cached upload.');\n        await removeCachedUpload(cacheKey);\n        return null;\n    }\n};\nconst listCachedUploadTasks = async (kvStorage) => {\n    try {\n        return JSON.parse((await kvStorage.getItem(UPLOADS_STORAGE_KEY)) ?? '{}');\n    }\n    catch (e) {\n        logger.debug('failed to parse cached uploads record.');\n        return {};\n    }\n};\n/**\n * Get the cache key of a multipart upload. Data source cached by different: size, content type, bucket, access level,\n * key. If the data source is a File instance, the upload is additionally indexed by file name and last modified time.\n * So the library always created a new multipart upload if the file is modified.\n */\nexport const getUploadsCacheKey = ({ file, size, contentType, bucket, accessLevel, key, }) => {\n    let levelStr;\n    const resolvedContentType = contentType ?? file?.type ?? 'application/octet-stream';\n    // If no access level is defined, we're using custom gen2 access rules\n    if (accessLevel === undefined) {\n        levelStr = 'custom';\n    }\n    else {\n        levelStr = accessLevel === 'guest' ? 'public' : accessLevel;\n    }\n    const baseId = `${size}_${resolvedContentType}_${bucket}_${levelStr}_${key}`;\n    if (file) {\n        return `${file.name}_${file.lastModified}_${baseId}`;\n    }\n    else {\n        return baseId;\n    }\n};\nexport const cacheMultipartUpload = async (cacheKey, fileMetadata) => {\n    const cachedUploads = await listCachedUploadTasks(defaultStorage);\n    cachedUploads[cacheKey] = {\n        ...fileMetadata,\n        lastTouched: Date.now(),\n    };\n    await defaultStorage.setItem(UPLOADS_STORAGE_KEY, JSON.stringify(cachedUploads));\n};\nexport const removeCachedUpload = async (cacheKey) => {\n    const cachedUploads = await listCachedUploadTasks(defaultStorage);\n    delete cachedUploads[cacheKey];\n    await defaultStorage.setItem(UPLOADS_STORAGE_KEY, JSON.stringify(cachedUploads));\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AACA;AAKA,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC;AAChC;AACA;AACA;AACA;AACY,MAAC,qBAAqB,GAAG,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;AAC1F,IAAI,MAAM,aAAa,GAAG,MAAM,qBAAqB,CAAC,cAAc,CAAC,CAAC;AACtE,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;AAChC,QAAQ,aAAa,CAAC,QAAQ,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ;AACnE,MAAM;AACN,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK;AACL,IAAI,MAAM,YAAY,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AACjD,IAAI,YAAY,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;AAC1C,IAAI,MAAM,cAAc,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AACrF,IAAI,IAAI;AACR,QAAQ,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE;AACzD,YAAY,MAAM,EAAE,MAAM;AAC1B,YAAY,GAAG,EAAE,QAAQ;AACzB,YAAY,QAAQ,EAAE,YAAY,CAAC,QAAQ;AAC3C,SAAS,CAAC,CAAC;AACX,QAAQ,OAAO;AACf,YAAY,KAAK,EAAE,KAAK;AACxB,YAAY,QAAQ,EAAE,YAAY,CAAC,QAAQ;AAC3C,SAAS,CAAC;AACV,KAAK;AACL,IAAI,OAAO,CAAC,EAAE;AACd,QAAQ,MAAM,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;AAC7E,QAAQ,MAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAC3C,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK;AACL,EAAE;AACF,MAAM,qBAAqB,GAAG,OAAO,SAAS,KAAK;AACnD,IAAI,IAAI;AACR,QAAQ,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,IAAI,CAAC,CAAC;AAClF,KAAK;AACL,IAAI,OAAO,CAAC,EAAE;AACd,QAAQ,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC/D,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,CAAC,CAAC;AACF;AACA;AACA;AACA;AACA;AACY,MAAC,kBAAkB,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,GAAG,KAAK;AAC9F,IAAI,IAAI,QAAQ,CAAC;AACjB,IAAI,MAAM,mBAAmB,GAAG,WAAW,IAAI,IAAI,EAAE,IAAI,IAAI,0BAA0B,CAAC;AACxF;AACA,IAAI,IAAI,WAAW,KAAK,SAAS,EAAE;AACnC,QAAQ,QAAQ,GAAG,QAAQ,CAAC;AAC5B,KAAK;AACL,SAAS;AACT,QAAQ,QAAQ,GAAG,WAAW,KAAK,OAAO,GAAG,QAAQ,GAAG,WAAW,CAAC;AACpE,KAAK;AACL,IAAI,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACjF,IAAI,IAAI,IAAI,EAAE;AACd,QAAQ,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAC7D,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK;AACL,EAAE;AACU,MAAC,oBAAoB,GAAG,OAAO,QAAQ,EAAE,YAAY,KAAK;AACtE,IAAI,MAAM,aAAa,GAAG,MAAM,qBAAqB,CAAC,cAAc,CAAC,CAAC;AACtE,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG;AAC9B,QAAQ,GAAG,YAAY;AACvB,QAAQ,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;AAC/B,KAAK,CAAC;AACN,IAAI,MAAM,cAAc,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AACrF,EAAE;AACU,MAAC,kBAAkB,GAAG,OAAO,QAAQ,KAAK;AACtD,IAAI,MAAM,aAAa,GAAG,MAAM,qBAAqB,CAAC,cAAc,CAAC,CAAC;AACtE,IAAI,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;AACnC,IAAI,MAAM,cAAc,CAAC,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AACrF;;;;"}

package/dist/esm/providers/s3/apis/uploadData/multipart/uploadHandlers.d.ts

@@ -1,13 +1,13 @@
-import { UploadDataInput } from '../../../types';
-import { Item as S3Item } from '../../../types/outputs';
+import { UploadDataInput, UploadDataWithPathInput } from '../../../types';
+import { ItemWithKey, ItemWithPath } from '../../../types/outputs';
 /**
  * Create closure hiding the multipart upload implementation details and expose the upload job and control functions(
  * onPause, onResume, onCancel).
  *
  * @internal
  */
-export declare const getMultipartUploadHandlers: ({ options: uploadDataOptions, key, data }: UploadDataInput, size?: number) => {
-    multipartUploadJob: () => Promise<S3Item>;
+export declare const getMultipartUploadHandlers: (uploadDataInput: UploadDataInput | UploadDataWithPathInput, size?: number) => {
+    multipartUploadJob: () => Promise<ItemWithKey | ItemWithPath>;
     onPause: () => void;
     onResume: () => void;
     onCancel: (message?: string) => void;