chore(storage): extract isInputWithPath into separate file (#13114)

* fix: extract isInputWithPath into separate file * chore: add unit test * Update packages/storage/__tests__/providers/s3/apis/utils/isInputWithPath.test.ts Co-authored-by: ashika112 <155593080+ashika112@users.noreply.github.com> * Update packages/storage/__tests__/providers/s3/apis/utils/isInputWithPath.test.ts * address feedback --------- Co-authored-by: Ashwin Kumar <ashwsrir@amazon.com> Co-authored-by: ashika112 <155593080+ashika112@users.noreply.github.com>
aws-amplify · Mar 13, 2024 · 1a1e0f4 · 1a1e0f4
1 parent e882c68
commit 1a1e0f4
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 12 deletions.
diff --git a/packages/storage/__tests__/providers/s3/apis/utils/isInputWithPath.test.ts b/packages/storage/__tests__/providers/s3/apis/utils/isInputWithPath.test.ts
@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { isInputWithPath } from '../../../../../src/providers/s3/utils';
+
+describe('isInputWithPath', () => {
+	it('should return true if input contains path', async () => {
+		expect(isInputWithPath({ path: '' })).toBe(true);
+	});
+	it('should return false if input does not contain path', async () => {
+		expect(isInputWithPath({ key: '' })).toBe(false);
+	});
+});
diff --git a/packages/storage/src/providers/s3/utils/index.ts b/packages/storage/src/providers/s3/utils/index.ts
@@ -5,3 +5,4 @@ export { calculateContentMd5 } from './md5';
 export { resolveS3ConfigAndInput } from './resolveS3ConfigAndInput';
 export { createDownloadTask, createUploadTask } from './transferTask';
 export { validateStorageOperationInput } from './validateStorageOperationInput';
+export { isInputWithPath } from './isInputWithPath';
diff --git a/packages/storage/src/providers/s3/utils/isInputWithPath.ts b/packages/storage/src/providers/s3/utils/isInputWithPath.ts
@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	StorageOperationInputPath,
+	StorageOperationInputType,
+} from '../../../types/inputs';
+
+export const isInputWithPath = (
+	input: StorageOperationInputType,
+): input is StorageOperationInputPath => {
+	return input.path !== undefined;
+};
diff --git a/packages/storage/src/providers/s3/utils/validateStorageOperationInput.ts b/packages/storage/src/providers/s3/utils/validateStorageOperationInput.ts
@@ -1,23 +1,13 @@
 // 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 {
-	StorageOperationInputKey,
-	StorageOperationInputPath,
-} from '../../../types/inputs';
+import { StorageOperationInputType as Input } from '../../../types/inputs';
 import { assertValidationError } from '../../../errors/utils/assertValidationError';
 import { StorageValidationErrorCode } from '../../../errors/types/validation';
 
+import { isInputWithPath } from './isInputWithPath';
 import { STORAGE_INPUT_KEY, STORAGE_INPUT_PATH } from './constants';
 
-type Input = StrictUnion<StorageOperationInputKey | StorageOperationInputPath>;
-
-const isInputWithPath = (input: Input): input is StorageOperationInputPath => {
-	return input.path !== undefined;
-};
-
 export const validateStorageOperationInput = (
 	input: Input,
 	identityId?: string,

diff --git a/packages/storage/src/types/inputs.ts b/packages/storage/src/types/inputs.ts
@@ -1,12 +1,20 @@
 // 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';
 
+// 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. */