tychat-contracts 1.0.100 → 1.0.101

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

@@ -32,6 +32,18 @@ export declare class AnalyticsDashboardTopProcedureDto {
     name: string;
     count: number;
 }
+/** Média de `message.sent` por hora do relógio durante o expediente configurado. */
+export declare class AnalyticsDashboardMessageHourDto {
+    hour: number;
+    averageSent: number;
+    totalSent: number;
+    openOccurrencesInPeriod: number;
+}
+export declare class AnalyticsDashboardMessagePeakDto {
+    hour: number;
+    totalSent: number;
+    averageSent: number;
+}
 /**
  * Resposta enriquecida de `GET /analytics/dashboard` (mantém campos legados `total`, `byEventType`, `byDomain`).
  */
@@ -44,6 +56,9 @@ export declare class AnalyticsDashboardResponseDto {
     noShowRatePercent: number;
     financialSummary: AnalyticsDashboardFinancialDto;
     topProcedures: AnalyticsDashboardTopProcedureDto[];
+    messagesByClinicHour: AnalyticsDashboardMessageHourDto[];
+    messagesPeakHour: AnalyticsDashboardMessagePeakDto | null;
+    clinicTimezone: string;
     total: number;
     byEventType: Array<{
         eventType: string;

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

@@ -1 +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;AAED,8FAA8F;AAC9F,qBAAa,8BAA8B;IAKzC,OAAO,EAAE,MAAM,CAAC;IAMhB,aAAa,EAAE,MAAM,CAAC;IAMtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,iCAAiC;IAE5C,IAAI,EAAE,MAAM,CAAC;IAGb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,qBAAa,6BAA6B;IAExC,mBAAmB,EAAE,MAAM,CAAC;IAG5B,oBAAoB,EAAE,MAAM,CAAC;IAM7B,mBAAmB,EAAE,MAAM,CAAC;IAK5B,kBAAkB,EAAE,MAAM,CAAC;IAO3B,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAMnC,iBAAiB,EAAE,MAAM,CAAC;IAG1B,gBAAgB,EAAE,8BAA8B,CAAC;IAGjD,aAAa,EAAE,iCAAiC,EAAE,CAAC;IAGnD,KAAK,EAAE,MAAM,CAAC;IAKd,WAAW,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAKzD,QAAQ,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACpD"}
+{"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;AAED,8FAA8F;AAC9F,qBAAa,8BAA8B;IAKzC,OAAO,EAAE,MAAM,CAAC;IAMhB,aAAa,EAAE,MAAM,CAAC;IAMtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,iCAAiC;IAE5C,IAAI,EAAE,MAAM,CAAC;IAGb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,oFAAoF;AACpF,qBAAa,gCAAgC;IAE3C,IAAI,EAAE,MAAM,CAAC;IAMb,WAAW,EAAE,MAAM,CAAC;IAGpB,SAAS,EAAE,MAAM,CAAC;IAMlB,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED,qBAAa,gCAAgC;IAE3C,IAAI,EAAE,MAAM,CAAC;IAEE,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;CACpC;AAED;;GAEG;AACH,qBAAa,6BAA6B;IAExC,mBAAmB,EAAE,MAAM,CAAC;IAG5B,oBAAoB,EAAE,MAAM,CAAC;IAM7B,mBAAmB,EAAE,MAAM,CAAC;IAK5B,kBAAkB,EAAE,MAAM,CAAC;IAO3B,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAMnC,iBAAiB,EAAE,MAAM,CAAC;IAG1B,gBAAgB,EAAE,8BAA8B,CAAC;IAGjD,aAAa,EAAE,iCAAiC,EAAE,CAAC;IAOnD,oBAAoB,EAAE,gCAAgC,EAAE,CAAC;IAOzD,gBAAgB,EAAE,gCAAgC,GAAG,IAAI,CAAC;IAM1D,cAAc,EAAE,MAAM,CAAC;IAGvB,KAAK,EAAE,MAAM,CAAC;IAKd,WAAW,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAKzD,QAAQ,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACpD"}

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

@@ -9,7 +9,7 @@ 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.AnalyticsDashboardResponseDto = exports.AnalyticsDashboardTopProcedureDto = exports.AnalyticsDashboardFinancialDto = exports.AnalyticsDashboardQueryDto = exports.AnalyticsReportQueryDto = exports.ANALYTICS_GROUP_BY = void 0;
+exports.AnalyticsDashboardResponseDto = exports.AnalyticsDashboardMessagePeakDto = exports.AnalyticsDashboardMessageHourDto = exports.AnalyticsDashboardTopProcedureDto = exports.AnalyticsDashboardFinancialDto = 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");
@@ -127,7 +127,7 @@ __decorate([
 ], AnalyticsDashboardFinancialDto.prototype, "averageTicket", void 0);
 __decorate([
     (0, swagger_1.ApiProperty)({
-        description: 'Volume de cobranças criadas no período ainda não quitadas no momento do registro: soma de `payment.created` + faturas `billing.invoice_created` com status PENDING ou OVERDUE no metadata (aproximação; não substitui saldo contábil)',
+        description: 'Valor ainda em aberto no fim do período (exclusive endDate): soma de `payment.created` no intervalo sem `payment.payed` correspondente (mesmo paymentId) com occurredAt anterior a endDate; mais faturas `billing.invoice_created` PENDING/OVERDUE sem `billing.invoice_paid` (mesmo invoiceId). Baseado em eventos de analytics.',
     }),
     __metadata("design:type", Number)
 ], AnalyticsDashboardFinancialDto.prototype, "pending", void 0);
@@ -144,6 +144,52 @@ __decorate([
     (0, swagger_1.ApiProperty)({ description: 'Quantidade de ocorrências no período' }),
     __metadata("design:type", Number)
 ], AnalyticsDashboardTopProcedureDto.prototype, "count", void 0);
+/** Média de `message.sent` por hora do relógio durante o expediente configurado. */
+class AnalyticsDashboardMessageHourDto {
+    hour;
+    averageSent;
+    totalSent;
+    openOccurrencesInPeriod;
+}
+exports.AnalyticsDashboardMessageHourDto = AnalyticsDashboardMessageHourDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Hora local (0–23) no fuso clinicTimezone' }),
+    __metadata("design:type", Number)
+], AnalyticsDashboardMessageHourDto.prototype, "hour", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Média de mensagens enviadas nessa hora: totalSent / openOccurrencesInPeriod (0 se não houve expediente nessa hora no período)',
+    }),
+    __metadata("design:type", Number)
+], AnalyticsDashboardMessageHourDto.prototype, "averageSent", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Total de eventos message.sent nessa hora local, só dentro do horário da clínica' }),
+    __metadata("design:type", Number)
+], AnalyticsDashboardMessageHourDto.prototype, "totalSent", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Quantas vezes essa hora calendário integrou o expediente (dias locais no intervalo × slots de opening_hours)',
+    }),
+    __metadata("design:type", Number)
+], AnalyticsDashboardMessageHourDto.prototype, "openOccurrencesInPeriod", void 0);
+class AnalyticsDashboardMessagePeakDto {
+    hour;
+    totalSent;
+    averageSent;
+}
+exports.AnalyticsDashboardMessagePeakDto = AnalyticsDashboardMessagePeakDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Hora local (0–23) com maior totalSent entre as horas de expediente' }),
+    __metadata("design:type", Number)
+], AnalyticsDashboardMessagePeakDto.prototype, "hour", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", Number)
+], AnalyticsDashboardMessagePeakDto.prototype, "totalSent", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", Number)
+], AnalyticsDashboardMessagePeakDto.prototype, "averageSent", void 0);
 /**
  * Resposta enriquecida de `GET /analytics/dashboard` (mantém campos legados `total`, `byEventType`, `byDomain`).
  */
@@ -156,6 +202,9 @@ class AnalyticsDashboardResponseDto {
     noShowRatePercent;
     financialSummary;
     topProcedures;
+    messagesByClinicHour;
+    messagesPeakHour;
+    clinicTimezone;
     total;
     byEventType;
     byDomain;
@@ -202,6 +251,28 @@ __decorate([
     (0, swagger_1.ApiProperty)({ type: [AnalyticsDashboardTopProcedureDto], maxItems: 5 }),
     __metadata("design:type", Array)
 ], AnalyticsDashboardResponseDto.prototype, "topProcedures", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Pico / distribuição de mensagens no horário da clínica: médias por hora local (só `message.sent` dentro de opening_hours). Ordenado por hora crescente. Vazio se não houver opening_hours.',
+        type: [AnalyticsDashboardMessageHourDto],
+    }),
+    __metadata("design:type", Array)
+], AnalyticsDashboardResponseDto.prototype, "messagesByClinicHour", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Hora com maior volume de mensagens no expediente; null se não houver dados ou horário configurado',
+        nullable: true,
+        type: AnalyticsDashboardMessagePeakDto,
+    }),
+    __metadata("design:type", Object)
+], AnalyticsDashboardResponseDto.prototype, "messagesPeakHour", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Fuso IANA usado para hora local e opening_hours (env ANALYTICS_CLINIC_TIMEZONE ou America/Sao_Paulo)',
+        example: 'America/Sao_Paulo',
+    }),
+    __metadata("design:type", String)
+], AnalyticsDashboardResponseDto.prototype, "clinicTimezone", void 0);
 __decorate([
     (0, swagger_1.ApiProperty)({ description: 'Total de eventos de analytics no período (legado)' }),
     __metadata("design:type", Number)

package/package.json

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

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

@@ -104,7 +104,7 @@ export class AnalyticsDashboardFinancialDto {
 
   @ApiProperty({
     description:
-      'Volume de cobranças criadas no período ainda não quitadas no momento do registro: soma de `payment.created` + faturas `billing.invoice_created` com status PENDING ou OVERDUE no metadata (aproximação; não substitui saldo contábil)',
+      'Valor ainda em aberto no fim do período (exclusive endDate): soma de `payment.created` no intervalo sem `payment.payed` correspondente (mesmo paymentId) com occurredAt anterior a endDate; mais faturas `billing.invoice_created` PENDING/OVERDUE sem `billing.invoice_paid` (mesmo invoiceId). Baseado em eventos de analytics.',
   })
   pending: number;
 }
@@ -117,6 +117,36 @@ export class AnalyticsDashboardTopProcedureDto {
   count: number;
 }
 
+/** Média de `message.sent` por hora do relógio durante o expediente configurado. */
+export class AnalyticsDashboardMessageHourDto {
+  @ApiProperty({ description: 'Hora local (0–23) no fuso clinicTimezone' })
+  hour: number;
+
+  @ApiProperty({
+    description:
+      'Média de mensagens enviadas nessa hora: totalSent / openOccurrencesInPeriod (0 se não houve expediente nessa hora no período)',
+  })
+  averageSent: number;
+
+  @ApiProperty({ description: 'Total de eventos message.sent nessa hora local, só dentro do horário da clínica' })
+  totalSent: number;
+
+  @ApiProperty({
+    description:
+      'Quantas vezes essa hora calendário integrou o expediente (dias locais no intervalo × slots de opening_hours)',
+  })
+  openOccurrencesInPeriod: number;
+}
+
+export class AnalyticsDashboardMessagePeakDto {
+  @ApiProperty({ description: 'Hora local (0–23) com maior totalSent entre as horas de expediente' })
+  hour: number;
+
+  @ApiProperty() totalSent: number;
+
+  @ApiProperty() averageSent: number;
+}
+
 /**
  * Resposta enriquecida de `GET /analytics/dashboard` (mantém campos legados `total`, `byEventType`, `byDomain`).
  */
@@ -157,6 +187,26 @@ export class AnalyticsDashboardResponseDto {
   @ApiProperty({ type: [AnalyticsDashboardTopProcedureDto], maxItems: 5 })
   topProcedures: AnalyticsDashboardTopProcedureDto[];
 
+  @ApiProperty({
+    description:
+      'Pico / distribuição de mensagens no horário da clínica: médias por hora local (só `message.sent` dentro de opening_hours). Ordenado por hora crescente. Vazio se não houver opening_hours.',
+    type: [AnalyticsDashboardMessageHourDto],
+  })
+  messagesByClinicHour: AnalyticsDashboardMessageHourDto[];
+
+  @ApiProperty({
+    description: 'Hora com maior volume de mensagens no expediente; null se não houver dados ou horário configurado',
+    nullable: true,
+    type: AnalyticsDashboardMessagePeakDto,
+  })
+  messagesPeakHour: AnalyticsDashboardMessagePeakDto | null;
+
+  @ApiProperty({
+    description: 'Fuso IANA usado para hora local e opening_hours (env ANALYTICS_CLINIC_TIMEZONE ou America/Sao_Paulo)',
+    example: 'America/Sao_Paulo',
+  })
+  clinicTimezone: string;
+
   @ApiProperty({ description: 'Total de eventos de analytics no período (legado)' })
   total: number;