@aws-amplify/analytics 7.0.1-console-preview.f63250a.0 → 7.0.1-console-preview.5dc0b68.0

package/{lib-esm/types/Analytics.d.ts → lib/types/analytics.d.ts}

@@ -56,11 +56,3 @@ export interface AutoTrackEventOpts {
     provider?: string;
     attributes?: AutoTrackAttributes;
 }
-export interface AnalyticsEvent {
-    name: string;
-    attributes?: EventAttributes;
-    metrics?: EventMetrics;
-    immediate?: boolean;
-}
-export { PersonalizeAnalyticsEvent } from './providers/AmazonPersonalizeProvider';
-export { KinesisAnalyticsEvent } from './providers/AWSKinesisProvider';

package/lib/types/index.d.ts

@@ -1,3 +1 @@
-export * from './Analytics';
-export * from './Provider';
-export * from './providers';
+export * from './analytics';

package/lib/types/index.js

@@ -3,6 +3,4 @@
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./Analytics"), exports);
-tslib_1.__exportStar(require("./Provider"), exports);
-tslib_1.__exportStar(require("./providers"), exports);
+tslib_1.__exportStar(require("./analytics"), exports);

package/lib/utils/{UserAgent.d.ts → userAgent.d.ts}

@@ -1,4 +1,4 @@
-import { AnalyticsAction } from '@aws-amplify/core';
+import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
 import { UserAgent } from '@aws-sdk/types';
 export declare function getAnalyticsUserAgent(action: AnalyticsAction): UserAgent;
 export declare function getAnalyticsUserAgentString(action: AnalyticsAction): string;

package/lib/utils/{UserAgent.js → userAgent.js}

@@ -3,17 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAnalyticsUserAgentString = exports.getAnalyticsUserAgent = 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");
+var utils_1 = require("@aws-amplify/core/internals/utils");
 function getAnalyticsUserAgent(action) {
-    return (0, core_1.getAmplifyUserAgentObject)({
-        category: core_1.Category.Analytics,
+    return (0, utils_1.getAmplifyUserAgentObject)({
+        category: utils_1.Category.Analytics,
         action: action,
     });
 }
 exports.getAnalyticsUserAgent = getAnalyticsUserAgent;
 function getAnalyticsUserAgentString(action) {
-    return (0, core_1.getAmplifyUserAgent)({
-        category: core_1.Category.Analytics,
+    return (0, utils_1.getAmplifyUserAgent)({
+        category: utils_1.Category.Analytics,
         action: action,
     });
 }

package/lib-esm/errors/AnalyticsError.d.ts

@@ -0,0 +1,7 @@
+import { AmplifyError, ErrorParams } from '@aws-amplify/core/internals/utils';
+/**
+ * @internal
+ */
+export declare class AnalyticsError extends AmplifyError {
+    constructor(params: ErrorParams);
+}

package/lib-esm/errors/AnalyticsError.js

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __extends } from "tslib";
+import { AmplifyError } from '@aws-amplify/core/internals/utils';
+/**
+ * @internal
+ */
+var AnalyticsError = /** @class */ (function (_super) {
+    __extends(AnalyticsError, _super);
+    function AnalyticsError(params) {
+        var _this = _super.call(this, params) || this;
+        // Hack for making the custom error class work when transpiled to es5
+        // TODO: Delete the following 2 lines after we change the build target to >= es2015
+        _this.constructor = AnalyticsError;
+        Object.setPrototypeOf(_this, AnalyticsError.prototype);
+        return _this;
+    }
+    return AnalyticsError;
+}(AmplifyError));
+export { AnalyticsError };

package/lib-esm/errors/assertValidationError.d.ts

@@ -0,0 +1,5 @@
+import { AnalyticsValidationErrorCode } from './validation';
+/**
+ * @internal
+ */
+export declare function assertValidationError(assertion: boolean, name: AnalyticsValidationErrorCode): asserts assertion;

package/lib-esm/errors/assertValidationError.js

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AnalyticsError } from './AnalyticsError';
+import { validationErrorMap } from './validation';
+/**
+ * @internal
+ */
+export function assertValidationError(assertion, name) {
+    var _a = validationErrorMap[name], message = _a.message, recoverySuggestion = _a.recoverySuggestion;
+    if (!assertion) {
+        throw new AnalyticsError({ name: name, message: message, recoverySuggestion: recoverySuggestion });
+    }
+}

package/lib-esm/errors/index.d.ts

@@ -0,0 +1,3 @@
+export { AnalyticsError } from './AnalyticsError';
+export { assertValidationError } from './assertValidationError';
+export { AnalyticsValidationErrorCode, validationErrorMap } from './validation';

package/lib-esm/errors/index.js

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { AnalyticsError } from './AnalyticsError';
+export { assertValidationError } from './assertValidationError';
+export { AnalyticsValidationErrorCode, validationErrorMap } from './validation';

package/lib-esm/errors/validation.d.ts

@@ -0,0 +1,9 @@
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+export declare enum AnalyticsValidationErrorCode {
+    NoAppId = "NoAppId",
+    NoCredentials = "NoCredentials",
+    NoEvent = "NoEvent",
+    NoEventName = "NoEventName",
+    NoRegion = "NoRegion"
+}
+export declare const validationErrorMap: AmplifyErrorMap<AnalyticsValidationErrorCode>;

package/lib-esm/errors/validation.js

@@ -0,0 +1,28 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var _a;
+export var AnalyticsValidationErrorCode;
+(function (AnalyticsValidationErrorCode) {
+    AnalyticsValidationErrorCode["NoAppId"] = "NoAppId";
+    AnalyticsValidationErrorCode["NoCredentials"] = "NoCredentials";
+    AnalyticsValidationErrorCode["NoEvent"] = "NoEvent";
+    AnalyticsValidationErrorCode["NoEventName"] = "NoEventName";
+    AnalyticsValidationErrorCode["NoRegion"] = "NoRegion";
+})(AnalyticsValidationErrorCode || (AnalyticsValidationErrorCode = {}));
+export var validationErrorMap = (_a = {},
+    _a[AnalyticsValidationErrorCode.NoAppId] = {
+        message: 'Missing application id.',
+    },
+    _a[AnalyticsValidationErrorCode.NoCredentials] = {
+        message: 'Credentials should not be empty.',
+    },
+    _a[AnalyticsValidationErrorCode.NoEvent] = {
+        message: 'An event is required to record.',
+    },
+    _a[AnalyticsValidationErrorCode.NoEventName] = {
+        message: 'Events must specify a name.',
+    },
+    _a[AnalyticsValidationErrorCode.NoRegion] = {
+        message: 'Missing region.',
+    },
+    _a);

package/lib-esm/index.d.ts

@@ -1,4 +1 @@
-export { Analytics } from './Analytics';
-export { AnalyticsProvider } from './types';
-export { AWSPinpointProvider } from './providers';
 export * from './providers/pinpoint';

package/lib-esm/index.js

@@ -1,15 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-// TODO(v6) Remove once all default provider functional APIs available
-export { Analytics } from './Analytics';
-export { AWSPinpointProvider } from './providers';
-// TODO(v6) Refactor as additional Analytics providers come online
-/*
-export {
-    AWSKinesisProvider,
-    AWSKinesisFirehoseProvider,
-    AmazonPersonalizeProvider,
-} from './providers';
-*/
-// Default provider types
 export * from './providers/pinpoint';

package/lib-esm/providers/pinpoint/apis/identifyUser.d.ts

@@ -0,0 +1,10 @@
+import { IdentifyUserParameters } from '../types';
+/**
+ * Identifies the current user with Pinpoint.
+ *
+ * @param {IdentifyUserParameters} params parameters used to construct requests sent to Pinpoint's UpdateEndpoint API.
+ *
+ * @throws An {@link UpdateEndpointException} when the underlying Pinpoint service returns an error.
+ * @throws An {@link AnalyticsValidationErrorCode} when API call parameters are invalid.
+ */
+export declare const identifyUser: ({ userId, userProfile, }: IdentifyUserParameters) => Promise<void>;

package/lib-esm/providers/pinpoint/apis/identifyUser.js

@@ -0,0 +1,40 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __awaiter, __generator } from "tslib";
+import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
+import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
+import { getAnalyticsUserAgentString } from '../../../utils/userAgent';
+import { resolveConfig, resolveCredentials } from '../utils';
+/**
+ * Identifies the current user with Pinpoint.
+ *
+ * @param {IdentifyUserParameters} params parameters used to construct requests sent to Pinpoint's UpdateEndpoint API.
+ *
+ * @throws An {@link UpdateEndpointException} when the underlying Pinpoint service returns an error.
+ * @throws An {@link AnalyticsValidationErrorCode} when API call parameters are invalid.
+ */
+export var identifyUser = function (_a) {
+    var userId = _a.userId, userProfile = _a.userProfile;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var _b, credentials, identityId, _c, appId, region;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0: return [4 /*yield*/, resolveCredentials()];
+                case 1:
+                    _b = _d.sent(), credentials = _b.credentials, identityId = _b.identityId;
+                    _c = resolveConfig(), appId = _c.appId, region = _c.region;
+                    updateEndpoint({
+                        appId: appId,
+                        category: 'Analytics',
+                        credentials: credentials,
+                        identityId: identityId,
+                        region: region,
+                        userId: userId,
+                        userProfile: userProfile,
+                        userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.UpdateEndpoint),
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    });
+};

package/lib-esm/providers/pinpoint/apis/index.d.ts

@@ -0,0 +1,2 @@
+export { record } from './record';
+export { identifyUser } from './identifyUser';

package/{src/types/providers/index.ts → lib-esm/providers/pinpoint/apis/index.js}

@@ -1,3 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export * from './AWSPinpointProvider';
+export { record } from './record';
+export { identifyUser } from './identifyUser';

package/lib-esm/providers/pinpoint/apis/record.d.ts

@@ -0,0 +1,11 @@
+import { RecordParameters } from '../types/parameters';
+/**
+ * Sends an event to Pinpoint.
+ *
+ * @param {RecordParameters} params Parameters used to construct the request.
+ *
+ * @throws An {@link AnalyticsValidationErrorCode} when there is an error in the parameters or configuration.
+ *
+ * @returns A promise that will resolve when the request is complete.
+ */
+export declare const record: ({ event }: RecordParameters) => void;

package/lib-esm/providers/pinpoint/apis/record.js

@@ -0,0 +1,40 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AnalyticsAction, ConsoleLogger as Logger, } from '@aws-amplify/core/internals/utils';
+import { record as recordCore } from '@aws-amplify/core/internals/providers/pinpoint';
+import { AnalyticsValidationErrorCode, assertValidationError, } from '../../../errors';
+import { getAnalyticsUserAgentString } from '../../../utils/userAgent';
+import { resolveConfig, resolveCredentials } from '../utils';
+var logger = new Logger('Analytics');
+/**
+ * Sends an event to Pinpoint.
+ *
+ * @param {RecordParameters} params Parameters used to construct the request.
+ *
+ * @throws An {@link AnalyticsValidationErrorCode} when there is an error in the parameters or configuration.
+ *
+ * @returns A promise that will resolve when the request is complete.
+ */
+export var record = function (_a) {
+    var event = _a.event;
+    var _b = resolveConfig(), appId = _b.appId, region = _b.region;
+    assertValidationError(!!event, AnalyticsValidationErrorCode.NoEvent);
+    assertValidationError(!!event.name, AnalyticsValidationErrorCode.NoEventName);
+    resolveCredentials()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        recordCore({
+            appId: appId,
+            category: 'Analytics',
+            credentials: credentials,
+            event: event,
+            identityId: identityId,
+            region: region,
+            userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+        });
+    })
+        .catch(function (e) {
+        // An error occured while fetching credentials or persisting the event to the buffer
+        logger.warn('Failed to record event.', e);
+    });
+};

package/lib-esm/providers/pinpoint/index.d.ts

@@ -1 +1 @@
-export declare const record: () => Promise<void>;
+export * from './apis';

package/lib-esm/providers/pinpoint/index.js

@@ -1,8 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { __awaiter, __generator } from "tslib";
-// TODO(v6): Export Pinpoint functional APIs & types
-// Mock function to make exports work
-export var record = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/];
-}); }); };
+export * from './apis';

package/lib-esm/providers/pinpoint/types/errors.d.ts

@@ -0,0 +1,9 @@
+export declare enum UpdateEndpointException {
+    BadRequestException = "BadRequestException",
+    ForbiddenException = "ForbiddenException",
+    InternalServerErrorException = "InternalServerErrorException",
+    MethodNotAllowedException = "MethodNotAllowedException",
+    NotFoundException = "NotFoundException",
+    PayloadTooLargeException = "PayloadTooLargeException",
+    TooManyRequestsException = "TooManyRequestsException"
+}

package/lib-esm/providers/pinpoint/types/errors.js

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export var UpdateEndpointException;
+(function (UpdateEndpointException) {
+    UpdateEndpointException["BadRequestException"] = "BadRequestException";
+    UpdateEndpointException["ForbiddenException"] = "ForbiddenException";
+    UpdateEndpointException["InternalServerErrorException"] = "InternalServerErrorException";
+    UpdateEndpointException["MethodNotAllowedException"] = "MethodNotAllowedException";
+    UpdateEndpointException["NotFoundException"] = "NotFoundException";
+    UpdateEndpointException["PayloadTooLargeException"] = "PayloadTooLargeException";
+    UpdateEndpointException["TooManyRequestsException"] = "TooManyRequestsException";
+})(UpdateEndpointException || (UpdateEndpointException = {}));

package/lib-esm/providers/pinpoint/types/index.d.ts

@@ -0,0 +1,2 @@
+export { UpdateEndpointException } from './errors';
+export { IdentifyUserParameters } from './parameters';

package/lib-esm/{types/providers → providers/pinpoint/types}/index.js

@@ -1,3 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export * from './AWSPinpointProvider';
+export { UpdateEndpointException } from './errors';

package/lib-esm/providers/pinpoint/types/parameters.d.ts

@@ -0,0 +1,18 @@
+import { UserProfile } from '@aws-amplify/core';
+import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
+export type RecordParameters = {
+    /**
+     * An event to send to the default Analytics provider.
+     */
+    event: PinpointAnalyticsEvent;
+};
+export type IdentifyUserParameters = {
+    /**
+     * A User ID associated to the current device.
+     */
+    userId: string;
+    /**
+     * Additional information about the user and their device.
+     */
+    userProfile: UserProfile;
+};

package/lib-esm/providers/pinpoint/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';

package/lib-esm/{utils/AppUtils.js → providers/pinpoint/utils/index.js}

@@ -1,6 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var isAppInForeground = function () {
-    return true;
-};
-export { isAppInForeground };
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';

package/lib-esm/providers/pinpoint/utils/resolveConfig.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @internal
+ */
+export declare const resolveConfig: () => {
+    appId: string;
+    region: string;
+};

package/lib-esm/providers/pinpoint/utils/resolveConfig.js

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Amplify } from '@aws-amplify/core';
+import { AnalyticsValidationErrorCode, assertValidationError, } from '../../../errors';
+/**
+ * @internal
+ */
+export var resolveConfig = function () {
+    var _a, _b;
+    var _c = (_b = (_a = Amplify.getConfig().Analytics) === null || _a === void 0 ? void 0 : _a.AWSPinpoint) !== null && _b !== void 0 ? _b : {}, appId = _c.appId, region = _c.region;
+    assertValidationError(!!appId, AnalyticsValidationErrorCode.NoAppId);
+    assertValidationError(!!region, AnalyticsValidationErrorCode.NoRegion);
+    return { appId: appId, region: region };
+};

package/lib-esm/providers/pinpoint/utils/resolveCredentials.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @internal
+ */
+export declare const resolveCredentials: () => Promise<{
+    credentials: {
+        accessKeyId: string;
+        secretAccessKey: string;
+        sessionToken?: string | undefined;
+        expiration?: Date | undefined;
+    };
+    identityId: string | undefined;
+}>;

package/lib-esm/providers/pinpoint/utils/resolveCredentials.js

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __awaiter, __generator } from "tslib";
+import { fetchAuthSession } from '@aws-amplify/core';
+import { AnalyticsValidationErrorCode, assertValidationError, } from '../../../errors';
+/**
+ * @internal
+ */
+export var resolveCredentials = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, credentials, identityId;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, fetchAuthSession()];
+            case 1:
+                _a = _b.sent(), credentials = _a.credentials, identityId = _a.identityId;
+                assertValidationError(!!credentials, AnalyticsValidationErrorCode.NoCredentials);
+                return [2 /*return*/, { credentials: credentials, identityId: identityId }];
+        }
+    });
+}); };

package/lib-esm/setupTests.js

@@ -1,3 +1,4 @@
+"use strict";
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 var anyGlobal = global;