@aws-amplify/storage 6.0.20 → 6.0.21-gen2-storage.7da2b89.0

package/src/types/inputs.ts

@@ -1,25 +1,58 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { StrictUnion } from '@aws-amplify/core/internals/utils';
+
 import {
 	StorageListAllOptions,
 	StorageListPaginateOptions,
 	StorageOptions,
 } from './options';
 
-export interface StorageOperationInput<Options extends StorageOptions> {
+// TODO: rename to StorageOperationInput once the other type with
+// the same named is removed
+export type StorageOperationInputType = StrictUnion<
+	StorageOperationInputKey | StorageOperationInputPath
+>;
+
+/** @deprecated Use {@link StorageOperationInputPath} instead. */
+export interface StorageOperationInputKey {
+	/** @deprecated Use `path` instead. */
 	key: string;
+}
+export interface StorageOperationInputPath {
+	path: string | (({ identityId }: { identityId?: string }) => string);
+}
+export interface StorageOperationOptionsInput<Options> {
 	options?: Options;
 }
 
-export type StorageGetPropertiesInput<Options extends StorageOptions> =
-	StorageOperationInput<Options>;
+/** @deprecated Use {@link StorageDownloadDataInputPath} instead. */
+export type StorageDownloadDataInputKey<Options extends StorageOptions> =
+	StorageOperationInputKey & StorageOperationOptionsInput<Options>;
 
-export interface StorageRemoveInput<Options extends StorageOptions> {
+export type StorageDownloadDataInputPath<Options> = StorageOperationInputPath &
+	StorageOperationOptionsInput<Options>;
+
+// TODO: This needs to be removed after refactor of all storage APIs
+export interface StorageOperationInput<Options extends StorageOptions> {
 	key: string;
 	options?: Options;
 }
 
+/** @deprecated Use {@link StorageGetPropertiesInputPath} instead. */
+export type StorageGetPropertiesInputKey<Options extends StorageOptions> =
+	StorageOperationInputKey & StorageOperationInput<Options>;
+
+export type StorageGetPropertiesInputPath<Options> = StorageOperationInputPath &
+	StorageOperationOptionsInput<Options>;
+
+export type StorageRemoveInputKey<Options> = StorageOperationInputKey &
+	StorageOperationOptionsInput<Options>;
+
+export type StorageRemoveInputPath<Options> = StorageOperationInputPath &
+	StorageOperationOptionsInput<Options>;
+
 export interface StorageListInput<
 	Options extends StorageListAllOptions | StorageListPaginateOptions,
 > {
@@ -27,23 +60,40 @@ export interface StorageListInput<
 	options?: Options;
 }
 
-export type StorageGetUrlInput<Options extends StorageOptions> =
-	StorageOperationInput<Options>;
+/** @deprecated Use {@link StorageGetUrlInputPath} instead. */
+export type StorageGetUrlInputKey<Options extends StorageOptions> =
+	StorageOperationInputKey & StorageOperationInput<Options>;
 
-export type StorageDownloadDataInput<Options extends StorageOptions> =
-	StorageOperationInput<Options>;
+export type StorageGetUrlInputPath<Options> = StorageOperationInputPath &
+	StorageOperationOptionsInput<Options>;
 
 export type StorageUploadDataInput<Options extends StorageOptions> =
 	StorageOperationInput<Options> & {
 		data: StorageUploadDataPayload;
 	};
 
-export interface StorageCopyInput<
+/** @deprecated Use {@link StorageCopyInputPath} instead. */
+export interface StorageCopyInputKey<
 	SourceOptions extends StorageOptions,
 	DestinationOptions extends StorageOptions,
 > {
-	source: SourceOptions;
-	destination: DestinationOptions;
+	source: SourceOptions & {
+		path?: never;
+	};
+	destination: DestinationOptions & {
+		path?: never;
+	};
+}
+
+export interface StorageCopyInputPath {
+	source: StorageOperationInputPath & {
+		/** @deprecated Use path instead. */
+		key?: never;
+	};
+	destination: StorageOperationInputPath & {
+		/** @deprecated Use path instead. */
+		key?: never;
+	};
 }
 
 /**

package/src/types/options.ts

@@ -4,6 +4,7 @@
 import { StorageAccessLevel } from '@aws-amplify/core';
 
 export interface StorageOptions {
+	/** @deprecated This may be removed in the next major version. */
 	accessLevel?: StorageAccessLevel;
 }
 

package/src/types/outputs.ts

@@ -3,11 +3,10 @@
 
 import { ResponseBodyMixin } from '@aws-amplify/core/internals/aws-client-utils';
 
-export interface StorageItem {
-	/**
-	 * Key of the object
-	 */
-	key: string;
+/**
+ * Base type for a storage item.
+ */
+export interface StorageItemBase {
 	/**
 	 * Creation date of the object.
 	 */
@@ -28,7 +27,27 @@ export interface StorageItem {
 	metadata?: Record<string, string>;
 }
 
-export type StorageDownloadDataOutput<T extends StorageItem> = T & {
+/** @deprecated Use {@link StorageItemPath} instead. */
+export type StorageItemKey = StorageItemBase & {
+	/**
+	 * Key of the object.
+	 */
+	key: string;
+};
+
+export type StorageItemPath = StorageItemBase & {
+	/**
+	 * Path of the object.
+	 */
+	path: string;
+};
+
+/**
+ * A storage item can be identified either by a key or a path.
+ */
+export type StorageItem = StorageItemKey | StorageItemPath;
+
+export type StorageDownloadDataOutput<Item extends StorageItem> = Item & {
 	body: ResponseBodyMixin;
 };