@aws-amplify/storage 6.0.1-preview-testing.64b45b1.0 → 6.0.1-preview-testing.ddb17c0.0

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

@@ -3,16 +3,16 @@ 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 {ListPaginateInput} The input object
-     * @return {Promise<ListPaginateOutput>} - Promise resolves to list of keys and metadata with
+     * @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 {ListAllInput} The input object
-     * @return {Promise<ListAllOutput>} - Promise resolves to list of keys and metadata for all objects in path
+     * @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
      */

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

@@ -1,8 +1,8 @@
 import { RemoveInput, RemoveOutput } from '../types';
 /**
  * Remove a file from your S3 bucket.
- * @param {RemoveInput} The input object
- * @return {Promise<RemoveOutput>} - Promise resolves upon successful removal of the object
+ * @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
  */

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

@@ -4,8 +4,8 @@ import { Amplify } from '@aws-amplify/core';
 import { remove as removeInternal } from './internal/remove';
 /**
  * Remove a file from your S3 bucket.
- * @param {RemoveInput} The input object
- * @return {Promise<RemoveOutput>} - Promise resolves upon successful removal of the object
+ * @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
  */

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

@@ -7,9 +7,8 @@ import { UploadDataInput, UploadDataOutput } from '../../types';
  * * Maximum object size is 5TB.
  * * Maximum object size if the size cannot be determined before upload is 50GB.
  *
- * @param {UploadDataInput} The input parameters that are passed to the
- * 	uploadData operation.
- * @returns {UploadDataOutput} Cancelable and Resumable task exposing result promise from `result`
+ * @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.

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

@@ -15,9 +15,8 @@ import { getMultipartUploadHandlers } from './multipart';
  * * Maximum object size is 5TB.
  * * Maximum object size if the size cannot be determined before upload is 50GB.
  *
- * @param {UploadDataInput} The input parameters that are passed to the
- * 	uploadData operation.
- * @returns {UploadDataOutput} Cancelable and Resumable task exposing result promise from `result`
+ * @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.

package/lib-esm/providers/s3/types/index.d.ts

@@ -1,4 +1,4 @@
-export { GetUrlOptions, UploadDataOptions, GetPropertiesOptions, ListAllOptions, ListPaginateOptions, RemoveOptions, DownloadDataOptions, } from './options';
+export { GetUrlOptions, UploadDataOptions, GetPropertiesOptions, ListAllOptions, ListPaginateOptions, RemoveOptions, DownloadDataOptions, CopyDestinationOptions, CopySourceOptions, } from './options';
 export { DownloadDataOutput, GetUrlOutput, UploadDataOutput, ListOutputItem, ListAllOutput, ListPaginateOutput, GetPropertiesOutput, CopyOutput, RemoveOutput, } from './outputs';
 export { CopyInput, GetPropertiesInput, GetUrlInput, ListAllInput, ListPaginateInput, RemoveInput, DownloadDataInput, UploadDataInput, } from './inputs';
 export { S3Exception } from './errors';

package/lib-esm/providers/s3/types/inputs.d.ts

@@ -1,10 +1,34 @@
 import { StorageCopyInput, StorageGetPropertiesInput, StorageGetUrlInput, StorageListInput, StorageRemoveInput, StorageDownloadDataInput, StorageUploadDataInput } from '../../../types';
-import { GetPropertiesOptions, GetUrlOptions, ListAllOptions, ListPaginateOptions, RemoveOptions, DownloadDataOptions, UploadDataOptions } from '../types';
-export type CopyInput = StorageCopyInput;
+import { GetPropertiesOptions, GetUrlOptions, ListAllOptions, ListPaginateOptions, RemoveOptions, DownloadDataOptions, UploadDataOptions, CopyDestinationOptions, CopySourceOptions } from '../types';
+/**
+ * Input type for S3 copy API.
+ */
+export type CopyInput = StorageCopyInput<CopySourceOptions, CopyDestinationOptions>;
+/**
+ * Input type for S3 getProperties API.
+ */
 export type GetPropertiesInput = StorageGetPropertiesInput<GetPropertiesOptions>;
+/**
+ * Input type for S3 getUrl API.
+ */
 export type GetUrlInput = StorageGetUrlInput<GetUrlOptions>;
+/**
+ * Input type for S3 list API. Lists all bucket objects.
+ */
 export type ListAllInput = StorageListInput<ListAllOptions>;
+/**
+ * Input type for S3 list API. Lists bucket objects with pagination.
+ */
 export type ListPaginateInput = StorageListInput<ListPaginateOptions>;
+/**
+ * Input type for S3 remove API.
+ */
 export type RemoveInput = StorageRemoveInput<RemoveOptions>;
+/**
+ * Input type for S3 downloadData API.
+ */
 export type DownloadDataInput = StorageDownloadDataInput<DownloadDataOptions>;
+/**
+ * Input type for S3 uploadData API.
+ */
 export type UploadDataInput = StorageUploadDataInput<UploadDataOptions>;

package/lib-esm/providers/s3/types/options.d.ts

@@ -1,40 +1,52 @@
+import { StorageAccessLevel } from '@aws-amplify/core';
 import { Credentials } from '@aws-sdk/types';
 import { TransferProgressEvent } from '../../../types';
-import { StorageOptions, StorageListAllOptions, StorageListPaginateOptions } from '../../../types/options';
-/**
- * Input options type for S3 Storage operations.
- */
-export type Options = StorageOptions & {
+import { StorageListAllOptions, StorageListPaginateOptions } from '../../../types/options';
+type CommonOptions = {
     /**
      * Whether to use accelerate endpoint.
      * @default false
      */
     useAccelerateEndpoint?: boolean;
 };
+type ReadOptions = {
+    accessLevel?: 'guest' | 'private';
+} | {
+    accessLevel: 'protected';
+    targetIdentityId?: string;
+};
+type WriteOptions = {
+    accessLevel?: StorageAccessLevel;
+};
 /**
- * Input options type for S3 getProperties API.
+ * Transfer-related options type for S3 downloadData, uploadData APIs.
  */
-export type GetPropertiesOptions = Options;
+type TransferOptions = {
+    /**
+     * Callback function tracking the upload/download progress.
+     */
+    onProgress?: (event: TransferProgressEvent) => void;
+};
 /**
  * Input options type for S3 getProperties API.
  */
-export type RemoveOptions = Options;
+export type GetPropertiesOptions = ReadOptions & CommonOptions;
 /**
- * Input options type for S3 list API.
+ * Input options type for S3 getProperties API.
  */
-export type ListAllOptions = StorageListAllOptions;
+export type RemoveOptions = WriteOptions & CommonOptions;
 /**
  * Input options type for S3 list API.
  */
-export type ListPaginateOptions = StorageListPaginateOptions;
+export type ListAllOptions = StorageListAllOptions & ReadOptions & CommonOptions;
 /**
- * Input options type for S3 downloadData API.
+ * Input options type for S3 list API.
  */
-export type DownloadDataOptions = TransferOptions;
+export type ListPaginateOptions = StorageListPaginateOptions & ReadOptions & CommonOptions;
 /**
  * Input options type for S3 getUrl API.
  */
-export type GetUrlOptions = Options & {
+export type GetUrlOptions = ReadOptions & CommonOptions & {
     /**
      * Whether to head object to make sure the object existence before downloading.
      * @default false
@@ -46,7 +58,11 @@ export type GetUrlOptions = Options & {
      */
     expiresIn?: number;
 };
-export type UploadDataOptions = Omit<TransferOptions, 'targetIdentityId'> & {
+/**
+ * Input options type for S3 downloadData API.
+ */
+export type DownloadDataOptions = ReadOptions & CommonOptions & TransferOptions;
+export type UploadDataOptions = WriteOptions & CommonOptions & TransferOptions & {
     /**
      * The default content-disposition header value of the file when downloading it.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
@@ -68,6 +84,12 @@ export type UploadDataOptions = Omit<TransferOptions, 'targetIdentityId'> & {
      */
     metadata?: Record<string, string>;
 };
+export type CopySourceOptions = ReadOptions & {
+    key: string;
+};
+export type CopyDestinationOptions = WriteOptions & {
+    key: string;
+};
 /**
  * Internal only type for S3 API handlers' config parameter.
  *
@@ -80,13 +102,4 @@ export type ResolvedS3Config = {
     forcePathStyle?: boolean;
     useAccelerateEndpoint?: boolean;
 };
-/**
- * Input options type for S3 downloadData, uploadData APIs.
- */
-type TransferOptions = Options & {
-    /**
-     * Callback function tracking the upload/download progress.
-     */
-    onProgress?: (event: TransferProgressEvent) => void;
-};
 export {};

package/lib-esm/providers/s3/types/outputs.d.ts

@@ -1,4 +1,7 @@
 import { StorageDownloadDataOutput, StorageGetUrlOutput, StorageItem, StorageListOutput, DownloadTask, UploadTask } from '../../../types';
+/**
+ * type for S3 item.
+ */
 export interface Item extends StorageItem {
     /**
      * VersionId used to reference a specific version of the object.
@@ -9,14 +12,41 @@ export interface Item extends StorageItem {
      */
     contentType?: string;
 }
+/**
+ * type for S3 list item.
+ */
+export type ListOutputItem = Omit<StorageItem, 'metadata'>;
+/**
+ * Output type for S3 downloadData API.
+ */
 export type DownloadDataOutput = DownloadTask<StorageDownloadDataOutput<Item>>;
+/**
+ * Output type for S3 getUrl API.
+ */
 export type GetUrlOutput = StorageGetUrlOutput;
+/**
+ * Output type for S3 uploadData API.
+ */
 export type UploadDataOutput = UploadTask<Item>;
+/**
+ * Output type for S3 getProperties API.
+ */
 export type GetPropertiesOutput = Item;
-export type ListOutputItem = Omit<StorageItem, 'metadata'>;
+/**
+ * Output type for S3 list API. Lists all bucket objects.
+ */
 export type ListAllOutput = StorageListOutput<ListOutputItem>;
+/**
+ * Output type for S3 list API. Lists bucket objects with pagination.
+ */
 export type ListPaginateOutput = StorageListOutput<ListOutputItem> & {
     nextToken?: string;
 };
+/**
+ * Output type for S3 copy API.
+ */
 export type CopyOutput = Pick<Item, 'key'>;
+/**
+ * Output type for S3 remove API.
+ */
 export type RemoveOutput = Pick<Item, 'key'>;

package/lib-esm/providers/s3/utils/client/abortMultipartUpload.d.ts

@@ -17,7 +17,7 @@ export declare const abortMultipartUpload: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types").Credentials | (() => Promise<import("@aws-sdk/types").Credentials>);
+    credentials: import("@aws-sdk/types").AwsCredentialIdentity | (() => Promise<import("@aws-sdk/types").AwsCredentialIdentity>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/completeMultipartUpload.d.ts

@@ -16,7 +16,7 @@ export declare const completeMultipartUpload: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/copyObject.d.ts

@@ -16,7 +16,7 @@ export declare const copyObject: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/createMultipartUpload.d.ts

@@ -17,7 +17,7 @@ export declare const createMultipartUpload: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/deleteObject.d.ts

@@ -16,7 +16,7 @@ export declare const deleteObject: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/getObject.d.ts

@@ -17,7 +17,7 @@ export declare const getObject: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/headObject.d.ts

@@ -16,7 +16,7 @@ export declare const headObject: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/listObjectsV2.d.ts

@@ -16,7 +16,7 @@ export declare const listObjectsV2: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/listParts.d.ts

@@ -16,7 +16,7 @@ export declare const listParts: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/putObject.d.ts

@@ -16,7 +16,7 @@ export declare const putObject: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/client/uploadPart.d.ts

@@ -16,7 +16,7 @@ export declare const uploadPart: (config: {
     useAccelerateEndpoint?: boolean | undefined;
     uriEscapePath?: boolean | undefined;
 } & {
-    credentials: import("@aws-sdk/types/dist-types/credentials").Credentials | (() => Promise<import("@aws-sdk/types/dist-types/credentials").Credentials>);
+    credentials: import("@aws-amplify/core/internals/aws-client-utils").Credentials | (() => Promise<import("@aws-amplify/core/internals/aws-client-utils").Credentials>);
     maxAttempts?: number | undefined;
     abortSignal?: AbortSignal | undefined;
     region: string;

package/lib-esm/providers/s3/utils/transferTask.js

@@ -2,21 +2,18 @@
 // SPDX-License-Identifier: Apache-2.0
 import { __awaiter, __generator } from "tslib";
 import { isCancelError } from '../../../errors/CanceledError';
-import { TransferTaskState, } from '../../../types/common';
 var createCancellableTask = function (_a) {
     var job = _a.job, onCancel = _a.onCancel;
-    var state = TransferTaskState.IN_PROGRESS;
+    var state = 'IN_PROGRESS';
     var abortErrorOverwriteRecord = undefined;
     var cancelableTask = {
         cancel: function (abortErrorOverwrite) {
             abortErrorOverwriteRecord = abortErrorOverwrite;
             var state = cancelableTask.state;
-            if (state === TransferTaskState.CANCELED ||
-                state === TransferTaskState.ERROR ||
-                state === TransferTaskState.SUCCESS) {
+            if (state === 'CANCELED' || state === 'ERROR' || state === 'SUCCESS') {
                 return;
             }
-            cancelableTask.state = TransferTaskState.CANCELED;
+            cancelableTask.state = 'CANCELED';
             onCancel(abortErrorOverwrite);
         },
         state: state,
@@ -30,15 +27,15 @@ var createCancellableTask = function (_a) {
                     return [4 /*yield*/, job()];
                 case 1:
                     result = _a.sent();
-                    cancelableTask.state = TransferTaskState.SUCCESS;
+                    cancelableTask.state = 'SUCCESS';
                     return [2 /*return*/, result];
                 case 2:
                     e_1 = _a.sent();
                     if (isCancelError(e_1)) {
-                        cancelableTask.state = TransferTaskState.CANCELED;
+                        cancelableTask.state = 'CANCELED';
                         throw abortErrorOverwriteRecord !== null && abortErrorOverwriteRecord !== void 0 ? abortErrorOverwriteRecord : e_1;
                     }
-                    cancelableTask.state = TransferTaskState.ERROR;
+                    cancelableTask.state = 'ERROR';
                     throw e_1;
                 case 3: return [2 /*return*/];
             }
@@ -58,20 +55,20 @@ export var createUploadTask = function (_a) {
     var uploadTask = Object.assign(cancellableTask, {
         pause: function () {
             var state = uploadTask.state;
-            if (!isMultipartUpload || state !== TransferTaskState.IN_PROGRESS) {
+            if (!isMultipartUpload || state !== 'IN_PROGRESS') {
                 return;
             }
             // @ts-ignore
-            uploadTask.state = TransferTaskState.PAUSED;
+            uploadTask.state = 'PAUSED';
             onPause === null || onPause === void 0 ? void 0 : onPause();
         },
         resume: function () {
             var state = uploadTask.state;
-            if (!isMultipartUpload || state !== TransferTaskState.PAUSED) {
+            if (!isMultipartUpload || state !== 'PAUSED') {
                 return;
             }
             // @ts-ignore
-            uploadTask.state = TransferTaskState.IN_PROGRESS;
+            uploadTask.state = 'IN_PROGRESS';
             onResume === null || onResume === void 0 ? void 0 : onResume();
         },
     });