@gymspace/shared 1.2.4 → 1.2.8

package/src/constants.ts

@@ -5,102 +5,109 @@ export const PERMISSIONS = {
   ORGANIZATIONS_READ: 'ORGANIZATIONS_READ',
   ORGANIZATIONS_UPDATE: 'ORGANIZATIONS_UPDATE',
   ORGANIZATIONS_DELETE: 'ORGANIZATIONS_DELETE',
-  
+
   // Gyms
   GYMS_CREATE: 'GYMS_CREATE',
   GYMS_READ: 'GYMS_READ',
   GYMS_UPDATE: 'GYMS_UPDATE',
   GYMS_DELETE: 'GYMS_DELETE',
-  
+
   // Collaborators
   COLLABORATORS_CREATE: 'COLLABORATORS_CREATE',
   COLLABORATORS_READ: 'COLLABORATORS_READ',
   COLLABORATORS_UPDATE: 'COLLABORATORS_UPDATE',
   COLLABORATORS_DELETE: 'COLLABORATORS_DELETE',
-  
+
   // Clients
   CLIENTS_CREATE: 'CLIENTS_CREATE',
   CLIENTS_READ: 'CLIENTS_READ',
   CLIENTS_UPDATE: 'CLIENTS_UPDATE',
   CLIENTS_DELETE: 'CLIENTS_DELETE',
-  
+
   // Contracts
   CONTRACTS_CREATE: 'CONTRACTS_CREATE',
   CONTRACTS_READ: 'CONTRACTS_READ',
   CONTRACTS_UPDATE: 'CONTRACTS_UPDATE',
   CONTRACTS_APPROVE: 'CONTRACTS_APPROVE',
   CONTRACTS_CANCEL: 'CONTRACTS_CANCEL',
-  
+
   // Evaluations
   EVALUATIONS_CREATE: 'EVALUATIONS_CREATE',
   EVALUATIONS_READ: 'EVALUATIONS_READ',
   EVALUATIONS_UPDATE: 'EVALUATIONS_UPDATE',
   EVALUATIONS_DELETE: 'EVALUATIONS_DELETE',
-  
+
   // Check-ins
   CHECKINS_CREATE: 'CHECKINS_CREATE',
   CHECKINS_READ: 'CHECKINS_READ',
-  
+
   // Leads
   LEADS_CREATE: 'LEADS_CREATE',
   LEADS_READ: 'LEADS_READ',
   LEADS_UPDATE: 'LEADS_UPDATE',
   LEADS_DELETE: 'LEADS_DELETE',
-  
+
   // Reports
   REPORTS_VIEW: 'REPORTS_VIEW',
   REPORTS_FINANCIAL: 'REPORTS_FINANCIAL',
-  
+
   // Settings
   SETTINGS_UPDATE: 'SETTINGS_UPDATE',
-  
+
   // Assets
   ASSETS_CREATE: 'ASSETS_CREATE',
   ASSETS_READ: 'ASSETS_READ',
   ASSETS_DELETE: 'ASSETS_DELETE',
-  
+
   // Files
   FILES_CREATE: 'FILES_CREATE',
   FILES_READ: 'FILES_READ',
   FILES_DELETE: 'FILES_DELETE',
-  
+
   // Products
   PRODUCTS_CREATE: 'PRODUCTS_CREATE',
   PRODUCTS_READ: 'PRODUCTS_READ',
   PRODUCTS_UPDATE: 'PRODUCTS_UPDATE',
   PRODUCTS_DELETE: 'PRODUCTS_DELETE',
-  
+
   // Product Categories
   PRODUCT_CATEGORIES_CREATE: 'PRODUCT_CATEGORIES_CREATE',
   PRODUCT_CATEGORIES_READ: 'PRODUCT_CATEGORIES_READ',
   PRODUCT_CATEGORIES_UPDATE: 'PRODUCT_CATEGORIES_UPDATE',
   PRODUCT_CATEGORIES_DELETE: 'PRODUCT_CATEGORIES_DELETE',
-  
+
   // Sales
   SALES_CREATE: 'SALES_CREATE',
   SALES_READ: 'SALES_READ',
   SALES_UPDATE: 'SALES_UPDATE',
   SALES_DELETE: 'SALES_DELETE',
-  
+
   // Suppliers
   SUPPLIERS_CREATE: 'SUPPLIERS_CREATE',
   SUPPLIERS_READ: 'SUPPLIERS_READ',
   SUPPLIERS_UPDATE: 'SUPPLIERS_UPDATE',
   SUPPLIERS_DELETE: 'SUPPLIERS_DELETE',
-  
+
   // Payment Methods
   PAYMENT_METHODS_CREATE: 'PAYMENT_METHODS_CREATE',
   PAYMENT_METHODS_READ: 'PAYMENT_METHODS_READ',
   PAYMENT_METHODS_UPDATE: 'PAYMENT_METHODS_UPDATE',
   PAYMENT_METHODS_DELETE: 'PAYMENT_METHODS_DELETE',
-  
-  // Super Admin
+
+  // WhatsApp
+  WHATSAPP_READ: 'WHATSAPP_READ',
+  WHATSAPP_SEND: 'WHATSAPP_SEND',
+  WHATSAPP_MANAGE: 'WHATSAPP_MANAGE',
+
+  // Special permissions
   SUPER_ADMIN: 'SUPER_ADMIN',
+  OWNER: 'OWNER',
+  All: 'ALL',
 } as const;
 
 // Role definitions
 export const ROLE_PERMISSIONS = {
-  OWNER: Object.values(PERMISSIONS),
+  ADMIN: Object.values(PERMISSIONS),
   MANAGER: [
     PERMISSIONS.GYMS_READ,
     PERMISSIONS.COLLABORATORS_READ,
@@ -141,26 +148,6 @@ export const ROLE_PERMISSIONS = {
     PERMISSIONS.PAYMENT_METHODS_UPDATE,
     PERMISSIONS.PAYMENT_METHODS_DELETE,
   ],
-  STAFF: [
-    PERMISSIONS.CLIENTS_READ,
-    PERMISSIONS.CHECKINS_CREATE,
-    PERMISSIONS.CHECKINS_READ,
-    PERMISSIONS.PRODUCTS_READ,
-    PERMISSIONS.PRODUCT_CATEGORIES_READ,
-    PERMISSIONS.SALES_CREATE,
-    PERMISSIONS.SALES_READ,
-    PERMISSIONS.PAYMENT_METHODS_READ,
-  ],
-  ADVISOR: [
-    PERMISSIONS.CLIENTS_READ,
-    PERMISSIONS.EVALUATIONS_CREATE,
-    PERMISSIONS.EVALUATIONS_READ,
-    PERMISSIONS.EVALUATIONS_UPDATE,
-    PERMISSIONS.ASSETS_CREATE,
-    PERMISSIONS.ASSETS_READ,
-    PERMISSIONS.FILES_CREATE,
-    PERMISSIONS.FILES_READ,
-  ],
 } as const;
 
 // Cache TTL values (in seconds)
@@ -170,6 +157,7 @@ export const CACHE_TTL = {
   STATIC_DATA: 3600, // 60 minutes
   REPORTS: 300, // 5 minutes
   DASHBOARD: 180, // 3 minutes
+  WHATSAPP_MESSAGE_STATUS: 300, // 5 minutes
 } as const;
 
 // File size limits (in bytes)
@@ -197,4 +185,7 @@ export const DATE_FORMATS = {
 export const HEADERS = {
   GYM_ID: 'X-Gym-Id',
   REQUEST_ID: 'X-Request-Id',
-} as const;
+} as const;
+
+// Re-export template constants
+export * from './constants/template-codes.constants';

package/src/enums.ts

@@ -20,6 +20,7 @@ export enum CollaboratorStatus {
 export enum InvitationStatus {
   PENDING = 'pending',
   ACCEPTED = 'accepted',
+  CANCELLED = 'cancelled',
   EXPIRED = 'expired',
 }
 
@@ -110,4 +111,4 @@ export enum LeadStatus {
   INTERESTED = 'INTERESTED',
   CONVERTED = 'CONVERTED',
   LOST = 'LOST',
-}
+}

package/src/events/index.ts

@@ -0,0 +1 @@
+export * from './whatsapp.events';

package/src/events/whatsapp.events.ts

@@ -0,0 +1,31 @@
+/**
+ * Evento para enviar un mensaje de WhatsApp
+ */
+export interface WhatsAppMessageSendEventData {
+  // Identificadores
+  gymId: string;
+  instanceName: string; // Nombre de la instancia de Evolution API
+
+  // Destinatario
+  phoneNumber: string;
+
+  // Contenido
+  content: string;
+
+  // Metadata opcional
+  clientId?: string;
+  templateId?: string;
+  variables?: Record<string, any>;
+
+  // Usuario que generó el envío
+  userId?: string;
+}
+
+/**
+ * Nombres de eventos de WhatsApp
+ */
+export const WHATSAPP_EVENTS = {
+  MESSAGE_SEND: 'whatsapp/message.send',
+  MESSAGE_RECEIVED: 'whatsapp/message.received',
+  CONNECTION_UPDATE: 'whatsapp/connection.update',
+} as const;

package/src/index.ts

@@ -1,4 +1,7 @@
 export * from './types';
 export * from './enums';
 export * from './interfaces';
-export * from './constants';
+export * from './constants';
+export * from './utils/roleHelpers';
+export * from './events';
+export * from './schemas';

package/src/interfaces.ts

@@ -94,11 +94,8 @@ export interface IRequestContext {
   getOrganizationId(): UUID | undefined;
   getUserId(): UUID | undefined;
   getTimezone(): string;
+  // Convenience flags
+  readonly isOwner: boolean;
+  readonly isCollaborator: boolean;
 }
 
-// Type aliases for convenience
-export type Organization = IOrganization;
-export type User = IUser;
-export type Gym = IGym;
-export type Collaborator = ICollaborator;
-export type Role = IRole;

package/src/schemas/ai-template.schema.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+
+export const templateGenerationRequestSchema = z.object({
+  templateCode: z.string(),
+  templateMetadata: z.object({
+    title: z.string(),
+    description: z.string(),
+    variables: z.array(z.string()),
+    exampleValues: z.record(z.string()),
+  }),
+  userPrompt: z.string().optional(),
+  language: z.string().default('es'),
+});
+
+export const aiGeneratedTemplateSchema = z.object({
+  message: z.string().describe('Mensaje generado con variables en formato {{variable}}'),
+  tone: z.enum(['professional', 'friendly', 'casual', 'urgent']).describe('Tono del mensaje'),
+  usedVariables: z.array(z.string()).describe('Variables utilizadas en el mensaje'),
+  suggestions: z.array(z.string()).optional().describe('Sugerencias adicionales'),
+});
+
+export type TemplateGenerationRequest = z.infer<typeof templateGenerationRequestSchema>;
+export type AIGeneratedTemplate = z.infer<typeof aiGeneratedTemplateSchema>;

package/src/schemas/index.ts

@@ -0,0 +1 @@
+export * from './ai-template.schema';

package/src/types/whatsapp-templates.types.ts

@@ -0,0 +1,174 @@
+/**
+ * Template codes for WhatsApp messages
+ */
+export const TemplateCode = {
+  WELCOME: 'WELCOME',
+  MEMBERSHIP_PURCHASE: 'MEMBERSHIP_PURCHASE',
+  MEMBERSHIP_RENEWAL: 'MEMBERSHIP_RENEWAL',
+  MEMBERSHIP_EXPIRING: 'MEMBERSHIP_EXPIRING',
+  PAYMENT_REMINDER: 'PAYMENT_REMINDER',
+  BIRTHDAY: 'BIRTHDAY',
+  PAYMENT_RECEIPT: 'PAYMENT_RECEIPT',
+} as const;
+
+export type TemplateCodeValue = (typeof TemplateCode)[keyof typeof TemplateCode];
+export type TemplateCode = TemplateCodeValue;
+
+/**
+ * Template types
+ */
+export const TemplateType = {
+  STATIC: 'STATIC',
+  PROMPT: 'PROMPT',
+} as const;
+
+export type TemplateTypeValue = (typeof TemplateType)[keyof typeof TemplateType];
+export type TemplateType = TemplateTypeValue;
+
+/**
+ * Base interface for WhatsApp template data
+ */
+export interface WhatsAppTemplateData {
+  gymId: string;
+  clientId: string;
+  phoneNumber: string;
+  templateCode: TemplateCode;
+  variables: Record<string, any>;
+  metadata?: {
+    contractId?: string;
+    userId?: string;
+    source?: string;
+    instanceName?: string;
+  };
+}
+
+/**
+ * Welcome message template data
+ */
+export interface WelcomeTemplateData
+  extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
+  templateCode: typeof TemplateCode.WELCOME;
+  variables: {
+    clientName: string;
+    gymName: string;
+    registrationDate: string;
+  };
+}
+
+/**
+ * Membership purchase template data
+ */
+export interface MembershipPurchaseTemplateData
+  extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
+  templateCode: typeof TemplateCode.MEMBERSHIP_PURCHASE;
+  variables: {
+    clientName: string;
+    planName: string;
+    startDate: string;
+    endDate: string;
+    amount: string;
+    paymentFrequency: string;
+  };
+}
+
+/**
+ * Membership renewal template data
+ */
+export interface MembershipRenewalTemplateData
+  extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
+  templateCode: typeof TemplateCode.MEMBERSHIP_RENEWAL;
+  variables: {
+    clientName: string;
+    planName: string;
+    newEndDate: string;
+    amount: string;
+  };
+}
+
+/**
+ * Membership expiring template data
+ */
+export interface MembershipExpiringTemplateData
+  extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
+  templateCode: typeof TemplateCode.MEMBERSHIP_EXPIRING;
+  variables: {
+    clientName: string;
+    planName: string;
+    expirationDate: string;
+    daysRemaining: string;
+  };
+}
+
+/**
+ * Payment reminder template data
+ */
+export interface PaymentReminderTemplateData
+  extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
+  templateCode: typeof TemplateCode.PAYMENT_REMINDER;
+  variables: {
+    clientName: string;
+    amount: string;
+    dueDate: string;
+    planName: string;
+  };
+}
+
+/**
+ * Birthday template data
+ */
+export interface BirthdayTemplateData
+  extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
+  templateCode: typeof TemplateCode.BIRTHDAY;
+  variables: {
+    clientName: string;
+    gymName: string;
+    age: string;
+  };
+}
+
+/**
+ * Payment receipt template data
+ */
+export interface PaymentReceiptTemplateData
+  extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
+  templateCode: typeof TemplateCode.PAYMENT_RECEIPT;
+  variables: {
+    gymName: string;
+    receiptNumber: string;
+    date: string;
+    clientName: string;
+    items: string;
+    amount: string;
+    paymentMethod: string;
+  };
+  metadata?: {
+    saleId?: string;
+    userId?: string;
+    source?: string;
+    instanceName?: string;
+  };
+}
+
+/**
+ * Union type for all template data types
+ */
+export type WhatsAppTemplateEventData =
+  | WelcomeTemplateData
+  | MembershipPurchaseTemplateData
+  | MembershipRenewalTemplateData
+  | MembershipExpiringTemplateData
+  | PaymentReminderTemplateData
+  | BirthdayTemplateData
+  | PaymentReceiptTemplateData;
+
+/**
+ * Template metadata interface
+ */
+export interface TemplateMetadata {
+  code: TemplateCode;
+  title: string;
+  description: string;
+  icon: string;
+  variables: string[];
+  exampleValues: Record<string, string>;
+}

package/src/types.ts

@@ -1,3 +1,5 @@
+import { UserType, CollaboratorStatus, InvitationStatus } from './enums';
+
 export type UUID = string;
 
 export type Currency = 'USD' | 'EUR' | 'PEN' | 'MXN' | 'COP' | 'ARS' | 'CLP';
@@ -13,6 +15,8 @@ export type EntityType =
   | 'asset';
 
 export type Permission =
+  | 'SUPER_ADMIN'
+  | 'OWNER'
   | 'ORGANIZATIONS_CREATE'
   | 'ORGANIZATIONS_READ'
   | 'ORGANIZATIONS_UPDATE'
@@ -73,7 +77,9 @@ export type Permission =
   | 'PAYMENT_METHODS_READ'
   | 'PAYMENT_METHODS_UPDATE'
   | 'PAYMENT_METHODS_DELETE'
-  | 'SUPER_ADMIN';
+  | 'WHATSAPP_READ'
+  | 'WHATSAPP_SEND'
+  | 'WHATSAPP_MANAGE';
 
 export interface AuditFields {
   createdByUserId: UUID;
@@ -103,3 +109,143 @@ export interface PaginatedResponse<T> {
   data: T[];
   meta: PaginationMeta;
 }
+
+export interface User {
+  id: UUID;
+  email: string;
+  name: string;
+  phone?: string;
+  birthDate?: Date;
+  userType: UserType;
+}
+
+export interface Role {
+  id: UUID;
+  name: string;
+  permissions: Permission[];
+  description?: string;
+  canManageEvaluations: boolean;
+}
+
+export interface Collaborator {
+  id: UUID;
+  userId: UUID;
+  gymId: UUID;
+  roleId: UUID;
+  status: CollaboratorStatus;
+  hiredDate?: Date;
+  profilePhotoId?: string;
+  coverPhotoId?: string;
+  description?: string;
+  specialties?: any;
+  user?: User;
+  role?: Role;
+}
+
+export interface Invitation {
+  id: UUID;
+  gymId: UUID;
+  email: string;
+  roleId: UUID;
+  token: string;
+  code: string;
+  status: InvitationStatus;
+  expiresAt: Date;
+  invitedByUserId: UUID;
+  acceptedByUserId?: UUID;
+  acceptedAt?: Date;
+  role?: Role;
+}
+
+export interface CreateInvitationDto {
+  gymId: UUID;
+  email: string;
+  roleId: UUID;
+}
+
+export interface AcceptInvitationDto {
+  token?: string;
+  code?: string;
+  name: string;
+  phone: string;
+  password: string;
+}
+
+export interface ValidateByCodeDto {
+  code: string;
+}
+
+export interface UpdateCollaboratorDto {
+  hiredDate?: string;
+  profilePhotoId?: string;
+  coverPhotoId?: string;
+  description?: string;
+  specialties?: any;
+}
+
+export interface UpdateCollaboratorStatusDto {
+  status: 'active' | 'inactive';
+}
+
+export interface UpdateCollaboratorRoleDto {
+  roleId: UUID;
+}
+
+export interface ListCollaboratorsParams extends PaginationParams {
+  status?: CollaboratorStatus;
+  roleId?: UUID;
+  search?: string;
+}
+
+export interface ActivityQueryParams {
+  startDate?: string;
+  endDate?: string;
+  limit?: number;
+  type?: string;
+}
+
+export interface StatsQueryParams {
+  startDate?: string;
+  endDate?: string;
+}
+
+export interface CollaboratorStats {
+  contracts: {
+    total: number;
+    totalAmount: number;
+    averageAmount: number;
+  };
+  checkIns: {
+    total: number;
+  };
+  sales: {
+    total: number;
+    totalAmount: number;
+  };
+  clients: {
+    created: number;
+  };
+}
+
+export interface ActivityItem {
+  type: string;
+  timestamp: Date;
+  description: string;
+  metadata: any;
+}
+
+// Re-export WhatsApp template types and constants
+export {
+  TemplateCode,
+  TemplateType,
+  type WhatsAppTemplateData,
+  type WelcomeTemplateData,
+  type MembershipPurchaseTemplateData,
+  type MembershipRenewalTemplateData,
+  type MembershipExpiringTemplateData,
+  type PaymentReminderTemplateData,
+  type BirthdayTemplateData,
+  type PaymentReceiptTemplateData,
+  type WhatsAppTemplateEventData,
+  type TemplateMetadata,
+} from './types/whatsapp-templates.types';