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

package/src/providers/s3/utils/validateStorageOperationInputWithPrefix.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	StorageOperationInputWithPath,
+	StorageOperationInputWithPrefixPath,
+} from '../../../types/inputs';
+import { assertValidationError } from '../../../errors/utils/assertValidationError';
+import { StorageValidationErrorCode } from '../../../errors/types/validation';
+
+import { STORAGE_INPUT_PATH, STORAGE_INPUT_PREFIX } from './constants';
+
+// Local assertion function with StorageOperationInputWithPrefixPath as Input
+const _isInputWithPath = (
+	input: StorageOperationInputWithPrefixPath,
+): input is StorageOperationInputWithPath => {
+	return input.path !== undefined;
+};
+
+export const validateStorageOperationInputWithPrefix = (
+	input: StorageOperationInputWithPrefixPath,
+	identityId?: string,
+) => {
+	// Validate prefix & path not present at the same time
+	assertValidationError(
+		!(input.prefix && input.path),
+		StorageValidationErrorCode.InvalidStorageOperationPrefixInput,
+	);
+	if (_isInputWithPath(input)) {
+		const { path } = input;
+		const objectKey = typeof path === 'string' ? path : path({ identityId });
+
+		// Assert on no leading slash in the path parameter
+		assertValidationError(
+			!objectKey.startsWith('/'),
+			StorageValidationErrorCode.InvalidStoragePathInput,
+		);
+
+		return {
+			inputType: STORAGE_INPUT_PATH,
+			objectKey,
+		};
+	} else {
+		return { inputType: STORAGE_INPUT_PREFIX, objectKey: input.prefix ?? '' };
+	}
+};

package/src/types/index.ts

@@ -8,14 +8,20 @@ export {
 	UploadTask,
 } from './common';
 export {
-	StorageOperationInput,
-	StorageListInput,
-	StorageGetPropertiesInput,
-	StorageRemoveInput,
-	StorageDownloadDataInput,
-	StorageUploadDataInput,
-	StorageCopyInput,
-	StorageGetUrlInput,
+	StorageGetPropertiesInputWithKey,
+	StorageGetPropertiesInputWithPath,
+	StorageListInputWithPrefix,
+	StorageListInputWithPath,
+	StorageRemoveInputWithPath,
+	StorageRemoveInputWithKey,
+	StorageDownloadDataInputWithKey,
+	StorageDownloadDataInputWithPath,
+	StorageUploadDataInputWithKey,
+	StorageUploadDataInputWithPath,
+	StorageCopyInputWithKey,
+	StorageCopyInputWithPath,
+	StorageGetUrlInputWithKey,
+	StorageGetUrlInputWithPath,
 	StorageUploadDataPayload,
 } from './inputs';
 export {
@@ -26,6 +32,8 @@ export {
 } from './options';
 export {
 	StorageItem,
+	StorageItemWithKey,
+	StorageItemWithPath,
 	StorageListOutput,
 	StorageDownloadDataOutput,
 	StorageGetUrlOutput,

package/src/types/inputs.ts

@@ -1,44 +1,88 @@
 // 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> {
+export type StorageOperationInput = StrictUnion<
+	StorageOperationInputWithKey | StorageOperationInputWithPath
+>;
+export type StorageOperationInputWithPrefixPath = StrictUnion<
+	StorageOperationInputWithPath | StorageOperationInputWithPrefix
+>;
+/** @deprecated Use {@link StorageOperationInputWithPath} instead. */
+export interface StorageOperationInputWithKey {
+	/** @deprecated Use `path` instead. */
 	key: string;
-	options?: Options;
+}
+export interface StorageOperationInputWithPath {
+	path: string | (({ identityId }: { identityId?: string }) => string);
 }
 
-export type StorageGetPropertiesInput<Options extends StorageOptions> =
-	StorageOperationInput<Options>;
+/** @deprecated Use {@link StorageOperationInputWithPath} instead. */
+export interface StorageOperationInputWithPrefix {
+	/** @deprecated Use `path` instead. */
+	prefix?: string;
+}
 
-export interface StorageRemoveInput<Options extends StorageOptions> {
-	key: string;
+export interface StorageOperationOptionsInput<Options> {
 	options?: Options;
 }
 
-export interface StorageListInput<
+/** @deprecated Use {@link StorageDownloadDataInputWithPath} instead. */
+export type StorageDownloadDataInputWithKey<Options extends StorageOptions> =
+	StorageOperationInputWithKey & StorageOperationOptionsInput<Options>;
+
+export type StorageDownloadDataInputWithPath<Options> =
+	StorageOperationInputWithPath & StorageOperationOptionsInput<Options>;
+
+/** @deprecated Use {@link StorageGetPropertiesInputWithPath} instead. */
+export type StorageGetPropertiesInputWithKey<Options extends StorageOptions> =
+	StorageOperationInputWithKey & StorageOperationOptionsInput<Options>;
+
+export type StorageGetPropertiesInputWithPath<Options> =
+	StorageOperationInputWithPath & StorageOperationOptionsInput<Options>;
+
+export type StorageRemoveInputWithKey<Options> = StorageOperationInputWithKey &
+	StorageOperationOptionsInput<Options>;
+
+export type StorageRemoveInputWithPath<Options> =
+	StorageOperationInputWithPath & StorageOperationOptionsInput<Options>;
+
+/** @deprecated Use {@link StorageListInputWithPath} instead. */
+export type StorageListInputWithPrefix<
 	Options extends StorageListAllOptions | StorageListPaginateOptions,
-> {
-	prefix?: string;
-	options?: Options;
-}
+> = StorageOperationInputWithPrefix & StorageOperationOptionsInput<Options>;
+
+export type StorageListInputWithPath<
+	Options extends StorageListAllOptions | StorageListPaginateOptions,
+> = StorageOperationInputWithPath & StorageOperationOptionsInput<Options>;
 
-export type StorageGetUrlInput<Options extends StorageOptions> =
-	StorageOperationInput<Options>;
+/** @deprecated Use {@link StorageGetUrlInputWithPath} instead. */
+export type StorageGetUrlInputWithKey<Options extends StorageOptions> =
+	StorageOperationInputWithKey & StorageOperationOptionsInput<Options>;
 
-export type StorageDownloadDataInput<Options extends StorageOptions> =
-	StorageOperationInput<Options>;
+export type StorageGetUrlInputWithPath<Options> =
+	StorageOperationInputWithPath & StorageOperationOptionsInput<Options>;
 
-export type StorageUploadDataInput<Options extends StorageOptions> =
-	StorageOperationInput<Options> & {
-		data: StorageUploadDataPayload;
-	};
+/** @deprecated Use {@link StorageUploadDataInputWithPath} instead. */
+export type StorageUploadDataInputWithKey<Options extends StorageOptions> =
+	StorageOperationInputWithKey &
+		StorageOperationOptionsInput<Options> &
+		StorageUploadDataInputPayload;
 
-export interface StorageCopyInput<
+export type StorageUploadDataInputWithPath<Options> =
+	StorageOperationInputWithPath &
+		StorageOperationOptionsInput<Options> &
+		StorageUploadDataInputPayload;
+
+/** @deprecated Use {@link StorageCopyInputWithPath} instead. */
+export interface StorageCopyInputWithKey<
 	SourceOptions extends StorageOptions,
 	DestinationOptions extends StorageOptions,
 > {
@@ -46,6 +90,11 @@ export interface StorageCopyInput<
 	destination: DestinationOptions;
 }
 
+export interface StorageCopyInputWithPath {
+	source: StorageOperationInputWithPath;
+	destination: StorageOperationInputWithPath;
+}
+
 /**
  * The data payload type for upload operation.
  */
@@ -54,3 +103,7 @@ export type StorageUploadDataPayload =
 	| ArrayBufferView
 	| ArrayBuffer
 	| string;
+
+export interface StorageUploadDataInputPayload {
+	data: StorageUploadDataPayload;
+}

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,28 @@ export interface StorageItem {
 	metadata?: Record<string, string>;
 }
 
-export type StorageDownloadDataOutput<T extends StorageItem> = T & {
+/** @deprecated Use {@link StorageItemWithPath} instead. */
+export type StorageItemWithKey = StorageItemBase & {
+	/**
+	 * @deprecated This may be removed in next major version.
+	 * Key of the object.
+	 */
+	key: string;
+};
+
+export type StorageItemWithPath = StorageItemBase & {
+	/**
+	 * Path of the object.
+	 */
+	path: string;
+};
+
+/**
+ * A storage item can be identified either by a key or a path.
+ */
+export type StorageItem = StorageItemWithKey | StorageItemWithPath;
+
+export type StorageDownloadDataOutput<Item extends StorageItem> = Item & {
 	body: ResponseBodyMixin;
 };
 
@@ -46,5 +66,8 @@ export interface StorageGetUrlOutput {
 export type StorageUploadOutput<Item extends StorageItem> = Item;
 
 export interface StorageListOutput<Item extends StorageItem> {
+	/**
+	 * List of items returned by the list API.
+	 */
 	items: Item[];
 }