@aws-amplify/storage 5.9.22 → 5.9.24

package/src/types/AWSS3Provider.ts

@@ -19,6 +19,11 @@ import { UploadTask } from './Provider';
 
 type ListObjectsCommandOutputContent = _Object;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface FileMetadata {
 	bucket: string;
 	fileName: string;
@@ -28,6 +33,11 @@ export interface FileMetadata {
 	uploadId: string;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type CommonStorageOptions = Omit<
 	StorageOptions,
 	| 'credentials'
@@ -36,6 +46,11 @@ export type CommonStorageOptions = Omit<
 	| 'dangerouslyConnectToHttpEndpointForTesting'
 >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderGetConfig = CommonStorageOptions & {
 	download?: boolean;
 	track?: boolean;
@@ -55,6 +70,11 @@ export type S3ProviderGetConfig = CommonStorageOptions & {
 	validateObjectExistence?: boolean;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderGetPropertiesConfig = CommonStorageOptions & {
 	SSECustomerAlgorithm?: HeadObjectInput['SSECustomerAlgorithm'];
 	SSECustomerKey?: HeadObjectInput['SSECustomerKey'];
@@ -62,6 +82,11 @@ export type S3ProviderGetPropertiesConfig = CommonStorageOptions & {
 	SSECustomerKeyMD5?: HeadObjectInput['SSECustomerKeyMD5'];
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderGetOuput<T> = T extends { download: true }
 	? GetObjectOutput
 	: string;
@@ -89,6 +114,11 @@ type _S3ProviderPutConfig = {
 	resumable?: boolean;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type ResumableUploadConfig = {
 	resumable: true;
 	progressCallback?: (progress: UploadTaskProgressEvent) => any;
@@ -104,6 +134,9 @@ export type ResumableUploadConfig = {
  * Usage of this parameter is not considered a recommended practice:
  *  {@link https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html}
  *
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export type S3ProviderPutConfig = CommonStorageOptions &
 	(
@@ -112,19 +145,39 @@ export type S3ProviderPutConfig = CommonStorageOptions &
 		| (_S3ProviderPutConfig & ResumableUploadConfig)
 	);
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderRemoveConfig = CommonStorageOptions & {
 	bucket?: string;
 	provider?: 'AWSS3';
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderListOutput = {
 	results: S3ProviderListOutputItem[];
 	nextToken?: string;
 	hasNextToken: boolean;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderRemoveOutput = DeleteObjectOutput;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderListConfig = CommonStorageOptions & {
 	bucket?: string;
 	pageSize?: number | 'ALL';
@@ -133,10 +186,20 @@ export type S3ProviderListConfig = CommonStorageOptions & {
 	nextToken?: string;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ClientOptions = StorageOptions & {
 	credentials: ICredentials;
 } & S3ProviderListConfig;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface S3ProviderListOutputItem {
 	key: ListObjectsCommandOutputContent['Key'];
 	eTag: ListObjectsCommandOutputContent['ETag'];
@@ -144,14 +207,29 @@ export interface S3ProviderListOutputItem {
 	size: ListObjectsCommandOutputContent['Size'];
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface S3CopyTarget {
 	key: string;
 	level?: StorageAccessLevel;
 	identityId?: string;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3CopySource = S3CopyTarget;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3CopyDestination = Omit<S3CopyTarget, 'identityId'>;
 
 /**
@@ -162,6 +240,9 @@ export type S3CopyDestination = Omit<S3CopyTarget, 'identityId'>;
  * Usage of this parameter is not considered a recommended practice:
  *  {@link https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html}
  *
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export type S3ProviderCopyConfig = Omit<CommonStorageOptions, 'level'> & {
 	provider?: 'AWSS3';
@@ -182,10 +263,20 @@ export type S3ProviderCopyConfig = Omit<CommonStorageOptions, 'level'> & {
 	SSEKMSKeyId?: CopyObjectInput['SSEKMSKeyId'];
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderCopyOutput = {
 	key: string;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderGetPropertiesOutput = {
 	contentType: string;
 	contentLength: number;
@@ -194,10 +285,20 @@ export type S3ProviderGetPropertiesOutput = {
 	metadata: Record<string, string>;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type PutResult = {
 	key: string;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type S3ProviderPutOutput<T> = T extends { resumable: true }
 	? UploadTask
 	: Promise<PutResult>;

package/src/types/Provider.ts

@@ -10,6 +10,11 @@ import {
 // CAUTION: The StorageProvider interface is publicly available and allows customers to implement their own custom
 // storage providers. Exercise caution when modifying this class as additive changes to this interface can break
 // customers when not marked as optional.
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface StorageProvider {
 	// you need to implement those methods
 
@@ -48,6 +53,11 @@ export interface StorageProvider {
 	getProviderName(): string;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface UploadTask {
 	resume(): any;
 	pause(): any;
@@ -55,6 +65,11 @@ export interface UploadTask {
 	isInProgress: boolean;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface StorageProviderWithCopy extends StorageProvider {
 	// copy object from src to dest
 	copy(
@@ -64,10 +79,20 @@ export interface StorageProviderWithCopy extends StorageProvider {
 	): Promise<any>;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface StorageProviderWithGetProperties extends StorageProvider {
 	getProperties(key: string, options?): Promise<Object>;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageProviderApi =
 	| 'copy'
 	| 'get'

package/src/types/Storage.ts

@@ -31,6 +31,11 @@ type Last<T extends any[]> = T[Exclude<keyof T, keyof Tail<T>>];
 // Utility type to extract the last parameter type of a function
 type LastParameter<F extends (...args: any) => any> = Last<Parameters<F>>;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface StorageOptions {
 	credentials?: ICredentials;
 	region?: string;
@@ -50,20 +55,45 @@ export interface StorageOptions {
 	dangerouslyConnectToHttpEndpointForTesting?: boolean;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageAccessLevel = 'public' | 'protected' | 'private';
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type CustomPrefix = {
 	[key in StorageAccessLevel]?: string;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageCopyTarget = {
 	key: string;
 	level?: string;
 	identityId?: string;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageCopySource = StorageCopyTarget;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageCopyDestination = Omit<StorageCopyTarget, 'identityId'>;
 
 /**
@@ -94,6 +124,11 @@ type StorageOperationConfig<
 			provider: ReturnType<T['getProviderName']>;
 	  };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageGetConfig<T extends Record<string, any>> =
 	T extends StorageProvider
 		? StorageOperationConfig<T, 'get'>
@@ -102,6 +137,11 @@ export type StorageGetConfig<T extends Record<string, any>> =
 				T
 		  >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageGetPropertiesConfig<T extends Record<string, any>> =
 	T extends StorageProviderWithGetProperties
 		? StorageOperationConfig<T, 'getProperties'>
@@ -110,6 +150,11 @@ export type StorageGetPropertiesConfig<T extends Record<string, any>> =
 				T
 		  >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StoragePutConfig<T extends Record<string, any>> =
 	T extends StorageProvider
 		? StorageOperationConfig<T, 'put'>
@@ -118,6 +163,11 @@ export type StoragePutConfig<T extends Record<string, any>> =
 				T
 		  >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageRemoveConfig<T extends Record<string, any>> =
 	T extends StorageProvider
 		? StorageOperationConfig<T, 'remove'>
@@ -126,6 +176,11 @@ export type StorageRemoveConfig<T extends Record<string, any>> =
 				T
 		  >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageListConfig<T extends Record<string, any>> =
 	T extends StorageProvider
 		? StorageOperationConfig<T, 'list'>
@@ -134,6 +189,11 @@ export type StorageListConfig<T extends Record<string, any>> =
 				T
 		  >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageCopyConfig<T extends Record<string, any>> =
 	T extends StorageProviderWithCopy
 		? StorageOperationConfig<T, 'copy'>
@@ -168,33 +228,63 @@ type PickProviderOutput<
 		: Promise<any>
 	: DefaultOutput;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageGetOutput<T extends StorageProvider | Record<string, any>> =
 	PickProviderOutput<Promise<S3ProviderGetOuput<T>>, T, 'get'>;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StoragePutOutput<T> = PickProviderOutput<
 	S3ProviderPutOutput<T>,
 	T,
 	'put'
 >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageRemoveOutput<T> = PickProviderOutput<
 	Promise<S3ProviderRemoveOutput>,
 	T,
 	'remove'
 >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageListOutput<T> = PickProviderOutput<
 	Promise<S3ProviderListOutput>,
 	T,
 	'list'
 >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageCopyOutput<T> = PickProviderOutput<
 	Promise<S3ProviderCopyOutput>,
 	T,
 	'copy'
 >;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export type StorageGetPropertiesOutput<T> = PickProviderOutput<
 	Promise<S3ProviderGetPropertiesOutput>,
 	T,
@@ -204,6 +294,9 @@ export type StorageGetPropertiesOutput<T> = PickProviderOutput<
 /**
  * Utility type to allow custom provider to use any config keys, if provider is set to AWSS3 then it should use
  * AWSS3Provider's config.
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export type StorageOperationConfigMap<
 	Default,