@aws-amplify/storage 5.6.4-api-v6.25 → 5.6.4-api-v6-models.34

package/internals/package.json

@@ -0,0 +1,8 @@
+{
+	"name": "@aws-amplify/storage/internals",
+	"types": "../lib-esm/internals/index.d.ts",
+	"main": "../lib/internals/index.js",
+	"module": "../lib-esm/internals/index.js",
+	"react-native": "../lib-esm/internals/index.js",
+	"sideEffects": false
+}

package/lib/Storage.d.ts

@@ -1,54 +1,14 @@
 import { StorageCopySource, StorageCopyDestination, StorageGetConfig, StorageProvider, StoragePutConfig, StorageRemoveConfig, StorageListConfig, StorageCopyConfig, StorageGetOutput, StoragePutOutput, StorageRemoveOutput, StorageListOutput, StorageCopyOutput, UploadTask, StorageGetPropertiesConfig, StorageGetPropertiesOutput } from './types';
+import { InternalStorageClass } from './internals/InternalStorage';
 /**
  * Provide storage methods to use AWS S3
  */
-export declare class Storage {
-    /**
-     * @private
-     */
-    private _config;
-    private _pluggables;
-    /**
-     * Similar to the API module. This weak map allows users to cancel their in-flight request made using the Storage
-     * module. For every get or put request, a unique AbortConttroller will be generated and injected to it's underlying
-     * Xhr HTTP handler. This map maintains a mapping of Request to AbortController. When .cancel is invoked, it will
-     * attempt to retrieve it's corresponding abortController and cancel the in-flight request.
-     */
-    private _abortControllerMap;
+export declare class Storage extends InternalStorageClass {
     /**
      * @public
      */
     vault: Storage;
-    /**
-     * Initialize Storage
-     * @param {Object} config - Configuration object for storage
-     */
-    constructor();
     getModuleName(): string;
-    /**
-     * add plugin into Storage category
-     * @param {Object} pluggable - an instance of the plugin
-     */
-    addPluggable(pluggable: StorageProvider): {};
-    /**
-     * Get the plugin object
-     * @param providerName - the name of the plugin
-     */
-    getPluggable(providerName: string): StorageProvider;
-    /**
-     * Remove the plugin object
-     * @param providerName - the name of the plugin
-     */
-    removePluggable(providerName: string): void;
-    /**
-     * Configure Storage
-     * @param {Object} config - Configuration object for storage
-     * @return {Object} - Current configuration
-     */
-    configure(config?: any): any;
-    private getAbortController;
-    private updateRequestToBeCancellable;
-    private isUploadTask;
     /**
      * Cancels an inflight request
      *
@@ -76,7 +36,6 @@ export declare class Storage {
     get<T extends Record<string, any> & {
         download?: boolean;
     }>(key: string, config?: StorageGetConfig<T>): StorageGetOutput<T>;
-    isCancelError(error: any): boolean;
     getProperties<T extends StorageProvider | {
         [key: string]: any;
     }>(key: string, config?: StorageGetPropertiesConfig<T>): StorageGetPropertiesOutput<T>;

package/lib/Storage.js

@@ -1,6 +1,21 @@
 "use strict";
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 var __assign = (this && this.__assign) || function () {
     __assign = Object.assign || function(t) {
         for (var s, i = 1, n = arguments.length; i < n; i++) {
@@ -12,246 +27,47 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StorageInstance = exports.Storage = void 0;
 var core_1 = require("@aws-amplify/core");
-var providers_1 = require("./providers");
-var utils_1 = require("./AwsClients/S3/utils");
-var AWSS3UploadTask_1 = require("./providers/AWSS3UploadTask");
+var InternalStorage_1 = require("./internals/InternalStorage");
 var logger = new core_1.ConsoleLogger('StorageClass');
 var loggerStorageInstance = new core_1.ConsoleLogger('Storage'); // Logging relating to Storage instance management
 var DEFAULT_PROVIDER = 'AWSS3';
 /**
  * Provide storage methods to use AWS S3
  */
-var Storage = /** @class */ (function () {
-    /**
-     * Initialize Storage
-     * @param {Object} config - Configuration object for storage
-     */
+var Storage = /** @class */ (function (_super) {
+    __extends(Storage, _super);
     function Storage() {
-        this._config = {};
-        this._pluggables = [];
-        this._abortControllerMap = new WeakMap();
-        logger.debug('Storage Options', this._config);
-        this.get = this.get.bind(this);
-        this.put = this.put.bind(this);
-        this.remove = this.remove.bind(this);
-        this.list = this.list.bind(this);
+        return _super !== null && _super.apply(this, arguments) || this;
     }
     Storage.prototype.getModuleName = function () {
         return 'Storage';
     };
-    /**
-     * add plugin into Storage category
-     * @param {Object} pluggable - an instance of the plugin
-     */
-    Storage.prototype.addPluggable = function (pluggable) {
-        if (pluggable && pluggable.getCategory() === 'Storage') {
-            this._pluggables.push(pluggable);
-            var config = {};
-            config = pluggable.configure(this._config[pluggable.getProviderName()]);
-            return config;
-        }
-    };
-    /**
-     * Get the plugin object
-     * @param providerName - the name of the plugin
-     */
-    Storage.prototype.getPluggable = function (providerName) {
-        var pluggable = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === providerName; });
-        if (pluggable === undefined) {
-            logger.debug('No plugin found with providerName', providerName);
-            return null;
-        }
-        else
-            return pluggable;
-    };
-    /**
-     * Remove the plugin object
-     * @param providerName - the name of the plugin
-     */
-    Storage.prototype.removePluggable = function (providerName) {
-        this._pluggables = this._pluggables.filter(function (pluggable) { return pluggable.getProviderName() !== providerName; });
-        return;
-    };
-    /**
-     * Configure Storage
-     * @param {Object} config - Configuration object for storage
-     * @return {Object} - Current configuration
-     */
-    Storage.prototype.configure = function (config) {
-        var _this = this;
-        var _a;
-        logger.debug('configure Storage');
-        if (!config)
-            return this._config;
-        var amplifyConfig = (0, core_1.parseAWSExports)(config);
-        var storageConfig = (_a = amplifyConfig.Storage) !== null && _a !== void 0 ? _a : {};
-        var defaultProviderConfigKeys = [
-            'bucket',
-            'region',
-            'level',
-            'track',
-            'customPrefix',
-            'ContentMD5',
-            'serverSideEncryption',
-            'SSECustomerAlgorithm',
-            'SSECustomerKey',
-            // TODO(AllanZhengYP): remove in V6.
-            'SSECustomerKeyMD5',
-            'SSEKMSKeyId',
-        ];
-        var hasDefaultProviderConfigKeys = function (config) {
-            return Object.keys(config).find(function (key) { return defaultProviderConfigKeys.includes(key); });
-        };
-        if (hasDefaultProviderConfigKeys(storageConfig) &&
-            !storageConfig[DEFAULT_PROVIDER]) {
-            storageConfig[DEFAULT_PROVIDER] = {};
-        }
-        Object.entries(storageConfig).forEach(function (_a) {
-            var _b = __read(_a, 2), key = _b[0], value = _b[1];
-            if (key &&
-                defaultProviderConfigKeys.includes(key) &&
-                value !== undefined) {
-                storageConfig[DEFAULT_PROVIDER][key] = value;
-                delete storageConfig[key];
-            }
-        });
-        // only update new values for each provider
-        Object.keys(storageConfig).forEach(function (providerName) {
-            if (typeof storageConfig[providerName] !== 'string') {
-                _this._config[providerName] = __assign(__assign({}, _this._config[providerName]), storageConfig[providerName]);
-            }
-        });
-        this._pluggables.forEach(function (pluggable) {
-            pluggable.configure(_this._config[pluggable.getProviderName()]);
-        });
-        if (this._pluggables.length === 0) {
-            this.addPluggable(new providers_1.AWSS3Provider());
-        }
-        return this._config;
-    };
-    Storage.prototype.getAbortController = function () {
-        return new AbortController();
-    };
-    Storage.prototype.updateRequestToBeCancellable = function (request, abortController) {
-        this._abortControllerMap.set(request, abortController);
-    };
-    Storage.prototype.isUploadTask = function (x) {
-        return (typeof x !== 'undefined' &&
-            typeof x['pause'] === 'function' &&
-            typeof x['resume'] === 'function');
-    };
     Storage.prototype.cancel = function (request, message) {
-        if (request instanceof AWSS3UploadTask_1.AWSS3UploadTask) {
-            return request._cancel();
-        }
-        var abortController = this._abortControllerMap.get(request);
-        if (abortController) {
-            // TODO: [v6] clean up the aborted promise in the weak map.
-            // Not doing it yet to avoid breaking changes when users may abort a request twice.
-            abortController.abort(message);
-        }
-        else {
-            logger.debug('The request does not map to any cancel token');
-        }
+        return _super.prototype.cancel.call(this, request, message);
     };
     Storage.prototype.copy = function (src, dest, config) {
-        var provider = (config === null || config === void 0 ? void 0 : config.provider) || DEFAULT_PROVIDER;
-        var plugin = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === provider; });
-        if (plugin === undefined) {
-            logger.debug('No plugin found with providerName', provider);
-            return Promise.reject('No plugin found in Storage for the provider');
-        }
-        var abortController = this.getAbortController();
-        if (typeof plugin.copy !== 'function') {
-            return Promise.reject(".copy is not implemented on provider ".concat(plugin.getProviderName()));
-        }
-        var responsePromise = plugin.copy(src, dest, __assign(__assign({}, config), { abortSignal: abortController.signal }));
-        this.updateRequestToBeCancellable(responsePromise, abortController);
-        return responsePromise;
+        return _super.prototype.copy.call(this, src, dest, config);
     };
     Storage.prototype.get = function (key, config) {
-        var provider = (config === null || config === void 0 ? void 0 : config.provider) || DEFAULT_PROVIDER;
-        var plugin = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === provider; });
-        if (plugin === undefined) {
-            logger.debug('No plugin found with providerName', provider);
-            return Promise.reject('No plugin found in Storage for the provider');
-        }
-        var abortController = this.getAbortController();
-        var responsePromise = plugin.get(key, __assign(__assign({}, config), { abortSignal: abortController.signal }));
-        this.updateRequestToBeCancellable(responsePromise, abortController);
-        return responsePromise;
-    };
-    Storage.prototype.isCancelError = function (error) {
-        return (0, utils_1.isCancelError)(error);
+        return _super.prototype.get.call(this, key, config);
     };
     Storage.prototype.getProperties = function (key, config) {
-        var provider = (config === null || config === void 0 ? void 0 : config.provider) || DEFAULT_PROVIDER;
-        var plugin = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === provider; });
-        if (plugin === undefined) {
-            logger.debug('No plugin found with providerName', provider);
-            throw new Error('No plugin found with providerName');
-        }
-        var abortController = this.getAbortController();
-        if (typeof plugin.getProperties !== 'function') {
-            return Promise.reject(".getProperties is not implemented on provider ".concat(plugin.getProviderName()));
-        }
-        var responsePromise = plugin === null || plugin === void 0 ? void 0 : plugin.getProperties(key, __assign({}, config));
-        this.updateRequestToBeCancellable(responsePromise, abortController);
-        return responsePromise;
+        return _super.prototype.getProperties.call(this, key, config);
     };
     Storage.prototype.put = function (key, object, config) {
-        var provider = (config === null || config === void 0 ? void 0 : config.provider) || DEFAULT_PROVIDER;
-        var plugin = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === provider; });
-        if (plugin === undefined) {
-            logger.debug('No plugin found with providerName', provider);
-            return Promise.reject('No plugin found in Storage for the provider');
-        }
-        var abortController = this.getAbortController();
-        var response = plugin.put(key, object, __assign(__assign({}, config), { abortSignal: abortController.signal }));
-        if (!this.isUploadTask(response)) {
-            this.updateRequestToBeCancellable(response, abortController);
-        }
-        return response;
+        return _super.prototype.put.call(this, key, object, config);
     };
     Storage.prototype.remove = function (key, config) {
-        var provider = (config === null || config === void 0 ? void 0 : config.provider) || DEFAULT_PROVIDER;
-        var plugin = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === provider; });
-        if (plugin === undefined) {
-            logger.debug('No plugin found with providerName', provider);
-            return Promise.reject('No plugin found in Storage for the provider');
-        }
-        return plugin.remove(key, config);
+        return _super.prototype.remove.call(this, key, config);
     };
     Storage.prototype.list = function (path, config) {
-        var provider = (config === null || config === void 0 ? void 0 : config.provider) || DEFAULT_PROVIDER;
-        var plugin = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === provider; });
-        if (plugin === undefined) {
-            logger.debug('No plugin found with providerName', provider);
-            return Promise.reject('No plugin found in Storage for the provider');
-        }
-        return plugin.list(path, config);
+        return _super.prototype.list.call(this, path, config);
     };
     return Storage;
-}());
+}(InternalStorage_1.InternalStorageClass));
 exports.Storage = Storage;
 /**
  * Configure & register Storage singleton instance.

package/lib/common/S3ClientUtils.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { ICredentials, StorageAction } from '@aws-amplify/core';
+import { ICredentials } from '@aws-amplify/core';
 import type { Credentials as AwsCredentials } from '@aws-sdk/types';
 import type { EventEmitter } from 'events';
 import { StorageAccessLevel, CustomPrefix } from '../types';
@@ -22,12 +22,11 @@ interface S3InputConfig {
     useAccelerateEndpoint?: boolean;
     abortSignal?: AbortSignal;
     emitter?: EventEmitter;
-    storageAction: StorageAction;
+    userAgentValue?: string;
     dangerouslyConnectToHttpEndpointForTesting?: boolean;
 }
 export interface S3ResolvedConfig extends Omit<S3InputConfig, 'region' | 'credentials'> {
     region: string;
-    userAgentValue?: string;
     credentials: () => Promise<AwsCredentials>;
     customEndpoint?: string;
     forcePathStyle?: boolean;
@@ -36,7 +35,7 @@ export interface S3ResolvedConfig extends Omit<S3InputConfig, 'region' | 'creden
  * A function that persists the s3 configs, so we don't need to
  * assign each config parameter for every s3 API call.
  *
- * @inernal
+ * @internal
  */
 export declare const loadS3Config: (config: S3InputConfig) => S3ResolvedConfig;
 export declare const DEFAULT_PART_SIZE: number;

package/lib/common/S3ClientUtils.js

@@ -109,7 +109,7 @@ exports.credentialsProvider = credentialsProvider;
  * A function that persists the s3 configs, so we don't need to
  * assign each config parameter for every s3 API call.
  *
- * @inernal
+ * @internal
  */
 var loadS3Config = function (config) {
     if (!config.region) {
@@ -118,10 +118,7 @@ var loadS3Config = function (config) {
     }
     return __assign(__assign(__assign({}, config), { region: config.region, credentials: config.credentials
             ? function () { return Promise.resolve(config.credentials); }
-            : exports.credentialsProvider, userAgentValue: (0, core_1.getAmplifyUserAgent)({
-            category: core_1.Category.Storage,
-            action: config.storageAction,
-        }) }), (config.dangerouslyConnectToHttpEndpointForTesting
+            : exports.credentialsProvider }), (config.dangerouslyConnectToHttpEndpointForTesting
         ? {
             customEndpoint: StorageConstants_1.localTestingStorageEndpoint,
             forcePathStyle: true,

package/lib/common/StorageUtils.d.ts

@@ -1,4 +1,6 @@
+import { CustomUserAgentDetails, StorageAction } from '@aws-amplify/core';
 export declare const byteLength: (x: unknown) => number;
 export declare const dispatchStorageEvent: (track: boolean, event: string, attrs: any, metrics: any, message: string) => void;
 export declare const isFile: (x: unknown) => x is File;
 export declare const isBlob: (x: unknown) => x is Blob;
+export declare const getStorageUserAgentValue: (action: StorageAction, customUserAgentDetails?: CustomUserAgentDetails) => string;

package/lib/common/StorageUtils.js

@@ -1,6 +1,17 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isBlob = exports.isFile = exports.dispatchStorageEvent = exports.byteLength = void 0;
+exports.getStorageUserAgentValue = exports.isBlob = exports.isFile = exports.dispatchStorageEvent = exports.byteLength = void 0;
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 var core_1 = require("@aws-amplify/core");
@@ -42,6 +53,10 @@ var isBlob = function (x) {
     return typeof x !== 'undefined' && x instanceof Blob;
 };
 exports.isBlob = isBlob;
+var getStorageUserAgentValue = function (action, customUserAgentDetails) {
+    return (0, core_1.getAmplifyUserAgent)(__assign({ category: core_1.Category.Storage, action: action }, customUserAgentDetails));
+};
+exports.getStorageUserAgentValue = getStorageUserAgentValue;
 var isArrayBuffer = function (x) {
     return typeof x !== 'undefined' && x instanceof ArrayBuffer;
 };

package/lib/internals/InternalStorage.d.ts

@@ -0,0 +1,103 @@
+import { CustomUserAgentDetails } from '@aws-amplify/core';
+import { StorageCopySource, StorageCopyDestination, StorageGetConfig, StorageProvider, StoragePutConfig, StorageRemoveConfig, StorageListConfig, StorageCopyConfig, StorageGetOutput, StoragePutOutput, StorageRemoveOutput, StorageListOutput, StorageCopyOutput, UploadTask, StorageGetPropertiesConfig, StorageGetPropertiesOutput } from '../types';
+/**
+ * Provide storage methods to use AWS S3
+ */
+export declare class InternalStorageClass {
+    /**
+     * @private
+     */
+    private _config;
+    private _pluggables;
+    /**
+     * Similar to the API module. This weak map allows users to cancel their in-flight request made using the Storage
+     * module. For every get or put request, a unique AbortConttroller will be generated and injected to it's underlying
+     * Xhr HTTP handler. This map maintains a mapping of Request to AbortController. When .cancel is invoked, it will
+     * attempt to retrieve it's corresponding abortController and cancel the in-flight request.
+     */
+    private _abortControllerMap;
+    /**
+     * Initialize Storage
+     * @param {Object} config - Configuration object for storage
+     */
+    constructor();
+    getModuleName(): string;
+    /**
+     * add plugin into Storage category
+     * @param {Object} pluggable - an instance of the plugin
+     */
+    addPluggable(pluggable: StorageProvider): {};
+    /**
+     * Get the plugin object
+     * @param providerName - the name of the plugin
+     */
+    getPluggable(providerName: string): StorageProvider;
+    /**
+     * Remove the plugin object
+     * @param providerName - the name of the plugin
+     */
+    removePluggable(providerName: string): void;
+    /**
+     * Configure Storage
+     * @param {Object} config - Configuration object for storage
+     * @return {Object} - Current configuration
+     */
+    configure(config?: any): any;
+    private getAbortController;
+    private updateRequestToBeCancellable;
+    private isUploadTask;
+    /**
+     * Cancels an inflight request
+     *
+     * @param request - The request to cancel
+     * @param [message] - A message to include in the cancelation exception
+     */
+    cancel(request: Promise<any> | UploadTask, message?: string, customUserAgentDetails?: CustomUserAgentDetails): void | Promise<boolean>;
+    /**
+     * Copies a file from src to dest.
+     *
+     * @param src - The source object.
+     * @param dest - The destination object.
+     * @param [config] - config for the Storage operation.
+     * @return A promise resolves to the copied object's key.
+     */
+    copy<T extends Record<string, any>>(src: StorageCopySource, dest: StorageCopyDestination, config?: StorageCopyConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageCopyOutput<T>;
+    /**
+     * Get a presigned URL of the file or the object data when download:true
+     *
+     * @param key - key of the object
+     * @param [config] - config for the Storage operation.
+     * @return - A promise resolves to either a presigned url or the object
+     */
+    get<T extends Record<string, any> & {
+        download?: boolean;
+    }>(key: string, config?: StorageGetConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageGetOutput<T>;
+    isCancelError(error: any): boolean;
+    getProperties<T extends StorageProvider | {
+        [key: string]: any;
+    }>(key: string, config?: StorageGetPropertiesConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageGetPropertiesOutput<T>;
+    /**
+     * Put a file in storage bucket specified to configure method
+     * @param key - key of the object
+     * @param object - File to be put in bucket
+     * @param [config] - { level : private|protected|public, contentType: MIME Types,
+     *  progressCallback: function }
+     * @return - promise resolves to object on success
+     */
+    put<T extends Record<string, any>>(key: string, object: any, config?: StoragePutConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StoragePutOutput<T>;
+    /**
+     * Remove the object for specified key
+     * @param key - key of the object
+     * @param [config] - { level : private|protected|public }
+     * @return - Promise resolves upon successful removal of the object
+     */
+    remove<T extends Record<string, any>>(key: string, config?: StorageRemoveConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageRemoveOutput<T>;
+    /**
+     * List bucket objects relative to the level and prefix specified
+     * @param path - the path that contains objects
+     * @param [config] - { level : private|protected|public, maxKeys: NUMBER }
+     * @return - Promise resolves to list of keys for all objects in path
+     */
+    list<T extends Record<string, any>>(key: string, config?: StorageListConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageListOutput<T>;
+}
+export declare const InternalStorage: InternalStorageClass;