tychat-contracts 1.0.87 → 1.0.89

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

@@ -2,6 +2,6 @@
  * 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", "payment_gateway.payment_created", "payment_gateway.payment_confirmed", "payment_gateway.payment_failed", "payment_gateway.payment_refunded", "payment_gateway.payment_canceled", "payment_gateway.payment_expired", "payment_gateway.webhook_received", "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 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.abandonment.sent", "followup.appointment_confirmation.sent", "followup.satisfaction_booking.sent", "followup.satisfaction_finished.sent", "followup.no_show_reschedule.sent", "followup.wellness_check.sent", "followup.return_suggestion.sent", "followup.satisfaction_booking.response_received", "followup.satisfaction_finished.response_received", "followup.config_updated", "payment.created", "payment.payed", "payment.refunded", "payment.canceled", "payment.overdue", "payment_gateway.payment_created", "payment_gateway.payment_confirmed", "payment_gateway.payment_failed", "payment_gateway.payment_refunded", "payment_gateway.payment_canceled", "payment_gateway.payment_expired", "payment_gateway.webhook_received", "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

@@ -1 +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,s5CAoGvB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"event-analytic.enum.d.ts","sourceRoot":"","sources":["../../src/analytics/event-analytic.enum.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,oBAAoB,4sDA2GvB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC"}

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

@@ -28,9 +28,16 @@ exports.EVENT_ANALYTIC_TYPES = [
     'conversation.session_started',
     'conversation.session_ended',
     'conversation.transferred_to_human',
-    // ── Follow-up events ────────────────────────────────────────────
-    'followup.triggered',
-    'followup.completed',
+    // ── Follow-up events (tychat-followup-service) ─────────────────
+    'followup.abandonment.sent',
+    'followup.appointment_confirmation.sent',
+    'followup.satisfaction_booking.sent',
+    'followup.satisfaction_finished.sent',
+    'followup.no_show_reschedule.sent',
+    'followup.wellness_check.sent',
+    'followup.return_suggestion.sent',
+    'followup.satisfaction_booking.response_received',
+    'followup.satisfaction_finished.response_received',
     'followup.config_updated',
     // ── Payment events ──────────────────────────────────────────────
     'payment.created',

package/dist/analytics/followup-analytic-event-type.util.d.ts

@@ -0,0 +1,12 @@
+import type { EventAnalyticType } from './event-analytic.enum';
+/**
+ * Tipos de follow-up baseados em agendamento (fila `followup-appointment`),
+ * alinhados a {@link FOLLOWUP_TYPES} exceto `abandonment`.
+ */
+export type FollowupAppointmentDispatchKind = 'appointment_confirmation' | 'satisfaction_booking' | 'satisfaction_finished' | 'no_show_reschedule' | 'wellness_check' | 'return_suggestion';
+export declare function followupAppointmentSentEventType(kind: FollowupAppointmentDispatchKind): EventAnalyticType;
+export type FollowupSatisfactionSurveyKind = 'satisfaction_booking' | 'satisfaction_finished';
+export declare function followupSatisfactionResponseEventType(satisfactionType: FollowupSatisfactionSurveyKind): EventAnalyticType;
+/** Evento quando um passo de abandono é enviado com sucesso. */
+export declare const FOLLOWUP_ABANDONMENT_SENT_EVENT: EventAnalyticType;
+//# sourceMappingURL=followup-analytic-event-type.util.d.ts.map

package/dist/analytics/followup-analytic-event-type.util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"followup-analytic-event-type.util.d.ts","sourceRoot":"","sources":["../../src/analytics/followup-analytic-event-type.util.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GACvC,0BAA0B,GAC1B,sBAAsB,GACtB,uBAAuB,GACvB,oBAAoB,GACpB,gBAAgB,GAChB,mBAAmB,CAAC;AAWxB,wBAAgB,gCAAgC,CAC9C,IAAI,EAAE,+BAA+B,GACpC,iBAAiB,CAEnB;AAED,MAAM,MAAM,8BAA8B,GACtC,sBAAsB,GACtB,uBAAuB,CAAC;AAE5B,wBAAgB,qCAAqC,CACnD,gBAAgB,EAAE,8BAA8B,GAC/C,iBAAiB,CAKnB;AAED,gEAAgE;AAChE,eAAO,MAAM,+BAA+B,EAAE,iBAA+C,CAAC"}

package/dist/analytics/followup-analytic-event-type.util.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FOLLOWUP_ABANDONMENT_SENT_EVENT = void 0;
+exports.followupAppointmentSentEventType = followupAppointmentSentEventType;
+exports.followupSatisfactionResponseEventType = followupSatisfactionResponseEventType;
+const APPOINTMENT_SENT = {
+    appointment_confirmation: 'followup.appointment_confirmation.sent',
+    satisfaction_booking: 'followup.satisfaction_booking.sent',
+    satisfaction_finished: 'followup.satisfaction_finished.sent',
+    no_show_reschedule: 'followup.no_show_reschedule.sent',
+    wellness_check: 'followup.wellness_check.sent',
+    return_suggestion: 'followup.return_suggestion.sent',
+};
+function followupAppointmentSentEventType(kind) {
+    return APPOINTMENT_SENT[kind];
+}
+function followupSatisfactionResponseEventType(satisfactionType) {
+    if (satisfactionType === 'satisfaction_booking') {
+        return 'followup.satisfaction_booking.response_received';
+    }
+    return 'followup.satisfaction_finished.response_received';
+}
+/** Evento quando um passo de abandono é enviado com sucesso. */
+exports.FOLLOWUP_ABANDONMENT_SENT_EVENT = 'followup.abandonment.sent';

package/dist/analytics/index.d.ts

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

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

@@ -1 +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;AACzC,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC"}

package/dist/analytics/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./event-analytic.enum"), exports);
+__exportStar(require("./followup-analytic-event-type.util"), exports);
 __exportStar(require("./create-analytic-event.dto"), exports);
 __exportStar(require("./analytics-query.dto"), exports);
 __exportStar(require("./analytics-kafka-topics"), exports);

package/package.json

@@ -1,27 +1,27 @@
-{
-  "name": "tychat-contracts",
-  "version": "1.0.87",
-  "description": "DTOs compartilhados com class-validator (API e microserviços)",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "private": false,
-  "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build"
-  },
-  "dependencies": {
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
-    "ioredis": "^5.10.0",
-    "jest": "^30.3.0",
-    "reflect-metadata": "*"
-  },
-  "devDependencies": {
-    "@nestjs/swagger": "^11.2.6",
-    "typescript": "^5.7.3"
-  },
-  "peerDependencies": {
-    "@nestjs/swagger": "^11.2.6",
-    "reflect-metadata": "*"
-  }
-}
+{
+  "name": "tychat-contracts",
+  "version": "1.0.89",
+  "description": "DTOs compartilhados com class-validator (API e microserviços)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "private": false,
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "ioredis": "^5.10.0",
+    "jest": "^30.3.0",
+    "reflect-metadata": "*"
+  },
+  "devDependencies": {
+    "@nestjs/swagger": "^11.2.6",
+    "typescript": "^5.7.3"
+  },
+  "peerDependencies": {
+    "@nestjs/swagger": "^11.2.6",
+    "reflect-metadata": "*"
+  }
+}

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

@@ -30,9 +30,16 @@ export const EVENT_ANALYTIC_TYPES = [
   'conversation.session_ended',
   'conversation.transferred_to_human',
 
-  // ── Follow-up events ────────────────────────────────────────────
-  'followup.triggered',
-  'followup.completed',
+  // ── Follow-up events (tychat-followup-service) ─────────────────
+  'followup.abandonment.sent',
+  'followup.appointment_confirmation.sent',
+  'followup.satisfaction_booking.sent',
+  'followup.satisfaction_finished.sent',
+  'followup.no_show_reschedule.sent',
+  'followup.wellness_check.sent',
+  'followup.return_suggestion.sent',
+  'followup.satisfaction_booking.response_received',
+  'followup.satisfaction_finished.response_received',
   'followup.config_updated',
 
   // ── Payment events ──────────────────────────────────────────────

package/src/analytics/followup-analytic-event-type.util.ts

@@ -0,0 +1,44 @@
+import type { EventAnalyticType } from './event-analytic.enum';
+
+/**
+ * Tipos de follow-up baseados em agendamento (fila `followup-appointment`),
+ * alinhados a {@link FOLLOWUP_TYPES} exceto `abandonment`.
+ */
+export type FollowupAppointmentDispatchKind =
+  | 'appointment_confirmation'
+  | 'satisfaction_booking'
+  | 'satisfaction_finished'
+  | 'no_show_reschedule'
+  | 'wellness_check'
+  | 'return_suggestion';
+
+const APPOINTMENT_SENT: Record<FollowupAppointmentDispatchKind, EventAnalyticType> = {
+  appointment_confirmation: 'followup.appointment_confirmation.sent',
+  satisfaction_booking: 'followup.satisfaction_booking.sent',
+  satisfaction_finished: 'followup.satisfaction_finished.sent',
+  no_show_reschedule: 'followup.no_show_reschedule.sent',
+  wellness_check: 'followup.wellness_check.sent',
+  return_suggestion: 'followup.return_suggestion.sent',
+};
+
+export function followupAppointmentSentEventType(
+  kind: FollowupAppointmentDispatchKind,
+): EventAnalyticType {
+  return APPOINTMENT_SENT[kind];
+}
+
+export type FollowupSatisfactionSurveyKind =
+  | 'satisfaction_booking'
+  | 'satisfaction_finished';
+
+export function followupSatisfactionResponseEventType(
+  satisfactionType: FollowupSatisfactionSurveyKind,
+): EventAnalyticType {
+  if (satisfactionType === 'satisfaction_booking') {
+    return 'followup.satisfaction_booking.response_received';
+  }
+  return 'followup.satisfaction_finished.response_received';
+}
+
+/** Evento quando um passo de abandono é enviado com sucesso. */
+export const FOLLOWUP_ABANDONMENT_SENT_EVENT: EventAnalyticType = 'followup.abandonment.sent';

package/src/analytics/index.ts

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

package/src/tenants/tenant-slug.util.ts

@@ -1,56 +1,56 @@
-/**
- * Utility functions for tenant slug <-> domain transformations.
- *
- * Convention:
- * - Slugs stored in DB use underscores for word separation (e.g. "clinica_sampaio")
- *   or are single words (e.g. "homolog"). Hyphens are NOT allowed in slugs.
- * - DNS hostnames use hyphens (underscores are invalid in DNS labels).
- * - Conversion is bijective: slug "clinica_sampaio" <-> domain "clinica-sampaio"
- *
- * Examples:
- * - Slug "homolog"          -> domain segment "homolog"           -> slug "homolog"
- * - Slug "clinica_sampaio"  -> domain segment "clinica-sampaio"   -> slug "clinica_sampaio"
- */
-
-/**
- * Converts a tenant slug to a DNS-safe domain segment.
- * Replaces underscores with hyphens and lowercases the result.
- *
- * @example slugToDomainSegment("clinica_sampaio") // "clinica-sampaio"
- * @example slugToDomainSegment("homolog")         // "homolog"
- */
-export function slugToDomainSegment(slug: string): string {
-  return (slug || 'default').toLowerCase().replace(/_/g, '-');
-}
-
-/**
- * Converts a domain segment back to the tenant slug.
- * Replaces hyphens with underscores (the stored DB format).
- *
- * @example domainSegmentToSlug("clinica-sampaio") // "clinica_sampaio"
- * @example domainSegmentToSlug("homolog")         // "homolog"
- */
-export function domainSegmentToSlug(domainSegment: string): string {
-  return (domainSegment || 'default').toLowerCase().replace(/-/g, '_');
-}
-
-/**
- * Regex pattern that validates an acceptable tenant slug.
- * Allows lowercase alphanumeric characters and underscores only (no hyphens).
- * Must start and end with an alphanumeric character.
- * Single-character slugs (e.g. "a") are allowed.
- * Max 63 chars (DNS label limit after _ -> - conversion).
- */
-export const TENANT_SLUG_REGEX = /^[a-z0-9]([a-z0-9_]*[a-z0-9])?$/;
-
-/**
- * Validates whether a slug is acceptable.
- * Rules:
- * - Only lowercase letters, digits, and underscores (no hyphens)
- * - Must start and end with a letter or digit
- * - Length between 1 and 63 characters
- */
-export function isValidTenantSlug(slug: string): boolean {
-  if (!slug || slug.length > 63) return false;
-  return TENANT_SLUG_REGEX.test(slug.toLowerCase());
-}
+/**
+ * Utility functions for tenant slug <-> domain transformations.
+ *
+ * Convention:
+ * - Slugs stored in DB use underscores for word separation (e.g. "clinica_sampaio")
+ *   or are single words (e.g. "homolog"). Hyphens are NOT allowed in slugs.
+ * - DNS hostnames use hyphens (underscores are invalid in DNS labels).
+ * - Conversion is bijective: slug "clinica_sampaio" <-> domain "clinica-sampaio"
+ *
+ * Examples:
+ * - Slug "homolog"          -> domain segment "homolog"           -> slug "homolog"
+ * - Slug "clinica_sampaio"  -> domain segment "clinica-sampaio"   -> slug "clinica_sampaio"
+ */
+
+/**
+ * Converts a tenant slug to a DNS-safe domain segment.
+ * Replaces underscores with hyphens and lowercases the result.
+ *
+ * @example slugToDomainSegment("clinica_sampaio") // "clinica-sampaio"
+ * @example slugToDomainSegment("homolog")         // "homolog"
+ */
+export function slugToDomainSegment(slug: string): string {
+  return (slug || 'default').toLowerCase().replace(/_/g, '-');
+}
+
+/**
+ * Converts a domain segment back to the tenant slug.
+ * Replaces hyphens with underscores (the stored DB format).
+ *
+ * @example domainSegmentToSlug("clinica-sampaio") // "clinica_sampaio"
+ * @example domainSegmentToSlug("homolog")         // "homolog"
+ */
+export function domainSegmentToSlug(domainSegment: string): string {
+  return (domainSegment || 'default').toLowerCase().replace(/-/g, '_');
+}
+
+/**
+ * Regex pattern that validates an acceptable tenant slug.
+ * Allows lowercase alphanumeric characters and underscores only (no hyphens).
+ * Must start and end with an alphanumeric character.
+ * Single-character slugs (e.g. "a") are allowed.
+ * Max 63 chars (DNS label limit after _ -> - conversion).
+ */
+export const TENANT_SLUG_REGEX = /^[a-z0-9]([a-z0-9_]*[a-z0-9])?$/;
+
+/**
+ * Validates whether a slug is acceptable.
+ * Rules:
+ * - Only lowercase letters, digits, and underscores (no hyphens)
+ * - Must start and end with a letter or digit
+ * - Length between 1 and 63 characters
+ */
+export function isValidTenantSlug(slug: string): boolean {
+  if (!slug || slug.length > 63) return false;
+  return TENANT_SLUG_REGEX.test(slug.toLowerCase());
+}