tychat-contracts 1.0.76 → 1.0.77

package/dist/analytics/analytics-kafka-topics.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Kafka topic names used by the analytics service.
+ */
+/** Topic for ingesting analytic events from all microservices. */
+export declare const TOPIC_ANALYTICS_EVENT = "analytics.event";
+/** Topic for requesting a report grouped by event type and period. */
+export declare const TOPIC_ANALYTICS_REPORT = "analytics.report";
+/** Topic for requesting a dashboard summary (counts per domain). */
+export declare const TOPIC_ANALYTICS_DASHBOARD = "analytics.dashboard";
+/** Topic for requesting a time-series breakdown of events. */
+export declare const TOPIC_ANALYTICS_TIMESERIES = "analytics.timeseries";
+/** Topic for requesting event details with pagination. */
+export declare const TOPIC_ANALYTICS_EVENTS_LIST = "analytics.events.list";
+//# sourceMappingURL=analytics-kafka-topics.d.ts.map

package/dist/analytics/analytics-kafka-topics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics-kafka-topics.d.ts","sourceRoot":"","sources":["../../src/analytics/analytics-kafka-topics.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,kEAAkE;AAClE,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AAEvD,sEAAsE;AACtE,eAAO,MAAM,sBAAsB,qBAAqB,CAAC;AAEzD,oEAAoE;AACpE,eAAO,MAAM,yBAAyB,wBAAwB,CAAC;AAE/D,8DAA8D;AAC9D,eAAO,MAAM,0BAA0B,yBAAyB,CAAC;AAEjE,0DAA0D;AAC1D,eAAO,MAAM,2BAA2B,0BAA0B,CAAC"}

package/dist/analytics/analytics-kafka-topics.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * Kafka topic names used by the analytics service.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TOPIC_ANALYTICS_EVENTS_LIST = exports.TOPIC_ANALYTICS_TIMESERIES = exports.TOPIC_ANALYTICS_DASHBOARD = exports.TOPIC_ANALYTICS_REPORT = exports.TOPIC_ANALYTICS_EVENT = void 0;
+/** Topic for ingesting analytic events from all microservices. */
+exports.TOPIC_ANALYTICS_EVENT = 'analytics.event';
+/** Topic for requesting a report grouped by event type and period. */
+exports.TOPIC_ANALYTICS_REPORT = 'analytics.report';
+/** Topic for requesting a dashboard summary (counts per domain). */
+exports.TOPIC_ANALYTICS_DASHBOARD = 'analytics.dashboard';
+/** Topic for requesting a time-series breakdown of events. */
+exports.TOPIC_ANALYTICS_TIMESERIES = 'analytics.timeseries';
+/** Topic for requesting event details with pagination. */
+exports.TOPIC_ANALYTICS_EVENTS_LIST = 'analytics.events.list';

package/dist/analytics/analytics-query.dto.d.ts

@@ -0,0 +1,25 @@
+import { EventAnalyticType } from './event-analytic.enum';
+/**
+ * Grouping granularity for time-series report data.
+ */
+export declare const ANALYTICS_GROUP_BY: readonly ["hour", "day", "week", "month"];
+export type AnalyticsGroupBy = (typeof ANALYTICS_GROUP_BY)[number];
+/**
+ * Query DTO used to request analytics reports.
+ */
+export declare class AnalyticsReportQueryDto {
+    startDate: string;
+    endDate: string;
+    eventType?: EventAnalyticType;
+    groupBy?: AnalyticsGroupBy;
+    page?: number;
+    limit?: number;
+}
+/**
+ * Query DTO for the dashboard summary endpoint.
+ */
+export declare class AnalyticsDashboardQueryDto {
+    startDate: string;
+    endDate: string;
+}
+//# sourceMappingURL=analytics-query.dto.d.ts.map

package/dist/analytics/analytics-query.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics-query.dto.d.ts","sourceRoot":"","sources":["../../src/analytics/analytics-query.dto.ts"],"names":[],"mappings":"AAYA,OAAO,EAAwB,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,kBAAkB,2CAA4C,CAAC;AAC5E,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnE;;GAEG;AACH,qBAAa,uBAAuB;IAMlC,SAAS,EAAE,MAAM,CAAC;IAOlB,OAAO,EAAE,MAAM,CAAC;IAShB,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAS9B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAO3B,IAAI,CAAC,EAAE,MAAM,CAAC;IAOd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,0BAA0B;IAMrC,SAAS,EAAE,MAAM,CAAC;IAOlB,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/analytics/analytics-query.dto.js

@@ -0,0 +1,108 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsDashboardQueryDto = exports.AnalyticsReportQueryDto = exports.ANALYTICS_GROUP_BY = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const event_analytic_enum_1 = require("./event-analytic.enum");
+/**
+ * Grouping granularity for time-series report data.
+ */
+exports.ANALYTICS_GROUP_BY = ['hour', 'day', 'week', 'month'];
+/**
+ * Query DTO used to request analytics reports.
+ */
+class AnalyticsReportQueryDto {
+    startDate;
+    endDate;
+    eventType;
+    groupBy;
+    page;
+    limit;
+}
+exports.AnalyticsReportQueryDto = AnalyticsReportQueryDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Start of the reporting period (inclusive)',
+        example: '2026-03-01T00:00:00.000Z',
+    }),
+    (0, class_validator_1.IsISO8601)(),
+    __metadata("design:type", String)
+], AnalyticsReportQueryDto.prototype, "startDate", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'End of the reporting period (exclusive)',
+        example: '2026-04-01T00:00:00.000Z',
+    }),
+    (0, class_validator_1.IsISO8601)(),
+    __metadata("design:type", String)
+], AnalyticsReportQueryDto.prototype, "endDate", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Filter by event type',
+        enum: event_analytic_enum_1.EVENT_ANALYTIC_TYPES,
+        example: 'patient.created',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsIn)([...event_analytic_enum_1.EVENT_ANALYTIC_TYPES]),
+    __metadata("design:type", String)
+], AnalyticsReportQueryDto.prototype, "eventType", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Group results by time granularity',
+        enum: exports.ANALYTICS_GROUP_BY,
+        example: 'day',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsIn)([...exports.ANALYTICS_GROUP_BY]),
+    __metadata("design:type", String)
+], AnalyticsReportQueryDto.prototype, "groupBy", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ description: 'Page number (starts at 1)', example: 1 }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], AnalyticsReportQueryDto.prototype, "page", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ description: 'Records per page', example: 20 }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsPositive)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], AnalyticsReportQueryDto.prototype, "limit", void 0);
+/**
+ * Query DTO for the dashboard summary endpoint.
+ */
+class AnalyticsDashboardQueryDto {
+    startDate;
+    endDate;
+}
+exports.AnalyticsDashboardQueryDto = AnalyticsDashboardQueryDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Start of the reporting period (inclusive)',
+        example: '2026-03-01T00:00:00.000Z',
+    }),
+    (0, class_validator_1.IsISO8601)(),
+    __metadata("design:type", String)
+], AnalyticsDashboardQueryDto.prototype, "startDate", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'End of the reporting period (exclusive)',
+        example: '2026-04-01T00:00:00.000Z',
+    }),
+    (0, class_validator_1.IsISO8601)(),
+    __metadata("design:type", String)
+], AnalyticsDashboardQueryDto.prototype, "endDate", void 0);

package/dist/analytics/create-analytic-event.dto.d.ts

@@ -0,0 +1,15 @@
+import { EventAnalyticType } from './event-analytic.enum';
+/**
+ * Payload that every microservice must send to the analytics topic.
+ */
+export declare class CreateAnalyticEventDto {
+    eventId: string;
+    tenant: string;
+    eventType: EventAnalyticType;
+    entityId?: string;
+    source?: string;
+    userId?: string;
+    metadata?: Record<string, unknown>;
+    occurredAt: string;
+}
+//# sourceMappingURL=create-analytic-event.dto.d.ts.map

package/dist/analytics/create-analytic-event.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-analytic-event.dto.d.ts","sourceRoot":"","sources":["../../src/analytics/create-analytic-event.dto.ts"],"names":[],"mappings":"AAYA,OAAO,EAAwB,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAEhF;;GAEG;AACH,qBAAa,sBAAsB;IAMjC,OAAO,EAAE,MAAM,CAAC;IAUhB,MAAM,EAAE,MAAM,CAAC;IAQf,SAAS,EAAE,iBAAiB,CAAC;IAS7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IASlB,MAAM,CAAC,EAAE,MAAM,CAAC;IAShB,MAAM,CAAC,EAAE,MAAM,CAAC;IAQhB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAOnC,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/analytics/create-analytic-event.dto.js

@@ -0,0 +1,104 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateAnalyticEventDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const event_analytic_enum_1 = require("./event-analytic.enum");
+/**
+ * Payload that every microservice must send to the analytics topic.
+ */
+class CreateAnalyticEventDto {
+    eventId;
+    tenant;
+    eventType;
+    entityId;
+    source;
+    userId;
+    metadata;
+    occurredAt;
+}
+exports.CreateAnalyticEventDto = CreateAnalyticEventDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Unique event ID for idempotent processing',
+        example: 'f3f50ecb-fb71-4d4b-a0dd-910ef6e3fd0a',
+    }),
+    (0, class_validator_1.IsUUID)(),
+    __metadata("design:type", String)
+], CreateAnalyticEventDto.prototype, "eventId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Tenant slug that originated the event',
+        example: 'homolog',
+    }),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.MinLength)(1),
+    (0, class_validator_1.MaxLength)(255),
+    __metadata("design:type", String)
+], CreateAnalyticEventDto.prototype, "tenant", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Type of analytic event',
+        enum: event_analytic_enum_1.EVENT_ANALYTIC_TYPES,
+        example: 'patient.created',
+    }),
+    (0, class_validator_1.IsIn)([...event_analytic_enum_1.EVENT_ANALYTIC_TYPES]),
+    __metadata("design:type", String)
+], CreateAnalyticEventDto.prototype, "eventType", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'ID of the entity related to this event (patient, appointment, etc.)',
+        example: '3c593727-4505-495a-a054-c052acb4cf19',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(255),
+    __metadata("design:type", String)
+], CreateAnalyticEventDto.prototype, "entityId", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Name of the source microservice',
+        example: 'tychat-patient-service',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(255),
+    __metadata("design:type", String)
+], CreateAnalyticEventDto.prototype, "source", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Optional user ID who triggered the action',
+        example: 'a1b2c3d4-e5f6-4789-abcd-ef0123456789',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(255),
+    __metadata("design:type", String)
+], CreateAnalyticEventDto.prototype, "userId", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Additional metadata for the event (flexible JSON)',
+        example: { previousStatus: 'pending', newStatus: 'finished' },
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], CreateAnalyticEventDto.prototype, "metadata", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'ISO 8601 timestamp when the event occurred',
+        example: '2026-04-02T12:00:00.000Z',
+    }),
+    (0, class_validator_1.IsISO8601)(),
+    __metadata("design:type", String)
+], CreateAnalyticEventDto.prototype, "occurredAt", void 0);

package/dist/analytics/event-analytic.enum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Enum of all analytic event types emitted by microservices.
+ * Each value follows the pattern: `domain.action`.
+ */
+export declare const EVENT_ANALYTIC_TYPES: readonly ["patient.created", "patient.updated", "patient.deleted", "patient.status_changed", "appointment.created", "appointment.updated", "appointment.canceled", "appointment.rescheduled", "appointment.no_show", "appointment.finished", "checkin.effectued", "checkout.effectued", "message.sent", "message.received", "conversation.session_started", "conversation.session_ended", "conversation.transferred_to_human", "followup.triggered", "followup.completed", "followup.config_updated", "payment.created", "payment.payed", "payment.refunded", "payment.canceled", "payment.overdue", "billing.invoice_created", "billing.invoice_paid", "ai.interaction", "ai.fallback", "auth.login", "auth.logout", "auth.password_reset", "user.created", "user.updated", "user.deleted", "notification.sent", "notification.failed", "whatsapp.connection_established", "whatsapp.connection_lost", "procedure.created", "procedure.updated", "procedure.deleted", "specialty.created", "specialty.updated", "specialty.deleted", "professional.created", "professional.updated", "professional.deleted", "configuration.updated", "storage.file_uploaded", "storage.file_deleted", "tenant.created", "tenant.updated"];
+export type EventAnalyticType = (typeof EVENT_ANALYTIC_TYPES)[number];
+//# sourceMappingURL=event-analytic.enum.d.ts.map

package/dist/analytics/event-analytic.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-analytic.enum.d.ts","sourceRoot":"","sources":["../../src/analytics/event-analytic.enum.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,oBAAoB,6pCA2FvB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/analytics/event-analytic.enum.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVENT_ANALYTIC_TYPES = void 0;
+/**
+ * Enum of all analytic event types emitted by microservices.
+ * Each value follows the pattern: `domain.action`.
+ */
+exports.EVENT_ANALYTIC_TYPES = [
+    // ── Patient events ──────────────────────────────────────────────
+    'patient.created',
+    'patient.updated',
+    'patient.deleted',
+    'patient.status_changed',
+    // ── Appointment events ──────────────────────────────────────────
+    'appointment.created',
+    'appointment.updated',
+    'appointment.canceled',
+    'appointment.rescheduled',
+    'appointment.no_show',
+    'appointment.finished',
+    // ── Check-in / Check-out events ─────────────────────────────────
+    'checkin.effectued',
+    'checkout.effectued',
+    // ── Message events ──────────────────────────────────────────────
+    'message.sent',
+    'message.received',
+    // ── Conversation / Session events ───────────────────────────────
+    'conversation.session_started',
+    'conversation.session_ended',
+    'conversation.transferred_to_human',
+    // ── Follow-up events ────────────────────────────────────────────
+    'followup.triggered',
+    'followup.completed',
+    'followup.config_updated',
+    // ── Payment events ──────────────────────────────────────────────
+    'payment.created',
+    'payment.payed',
+    'payment.refunded',
+    'payment.canceled',
+    'payment.overdue',
+    // ── Billing events ──────────────────────────────────────────────
+    'billing.invoice_created',
+    'billing.invoice_paid',
+    // ── AI events ───────────────────────────────────────────────────
+    'ai.interaction',
+    'ai.fallback',
+    // ── Auth events ─────────────────────────────────────────────────
+    'auth.login',
+    'auth.logout',
+    'auth.password_reset',
+    // ── User / Staff events ─────────────────────────────────────────
+    'user.created',
+    'user.updated',
+    'user.deleted',
+    // ── Notification events ─────────────────────────────────────────
+    'notification.sent',
+    'notification.failed',
+    // ── WhatsApp events ─────────────────────────────────────────────
+    'whatsapp.connection_established',
+    'whatsapp.connection_lost',
+    // ── Procedure events ────────────────────────────────────────────
+    'procedure.created',
+    'procedure.updated',
+    'procedure.deleted',
+    // ── Specialty events ────────────────────────────────────────────
+    'specialty.created',
+    'specialty.updated',
+    'specialty.deleted',
+    // ── Professional events ─────────────────────────────────────────
+    'professional.created',
+    'professional.updated',
+    'professional.deleted',
+    // ── Configuration events ────────────────────────────────────────
+    'configuration.updated',
+    // ── Storage events ──────────────────────────────────────────────
+    'storage.file_uploaded',
+    'storage.file_deleted',
+    // ── Tenant events ───────────────────────────────────────────────
+    'tenant.created',
+    'tenant.updated',
+];

package/dist/analytics/index.d.ts

@@ -0,0 +1,5 @@
+export * from './event-analytic.enum';
+export * from './create-analytic-event.dto';
+export * from './analytics-query.dto';
+export * from './analytics-kafka-topics';
+//# sourceMappingURL=index.d.ts.map

package/dist/analytics/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC"}

package/dist/analytics/index.js

@@ -0,0 +1,20 @@
+"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("./event-analytic.enum"), exports);
+__exportStar(require("./create-analytic-event.dto"), exports);
+__exportStar(require("./analytics-query.dto"), exports);
+__exportStar(require("./analytics-kafka-topics"), exports);

package/dist/index.d.ts

@@ -14,4 +14,5 @@ export * from './notifications';
 export * from './tenants';
 export * from './conversations';
 export * from './connections';
+export * from './analytics';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,MAAM,CAAC;AACrB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,MAAM,CAAC;AACrB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -30,3 +30,4 @@ __exportStar(require("./notifications"), exports);
 __exportStar(require("./tenants"), exports);
 __exportStar(require("./conversations"), exports);
 __exportStar(require("./connections"), exports);
+__exportStar(require("./analytics"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tychat-contracts",
-  "version": "1.0.76",
+  "version": "1.0.77",
   "description": "DTOs compartilhados com class-validator (API e microserviços)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/analytics/analytics-kafka-topics.ts

@@ -0,0 +1,18 @@
+/**
+ * Kafka topic names used by the analytics service.
+ */
+
+/** Topic for ingesting analytic events from all microservices. */
+export const TOPIC_ANALYTICS_EVENT = 'analytics.event';
+
+/** Topic for requesting a report grouped by event type and period. */
+export const TOPIC_ANALYTICS_REPORT = 'analytics.report';
+
+/** Topic for requesting a dashboard summary (counts per domain). */
+export const TOPIC_ANALYTICS_DASHBOARD = 'analytics.dashboard';
+
+/** Topic for requesting a time-series breakdown of events. */
+export const TOPIC_ANALYTICS_TIMESERIES = 'analytics.timeseries';
+
+/** Topic for requesting event details with pagination. */
+export const TOPIC_ANALYTICS_EVENTS_LIST = 'analytics.events.list';

package/src/analytics/analytics-query.dto.ts

@@ -0,0 +1,89 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  IsIn,
+  IsISO8601,
+  IsNotEmpty,
+  IsOptional,
+  IsPositive,
+  IsString,
+  MaxLength,
+  Min,
+} from 'class-validator';
+import { Type } from 'class-transformer';
+import { EVENT_ANALYTIC_TYPES, EventAnalyticType } from './event-analytic.enum';
+
+/**
+ * Grouping granularity for time-series report data.
+ */
+export const ANALYTICS_GROUP_BY = ['hour', 'day', 'week', 'month'] as const;
+export type AnalyticsGroupBy = (typeof ANALYTICS_GROUP_BY)[number];
+
+/**
+ * Query DTO used to request analytics reports.
+ */
+export class AnalyticsReportQueryDto {
+  @ApiProperty({
+    description: 'Start of the reporting period (inclusive)',
+    example: '2026-03-01T00:00:00.000Z',
+  })
+  @IsISO8601()
+  startDate: string;
+
+  @ApiProperty({
+    description: 'End of the reporting period (exclusive)',
+    example: '2026-04-01T00:00:00.000Z',
+  })
+  @IsISO8601()
+  endDate: string;
+
+  @ApiPropertyOptional({
+    description: 'Filter by event type',
+    enum: EVENT_ANALYTIC_TYPES,
+    example: 'patient.created',
+  })
+  @IsOptional()
+  @IsIn([...EVENT_ANALYTIC_TYPES])
+  eventType?: EventAnalyticType;
+
+  @ApiPropertyOptional({
+    description: 'Group results by time granularity',
+    enum: ANALYTICS_GROUP_BY,
+    example: 'day',
+  })
+  @IsOptional()
+  @IsIn([...ANALYTICS_GROUP_BY])
+  groupBy?: AnalyticsGroupBy;
+
+  @ApiPropertyOptional({ description: 'Page number (starts at 1)', example: 1 })
+  @IsOptional()
+  @Type(() => Number)
+  @IsPositive()
+  @Min(1)
+  page?: number;
+
+  @ApiPropertyOptional({ description: 'Records per page', example: 20 })
+  @IsOptional()
+  @Type(() => Number)
+  @IsPositive()
+  @Min(1)
+  limit?: number;
+}
+
+/**
+ * Query DTO for the dashboard summary endpoint.
+ */
+export class AnalyticsDashboardQueryDto {
+  @ApiProperty({
+    description: 'Start of the reporting period (inclusive)',
+    example: '2026-03-01T00:00:00.000Z',
+  })
+  @IsISO8601()
+  startDate: string;
+
+  @ApiProperty({
+    description: 'End of the reporting period (exclusive)',
+    example: '2026-04-01T00:00:00.000Z',
+  })
+  @IsISO8601()
+  endDate: string;
+}

package/src/analytics/create-analytic-event.dto.ts

@@ -0,0 +1,85 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  IsIn,
+  IsISO8601,
+  IsNotEmpty,
+  IsObject,
+  IsOptional,
+  IsString,
+  IsUUID,
+  MaxLength,
+  MinLength,
+} from 'class-validator';
+import { EVENT_ANALYTIC_TYPES, EventAnalyticType } from './event-analytic.enum';
+
+/**
+ * Payload that every microservice must send to the analytics topic.
+ */
+export class CreateAnalyticEventDto {
+  @ApiProperty({
+    description: 'Unique event ID for idempotent processing',
+    example: 'f3f50ecb-fb71-4d4b-a0dd-910ef6e3fd0a',
+  })
+  @IsUUID()
+  eventId: string;
+
+  @ApiProperty({
+    description: 'Tenant slug that originated the event',
+    example: 'homolog',
+  })
+  @IsString()
+  @IsNotEmpty()
+  @MinLength(1)
+  @MaxLength(255)
+  tenant: string;
+
+  @ApiProperty({
+    description: 'Type of analytic event',
+    enum: EVENT_ANALYTIC_TYPES,
+    example: 'patient.created',
+  })
+  @IsIn([...EVENT_ANALYTIC_TYPES])
+  eventType: EventAnalyticType;
+
+  @ApiPropertyOptional({
+    description: 'ID of the entity related to this event (patient, appointment, etc.)',
+    example: '3c593727-4505-495a-a054-c052acb4cf19',
+  })
+  @IsOptional()
+  @IsString()
+  @MaxLength(255)
+  entityId?: string;
+
+  @ApiPropertyOptional({
+    description: 'Name of the source microservice',
+    example: 'tychat-patient-service',
+  })
+  @IsOptional()
+  @IsString()
+  @MaxLength(255)
+  source?: string;
+
+  @ApiPropertyOptional({
+    description: 'Optional user ID who triggered the action',
+    example: 'a1b2c3d4-e5f6-4789-abcd-ef0123456789',
+  })
+  @IsOptional()
+  @IsString()
+  @MaxLength(255)
+  userId?: string;
+
+  @ApiPropertyOptional({
+    description: 'Additional metadata for the event (flexible JSON)',
+    example: { previousStatus: 'pending', newStatus: 'finished' },
+  })
+  @IsOptional()
+  @IsObject()
+  metadata?: Record<string, unknown>;
+
+  @ApiProperty({
+    description: 'ISO 8601 timestamp when the event occurred',
+    example: '2026-04-02T12:00:00.000Z',
+  })
+  @IsISO8601()
+  occurredAt: string;
+}

package/src/analytics/event-analytic.enum.ts

@@ -0,0 +1,98 @@
+/**
+ * Enum of all analytic event types emitted by microservices.
+ * Each value follows the pattern: `domain.action`.
+ */
+export const EVENT_ANALYTIC_TYPES = [
+  // ── Patient events ──────────────────────────────────────────────
+  'patient.created',
+  'patient.updated',
+  'patient.deleted',
+  'patient.status_changed',
+
+  // ── Appointment events ──────────────────────────────────────────
+  'appointment.created',
+  'appointment.updated',
+  'appointment.canceled',
+  'appointment.rescheduled',
+  'appointment.no_show',
+  'appointment.finished',
+
+  // ── Check-in / Check-out events ─────────────────────────────────
+  'checkin.effectued',
+  'checkout.effectued',
+
+  // ── Message events ──────────────────────────────────────────────
+  'message.sent',
+  'message.received',
+
+  // ── Conversation / Session events ───────────────────────────────
+  'conversation.session_started',
+  'conversation.session_ended',
+  'conversation.transferred_to_human',
+
+  // ── Follow-up events ────────────────────────────────────────────
+  'followup.triggered',
+  'followup.completed',
+  'followup.config_updated',
+
+  // ── Payment events ──────────────────────────────────────────────
+  'payment.created',
+  'payment.payed',
+  'payment.refunded',
+  'payment.canceled',
+  'payment.overdue',
+
+  // ── Billing events ──────────────────────────────────────────────
+  'billing.invoice_created',
+  'billing.invoice_paid',
+
+  // ── AI events ───────────────────────────────────────────────────
+  'ai.interaction',
+  'ai.fallback',
+
+  // ── Auth events ─────────────────────────────────────────────────
+  'auth.login',
+  'auth.logout',
+  'auth.password_reset',
+
+  // ── User / Staff events ─────────────────────────────────────────
+  'user.created',
+  'user.updated',
+  'user.deleted',
+
+  // ── Notification events ─────────────────────────────────────────
+  'notification.sent',
+  'notification.failed',
+
+  // ── WhatsApp events ─────────────────────────────────────────────
+  'whatsapp.connection_established',
+  'whatsapp.connection_lost',
+
+  // ── Procedure events ────────────────────────────────────────────
+  'procedure.created',
+  'procedure.updated',
+  'procedure.deleted',
+
+  // ── Specialty events ────────────────────────────────────────────
+  'specialty.created',
+  'specialty.updated',
+  'specialty.deleted',
+
+  // ── Professional events ─────────────────────────────────────────
+  'professional.created',
+  'professional.updated',
+  'professional.deleted',
+
+  // ── Configuration events ────────────────────────────────────────
+  'configuration.updated',
+
+  // ── Storage events ──────────────────────────────────────────────
+  'storage.file_uploaded',
+  'storage.file_deleted',
+
+  // ── Tenant events ───────────────────────────────────────────────
+  'tenant.created',
+  'tenant.updated',
+] as const;
+
+export type EventAnalyticType = (typeof EVENT_ANALYTIC_TYPES)[number];

package/src/analytics/index.ts

@@ -0,0 +1,4 @@
+export * from './event-analytic.enum';
+export * from './create-analytic-event.dto';
+export * from './analytics-query.dto';
+export * from './analytics-kafka-topics';

package/src/index.ts

@@ -14,3 +14,4 @@ export * from './notifications';
 export * from './tenants';
 export * from './conversations';
 export * from './connections';
+export * from './analytics';