@aws-amplify/core 5.4.1-unstable.f47d472.4 → 5.5.0

package/lib/AwsClients/CognitoIdentity/base.js

@@ -43,6 +43,7 @@ var clients_1 = require("../../clients");
 var composeTransferHandler_1 = require("../../clients/internal/composeTransferHandler");
 var retry_1 = require("../../clients/middleware/retry");
 var Platform_1 = require("../../Platform");
+var detectFramework_1 = require("../../Platform/detectFramework");
 /**
  * The service name used to sign requests if the API requires authentication.
  */
@@ -84,8 +85,11 @@ exports.defaultConfig = {
     endpointResolver: endpointResolver,
     retryDecider: (0, retry_1.getRetryDecider)(clients_1.parseJsonError),
     computeDelay: retry_1.jitteredBackoff,
-    userAgentValue: (0, Platform_1.getAmplifyUserAgent)(), // TODO: use getAmplifyUserAgentString() when available.
+    userAgentValue: (0, Platform_1.getAmplifyUserAgentString)(),
 };
+(0, detectFramework_1.observeFrameworkChanges)(function () {
+    exports.defaultConfig.userAgentValue = (0, Platform_1.getAmplifyUserAgentString)();
+});
 /**
  * @internal
  */

package/lib/AwsClients/Pinpoint/base.js

@@ -28,7 +28,7 @@ exports.defaultConfig = {
     endpointResolver: endpointResolver,
     retryDecider: (0, retry_1.getRetryDecider)(json_1.parseJsonError),
     computeDelay: retry_1.jitteredBackoff,
-    userAgentValue: (0, Platform_1.getAmplifyUserAgent)(), // TODO: use getAmplifyUserAgentString() when available.
+    userAgentValue: (0, Platform_1.getAmplifyUserAgentString)(),
 };
 /**
  * @internal

package/lib/Platform/detectFramework.d.ts

@@ -0,0 +1,7 @@
+import { Framework } from './types';
+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

@@ -0,0 +1,53 @@
+"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 = void 0;
+var types_1 = require("./types");
+var detection_1 = require("./detection");
+// We want to cache detection since the framework won't change
+var frameworkCache;
+var frameworkChangeObservers = [];
+// Setup the detection reset tracking / timeout delays
+var resetTriggered = false;
+var SSR_RESET_TIMEOUT = 10; // ms
+var WEB_RESET_TIMEOUT = 10; // ms
+var PRIME_FRAMEWORK_DELAY = 1000; // ms
+var detectFramework = function () {
+    if (!frameworkCache) {
+        frameworkCache = (0, detection_1.detect)();
+        // Everytime we update the cache, call each observer function
+        frameworkChangeObservers.forEach(function (fcn) { return 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
+ */
+var observeFrameworkChanges = function (fcn) {
+    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(function () {
+            clearCache();
+            resetTriggered = true;
+            setTimeout(exports.detectFramework, PRIME_FRAMEWORK_DELAY);
+        }, delay);
+    }
+}

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

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

package/lib/Platform/detection/Angular.js

@@ -0,0 +1,23 @@
+"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;
+var helpers_1 = require("./helpers");
+// Tested with @angular/core 16.0.0
+function angularWebDetect() {
+    var angularVersionSetInDocument = Boolean((0, helpers_1.documentExists)() && document.querySelector('[ng-version]'));
+    var angularContentSetInWindow = Boolean(
+    // @ts-ignore
+    (0, helpers_1.windowExists)() && typeof window['ng'] !== 'undefined');
+    return angularVersionSetInDocument || angularContentSetInWindow;
+}
+exports.angularWebDetect = angularWebDetect;
+function angularSSRDetect() {
+    var _a;
+    return (((0, helpers_1.processExists)() &&
+        typeof process.env === 'object' &&
+        ((_a = process.env['npm_lifecycle_script']) === null || _a === void 0 ? void 0 : _a.startsWith('ng '))) ||
+        false);
+}
+exports.angularSSRDetect = angularSSRDetect;

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

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

package/lib/Platform/detection/Expo.js

@@ -0,0 +1,12 @@
+"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;
+var 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

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

package/lib/Platform/detection/Next.js

@@ -0,0 +1,17 @@
+"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;
+var 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

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

package/lib/Platform/detection/Nuxt.js

@@ -0,0 +1,18 @@
+"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;
+var 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

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

package/lib/Platform/detection/React.js

@@ -0,0 +1,24 @@
+"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;
+var helpers_1 = require("./helpers");
+// Tested with react 18.2 - built using Vite
+function reactWebDetect() {
+    var elementKeyPrefixedWithReact = function (key) {
+        return key.startsWith('_react') || key.startsWith('__react');
+    };
+    var elementIsReactEnabled = function (element) {
+        return Object.keys(element).find(elementKeyPrefixedWithReact);
+    };
+    var allElementsWithId = function () { return 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(function (key) { return key.includes('react'); }));
+}
+exports.reactSSRDetect = reactSSRDetect;

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

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

package/lib/Platform/detection/ReactNative.js

@@ -0,0 +1,12 @@
+"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

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

package/lib/Platform/detection/Svelte.js

@@ -0,0 +1,17 @@
+"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;
+var 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(function (key) { return key.includes('svelte'); }));
+}
+exports.svelteSSRDetect = svelteSSRDetect;

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

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

package/lib/Platform/detection/Vue.js

@@ -0,0 +1,15 @@
+"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;
+var 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

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

package/lib/Platform/detection/Web.js

@@ -0,0 +1,10 @@
+"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;
+var helpers_1 = require("./helpers");
+function webDetect() {
+    return (0, helpers_1.windowExists)();
+}
+exports.webDetect = webDetect;

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,29 @@
+"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;
+var globalExists = function () {
+    return typeof global !== 'undefined';
+};
+exports.globalExists = globalExists;
+var globalThisExists = function () {
+    return typeof globalThis !== 'undefined';
+};
+exports.globalThisExists = globalThisExists;
+var windowExists = function () {
+    return typeof window !== 'undefined';
+};
+exports.windowExists = windowExists;
+var documentExists = function () {
+    return typeof document !== 'undefined';
+};
+exports.documentExists = documentExists;
+var processExists = function () {
+    return typeof process !== 'undefined';
+};
+exports.processExists = processExists;
+var keyPrefixMatch = function (object, prefix) {
+    return !!Object.keys(object).find(function (key) { return key.startsWith(prefix); });
+};
+exports.keyPrefixMatch = keyPrefixMatch;

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

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

package/lib/Platform/detection/index.js

@@ -0,0 +1,41 @@
+"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;
+var types_1 = require("../types");
+var React_1 = require("./React");
+var Vue_1 = require("./Vue");
+var Svelte_1 = require("./Svelte");
+var Next_1 = require("./Next");
+var Nuxt_1 = require("./Nuxt");
+var Angular_1 = require("./Angular");
+var ReactNative_1 = require("./ReactNative");
+var Expo_1 = require("./Expo");
+var Web_1 = require("./Web");
+// These are in the order of detection where when both are detectable, the early Framework will be reported
+var 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() {
+    var _a;
+    return (((_a = detectionMap.find(function (detectionEntry) { return detectionEntry.detectionMethod(); })) === null || _a === void 0 ? void 0 : _a.platform) || types_1.Framework.ServerSideUnknown);
+}
+exports.detect = detect;

package/lib/Platform/index.d.ts

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

package/lib/Platform/index.js

@@ -1,31 +1,70 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAmplifyUserAgent = exports.Platform = void 0;
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var version_1 = require("./version");
-var BASE_USER_AGENT = "aws-amplify/".concat(version_1.version);
-exports.Platform = {
-    userAgent: "".concat(BASE_USER_AGENT, " js"),
-    product: '',
-    navigator: null,
-    isReactNative: false,
+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;
 };
-if (typeof navigator !== 'undefined' && navigator.product) {
-    exports.Platform.product = navigator.product || '';
-    exports.Platform.navigator = navigator || null;
-    switch (navigator.product) {
-        case 'ReactNative':
-            exports.Platform.userAgent = "".concat(BASE_USER_AGENT, " react-native");
-            exports.Platform.isReactNative = true;
-            break;
-        default:
-            exports.Platform.userAgent = "".concat(BASE_USER_AGENT, " js");
-            exports.Platform.isReactNative = false;
-            break;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAmplifyUserAgentString = exports.getAmplifyUserAgent = exports.Platform = void 0;
+var types_1 = require("./types");
+var version_1 = require("./version");
+var detectFramework_1 = require("./detectFramework");
+var BASE_USER_AGENT = "aws-amplify";
+var PlatformBuilder = /** @class */ (function () {
+    function PlatformBuilder() {
+        this.userAgent = "".concat(BASE_USER_AGENT, "/").concat(version_1.version);
     }
-}
-var getAmplifyUserAgent = function (content) {
-    return "".concat(exports.Platform.userAgent).concat(content ? content : '');
+    Object.defineProperty(PlatformBuilder.prototype, "framework", {
+        get: function () {
+            return (0, detectFramework_1.detectFramework)();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PlatformBuilder.prototype, "isReactNative", {
+        get: function () {
+            return this.framework === types_1.Framework.ReactNative;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    PlatformBuilder.prototype.observeFrameworkChanges = function (fcn) {
+        (0, detectFramework_1.observeFrameworkChanges)(fcn);
+    };
+    return PlatformBuilder;
+}());
+exports.Platform = new PlatformBuilder();
+var getAmplifyUserAgent = function (_a) {
+    var _b = _a === void 0 ? {} : _a, category = _b.category, action = _b.action, framework = _b.framework;
+    var userAgent = [[BASE_USER_AGENT, version_1.version]];
+    if (category) {
+        userAgent.push([category, action]);
+    }
+    userAgent.push(['framework', (0, detectFramework_1.detectFramework)()]);
+    return userAgent;
 };
 exports.getAmplifyUserAgent = getAmplifyUserAgent;
+var getAmplifyUserAgentString = function (customUserAgentDetails) {
+    var userAgent = (0, exports.getAmplifyUserAgent)(customUserAgentDetails);
+    var userAgentString = userAgent
+        .map(function (_a) {
+        var _b = __read(_a, 2), agentKey = _b[0], agentValue = _b[1];
+        return "".concat(agentKey, "/").concat(agentValue);
+    })
+        .join(' ');
+    return userAgentString;
+};
+exports.getAmplifyUserAgentString = getAmplifyUserAgentString;

package/lib/Platform/types.d.ts

@@ -0,0 +1,104 @@
+export declare enum Framework {
+    WebUnknown = "0",
+    React = "1",
+    NextJs = "2",
+    Angular = "3",
+    VueJs = "4",
+    Nuxt = "5",
+    Svelte = "6",
+    ServerSideUnknown = "100",
+    ReactSSR = "101",
+    NextJsSSR = "102",
+    AngularSSR = "103",
+    VueJsSSR = "104",
+    NuxtSSR = "105",
+    SvelteSSR = "106",
+    ReactNative = "201",
+    Expo = "202"
+}
+export declare enum Category {
+    API = "api",
+    Auth = "auth",
+    Analytics = "analytics",
+    DataStore = "datastore",
+    Geo = "geo",
+    InAppMessaging = "inappmessaging",
+    Interactions = "interactions",
+    Predictions = "predictions",
+    PubSub = "pubsub",
+    PushNotification = "pushnotification",
+    Storage = "storage"
+}
+export declare enum AnalyticsAction {
+    Record = "1",
+    UpdateEndpoint = "2"
+}
+export declare enum ApiAction {
+    GraphQl = "1",
+    Get = "2",
+    Post = "3",
+    Put = "4",
+    Patch = "5",
+    Del = "6",
+    Head = "7"
+}
+export declare enum AuthAction {
+    FederatedSignIn = "30"
+}
+export declare enum DataStoreAction {
+    Subscribe = "1",
+    GraphQl = "2"
+}
+export declare enum GeoAction {
+    None = "0"
+}
+export declare enum InAppMessagingAction {
+    None = "0"
+}
+export declare enum InteractionsAction {
+    None = "0"
+}
+export declare enum PredictionsAction {
+    Convert = "1",
+    Identify = "2",
+    Interpret = "3"
+}
+export declare enum PubSubAction {
+    Subscribe = "1"
+}
+export declare enum PushNotificationAction {
+    None = "0"
+}
+export declare enum StorageAction {
+    Put = "1",
+    Get = "2",
+    List = "3",
+    Copy = "4",
+    Remove = "5",
+    GetProperties = "6"
+}
+type ActionMap = {
+    [Category.Auth]: AuthAction;
+    [Category.API]: ApiAction;
+    [Category.Analytics]: AnalyticsAction;
+    [Category.DataStore]: DataStoreAction;
+    [Category.Geo]: GeoAction;
+    [Category.InAppMessaging]: InAppMessagingAction;
+    [Category.Interactions]: InteractionsAction;
+    [Category.Predictions]: PredictionsAction;
+    [Category.PubSub]: PubSubAction;
+    [Category.PushNotification]: PushNotificationAction;
+    [Category.Storage]: StorageAction;
+};
+type UserAgentDetailsWithCategory<T extends Category> = CustomUserAgentDetailsBase & {
+    category: T;
+    action: T extends keyof ActionMap ? ActionMap[T] : never;
+};
+type CustomUserAgentDetailsBase = {
+    framework?: Framework;
+};
+export type CustomUserAgentDetails = (CustomUserAgentDetailsBase & {
+    category?: never;
+    action?: never;
+}) | UserAgentDetailsWithCategory<Category.API> | UserAgentDetailsWithCategory<Category.Auth> | UserAgentDetailsWithCategory<Category.Analytics> | UserAgentDetailsWithCategory<Category.DataStore> | UserAgentDetailsWithCategory<Category.Geo> | UserAgentDetailsWithCategory<Category.Interactions> | UserAgentDetailsWithCategory<Category.InAppMessaging> | UserAgentDetailsWithCategory<Category.Predictions> | UserAgentDetailsWithCategory<Category.PubSub> | UserAgentDetailsWithCategory<Category.PushNotification> | UserAgentDetailsWithCategory<Category.Storage>;
+export {};