@diia-inhouse/analytics 1.72.29 → 2.3.0

package/dist/mocks/analytics.d.ts

@@ -0,0 +1,6 @@
+import { RatingForm } from "@diia-inhouse/types";
+
+//#region src/mocks/analytics.d.ts
+declare function getRatingFormMock(ratingForm?: Partial<RatingForm>): RatingForm;
+//#endregion
+export { getRatingFormMock };

package/dist/mocks/analytics.js

@@ -1,81 +1,77 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRatingFormMock = getRatingFormMock;
-const interfaces_1 = require("../interfaces");
+import "../interfaces/rating.js";
+//#region src/mocks/analytics.ts
 function getRatingFormMock(ratingForm = {}) {
-    const chips = [
-        {
-            code: 'addressError',
-            name: 'name',
-        },
-        {
-            code: 'mobility',
-            name: 'name',
-        },
-    ];
-    return {
-        title: 'Поділіться враженнями',
-        rating: {
-            label: 'Задоволені замовленням та отриманням послуги в Дії?',
-            items: [
-                {
-                    rate: interfaces_1.RatingScore.Awful,
-                    emoji: '😡',
-                    chip: {
-                        label: 'Що засмутило?',
-                        description: 'Оберіть один або кілька варіантів.',
-                        chips,
-                    },
-                    chipBlocks: [],
-                },
-                {
-                    rate: interfaces_1.RatingScore.Bad,
-                    emoji: '😢',
-                    chip: {
-                        label: 'Що засмутило?',
-                        description: 'Оберіть один або кілька варіантів.',
-                        chips,
-                    },
-                    chipBlocks: [],
-                },
-                {
-                    rate: interfaces_1.RatingScore.Ok,
-                    emoji: '😐',
-                    chip: {
-                        label: 'На що команді звернути увагу?',
-                        description: 'Оберіть один або кілька варіантів.',
-                        chips,
-                    },
-                    chipBlocks: [],
-                },
-                {
-                    rate: interfaces_1.RatingScore.Good,
-                    emoji: '😁',
-                    chip: {
-                        label: 'Що сподобалось?',
-                        description: 'Оберіть один або кілька варіантів.',
-                        chips,
-                    },
-                    chipBlocks: [],
-                },
-                {
-                    rate: interfaces_1.RatingScore.Excellent,
-                    emoji: '😍',
-                    chip: {
-                        label: 'Що сподобалось?',
-                        description: 'Оберіть один або кілька варіантів.',
-                        chips,
-                    },
-                    chipBlocks: [],
-                },
-            ],
-        },
-        comment: {
-            label: 'Як можна покращити послугу?',
-            hint: 'Розкажіть більше про враження (необовʼязково)',
-        },
-        mainButton: 'Надіслати відгук',
-        ...ratingForm,
-    };
+	const chips = [{
+		code: "addressError",
+		name: "name"
+	}, {
+		code: "mobility",
+		name: "name"
+	}];
+	return {
+		title: "Поділіться враженнями",
+		rating: {
+			label: "Задоволені замовленням та отриманням послуги в Дії?",
+			items: [
+				{
+					rate: "1",
+					emoji: "😡",
+					chip: {
+						label: "Що засмутило?",
+						description: "Оберіть один або кілька варіантів.",
+						chips
+					},
+					chipBlocks: []
+				},
+				{
+					rate: "2",
+					emoji: "😢",
+					chip: {
+						label: "Що засмутило?",
+						description: "Оберіть один або кілька варіантів.",
+						chips
+					},
+					chipBlocks: []
+				},
+				{
+					rate: "3",
+					emoji: "😐",
+					chip: {
+						label: "На що команді звернути увагу?",
+						description: "Оберіть один або кілька варіантів.",
+						chips
+					},
+					chipBlocks: []
+				},
+				{
+					rate: "4",
+					emoji: "😁",
+					chip: {
+						label: "Що сподобалось?",
+						description: "Оберіть один або кілька варіантів.",
+						chips
+					},
+					chipBlocks: []
+				},
+				{
+					rate: "5",
+					emoji: "😍",
+					chip: {
+						label: "Що сподобалось?",
+						description: "Оберіть один або кілька варіантів.",
+						chips
+					},
+					chipBlocks: []
+				}
+			]
+		},
+		comment: {
+			label: "Як можна покращити послугу?",
+			hint: "Розкажіть більше про враження (необовʼязково)"
+		},
+		mainButton: "Надіслати відгук",
+		...ratingForm
+	};
 }
-//# sourceMappingURL=analytics.js.map
+//#endregion
+export { getRatingFormMock };

package/dist/mocks/index.d.ts

@@ -0,0 +1 @@
+import { getRatingFormMock } from "./analytics.js";

package/dist/services/analytics.d.ts

@@ -0,0 +1,25 @@
+import { AnalyticsActionResult } from "../interfaces/actionResult.js";
+import { AnalyticsActionType } from "../interfaces/actionType.js";
+import { AnalyticsCategory } from "../interfaces/categories.js";
+import { AcquirerAnalyticsData, NotificationAnalyticsData, UserAnalyticsData } from "../interfaces/data.js";
+import { ObjectId } from "bson";
+import { ActHeaders, AlsData, Logger } from "@diia-inhouse/types";
+import { AsyncLocalStorage } from "node:async_hooks";
+
+//#region src/services/analytics.d.ts
+declare class AnalyticsService {
+  private readonly logger;
+  private readonly asyncLocalStorage;
+  constructor(logger: Logger, asyncLocalStorage: AsyncLocalStorage<AlsData>);
+  acquirerLog(category: AnalyticsCategory, acquirerId: ObjectId, actionType: AnalyticsActionType, actionResult: AnalyticsActionResult, headers: ActHeaders | undefined, data?: AcquirerAnalyticsData): void;
+  userAcquirerLog(category: AnalyticsCategory, userIdentifier: string, acquirerId: ObjectId | undefined, actionType: AnalyticsActionType, actionResult: AnalyticsActionResult, headers: ActHeaders | undefined, data?: AcquirerAnalyticsData): void;
+  notificationLog(actionType: AnalyticsActionType, actionResult: AnalyticsActionResult, headers: ActHeaders, data?: NotificationAnalyticsData): void;
+  userLog(actionType: AnalyticsActionType, actionResult: AnalyticsActionResult, userIdentifier: string, headers: ActHeaders, data?: UserAnalyticsData): void;
+  authLog(actionType: AnalyticsActionType, actionResult: AnalyticsActionResult, userIdentifier: string, headers: ActHeaders, data?: Record<string, unknown>): void;
+  log(category: string, actionType: string, actionResult: string, data?: Record<string, unknown>): void;
+  private getDate;
+  private getDevice;
+  private logAnalytics;
+}
+//#endregion
+export { AnalyticsService };

package/dist/services/analytics.js

@@ -1,146 +1,134 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalyticsService = void 0;
-const utils_1 = require("@diia-inhouse/utils");
-const interfaces_1 = require("../interfaces");
-class AnalyticsService {
-    logger;
-    asyncLocalStorage;
-    constructor(logger, asyncLocalStorage) {
-        this.logger = logger;
-        this.asyncLocalStorage = asyncLocalStorage;
-    }
-    acquirerLog(category, acquirerId, actionType, actionResult, headers, data) {
-        const analytics = {
-            date: this.getDate(),
-            category,
-            acquirer: acquirerId,
-            action: {
-                type: actionType,
-                result: actionResult,
-            },
-            appVersion: headers?.appVersion,
-            device: this.getDevice(headers),
-            data,
-        };
-        this.logAnalytics(analytics);
-    }
-    userAcquirerLog(category, userIdentifier, acquirerId, actionType, actionResult, headers, data) {
-        const analytics = {
-            date: this.getDate(),
-            category,
-            acquirer: acquirerId,
-            identifier: userIdentifier,
-            action: {
-                type: actionType,
-                result: actionResult,
-            },
-            appVersion: headers?.appVersion,
-            device: this.getDevice(headers),
-            data,
-        };
-        this.logAnalytics(analytics);
-    }
-    notificationLog(actionType, actionResult, headers, data) {
-        const analytics = {
-            date: this.getDate(),
-            category: interfaces_1.AnalyticsCategory.Notification,
-            action: {
-                type: actionType,
-                result: actionResult,
-            },
-            appVersion: headers.appVersion,
-            device: this.getDevice(headers),
-            data,
-        };
-        this.logAnalytics(analytics);
-    }
-    userLog(actionType, actionResult, userIdentifier, headers, data) {
-        const analytics = {
-            date: this.getDate(),
-            category: interfaces_1.AnalyticsCategory.Users,
-            action: {
-                type: actionType,
-                result: actionResult,
-            },
-            identifier: userIdentifier,
-            appVersion: headers.appVersion,
-            device: this.getDevice(headers),
-            data,
-        };
-        this.logAnalytics(analytics);
-    }
-    authLog(actionType, actionResult, userIdentifier, headers, data) {
-        const analytics = {
-            date: this.getDate(),
-            category: interfaces_1.AnalyticsCategory.Auth,
-            action: {
-                type: actionType,
-                result: actionResult,
-            },
-            identifier: userIdentifier,
-            appVersion: headers.appVersion,
-            device: this.getDevice(headers),
-            data,
-        };
-        this.logAnalytics(analytics);
-    }
-    log(category, actionType, actionResult, data) {
-        const context = this.asyncLocalStorage.getStore();
-        if (!context) {
-            this.logger.fatal('Analytics log is used without als context');
-            return;
-        }
-        const { session, headers } = context;
-        const analytics = {
-            date: this.getDate(),
-            category,
-            action: {
-                type: actionType,
-                result: actionResult,
-            },
-            appVersion: headers?.appVersion,
-            device: this.getDevice(headers),
-            data,
-        };
-        if (utils_1.guards.isUserSession(session)) {
-            analytics.identifier = session.user.identifier;
-        }
-        if (utils_1.guards.isServiceEntranceSession(session)) {
-            const { acquirerId, branchHashId, offerHashId } = session.entrance;
-            analytics.acquirer = acquirerId;
-            if (!data) {
-                data = {};
-            }
-            if (!data.branch) {
-                data.branch = branchHashId;
-            }
-            if (!data.offer) {
-                data.offer = offerHashId;
-            }
-        }
-        this.logger.info('Analytics', { analytics });
-    }
-    getDate() {
-        return new Date().toISOString();
-    }
-    getDevice(headers) {
-        if (!headers) {
-            return;
-        }
-        const { mobileUid, platformType, platformVersion } = headers;
-        return {
-            identifier: mobileUid,
-            platform: {
-                type: platformType,
-                version: platformVersion,
-            },
-        };
-    }
-    logAnalytics(analytics) {
-        const log = { analytics };
-        this.logger.info('Analytics', log);
-    }
-}
-exports.AnalyticsService = AnalyticsService;
-//# sourceMappingURL=analytics.js.map
+import "../interfaces/categories.js";
+import { guards } from "@diia-inhouse/utils";
+//#region src/services/analytics.ts
+var AnalyticsService = class {
+	logger;
+	asyncLocalStorage;
+	constructor(logger, asyncLocalStorage) {
+		this.logger = logger;
+		this.asyncLocalStorage = asyncLocalStorage;
+	}
+	acquirerLog(category, acquirerId, actionType, actionResult, headers, data) {
+		const analytics = {
+			date: this.getDate(),
+			category,
+			acquirer: acquirerId,
+			action: {
+				type: actionType,
+				result: actionResult
+			},
+			appVersion: headers?.appVersion,
+			device: this.getDevice(headers),
+			data
+		};
+		this.logAnalytics(analytics);
+	}
+	userAcquirerLog(category, userIdentifier, acquirerId, actionType, actionResult, headers, data) {
+		const analytics = {
+			date: this.getDate(),
+			category,
+			acquirer: acquirerId,
+			identifier: userIdentifier,
+			action: {
+				type: actionType,
+				result: actionResult
+			},
+			appVersion: headers?.appVersion,
+			device: this.getDevice(headers),
+			data
+		};
+		this.logAnalytics(analytics);
+	}
+	notificationLog(actionType, actionResult, headers, data) {
+		const analytics = {
+			date: this.getDate(),
+			category: "notification",
+			action: {
+				type: actionType,
+				result: actionResult
+			},
+			appVersion: headers.appVersion,
+			device: this.getDevice(headers),
+			data
+		};
+		this.logAnalytics(analytics);
+	}
+	userLog(actionType, actionResult, userIdentifier, headers, data) {
+		const analytics = {
+			date: this.getDate(),
+			category: "users",
+			action: {
+				type: actionType,
+				result: actionResult
+			},
+			identifier: userIdentifier,
+			appVersion: headers.appVersion,
+			device: this.getDevice(headers),
+			data
+		};
+		this.logAnalytics(analytics);
+	}
+	authLog(actionType, actionResult, userIdentifier, headers, data) {
+		const analytics = {
+			date: this.getDate(),
+			category: "auth",
+			action: {
+				type: actionType,
+				result: actionResult
+			},
+			identifier: userIdentifier,
+			appVersion: headers.appVersion,
+			device: this.getDevice(headers),
+			data
+		};
+		this.logAnalytics(analytics);
+	}
+	log(category, actionType, actionResult, data) {
+		const context = this.asyncLocalStorage.getStore();
+		if (!context) {
+			this.logger.fatal("Analytics log is used without als context");
+			return;
+		}
+		const { session, headers } = context;
+		const analytics = {
+			date: this.getDate(),
+			category,
+			action: {
+				type: actionType,
+				result: actionResult
+			},
+			appVersion: headers?.appVersion,
+			device: this.getDevice(headers),
+			data
+		};
+		if (guards.isUserSession(session)) analytics.identifier = session.user.identifier;
+		if (guards.isServiceEntranceSession(session)) {
+			const { acquirerId, branchHashId, offerHashId } = session.entrance;
+			analytics.acquirer = acquirerId;
+			if (!data) data = {};
+			if (!data.branch) data.branch = branchHashId;
+			if (!data.offer) data.offer = offerHashId;
+		}
+		this.logger.info("Analytics", { analytics });
+	}
+	getDate() {
+		return (/* @__PURE__ */ new Date()).toISOString();
+	}
+	getDevice(headers) {
+		if (!headers) return;
+		const { mobileUid, platformType, platformVersion } = headers;
+		return {
+			identifier: mobileUid,
+			platform: {
+				type: platformType,
+				version: platformVersion
+			}
+		};
+	}
+	logAnalytics(analytics) {
+		const log = { analytics };
+		this.logger.info("Analytics", log);
+	}
+};
+//#endregion
+export { AnalyticsService };

package/dist/services/index.d.ts

@@ -0,0 +1 @@
+import { AnalyticsService } from "./analytics.js";

package/dist/services/index.js

@@ -1,18 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./analytics"), exports);
-//# sourceMappingURL=index.js.map
+import "./analytics.js";
+export {};

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+import { RatingUtils } from "./rating.js";

package/dist/utils/rating.d.ts

@@ -0,0 +1,13 @@
+import { ChipParams, RatingCategory, RatingFormCode, TextParams } from "../interfaces/rating.js";
+import { RatingForm } from "@diia-inhouse/types";
+
+//#region src/utils/rating.d.ts
+declare class RatingUtils {
+  private readonly chipCodeToValueDefaultMap;
+  private readonly chipLabelMap;
+  private readonly ratingLabelMap;
+  private readonly commentLabelMap;
+  getRatingForm<T extends string>(formCode: RatingFormCode, category: RatingCategory, chipParams: ChipParams<T>, textParams?: TextParams, resourceId?: string, showInAppReview?: boolean): RatingForm;
+}
+//#endregion
+export { RatingUtils };