@aws-amplify/core 5.8.2 → 6.0.1-console-preview.f63250a.0

package/README.md

@@ -0,0 +1,3 @@
+> INTERNAL USE ONLY
+
+This package contains the AWS Amplify core utilities and is intended for internal use only. To integrate Amplify into your app, please use [aws-amplify](https://www.npmjs.com/package/aws-amplify).

package/lib/Amplify.d.ts

@@ -3,24 +3,25 @@ export declare class AmplifyClass {
     private _components;
     private _config;
     private _modules;
-    Auth: any;
-    Analytics: any;
-    API: any;
-    Credentials: any;
-    Storage: any;
-    I18n: any;
-    Cache: any;
-    PubSub: any;
-    Interactions: any;
-    Pushnotification: any;
-    UI: any;
-    XR: any;
-    Predictions: any;
-    DataStore: any;
-    Geo: any;
-    Notifications: any;
+    Auth: null;
+    Analytics: null;
+    API: null;
+    Credentials: null;
+    Storage: null;
+    I18n: null;
+    Cache: null;
+    PubSub: null;
+    Interactions: null;
+    Pushnotification: null;
+    UI: null;
+    XR: null;
+    Predictions: null;
+    DataStore: null;
+    Geo: null;
+    Notifications: null;
     Logger: typeof LoggerClass;
-    ServiceWorker: any;
+    ServiceWorker: null;
+    get config(): any;
     register(comp: any): void;
     configure(config?: any): {};
     addPluggable(pluggable: any): void;

package/lib/Amplify.js

@@ -17,6 +17,7 @@ var __read = (this && this.__read) || function (o, n) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Amplify = exports.AmplifyClass = void 0;
+// @ts-nocheck
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 var Logger_1 = require("./Logger");
@@ -49,6 +50,14 @@ var AmplifyClass = /** @class */ (function () {
         this.Logger = Logger_1.ConsoleLogger;
         this.ServiceWorker = null;
     }
+    Object.defineProperty(AmplifyClass.prototype, "config", {
+        // TODO: update "any" when types are determined
+        get: function () {
+            return Object.assign({}, this._config);
+        },
+        enumerable: false,
+        configurable: true
+    });
     AmplifyClass.prototype.register = function (comp) {
         logger.debug('component registered in amplify', comp);
         this._components.push(comp);

package/lib/AwsClients/CognitoIdentity/base.d.ts

@@ -1,4 +1,5 @@
-import { Endpoint, EndpointResolverOptions, Headers, HttpRequest, HttpResponse } from '../../clients';
+import { Endpoint, Headers, HttpRequest, HttpResponse } from '../../clients';
+import { DefaultConfigOptions } from '../../clients/types';
 /**
  * A Cognito Identity-specific transfer handler that does NOT sign requests, and
  * disables caching.
@@ -9,15 +10,7 @@ export declare const cognitoIdentityTransferHandler: (request: HttpRequest, opti
 /**
  * @internal
  */
-export declare const defaultConfig: {
-    service: string;
-    endpointResolver: ({ region }: EndpointResolverOptions) => {
-        url: URL;
-    };
-    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
-    computeDelay: (attempt: number) => number;
-    userAgentValue: string;
-};
+export declare const defaultConfig: DefaultConfigOptions;
 /**
  * @internal
  */

package/lib/AwsClients/CognitoIdentity/getCredentialsForIdentity.d.ts

@@ -1,23 +1,9 @@
-import { Endpoint, HttpResponse } from '../../clients';
+import { HttpResponse } from '../../clients';
 import type { GetCredentialsForIdentityCommandInput as GetCredentialsForIdentityInput, GetCredentialsForIdentityCommandOutput as GetCredentialsForIdentityOutput } from './types';
 export type { GetCredentialsForIdentityInput, GetCredentialsForIdentityOutput };
 /**
  * @internal
  */
-export declare const getCredentialsForIdentity: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").ServiceClientOptions & {
-    service: string;
-    endpointResolver: ({ region }: import("../../clients").EndpointResolverOptions) => {
-        url: URL;
-    };
-    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
-    computeDelay: (attempt: number) => number;
-    userAgentValue: string;
-}, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
-    retryDecider?: ((response?: HttpResponse, error?: unknown) => Promise<boolean>) & ((response?: HttpResponse, error?: Error) => Promise<boolean>);
-    computeDelay?: (attempt: number) => number;
-    userAgentValue?: string;
-    service?: string;
-    endpointResolver?: ((options: import("../../clients").EndpointResolverOptions, input?: any) => Endpoint) & (({ region }: import("../../clients").EndpointResolverOptions) => {
-        url: URL;
-    });
+export declare const getCredentialsForIdentity: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").ServiceClientOptions & Partial<Record<string, unknown> & import("../../clients").ServiceClientOptions>, string> & {
+    [x: string]: unknown;
 }, input: GetCredentialsForIdentityInput) => Promise<GetCredentialsForIdentityOutput>;

package/lib/AwsClients/CognitoIdentity/getCredentialsForIdentity.js

@@ -68,14 +68,14 @@ var getCredentialsForIdentityDeserializer = function (response) { return __await
         }
     });
 }); };
-var deserializeCredentials = function (output) {
-    if (output === void 0) { output = {}; }
-    return ({
-        AccessKeyId: output['AccessKeyId'],
-        SecretKey: output['SecretKey'],
-        SessionToken: output['SessionToken'],
-        Expiration: new Date(output['Expiration'] * 1000),
-    });
+var deserializeCredentials = function (_a) {
+    var _b = _a === void 0 ? {} : _a, AccessKeyId = _b.AccessKeyId, SecretKey = _b.SecretKey, SessionToken = _b.SessionToken, Expiration = _b.Expiration;
+    return {
+        AccessKeyId: AccessKeyId,
+        SecretKey: SecretKey,
+        SessionToken: SessionToken,
+        Expiration: Expiration && new Date(Expiration * 1000),
+    };
 };
 /**
  * @internal

package/lib/AwsClients/CognitoIdentity/getId.d.ts

@@ -1,23 +1,9 @@
-import { Endpoint, HttpResponse } from '../../clients';
+import { HttpResponse } from '../../clients';
 import { GetIdCommandInput as GetIdInput, GetIdCommandOutput as GetIdOutput } from './types';
 export type { GetIdInput, GetIdOutput };
 /**
  * @internal
  */
-export declare const getId: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").ServiceClientOptions & {
-    service: string;
-    endpointResolver: ({ region }: import("../../clients").EndpointResolverOptions) => {
-        url: URL;
-    };
-    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
-    computeDelay: (attempt: number) => number;
-    userAgentValue: string;
-}, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
-    retryDecider?: ((response?: HttpResponse, error?: unknown) => Promise<boolean>) & ((response?: HttpResponse, error?: Error) => Promise<boolean>);
-    computeDelay?: (attempt: number) => number;
-    userAgentValue?: string;
-    service?: string;
-    endpointResolver?: ((options: import("../../clients").EndpointResolverOptions, input?: any) => Endpoint) & (({ region }: import("../../clients").EndpointResolverOptions) => {
-        url: URL;
-    });
+export declare const getId: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").ServiceClientOptions & Partial<Record<string, unknown> & import("../../clients").ServiceClientOptions>, string> & {
+    [x: string]: unknown;
 }, input: GetIdInput) => Promise<GetIdOutput>;

package/lib/AwsClients/Pinpoint/base.d.ts

@@ -1,16 +1,8 @@
-import type { EndpointResolverOptions, Headers } from '../../clients/types';
+import type { DefaultConfigOptions, Headers } from '../../clients/types';
 /**
  * @internal
  */
-export declare const defaultConfig: {
-    service: string;
-    endpointResolver: ({ region }: EndpointResolverOptions) => {
-        url: URL;
-    };
-    retryDecider: (response?: import("../../clients/types").HttpResponse, error?: Error) => Promise<boolean>;
-    computeDelay: (attempt: number) => number;
-    userAgentValue: string;
-};
+export declare const defaultConfig: DefaultConfigOptions;
 /**
  * @internal
  */

package/lib/AwsClients/Pinpoint/getInAppMessages.d.ts

@@ -1,23 +1,9 @@
-import { Endpoint, HttpResponse } from '../../clients/types';
+import { HttpResponse } from '../../clients/types';
 import type { GetInAppMessagesCommandInput as GetInAppMessagesInput, GetInAppMessagesCommandOutput as GetInAppMessagesOutput } from './types';
 export type { GetInAppMessagesInput, GetInAppMessagesOutput };
 /**
  * @internal
  */
-export declare const getInAppMessages: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & {
-    service: string;
-    endpointResolver: ({ region }: import("../../clients/types").EndpointResolverOptions) => {
-        url: URL;
-    };
-    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
-    computeDelay: (attempt: number) => number;
-    userAgentValue: string;
-}, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
-    retryDecider?: ((response?: HttpResponse, error?: unknown) => Promise<boolean>) & ((response?: HttpResponse, error?: Error) => Promise<boolean>);
-    computeDelay?: (attempt: number) => number;
-    userAgentValue?: string;
-    service?: string;
-    endpointResolver?: ((options: import("../../clients/types").EndpointResolverOptions, input?: any) => Endpoint) & (({ region }: import("../../clients/types").EndpointResolverOptions) => {
-        url: URL;
-    });
+export declare const getInAppMessages: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & Partial<Record<string, unknown> & import("../../clients/types").ServiceClientOptions>, string> & {
+    [x: string]: unknown;
 }, input: GetInAppMessagesInput) => Promise<GetInAppMessagesOutput>;

package/lib/AwsClients/Pinpoint/getInAppMessages.js

@@ -45,7 +45,7 @@ var extendedEncodeURIComponent_1 = require("../../clients/middleware/signing/uti
 var serde_1 = require("../../clients/serde");
 var base_1 = require("./base");
 var getInAppMessagesSerializer = function (_a, endpoint) {
-    var ApplicationId = _a.ApplicationId, EndpointId = _a.EndpointId;
+    var _b = _a.ApplicationId, ApplicationId = _b === void 0 ? '' : _b, _c = _a.EndpointId, EndpointId = _c === void 0 ? '' : _c;
     var headers = (0, base_1.getSharedHeaders)();
     var url = new URL(endpoint.url);
     url.pathname = "v1/apps/".concat((0, extendedEncodeURIComponent_1.extendedEncodeURIComponent)(ApplicationId), "/endpoints/").concat((0, extendedEncodeURIComponent_1.extendedEncodeURIComponent)(EndpointId), "/inappmessages");

package/lib/AwsClients/Pinpoint/putEvents.d.ts

@@ -1,23 +1,9 @@
-import { Endpoint, HttpResponse } from '../../clients/types';
+import { HttpResponse } from '../../clients/types';
 import type { PutEventsCommandInput as PutEventsInput, PutEventsCommandOutput as PutEventsOutput } from './types';
 export type { PutEventsInput, PutEventsOutput };
 /**
  * @internal
  */
-export declare const putEvents: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & {
-    service: string;
-    endpointResolver: ({ region }: import("../../clients/types").EndpointResolverOptions) => {
-        url: URL;
-    };
-    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
-    computeDelay: (attempt: number) => number;
-    userAgentValue: string;
-}, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
-    retryDecider?: ((response?: HttpResponse, error?: unknown) => Promise<boolean>) & ((response?: HttpResponse, error?: Error) => Promise<boolean>);
-    computeDelay?: (attempt: number) => number;
-    userAgentValue?: string;
-    service?: string;
-    endpointResolver?: ((options: import("../../clients/types").EndpointResolverOptions, input?: any) => Endpoint) & (({ region }: import("../../clients/types").EndpointResolverOptions) => {
-        url: URL;
-    });
+export declare const putEvents: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & Partial<Record<string, unknown> & import("../../clients/types").ServiceClientOptions>, string> & {
+    [x: string]: unknown;
 }, input: PutEventsInput) => Promise<PutEventsOutput>;

package/lib/AwsClients/Pinpoint/putEvents.js

@@ -39,13 +39,19 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.putEvents = void 0;
+var AssertError_1 = require("../../Util/errors/AssertError");
 var authenticated_1 = require("../../clients/handlers/authenticated");
 var composeServiceApi_1 = require("../../clients/internal/composeServiceApi");
 var extendedEncodeURIComponent_1 = require("../../clients/middleware/signing/utils/extendedEncodeURIComponent");
 var serde_1 = require("../../clients/serde");
+var constants_1 = require("../../constants");
 var base_1 = require("./base");
 var putEventsSerializer = function (_a, endpoint) {
     var ApplicationId = _a.ApplicationId, EventsRequest = _a.EventsRequest;
+    (0, AssertError_1.asserts)(!!ApplicationId, {
+        name: constants_1.APPLICATION_ID_EXCEPTION,
+        message: 'ApplicationId is required for putEvents',
+    });
     var headers = (0, base_1.getSharedHeaders)();
     var url = new URL(endpoint.url);
     url.pathname = "v1/apps/".concat((0, extendedEncodeURIComponent_1.extendedEncodeURIComponent)(ApplicationId), "/events");

package/lib/AwsClients/Pinpoint/updateEndpoint.d.ts

@@ -1,23 +1,9 @@
-import { Endpoint, HttpResponse } from '../../clients/types';
+import { HttpResponse } from '../../clients/types';
 import type { UpdateEndpointCommandInput as UpdateEndpointInput, UpdateEndpointCommandOutput as UpdateEndpointOutput } from './types';
 export type { UpdateEndpointInput, UpdateEndpointOutput };
 /**
  * @internal
  */
-export declare const updateEndpoint: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & {
-    service: string;
-    endpointResolver: ({ region }: import("../../clients/types").EndpointResolverOptions) => {
-        url: URL;
-    };
-    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
-    computeDelay: (attempt: number) => number;
-    userAgentValue: string;
-}, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
-    retryDecider?: ((response?: HttpResponse, error?: unknown) => Promise<boolean>) & ((response?: HttpResponse, error?: Error) => Promise<boolean>);
-    computeDelay?: (attempt: number) => number;
-    userAgentValue?: string;
-    service?: string;
-    endpointResolver?: ((options: import("../../clients/types").EndpointResolverOptions, input?: any) => Endpoint) & (({ region }: import("../../clients/types").EndpointResolverOptions) => {
-        url: URL;
-    });
+export declare const updateEndpoint: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & Partial<Record<string, unknown> & import("../../clients/types").ServiceClientOptions>, string> & {
+    [x: string]: unknown;
 }, input: UpdateEndpointInput) => Promise<UpdateEndpointOutput>;

package/lib/AwsClients/Pinpoint/updateEndpoint.js

@@ -45,11 +45,11 @@ var extendedEncodeURIComponent_1 = require("../../clients/middleware/signing/uti
 var serde_1 = require("../../clients/serde");
 var base_1 = require("./base");
 var updateEndpointSerializer = function (_a, endpoint) {
-    var ApplicationId = _a.ApplicationId, EndpointId = _a.EndpointId, EndpointRequest = _a.EndpointRequest;
+    var _b = _a.ApplicationId, ApplicationId = _b === void 0 ? '' : _b, _c = _a.EndpointId, EndpointId = _c === void 0 ? '' : _c, EndpointRequest = _a.EndpointRequest;
     var headers = (0, base_1.getSharedHeaders)();
     var url = new URL(endpoint.url);
     url.pathname = "v1/apps/".concat((0, extendedEncodeURIComponent_1.extendedEncodeURIComponent)(ApplicationId), "/endpoints/").concat((0, extendedEncodeURIComponent_1.extendedEncodeURIComponent)(EndpointId));
-    var body = JSON.stringify(EndpointRequest !== null && EndpointRequest !== void 0 ? EndpointRequest : {});
+    var body = JSON.stringify(EndpointRequest);
     return { method: 'PUT', headers: headers, url: url, body: body };
 };
 var updateEndpointDeserializer = function (response) { return __awaiter(void 0, void 0, void 0, function () {

package/lib/Cache/AsyncStorageCache.d.ts

@@ -0,0 +1,154 @@
+import AsyncStorage from '@react-native-async-storage/async-storage';
+import { StorageCache } from './StorageCache';
+import { CacheConfig, CacheItem, CacheItemOptions, ICache } from './types';
+export declare class AsyncStorageCache extends StorageCache implements ICache {
+    /**
+     * initialize the cache
+     *
+     * @param {Object} config - the configuration of the cache
+     */
+    constructor(config?: CacheConfig);
+    /**
+     * decrease current size of the cache
+     * @private
+     * @param amount - the amount of the cache size which needs to be decreased
+     */
+    _decreaseCurSizeInBytes(amount: number): Promise<void>;
+    /**
+     * increase current size of the cache
+     * @private
+     * @param amount - the amount of the cache szie which need to be increased
+     */
+    _increaseCurSizeInBytes(amount: number): Promise<void>;
+    /**
+     * update the visited time if item has been visited
+     * @private
+     * @param item - the item which need to be refreshed
+     * @param prefixedKey - the key of the item
+     *
+     * @return the refreshed item
+     */
+    _refreshItem(item: CacheItem, prefixedKey: string): Promise<CacheItem>;
+    /**
+     * check wether item is expired
+     * @private
+     * @param key - the key of the item
+     *
+     * @return true if the item is expired.
+     */
+    _isExpired(key: string): Promise<boolean>;
+    /**
+     * delete item from cache
+     * @private
+     * @param prefixedKey - the key of the item
+     * @param size - optional, the byte size of the item
+     */
+    _removeItem(prefixedKey: string, size?: number): Promise<void>;
+    /**
+     * put item into cache
+     * @private
+     * @param prefixedKey - the key of the item
+     * @param itemData - the value of the item
+     * @param itemSizeInBytes - the byte size of the item
+     */
+    _setItem(prefixedKey: string, item: any): Promise<void>;
+    /**
+     * total space needed when poping out items
+     * @private
+     * @param itemSize
+     *
+     * @return total space needed
+     */
+    _sizeToPop(itemSize: number): Promise<number>;
+    /**
+     * see whether cache is full
+     * @private
+     * @param itemSize
+     *
+     * @return true if cache is full
+     */
+    _isCacheFull(itemSize: number): Promise<boolean>;
+    /**
+     * scan the storage and find out all the keys owned by this cache
+     * also clean the expired keys while scanning
+     * @private
+     * @return array of keys
+     */
+    _findValidKeys(): Promise<string[]>;
+    /**
+     * get all the items we have, sort them by their priority,
+     * if priority is same, sort them by their last visited time
+     * pop out items from the low priority (5 is the lowest)
+     * @private
+     * @param keys - all the keys in this cache
+     * @param sizeToPop - the total size of the items which needed to be poped out
+     */
+    _popOutItems(keys: string[], sizeToPop: number): Promise<void>;
+    /**
+     * Set item into cache. You can put number, string, boolean or object.
+     * The cache will first check whether has the same key.
+     * If it has, it will delete the old item and then put the new item in
+     * The cache will pop out items if it is full
+     * You can specify the cache item options. The cache will abort and output a warning:
+     * If the key is invalid
+     * If the size of the item exceeds itemMaxSize.
+     * If the value is undefined
+     * If incorrect cache item configuration
+     * If error happened with browser storage
+     *
+     * @param {String} key - the key of the item
+     * @param {Object} value - the value of the item
+     * @param {Object} [options] - optional, the specified meta-data
+     * @return {Promise}
+     */
+    setItem(key: string, value: any, options: Record<string, any>): Promise<void>;
+    /**
+     * Get item from cache. It will return null if item doesn’t exist or it has been expired.
+     * If you specified callback function in the options,
+     * then the function will be executed if no such item in the cache
+     * and finally put the return value into cache.
+     * Please make sure the callback function will return the value you want to put into the cache.
+     * The cache will abort output a warning:
+     * If the key is invalid
+     * If error happened with AsyncStorage
+     *
+     * @param {String} key - the key of the item
+     * @param {Object} [options] - the options of callback function
+     * @return {Promise} - return a promise resolves to be the value of the item
+     */
+    getItem(key: string, options: CacheItemOptions): Promise<any>;
+    /**
+     * remove item from the cache
+     * The cache will abort output a warning:
+     * If error happened with AsyncStorage
+     * @param {String} key - the key of the item
+     * @return {Promise}
+     */
+    removeItem(key: string): Promise<void>;
+    /**
+     * clear the entire cache
+     * The cache will abort output a warning:
+     * If error happened with AsyncStorage
+     * @return {Promise}
+     */
+    clear(): Promise<void>;
+    /**
+     * return the current size of the cache
+     * @return {Promise}
+     */
+    getCacheCurSize(): Promise<number>;
+    /**
+     * Return all the keys in the cache.
+     * Will return an empty array if error happend.
+     * @return {Promise}
+     */
+    getAllKeys(): Promise<string[]>;
+    /**
+     * Return a new instance of cache with customized configuration.
+     * @param {Object} config - the customized configuration
+     * @return {Object} - the new instance of Cache
+     */
+    createInstance(config: CacheConfig): ICache;
+}
+declare const instance: ICache;
+export { AsyncStorage, instance as Cache };