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

package/lib/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/errors/AnalyticsError.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.AnalyticsError = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("@aws-amplify/core/internals/utils");
+/**
+ * @internal
+ */
+var AnalyticsError = /** @class */ (function (_super) {
+    tslib_1.__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;
+}(utils_1.AmplifyError));
+exports.AnalyticsError = AnalyticsError;

package/lib/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/errors/assertValidationError.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.assertValidationError = void 0;
+var AnalyticsError_1 = require("./AnalyticsError");
+var validation_1 = require("./validation");
+/**
+ * @internal
+ */
+function assertValidationError(assertion, name) {
+    var _a = validation_1.validationErrorMap[name], message = _a.message, recoverySuggestion = _a.recoverySuggestion;
+    if (!assertion) {
+        throw new AnalyticsError_1.AnalyticsError({ name: name, message: message, recoverySuggestion: recoverySuggestion });
+    }
+}
+exports.assertValidationError = assertValidationError;

package/lib/errors/index.d.ts

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

package/lib/errors/index.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.validationErrorMap = exports.AnalyticsValidationErrorCode = exports.assertValidationError = exports.AnalyticsError = void 0;
+var AnalyticsError_1 = require("./AnalyticsError");
+Object.defineProperty(exports, "AnalyticsError", { enumerable: true, get: function () { return AnalyticsError_1.AnalyticsError; } });
+var assertValidationError_1 = require("./assertValidationError");
+Object.defineProperty(exports, "assertValidationError", { enumerable: true, get: function () { return assertValidationError_1.assertValidationError; } });
+var validation_1 = require("./validation");
+Object.defineProperty(exports, "AnalyticsValidationErrorCode", { enumerable: true, get: function () { return validation_1.AnalyticsValidationErrorCode; } });
+Object.defineProperty(exports, "validationErrorMap", { enumerable: true, get: function () { return validation_1.validationErrorMap; } });

package/lib/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/errors/validation.js

@@ -0,0 +1,31 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validationErrorMap = exports.AnalyticsValidationErrorCode = void 0;
+var AnalyticsValidationErrorCode;
+(function (AnalyticsValidationErrorCode) {
+    AnalyticsValidationErrorCode["NoAppId"] = "NoAppId";
+    AnalyticsValidationErrorCode["NoCredentials"] = "NoCredentials";
+    AnalyticsValidationErrorCode["NoEvent"] = "NoEvent";
+    AnalyticsValidationErrorCode["NoEventName"] = "NoEventName";
+    AnalyticsValidationErrorCode["NoRegion"] = "NoRegion";
+})(AnalyticsValidationErrorCode = exports.AnalyticsValidationErrorCode || (exports.AnalyticsValidationErrorCode = {}));
+exports.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/index.d.ts

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

package/lib/index.js

@@ -2,20 +2,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AWSPinpointProvider = exports.Analytics = void 0;
 var tslib_1 = require("tslib");
-// TODO(v6) Remove once all default provider functional APIs available
-var Analytics_1 = require("./Analytics");
-Object.defineProperty(exports, "Analytics", { enumerable: true, get: function () { return Analytics_1.Analytics; } });
-var providers_1 = require("./providers");
-Object.defineProperty(exports, "AWSPinpointProvider", { enumerable: true, get: function () { return providers_1.AWSPinpointProvider; } });
-// TODO(v6) Refactor as additional Analytics providers come online
-/*
-export {
-    AWSKinesisProvider,
-    AWSKinesisFirehoseProvider,
-    AmazonPersonalizeProvider,
-} from './providers';
-*/
-// Default provider types
 tslib_1.__exportStar(require("./providers/pinpoint"), exports);

package/lib/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/providers/pinpoint/apis/identifyUser.js

@@ -0,0 +1,44 @@
+"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.identifyUser = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("@aws-amplify/core/internals/utils");
+var pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+var userAgent_1 = require("../../../utils/userAgent");
+var utils_2 = require("../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.
+ */
+var identifyUser = function (_a) {
+    var userId = _a.userId, userProfile = _a.userProfile;
+    return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+        var _b, credentials, identityId, _c, appId, region;
+        return tslib_1.__generator(this, function (_d) {
+            switch (_d.label) {
+                case 0: return [4 /*yield*/, (0, utils_2.resolveCredentials)()];
+                case 1:
+                    _b = _d.sent(), credentials = _b.credentials, identityId = _b.identityId;
+                    _c = (0, utils_2.resolveConfig)(), appId = _c.appId, region = _c.region;
+                    (0, pinpoint_1.updateEndpoint)({
+                        appId: appId,
+                        category: 'Analytics',
+                        credentials: credentials,
+                        identityId: identityId,
+                        region: region,
+                        userId: userId,
+                        userProfile: userProfile,
+                        userAgentValue: (0, userAgent_1.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.UpdateEndpoint),
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.identifyUser = identifyUser;

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

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

package/lib/providers/pinpoint/apis/index.js

@@ -0,0 +1,9 @@
+"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.identifyUser = exports.record = void 0;
+var record_1 = require("./record");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return record_1.record; } });
+var identifyUser_1 = require("./identifyUser");
+Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return identifyUser_1.identifyUser; } });

package/lib/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/providers/pinpoint/apis/record.js

@@ -0,0 +1,44 @@
+"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.record = void 0;
+var utils_1 = require("@aws-amplify/core/internals/utils");
+var pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+var errors_1 = require("../../../errors");
+var userAgent_1 = require("../../../utils/userAgent");
+var utils_2 = require("../utils");
+var logger = new utils_1.ConsoleLogger('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.
+ */
+var record = function (_a) {
+    var event = _a.event;
+    var _b = (0, utils_2.resolveConfig)(), appId = _b.appId, region = _b.region;
+    (0, errors_1.assertValidationError)(!!event, errors_1.AnalyticsValidationErrorCode.NoEvent);
+    (0, errors_1.assertValidationError)(!!event.name, errors_1.AnalyticsValidationErrorCode.NoEventName);
+    (0, utils_2.resolveCredentials)()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        (0, pinpoint_1.record)({
+            appId: appId,
+            category: 'Analytics',
+            credentials: credentials,
+            event: event,
+            identityId: identityId,
+            region: region,
+            userAgentValue: (0, userAgent_1.getAnalyticsUserAgentString)(utils_1.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);
+    });
+};
+exports.record = record;

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

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

package/lib/providers/pinpoint/index.js

@@ -2,11 +2,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.record = void 0;
 var tslib_1 = require("tslib");
-// TODO(v6): Export Pinpoint functional APIs & types
-// Mock function to make exports work
-var record = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
-    return [2 /*return*/];
-}); }); };
-exports.record = record;
+tslib_1.__exportStar(require("./apis"), exports);

package/lib/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/providers/pinpoint/types/errors.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.UpdateEndpointException = void 0;
+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 = exports.UpdateEndpointException || (exports.UpdateEndpointException = {}));

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

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

package/lib/providers/pinpoint/types/index.js

@@ -0,0 +1,7 @@
+"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.UpdateEndpointException = void 0;
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "UpdateEndpointException", { enumerable: true, get: function () { return errors_1.UpdateEndpointException; } });

package/lib/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/providers/pinpoint/utils/index.d.ts

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

package/lib/providers/pinpoint/utils/index.js

@@ -0,0 +1,9 @@
+"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.resolveCredentials = exports.resolveConfig = void 0;
+var resolveConfig_1 = require("./resolveConfig");
+Object.defineProperty(exports, "resolveConfig", { enumerable: true, get: function () { return resolveConfig_1.resolveConfig; } });
+var resolveCredentials_1 = require("./resolveCredentials");
+Object.defineProperty(exports, "resolveCredentials", { enumerable: true, get: function () { return resolveCredentials_1.resolveCredentials; } });

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

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

package/lib/providers/pinpoint/utils/resolveConfig.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.resolveConfig = void 0;
+var core_1 = require("@aws-amplify/core");
+var errors_1 = require("../../../errors");
+/**
+ * @internal
+ */
+var resolveConfig = function () {
+    var _a, _b;
+    var _c = (_b = (_a = core_1.Amplify.getConfig().Analytics) === null || _a === void 0 ? void 0 : _a.AWSPinpoint) !== null && _b !== void 0 ? _b : {}, appId = _c.appId, region = _c.region;
+    (0, errors_1.assertValidationError)(!!appId, errors_1.AnalyticsValidationErrorCode.NoAppId);
+    (0, errors_1.assertValidationError)(!!region, errors_1.AnalyticsValidationErrorCode.NoRegion);
+    return { appId: appId, region: region };
+};
+exports.resolveConfig = resolveConfig;

package/lib/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/providers/pinpoint/utils/resolveCredentials.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.resolveCredentials = void 0;
+var tslib_1 = require("tslib");
+var core_1 = require("@aws-amplify/core");
+var errors_1 = require("../../../errors");
+/**
+ * @internal
+ */
+var resolveCredentials = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+    var _a, credentials, identityId;
+    return tslib_1.__generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, (0, core_1.fetchAuthSession)()];
+            case 1:
+                _a = _b.sent(), credentials = _a.credentials, identityId = _a.identityId;
+                (0, errors_1.assertValidationError)(!!credentials, errors_1.AnalyticsValidationErrorCode.NoCredentials);
+                return [2 /*return*/, { credentials: credentials, identityId: identityId }];
+        }
+    });
+}); };
+exports.resolveCredentials = resolveCredentials;

package/lib/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;