@aws-amplify/core 6.0.1-unstable.cfbde4c.0 → 6.0.1

package/lib/Mutex/index.d.ts

@@ -1 +0,0 @@
-export { Mutex } from './Mutex';

package/lib/Mutex/index.js

@@ -1,7 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mutex = void 0;
-var Mutex_1 = require("./Mutex");
-Object.defineProperty(exports, "Mutex", { enumerable: true, get: function () { return Mutex_1.Mutex; } });

package/lib/Mutex/types.d.ts

@@ -1,13 +0,0 @@
-export interface MutexInterface {
-    acquire(): Promise<MutexInterface.Releaser>;
-    runExclusive<T>(callback: MutexInterface.Worker<T>): Promise<T>;
-    isLocked(): boolean;
-}
-export declare namespace MutexInterface {
-    interface Releaser {
-        (): void;
-    }
-    interface Worker<T> {
-        (): Promise<T> | T;
-    }
-}

package/lib/Mutex/types.js

@@ -1,4 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Platform/customUserAgent.d.ts

@@ -1,16 +0,0 @@
-import { AdditionalDetails, SetCustomUserAgentInput } from './types';
-/**
- * Sets custom user agent state which will be appended to applicable requests. Returns a function that can be used to
- * clean up any custom state set with this API.
- *
- * @note
- * This API operates globally. Calling this API multiple times will result in the most recently set values for a
- * particular API being used.
- *
- * @note
- * This utility IS NOT compatible with SSR.
- *
- * @param input - SetCustomUserAgentInput that defines custom state to apply to the specified APIs.
- */
-export declare const setCustomUserAgent: (input: SetCustomUserAgentInput) => (() => void);
-export declare const getCustomUserAgent: (category: string, api: string) => AdditionalDetails | undefined;

package/lib/Platform/customUserAgent.js

@@ -1,57 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCustomUserAgent = exports.setCustomUserAgent = void 0;
-// Maintains custom user-agent state set by external consumers.
-const customUserAgentState = {};
-/**
- * Sets custom user agent state which will be appended to applicable requests. Returns a function that can be used to
- * clean up any custom state set with this API.
- *
- * @note
- * This API operates globally. Calling this API multiple times will result in the most recently set values for a
- * particular API being used.
- *
- * @note
- * This utility IS NOT compatible with SSR.
- *
- * @param input - SetCustomUserAgentInput that defines custom state to apply to the specified APIs.
- */
-const setCustomUserAgent = (input) => {
-    // Save custom user-agent state & increment reference counter
-    // TODO Remove `any` when we upgrade to TypeScript 5.2, see: https://github.com/microsoft/TypeScript/issues/44373
-    customUserAgentState[input.category] = input.apis.reduce((acc, api) => ({
-        ...acc,
-        [api]: {
-            refCount: acc[api]?.refCount ? acc[api].refCount + 1 : 1,
-            additionalDetails: input.additionalDetails,
-        },
-    }), customUserAgentState[input.category] ?? {});
-    // Callback that cleans up state for APIs recorded by this call
-    let cleanUpCallbackCalled = false;
-    const cleanUpCallback = () => {
-        // Only allow the cleanup callback to be called once
-        if (cleanUpCallbackCalled) {
-            return;
-        }
-        cleanUpCallbackCalled = true;
-        input.apis.forEach(api => {
-            const apiRefCount = customUserAgentState[input.category][api].refCount;
-            if (apiRefCount > 1) {
-                customUserAgentState[input.category][api].refCount = apiRefCount - 1;
-            }
-            else {
-                delete customUserAgentState[input.category][api];
-                // Clean up category if no more APIs set
-                if (!Object.keys(customUserAgentState[input.category]).length) {
-                    delete customUserAgentState[input.category];
-                }
-            }
-        });
-    };
-    return cleanUpCallback;
-};
-exports.setCustomUserAgent = setCustomUserAgent;
-const getCustomUserAgent = (category, api) => customUserAgentState[category]?.[api]?.additionalDetails;
-exports.getCustomUserAgent = getCustomUserAgent;

package/lib/Platform/detectFramework.d.ts

@@ -1,8 +0,0 @@
-import { Framework } from './types';
-export declare const frameworkChangeObservers: (() => void)[];
-export declare const detectFramework: () => Framework;
-/**
- * @internal Setup observer callback that will be called everytime the framework changes
- */
-export declare const observeFrameworkChanges: (fcn: () => void) => void;
-export declare function clearCache(): void;

package/lib/Platform/detectFramework.js

@@ -1,70 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.clearCache = exports.observeFrameworkChanges = exports.detectFramework = exports.frameworkChangeObservers = void 0;
-const types_1 = require("./types");
-const detection_1 = require("./detection");
-// We want to cache detection since the framework won't change
-let frameworkCache;
-exports.frameworkChangeObservers = [];
-// Setup the detection reset tracking / timeout delays
-let resetTriggered = false;
-const SSR_RESET_TIMEOUT = 10; // ms
-const WEB_RESET_TIMEOUT = 10; // ms
-const PRIME_FRAMEWORK_DELAY = 1000; // ms
-const detectFramework = () => {
-    if (!frameworkCache) {
-        frameworkCache = (0, detection_1.detect)();
-        if (resetTriggered) {
-            // The final run of detectFramework:
-            // Starting from this point, the `frameworkCache` becomes "final".
-            // So we don't need to notify the observers again so the observer
-            // can be removed after the final notice.
-            while (exports.frameworkChangeObservers.length) {
-                exports.frameworkChangeObservers.pop()?.();
-            }
-        }
-        else {
-            // The first run of detectFramework:
-            // Every time we update the cache, call each observer function
-            exports.frameworkChangeObservers.forEach(fcn => fcn());
-        }
-        // Retry once for either Unknown type after a delay (explained below)
-        resetTimeout(types_1.Framework.ServerSideUnknown, SSR_RESET_TIMEOUT);
-        resetTimeout(types_1.Framework.WebUnknown, WEB_RESET_TIMEOUT);
-    }
-    return frameworkCache;
-};
-exports.detectFramework = detectFramework;
-/**
- * @internal Setup observer callback that will be called everytime the framework changes
- */
-const observeFrameworkChanges = (fcn) => {
-    // When the `frameworkCache` won't be updated again, we ignore all incoming
-    // observers.
-    if (resetTriggered) {
-        return;
-    }
-    exports.frameworkChangeObservers.push(fcn);
-};
-exports.observeFrameworkChanges = observeFrameworkChanges;
-function clearCache() {
-    frameworkCache = undefined;
-}
-exports.clearCache = clearCache;
-// For a framework type and a delay amount, setup the event to re-detect
-//   During the runtime boot, it is possible that framework detection will
-//   be triggered before the framework has made modifications to the
-//   global/window/etc needed for detection. When no framework is detected
-//   we will reset and try again to ensure we don't use a cached
-//   non-framework detection result for all requests.
-function resetTimeout(framework, delay) {
-    if (frameworkCache === framework && !resetTriggered) {
-        setTimeout(() => {
-            clearCache();
-            resetTriggered = true;
-            setTimeout(exports.detectFramework, PRIME_FRAMEWORK_DELAY);
-        }, delay);
-    }
-}

package/lib/Platform/detection/Angular.d.ts

@@ -1,2 +0,0 @@
-export declare function angularWebDetect(): boolean;
-export declare function angularSSRDetect(): boolean;

package/lib/Platform/detection/Angular.js

@@ -1,22 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.angularSSRDetect = exports.angularWebDetect = void 0;
-const helpers_1 = require("./helpers");
-// Tested with @angular/core 16.0.0
-function angularWebDetect() {
-    const angularVersionSetInDocument = Boolean((0, helpers_1.documentExists)() && document.querySelector('[ng-version]'));
-    const angularContentSetInWindow = Boolean(
-    // @ts-ignore
-    (0, helpers_1.windowExists)() && typeof window['ng'] !== 'undefined');
-    return angularVersionSetInDocument || angularContentSetInWindow;
-}
-exports.angularWebDetect = angularWebDetect;
-function angularSSRDetect() {
-    return (((0, helpers_1.processExists)() &&
-        typeof process.env === 'object' &&
-        process.env['npm_lifecycle_script']?.startsWith('ng ')) ||
-        false);
-}
-exports.angularSSRDetect = angularSSRDetect;

package/lib/Platform/detection/Expo.d.ts

@@ -1 +0,0 @@
-export declare function expoDetect(): boolean;

package/lib/Platform/detection/Expo.js

@@ -1,12 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expoDetect = void 0;
-const helpers_1 = require("./helpers");
-// Tested with expo 48 / react-native 0.71.3
-function expoDetect() {
-    // @ts-ignore
-    return (0, helpers_1.globalExists)() && typeof global['expo'] !== 'undefined';
-}
-exports.expoDetect = expoDetect;

package/lib/Platform/detection/Next.d.ts

@@ -1,2 +0,0 @@
-export declare function nextWebDetect(): any;
-export declare function nextSSRDetect(): boolean;

package/lib/Platform/detection/Next.js

@@ -1,17 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nextSSRDetect = exports.nextWebDetect = void 0;
-const helpers_1 = require("./helpers");
-// Tested with next 13.4 / react 18.2
-function nextWebDetect() {
-    // @ts-ignore
-    return (0, helpers_1.windowExists)() && window['next'] && typeof window['next'] === 'object';
-}
-exports.nextWebDetect = nextWebDetect;
-function nextSSRDetect() {
-    return ((0, helpers_1.globalExists)() &&
-        ((0, helpers_1.keyPrefixMatch)(global, '__next') || (0, helpers_1.keyPrefixMatch)(global, '__NEXT')));
-}
-exports.nextSSRDetect = nextSSRDetect;

package/lib/Platform/detection/Nuxt.d.ts

@@ -1,2 +0,0 @@
-export declare function nuxtWebDetect(): boolean;
-export declare function nuxtSSRDetect(): boolean;

package/lib/Platform/detection/Nuxt.js

@@ -1,18 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.nuxtSSRDetect = exports.nuxtWebDetect = void 0;
-const helpers_1 = require("./helpers");
-// Tested with nuxt 2.15 / vue 2.7
-function nuxtWebDetect() {
-    return ((0, helpers_1.windowExists)() &&
-        // @ts-ignore
-        (window['__NUXT__'] !== undefined || window['$nuxt'] !== undefined));
-}
-exports.nuxtWebDetect = nuxtWebDetect;
-function nuxtSSRDetect() {
-    // @ts-ignore
-    return (0, helpers_1.globalExists)() && typeof global['__NUXT_PATHS__'] !== 'undefined';
-}
-exports.nuxtSSRDetect = nuxtSSRDetect;

package/lib/Platform/detection/React.d.ts

@@ -1,2 +0,0 @@
-export declare function reactWebDetect(): boolean;
-export declare function reactSSRDetect(): boolean;

package/lib/Platform/detection/React.js

@@ -1,25 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.reactSSRDetect = exports.reactWebDetect = void 0;
-const helpers_1 = require("./helpers");
-// Tested with react 18.2 - built using Vite
-function reactWebDetect() {
-    const elementKeyPrefixedWithReact = (key) => {
-        return key.startsWith('_react') || key.startsWith('__react');
-    };
-    const elementIsReactEnabled = (element) => {
-        return Object.keys(element).find(elementKeyPrefixedWithReact);
-    };
-    const allElementsWithId = () => Array.from(document.querySelectorAll('[id]'));
-    return (0, helpers_1.documentExists)() && allElementsWithId().some(elementIsReactEnabled);
-}
-exports.reactWebDetect = reactWebDetect;
-function reactSSRDetect() {
-    return ((0, helpers_1.processExists)() &&
-        typeof process.env !== 'undefined' &&
-        !!Object.keys(process.env).find(key => key.includes('react')));
-}
-exports.reactSSRDetect = reactSSRDetect;
-// use the some

package/lib/Platform/detection/ReactNative.d.ts

@@ -1 +0,0 @@
-export declare function reactNativeDetect(): boolean;

package/lib/Platform/detection/ReactNative.js

@@ -1,12 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.reactNativeDetect = void 0;
-// Tested with react-native 0.17.7
-function reactNativeDetect() {
-    return (typeof navigator !== 'undefined' &&
-        typeof navigator.product !== 'undefined' &&
-        navigator.product === 'ReactNative');
-}
-exports.reactNativeDetect = reactNativeDetect;

package/lib/Platform/detection/Svelte.d.ts

@@ -1,2 +0,0 @@
-export declare function svelteWebDetect(): boolean;
-export declare function svelteSSRDetect(): boolean;

package/lib/Platform/detection/Svelte.js

@@ -1,17 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.svelteSSRDetect = exports.svelteWebDetect = void 0;
-const helpers_1 = require("./helpers");
-// Tested with svelte 3.59
-function svelteWebDetect() {
-    return (0, helpers_1.windowExists)() && (0, helpers_1.keyPrefixMatch)(window, '__SVELTE');
-}
-exports.svelteWebDetect = svelteWebDetect;
-function svelteSSRDetect() {
-    return ((0, helpers_1.processExists)() &&
-        typeof process.env !== 'undefined' &&
-        !!Object.keys(process.env).find(key => key.includes('svelte')));
-}
-exports.svelteSSRDetect = svelteSSRDetect;

package/lib/Platform/detection/Vue.d.ts

@@ -1,2 +0,0 @@
-export declare function vueWebDetect(): boolean;
-export declare function vueSSRDetect(): boolean;

package/lib/Platform/detection/Vue.js

@@ -1,15 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.vueSSRDetect = exports.vueWebDetect = void 0;
-const helpers_1 = require("./helpers");
-// Tested with vue 3.3.2
-function vueWebDetect() {
-    return (0, helpers_1.windowExists)() && (0, helpers_1.keyPrefixMatch)(window, '__VUE');
-}
-exports.vueWebDetect = vueWebDetect;
-function vueSSRDetect() {
-    return (0, helpers_1.globalExists)() && (0, helpers_1.keyPrefixMatch)(global, '__VUE');
-}
-exports.vueSSRDetect = vueSSRDetect;

package/lib/Platform/detection/Web.d.ts

@@ -1 +0,0 @@
-export declare function webDetect(): boolean;

package/lib/Platform/detection/Web.js

@@ -1,10 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.webDetect = void 0;
-const helpers_1 = require("./helpers");
-function webDetect() {
-    return (0, helpers_1.windowExists)();
-}
-exports.webDetect = webDetect;

package/lib/Platform/detection/helpers.d.ts

@@ -1,6 +0,0 @@
-export declare const globalExists: () => boolean;
-export declare const globalThisExists: () => boolean;
-export declare const windowExists: () => boolean;
-export declare const documentExists: () => boolean;
-export declare const processExists: () => boolean;
-export declare const keyPrefixMatch: (object: object, prefix: string) => boolean;

package/lib/Platform/detection/helpers.js

@@ -1,29 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.keyPrefixMatch = exports.processExists = exports.documentExists = exports.windowExists = exports.globalThisExists = exports.globalExists = void 0;
-const globalExists = () => {
-    return typeof global !== 'undefined';
-};
-exports.globalExists = globalExists;
-const globalThisExists = () => {
-    return typeof globalThis !== 'undefined';
-};
-exports.globalThisExists = globalThisExists;
-const windowExists = () => {
-    return typeof window !== 'undefined';
-};
-exports.windowExists = windowExists;
-const documentExists = () => {
-    return typeof document !== 'undefined';
-};
-exports.documentExists = documentExists;
-const processExists = () => {
-    return typeof process !== 'undefined';
-};
-exports.processExists = processExists;
-const keyPrefixMatch = (object, prefix) => {
-    return !!Object.keys(object).find(key => key.startsWith(prefix));
-};
-exports.keyPrefixMatch = keyPrefixMatch;

package/lib/Platform/detection/index.d.ts

@@ -1,2 +0,0 @@
-import { Framework } from '../types';
-export declare function detect(): Framework;

package/lib/Platform/detection/index.js

@@ -1,41 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.detect = void 0;
-const types_1 = require("../types");
-const React_1 = require("./React");
-const Vue_1 = require("./Vue");
-const Svelte_1 = require("./Svelte");
-const Next_1 = require("./Next");
-const Nuxt_1 = require("./Nuxt");
-const Angular_1 = require("./Angular");
-const ReactNative_1 = require("./ReactNative");
-const Expo_1 = require("./Expo");
-const Web_1 = require("./Web");
-// These are in the order of detection where when both are detectable, the early Framework will be reported
-const detectionMap = [
-    // First, detect mobile
-    { platform: types_1.Framework.Expo, detectionMethod: Expo_1.expoDetect },
-    { platform: types_1.Framework.ReactNative, detectionMethod: ReactNative_1.reactNativeDetect },
-    // Next, detect web frameworks
-    { platform: types_1.Framework.NextJs, detectionMethod: Next_1.nextWebDetect },
-    { platform: types_1.Framework.Nuxt, detectionMethod: Nuxt_1.nuxtWebDetect },
-    { platform: types_1.Framework.Angular, detectionMethod: Angular_1.angularWebDetect },
-    { platform: types_1.Framework.React, detectionMethod: React_1.reactWebDetect },
-    { platform: types_1.Framework.VueJs, detectionMethod: Vue_1.vueWebDetect },
-    { platform: types_1.Framework.Svelte, detectionMethod: Svelte_1.svelteWebDetect },
-    { platform: types_1.Framework.WebUnknown, detectionMethod: Web_1.webDetect },
-    // Last, detect ssr frameworks
-    { platform: types_1.Framework.NextJsSSR, detectionMethod: Next_1.nextSSRDetect },
-    { platform: types_1.Framework.NuxtSSR, detectionMethod: Nuxt_1.nuxtSSRDetect },
-    { platform: types_1.Framework.ReactSSR, detectionMethod: React_1.reactSSRDetect },
-    { platform: types_1.Framework.VueJsSSR, detectionMethod: Vue_1.vueSSRDetect },
-    { platform: types_1.Framework.AngularSSR, detectionMethod: Angular_1.angularSSRDetect },
-    { platform: types_1.Framework.SvelteSSR, detectionMethod: Svelte_1.svelteSSRDetect },
-];
-function detect() {
-    return (detectionMap.find(detectionEntry => detectionEntry.detectionMethod())
-        ?.platform || types_1.Framework.ServerSideUnknown);
-}
-exports.detect = detect;

package/lib/Platform/index.d.ts

@@ -1,12 +0,0 @@
-import { CustomUserAgentDetails, Framework } from './types';
-import { UserAgent as AWSUserAgent } from '@aws-sdk/types';
-declare class PlatformBuilder {
-    userAgent: string;
-    get framework(): Framework;
-    get isReactNative(): boolean;
-    observeFrameworkChanges(fcn: () => void): void;
-}
-export declare const Platform: PlatformBuilder;
-export declare const getAmplifyUserAgentObject: ({ category, action, framework, }?: CustomUserAgentDetails) => AWSUserAgent;
-export declare const getAmplifyUserAgent: (customUserAgentDetails?: CustomUserAgentDetails) => string;
-export {};

package/lib/Platform/index.js

@@ -1,51 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAmplifyUserAgent = exports.getAmplifyUserAgentObject = exports.Platform = void 0;
-const types_1 = require("./types");
-const version_1 = require("./version");
-const detectFramework_1 = require("./detectFramework");
-const customUserAgent_1 = require("./customUserAgent");
-const BASE_USER_AGENT = `aws-amplify`;
-class PlatformBuilder {
-    constructor() {
-        this.userAgent = `${BASE_USER_AGENT}/${version_1.version}`;
-    }
-    get framework() {
-        return (0, detectFramework_1.detectFramework)();
-    }
-    get isReactNative() {
-        return (this.framework === types_1.Framework.ReactNative ||
-            this.framework === types_1.Framework.Expo);
-    }
-    observeFrameworkChanges(fcn) {
-        (0, detectFramework_1.observeFrameworkChanges)(fcn);
-    }
-}
-exports.Platform = new PlatformBuilder();
-const getAmplifyUserAgentObject = ({ category, action, framework, } = {}) => {
-    const userAgent = [[BASE_USER_AGENT, version_1.version]];
-    if (category) {
-        userAgent.push([category, action]);
-    }
-    userAgent.push(['framework', (0, detectFramework_1.detectFramework)()]);
-    if (category && action) {
-        const customState = (0, customUserAgent_1.getCustomUserAgent)(category, action);
-        if (customState) {
-            customState.forEach(state => {
-                userAgent.push(state);
-            });
-        }
-    }
-    return userAgent;
-};
-exports.getAmplifyUserAgentObject = getAmplifyUserAgentObject;
-const getAmplifyUserAgent = (customUserAgentDetails) => {
-    const userAgent = (0, exports.getAmplifyUserAgentObject)(customUserAgentDetails);
-    const userAgentString = userAgent
-        .map(([agentKey, agentValue]) => agentKey && agentValue ? `${agentKey}/${agentValue}` : agentKey)
-        .join(' ');
-    return userAgentString;
-};
-exports.getAmplifyUserAgent = getAmplifyUserAgent;