@aws-amplify/storage 5.9.6-unstable.7762f1a.0 → 6.0.0

package/lib/providers/s3/apis/internal/list.js

@@ -0,0 +1,71 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.list = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const utils_2 = require("../../utils");
+const client_1 = require("../../utils/client");
+const userAgent_1 = require("../../utils/userAgent");
+const MAX_PAGE_SIZE = 1000;
+const list = async (amplify, input) => {
+    const { options = {}, prefix: path = '' } = input ?? {};
+    const { s3Config, bucket, keyPrefix: prefix, } = await (0, utils_2.resolveS3ConfigAndInput)(amplify, options);
+    const listParams = {
+        Bucket: bucket,
+        Prefix: `${prefix}${path}`,
+        MaxKeys: options?.listAll ? undefined : options?.pageSize,
+        ContinuationToken: options?.listAll ? undefined : options?.nextToken,
+    };
+    return options.listAll
+        ? await _listAll({ s3Config, listParams, prefix })
+        : await _list({ s3Config, listParams, prefix });
+};
+exports.list = list;
+const _listAll = async ({ s3Config, listParams, prefix, }) => {
+    // TODO(ashwinkumar6) V6-logger: pageSize and nextToken aren't required when listing all items
+    const listResult = [];
+    let continuationToken = listParams.ContinuationToken;
+    do {
+        const { items: pageResults, nextToken: pageNextToken } = await _list({
+            prefix,
+            s3Config,
+            listParams: {
+                ...listParams,
+                ContinuationToken: continuationToken,
+                MaxKeys: MAX_PAGE_SIZE,
+            },
+        });
+        listResult.push(...pageResults);
+        continuationToken = pageNextToken;
+    } while (continuationToken);
+    return {
+        items: listResult,
+    };
+};
+const _list = async ({ s3Config, listParams, prefix, }) => {
+    const listParamsClone = { ...listParams };
+    if (!listParamsClone.MaxKeys || listParamsClone.MaxKeys > MAX_PAGE_SIZE) {
+        listParamsClone.MaxKeys = MAX_PAGE_SIZE;
+        // TODO(ashwinkumar6) V6-logger: defaulting pageSize to ${MAX_PAGE_SIZE}.
+    }
+    const response = await (0, client_1.listObjectsV2)({
+        ...s3Config,
+        userAgentValue: (0, userAgent_1.getStorageUserAgentValue)(utils_1.StorageAction.List)
+    }, listParamsClone);
+    if (!response?.Contents) {
+        return {
+            items: [],
+        };
+    }
+    const listResult = response.Contents.map(item => ({
+        key: item.Key.substring(prefix.length),
+        eTag: item.ETag,
+        lastModified: item.LastModified,
+        size: item.Size,
+    }));
+    return {
+        items: listResult,
+        nextToken: response.NextContinuationToken,
+    };
+};

package/lib/providers/s3/apis/internal/remove.d.ts

@@ -0,0 +1,3 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
+import { RemoveInput, RemoveOutput } from '../../types';
+export declare const remove: (amplify: AmplifyClassV6, input: RemoveInput) => Promise<RemoveOutput>;

package/lib/providers/s3/apis/internal/remove.js

@@ -0,0 +1,25 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remove = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const utils_2 = require("../../utils");
+const client_1 = require("../../utils/client");
+const userAgent_1 = require("../../utils/userAgent");
+const remove = async (amplify, input) => {
+    const { key, options = {} } = input;
+    const { s3Config, keyPrefix, bucket } = await (0, utils_2.resolveS3ConfigAndInput)(amplify, options);
+    // TODO(ashwinkumar6) V6-logger: debug `remove ${key} from ${finalKey}`
+    await (0, client_1.deleteObject)({
+        ...s3Config,
+        userAgentValue: (0, userAgent_1.getStorageUserAgentValue)(utils_1.StorageAction.Remove)
+    }, {
+        Bucket: bucket,
+        Key: `${keyPrefix}${key}`
+    });
+    return {
+        key,
+    };
+};
+exports.remove = remove;

package/lib/providers/s3/apis/list.d.ts

@@ -0,0 +1,22 @@
+import { ListAllInput, ListPaginateInput, ListAllOutput, ListPaginateOutput } from '../types';
+type ListApi = {
+    /**
+     * List files with given prefix in pages
+     * pageSize 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 keys and metadata with
+     * @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
+     */
+    (input?: ListPaginateInput): Promise<ListPaginateOutput>;
+    /**
+     * List all files from S3. You can set `listAll` to true in `options` to get all the files from S3.
+     * @param input - The ListAllInput object.
+     * @returns A 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
+     */
+    (input?: ListAllInput): Promise<ListAllOutput>;
+};
+export declare const list: ListApi;
+export {};

package/lib/providers/s3/apis/list.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.list = void 0;
+const core_1 = require("@aws-amplify/core");
+const list_1 = require("./internal/list");
+const list = (input) => {
+    return (0, list_1.list)(core_1.Amplify, input ?? {});
+};
+exports.list = list;

package/lib/providers/s3/apis/remove.d.ts

@@ -0,0 +1,9 @@
+import { RemoveInput, RemoveOutput } from '../types';
+/**
+ * Remove a file from your S3 bucket.
+ * @param input - The RemoveInput object.
+ * @return Output containing the removed object key
+ * @throws service: {@link S3Exception} - S3 service errors thrown while getting properties
+ * @throws validation: {@link StorageValidationErrorCode } - Validation errors thrown
+ */
+export declare const remove: (input: RemoveInput) => Promise<RemoveOutput>;

package/lib/providers/s3/apis/remove.js

@@ -0,0 +1,18 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remove = void 0;
+const core_1 = require("@aws-amplify/core");
+const remove_1 = require("./internal/remove");
+/**
+ * Remove a file from your S3 bucket.
+ * @param input - The RemoveInput object.
+ * @return Output containing the removed object key
+ * @throws service: {@link S3Exception} - S3 service errors thrown while getting properties
+ * @throws validation: {@link StorageValidationErrorCode } - Validation errors thrown
+ */
+const remove = (input) => {
+    return (0, remove_1.remove)(core_1.Amplify, input);
+};
+exports.remove = remove;

package/lib/providers/s3/apis/server/copy.d.ts

@@ -0,0 +1,3 @@
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import { CopyInput, CopyOutput } from '../../types';
+export declare const copy: (contextSpec: AmplifyServer.ContextSpec, input: CopyInput) => Promise<CopyOutput>;

package/lib/providers/s3/apis/server/copy.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copy = void 0;
+const adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+const copy_1 = require("../internal/copy");
+const copy = async (contextSpec, input) => {
+    return (0, copy_1.copy)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.copy = copy;

package/lib/providers/s3/apis/server/getProperties.d.ts

@@ -0,0 +1,3 @@
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import { GetPropertiesInput, GetPropertiesOutput } from '../../types';
+export declare const getProperties: (contextSpec: AmplifyServer.ContextSpec, input: GetPropertiesInput) => Promise<GetPropertiesOutput>;

package/lib/providers/s3/apis/server/getProperties.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProperties = void 0;
+const adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+const getProperties_1 = require("../internal/getProperties");
+const getProperties = (contextSpec, input) => {
+    return (0, getProperties_1.getProperties)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.getProperties = getProperties;

package/lib/providers/s3/apis/server/getUrl.d.ts

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

package/lib/providers/s3/apis/server/getUrl.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUrl = void 0;
+const adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+const getUrl_1 = require("../internal/getUrl");
+const getUrl = async (contextSpec, input) => {
+    return (0, getUrl_1.getUrl)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.getUrl = getUrl;

package/lib/providers/s3/apis/server/index.d.ts

@@ -0,0 +1,5 @@
+export { getProperties } from './getProperties';
+export { getUrl } from './getUrl';
+export { list } from './list';
+export { remove } from './remove';
+export { copy } from './copy';

package/lib/providers/s3/apis/server/index.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copy = exports.remove = exports.list = exports.getUrl = exports.getProperties = void 0;
+var getProperties_1 = require("./getProperties");
+Object.defineProperty(exports, "getProperties", { enumerable: true, get: function () { return getProperties_1.getProperties; } });
+var getUrl_1 = require("./getUrl");
+Object.defineProperty(exports, "getUrl", { enumerable: true, get: function () { return getUrl_1.getUrl; } });
+var list_1 = require("./list");
+Object.defineProperty(exports, "list", { enumerable: true, get: function () { return list_1.list; } });
+var remove_1 = require("./remove");
+Object.defineProperty(exports, "remove", { enumerable: true, get: function () { return remove_1.remove; } });
+var copy_1 = require("./copy");
+Object.defineProperty(exports, "copy", { enumerable: true, get: function () { return copy_1.copy; } });

package/lib/providers/s3/apis/server/list.d.ts

@@ -0,0 +1,23 @@
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import { ListAllInput, ListPaginateInput, ListAllOutput, ListPaginateOutput } from '../../types';
+type ListApi = {
+    /**
+     * Lists bucket objects with pagination.
+     * @param {ListPaginateInput} 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} 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 {};

package/lib/providers/s3/apis/server/list.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.list = void 0;
+const adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+const list_1 = require("../internal/list");
+const list = (contextSpec, input) => {
+    return (0, list_1.list)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input ?? {});
+};
+exports.list = list;

package/lib/providers/s3/apis/server/remove.d.ts

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

package/lib/providers/s3/apis/server/remove.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remove = void 0;
+const adapter_core_1 = require("@aws-amplify/core/internals/adapter-core");
+const remove_1 = require("../internal/remove");
+const remove = (contextSpec, input) => {
+    return (0, remove_1.remove)((0, adapter_core_1.getAmplifyServerContext)(contextSpec).amplify, input);
+};
+exports.remove = remove;

package/lib/providers/s3/apis/uploadData/byteLength.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Calculate the total size of the data to be uploaded. The total size is not required for multipart upload, as it's
+ * only used in progress report.
+ */
+export declare const byteLength: (input?: any) => number | undefined;

package/lib/providers/s3/apis/uploadData/byteLength.js

@@ -0,0 +1,37 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.byteLength = void 0;
+/**
+ * Calculate the total size of the data to be uploaded. The total size is not required for multipart upload, as it's
+ * only used in progress report.
+ */
+const byteLength = (input) => {
+    if (input === null || input === undefined)
+        return 0;
+    if (typeof input === 'string') {
+        let len = input.length;
+        for (let i = len - 1; i >= 0; i--) {
+            const code = input.charCodeAt(i);
+            if (code > 0x7f && code <= 0x7ff)
+                len++;
+            else if (code > 0x7ff && code <= 0xffff)
+                len += 2;
+            if (code >= 0xdc00 && code <= 0xdfff)
+                i--; // trail surrogate
+        }
+        return len;
+    }
+    else if (typeof input.byteLength === 'number') {
+        // handles Uint8Array, ArrayBuffer, Buffer, and ArrayBufferView
+        return input.byteLength;
+    }
+    else if (typeof input.size === 'number') {
+        // handles browser File object
+        return input.size;
+    }
+    // TODO: support Node.js stream size
+    return undefined;
+};
+exports.byteLength = byteLength;

package/lib/providers/s3/apis/uploadData/index.d.ts

@@ -0,0 +1,50 @@
+import { UploadDataInput, UploadDataOutput } 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.
+ *
+ * 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;
+ * ```
+ */
+export declare const uploadData: (input: UploadDataInput) => UploadDataOutput;

package/lib/providers/s3/apis/uploadData/index.js

@@ -0,0 +1,88 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadData = void 0;
+const utils_1 = require("../../utils");
+const assertValidationError_1 = require("../../../../errors/utils/assertValidationError");
+const validation_1 = require("../../../../errors/types/validation");
+const constants_1 = require("../../utils/constants");
+const byteLength_1 = require("./byteLength");
+const putObjectJob_1 = require("./putObjectJob");
+const multipart_1 = require("./multipart");
+/**
+ * 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) => {
+    const { data } = input;
+    const dataByteLength = (0, byteLength_1.byteLength)(data);
+    (0, assertValidationError_1.assertValidationError)(dataByteLength === undefined || dataByteLength <= constants_1.MAX_OBJECT_SIZE, validation_1.StorageValidationErrorCode.ObjectIsTooLarge);
+    if (dataByteLength && dataByteLength <= constants_1.DEFAULT_PART_SIZE) {
+        const abortController = new AbortController();
+        return (0, utils_1.createUploadTask)({
+            isMultipartUpload: false,
+            job: (0, putObjectJob_1.putObjectJob)(input, abortController.signal, dataByteLength),
+            onCancel: (message) => {
+                abortController.abort(message);
+            },
+        });
+    }
+    else {
+        const { multipartUploadJob, onPause, onResume, onCancel } = (0, multipart_1.getMultipartUploadHandlers)(input, dataByteLength);
+        return (0, utils_1.createUploadTask)({
+            isMultipartUpload: true,
+            job: multipartUploadJob,
+            onCancel: (message) => {
+                onCancel(message);
+            },
+            onPause,
+            onResume,
+        });
+    }
+};
+exports.uploadData = uploadData;

package/lib/providers/s3/apis/uploadData/multipart/calculatePartSize.d.ts

@@ -0,0 +1 @@
+export declare const calculatePartSize: (totalSize?: number) => number;

package/lib/providers/s3/apis/uploadData/multipart/calculatePartSize.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculatePartSize = void 0;
+const constants_1 = require("../../../utils/constants");
+const calculatePartSize = (totalSize) => {
+    if (!totalSize) {
+        return constants_1.DEFAULT_PART_SIZE;
+    }
+    let partSize = constants_1.DEFAULT_PART_SIZE;
+    let partsCount = Math.ceil(totalSize / partSize);
+    while (partsCount > constants_1.MAX_PARTS_COUNT) {
+        partSize *= 2;
+        partsCount = Math.ceil(totalSize / partSize);
+    }
+    return partSize;
+};
+exports.calculatePartSize = calculatePartSize;

package/lib/providers/s3/apis/uploadData/multipart/getDataChunker.d.ts

@@ -0,0 +1,7 @@
+import { StorageUploadDataPayload } from '../../../../../types';
+export type PartToUpload = {
+    partNumber: number;
+    data: Blob | ArrayBuffer | string;
+    size: number;
+};
+export declare const getDataChunker: (data: StorageUploadDataPayload, totalSize?: number) => Generator<PartToUpload, void, undefined>;

package/lib/providers/s3/apis/uploadData/multipart/getDataChunker.js

@@ -0,0 +1,52 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDataChunker = void 0;
+const validation_1 = require("../../../../../errors/types/validation");
+const StorageError_1 = require("../../../../../errors/StorageError");
+const calculatePartSize_1 = require("./calculatePartSize");
+const getDataChunker = (data, totalSize) => {
+    const partSize = (0, calculatePartSize_1.calculatePartSize)(totalSize);
+    if (data instanceof Blob) {
+        return helper(data, 0, data.size, partSize);
+    }
+    else if (ArrayBuffer.isView(data)) {
+        return helper(data.buffer, data.byteOffset, data.byteLength, partSize);
+    }
+    else if (data instanceof ArrayBuffer) {
+        return helper(data, 0, data.byteLength, partSize);
+    }
+    else if (typeof data === 'string') {
+        return helper(data, 0, data.length, partSize);
+    }
+    else {
+        throw new StorageError_1.StorageError({
+            name: validation_1.StorageValidationErrorCode.InvalidUploadSource,
+            ...validation_1.validationErrorMap[validation_1.StorageValidationErrorCode.InvalidUploadSource],
+        });
+    }
+};
+exports.getDataChunker = getDataChunker;
+// TODO[AllanZhengYP]: the byte length of string is incorrect here which will cause the progress tracking behave
+// incorrectly. We should fix this in the future.
+const helper = function* (buffer, byteOffset, byteLength, partSize) {
+    let partNumber = 1;
+    let startByte = byteOffset;
+    let endByte = byteOffset + Math.min(partSize, byteLength);
+    while (endByte < byteLength + byteOffset) {
+        yield {
+            partNumber,
+            data: buffer.slice(startByte, endByte),
+            size: partSize,
+        };
+        partNumber += 1;
+        startByte = endByte;
+        endByte = startByte + partSize;
+    }
+    yield {
+        partNumber,
+        data: buffer.slice(startByte, byteLength + byteOffset),
+        size: byteLength + byteOffset - startByte,
+    };
+};

package/lib/providers/s3/apis/uploadData/multipart/index.d.ts

@@ -0,0 +1 @@
+export { getMultipartUploadHandlers } from './uploadHandlers';

package/lib/providers/s3/apis/uploadData/multipart/index.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMultipartUploadHandlers = void 0;
+var uploadHandlers_1 = require("./uploadHandlers");
+Object.defineProperty(exports, "getMultipartUploadHandlers", { enumerable: true, get: function () { return uploadHandlers_1.getMultipartUploadHandlers; } });

package/lib/providers/s3/apis/uploadData/multipart/initialUpload.d.ts

@@ -0,0 +1,30 @@
+import { StorageAccessLevel } from '@aws-amplify/core';
+import { ResolvedS3Config } from '../../../types/options';
+import { StorageUploadDataPayload } from '../../../../../types';
+import { Part } from '../../../utils/client';
+type LoadOrCreateMultipartUploadOptions = {
+    s3Config: ResolvedS3Config;
+    data: StorageUploadDataPayload;
+    bucket: string;
+    accessLevel: StorageAccessLevel;
+    keyPrefix: string;
+    key: string;
+    contentType?: string;
+    contentDisposition?: string;
+    contentEncoding?: string;
+    metadata?: Record<string, string>;
+    size?: number;
+    abortSignal?: AbortSignal;
+};
+type LoadOrCreateMultipartUploadResult = {
+    uploadId: string;
+    cachedParts: Part[];
+};
+/**
+ * Load the in-progress multipart upload from local storage or async storage(RN) if it exists, or create a new multipart
+ * upload.
+ *
+ * @internal
+ */
+export declare const loadOrCreateMultipartUpload: ({ s3Config, data, size, contentType, bucket, accessLevel, keyPrefix, key, contentDisposition, contentEncoding, metadata, abortSignal, }: LoadOrCreateMultipartUploadOptions) => Promise<LoadOrCreateMultipartUploadResult>;
+export {};