@aws-amplify/storage 4.5.14 → 4.5.15-unstable.2

package/src/providers/AWSS3Provider.ts

@@ -1,22 +1,12 @@
-/*
- * Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import {
 	ConsoleLogger as Logger,
 	Credentials,
-	Parser,
 	ICredentials,
 	StorageHelper,
 	Hub,
+	parseAWSExports,
 } from '@aws-amplify/core';
 import {
 	S3Client,
@@ -45,7 +35,6 @@ import {
 	S3ProviderGetOuput,
 	S3ProviderPutConfig,
 	S3ProviderRemoveConfig,
-	S3ProviderListOutput,
 	S3ProviderListConfig,
 	S3ProviderCopyConfig,
 	S3ProviderCopyOutput,
@@ -58,6 +47,7 @@ import {
 	ResumableUploadConfig,
 	UploadTask,
 	S3ClientOptions,
+	S3ProviderListOutput,
 } from '../types';
 import { StorageErrorStrings } from '../common/StorageErrorStrings';
 import { dispatchStorageEvent } from '../common/StorageUtils';
@@ -69,7 +59,6 @@ import {
 	autoAdjustClockskewMiddlewareOptions,
 	createS3Client,
 } from '../common/S3ClientUtils';
-import { S3ProviderListOutputWithToken } from '.././types/AWSS3Provider';
 import { AWSS3ProviderManagedUpload } from './AWSS3ProviderManagedUpload';
 import { AWSS3UploadTask, TaskEvents } from './AWSS3UploadTask';
 import { UPLOADS_STORAGE_KEY } from '../common/StorageConstants';
@@ -138,7 +127,7 @@ export class AWSS3Provider implements StorageProvider {
 	public configure(config?): object {
 		logger.debug('configure Storage', config);
 		if (!config) return this._config;
-		const amplifyConfig = Parser.parseMobilehubConfig(config);
+		const amplifyConfig = parseAWSExports(config);
 		this._config = Object.assign({}, this._config, amplifyConfig.Storage);
 		if (!this._config.bucket) {
 			logger.debug('Do not have bucket yet');
@@ -685,16 +674,16 @@ export class AWSS3Provider implements StorageProvider {
 		params: ListObjectsV2Request,
 		opt: S3ClientOptions,
 		prefix: string
-	): Promise<S3ProviderListOutputWithToken> {
-		const result: S3ProviderListOutputWithToken = {
-			contents: [],
-			nextToken: '',
+	): Promise<S3ProviderListOutput> {
+		const list: S3ProviderListOutput = {
+			results: [],
+			hasNextToken: false,
 		};
 		const s3 = this._createNewS3Client(opt);
 		const listObjectsV2Command = new ListObjectsV2Command({ ...params });
 		const response = await s3.send(listObjectsV2Command);
 		if (response && response.Contents) {
-			result.contents = response.Contents.map(item => {
+			list.results = response.Contents.map(item => {
 				return {
 					key: item.Key.substr(prefix.length),
 					eTag: item.ETag,
@@ -702,17 +691,18 @@ export class AWSS3Provider implements StorageProvider {
 					size: item.Size,
 				};
 			});
-			result.nextToken = response.NextContinuationToken;
+			list.nextToken = response.NextContinuationToken;
+			list.hasNextToken = response.IsTruncated;
 		}
-		return result;
+		return list;
 	}
 
 	/**
 	 * List bucket objects relative to the level and prefix specified
 	 * @param {string} path - the path that contains objects
 	 * @param {S3ProviderListConfig} [config] - Optional configuration for the underlying S3 command
-	 * @return {Promise<S3ProviderListOutput>} - Promise resolves to list of keys, eTags, lastModified and file size for
-	 * all objects in path
+	 * @return {Promise<S3ProviderListOutput>} - Promise resolves to list of keys, eTags, lastModified
+	 * and file size for all objects in path
 	 */
 	public async list(
 		path: string,
@@ -723,49 +713,55 @@ export class AWSS3Provider implements StorageProvider {
 			throw new Error(StorageErrorStrings.NO_CREDENTIALS);
 		}
 		const opt: S3ClientOptions = Object.assign({}, this._config, config);
-		const { bucket, track, maxKeys } = opt;
+		const { bucket, track, pageSize, nextToken } = opt;
 		const prefix = this._prefix(opt);
 		const final_path = prefix + path;
 		logger.debug('list ' + path + ' from ' + final_path);
 		try {
-			const list: S3ProviderListOutput = [];
-			let token: string;
-			let listResult: S3ProviderListOutputWithToken;
+			const list: S3ProviderListOutput = {
+				results: [],
+				hasNextToken: false,
+			};
+			const MAX_PAGE_SIZE = 1000;
+			let listResult: S3ProviderListOutput;
 			const params: ListObjectsV2Request = {
 				Bucket: bucket,
 				Prefix: final_path,
-				MaxKeys: 1000,
+				MaxKeys: MAX_PAGE_SIZE,
+				ContinuationToken: nextToken,
 			};
-			if (maxKeys === 'ALL') {
+			params.ContinuationToken = nextToken;
+			if (pageSize === 'ALL') {
 				do {
-					params.ContinuationToken = token;
-					params.MaxKeys = 1000;
 					listResult = await this._list(params, opt, prefix);
-					list.push(...listResult.contents);
-					if (listResult.nextToken) token = listResult.nextToken;
+					list.results.push(...listResult.results);
+					if (listResult.nextToken)
+						params.ContinuationToken = listResult.nextToken;
 				} while (listResult.nextToken);
 			} else {
-				maxKeys < 1000 || typeof maxKeys === 'string'
-					? (params.MaxKeys = maxKeys)
-					: (params.MaxKeys = 1000);
+				if (
+					pageSize &&
+					pageSize <= MAX_PAGE_SIZE &&
+					typeof pageSize === 'number'
+				)
+					params.MaxKeys = pageSize;
+				else logger.warn(`pageSize should be from 0 - ${MAX_PAGE_SIZE}.`);
 				listResult = await this._list(params, opt, prefix);
-				list.push(...listResult.contents);
-				if (maxKeys > 1000)
-					logger.warn(
-						"maxkeys can be from 0 - 1000 or 'ALL'. To list all files you can set maxKeys to 'ALL'."
-					);
+				list.results.push(...listResult.results);
+				list.hasNextToken = listResult.hasNextToken;
+				list.nextToken = null ?? listResult.nextToken;
 			}
 			dispatchStorageEvent(
 				track,
 				'list',
 				{ method: 'list', result: 'success' },
 				null,
-				`${list.length} items returned from list operation`
+				`${list.results.length} items returned from list operation`
 			);
 			logger.debug('list', list);
 			return list;
 		} catch (error) {
-			logger.warn('list error', error);
+			logger.error('list InvalidArgument', error);
 			dispatchStorageEvent(
 				track,
 				'list',
@@ -851,8 +847,3 @@ export class AWSS3Provider implements StorageProvider {
 		return s3client;
 	}
 }
-
-/**
- * @deprecated use named import
- */
-export default AWSS3Provider;

package/src/providers/AWSS3ProviderManagedUpload.ts

@@ -1,15 +1,5 @@
-/*
- * Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
 import { ConsoleLogger as Logger } from '@aws-amplify/core';
 import {

package/src/providers/axios-http-handler.ts

@@ -1,15 +1,5 @@
-/*
- * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
 import { HttpHandlerOptions } from '@aws-sdk/types';
 import { HttpHandler, HttpRequest, HttpResponse } from '@aws-sdk/protocol-http';

package/src/types/AWSS3Provider.ts

@@ -95,18 +95,20 @@ export type S3ProviderRemoveConfig = CommonStorageOptions & {
 	provider?: 'AWSS3';
 };
 
-export type S3ProviderListOutputWithToken = {
-	contents: S3ProviderListOutputItem[];
-	nextToken: string;
+export type S3ProviderListOutput = {
+	results: S3ProviderListOutputItem[];
+	nextToken?: string;
+	hasNextToken: boolean;
 };
 
 export type S3ProviderRemoveOutput = DeleteObjectCommandOutput;
 
 export type S3ProviderListConfig = CommonStorageOptions & {
 	bucket?: string;
-	maxKeys?: number | 'ALL';
+	pageSize?: number | 'ALL';
 	provider?: 'AWSS3';
 	identityId?: string;
+	nextToken?: string;
 };
 
 export type S3ClientOptions = StorageOptions & {
@@ -120,8 +122,6 @@ export interface S3ProviderListOutputItem {
 	size: ListObjectsCommandOutputContent['Size'];
 }
 
-export type S3ProviderListOutput = S3ProviderListOutputItem[];
-
 export interface S3CopyTarget {
 	key: string;
 	level?: StorageAccessLevel;

package/src/types/Provider.ts

@@ -1,16 +1,6 @@
 import { StorageCopySource, StorageCopyDestination } from './Storage';
-/*
- * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export interface StorageProvider {
 	// you need to implement those methods
 

package/src/types/Storage.ts

@@ -1,15 +1,5 @@
-/*
- * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * Storage instance options
  */

package/src/types/index.ts

@@ -1,15 +1,5 @@
-/*
- * Copyright 2017-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 
 export * from './Storage';
 export * from './Provider';

package/build.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const build = require('../../scripts/build');
-
-build(process.argv[2], process.argv[3]);