@wabot-dev/framework 0.2.1-beta.2 → 0.2.1

package/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-MIT License
+The MIT License (MIT)
 
 Copyright (c) 2025 Wabot
 

package/README.md

@@ -0,0 +1,115 @@
+# 🤖 Wabot
+
+<div align="center">
+
+[![npm version](https://img.shields.io/npm/v/@wabot-dev/framework.svg?style=flat-square)](https://www.npmjs.com/package/@wabot-dev/framework)
+[![License](https://img.shields.io/npm/l/@wabot-dev/framework.svg?style=flat-square)](https://github.com/wabot-dev/wabot-ts/blob/main/LICENSE.md)
+[![Documentation](https://img.shields.io/badge/docs-wabot.dev-blue.svg?style=flat-square)](https://docs.wabot.dev)
+
+
+**Un framework moderno y flexible para crear bots con TypeScript e Inteligencia Artificial**
+
+[Documentación](https://docs.wabot.dev) • [Inicio Rápido](https://docs.wabot.dev/guides/start-new-project/) • [Repositorio](https://github.com/wabot-dev/wabot-ts)
+
+</div>
+
+---
+
+## 🌟 Introducción
+
+**Wabot** es un framework diseñado para desarrolladores que desean crear bots inteligentes de manera rápida y profesional. Con soporte nativo para TypeScript, múltiples plataformas de mensajería y los principales proveedores de IA, Wabot te permite enfocarte en la lógica de tu bot mientras nosotros nos encargamos de la infraestructura.
+
+---
+
+## ✨ Características Principales
+
+- 🔷 **Tipado estricto con TypeScript** - Desarrollo seguro y predecible
+- 🧩 **Modular y extensible** - Arquitectura flexible para escalar
+- 🔌 **Fácil integración con múltiples plataformas** - Conecta con diversos canales
+- 🤖 **Soporte para bots con IA** - Inteligencia artificial lista para usar
+- 🧠 **Múltiples proveedores de IA** - OpenAI, Google Gemini, Anthropic Claude
+- 💬 **Múltiples canales de chat** - Telegram, WhatsApp, Socket y más
+- 📖 **Documentación clara y en español** - Aprende sin barreras de idioma
+
+---
+
+## 🚀 Inicio Rápido
+
+visita nuestra documentación 📘 **[Ver guía completa de inicio →](https://docs.wabot.dev/guides/start-new-project/)**
+
+---
+
+## 💬 Plataformas Soportadas
+
+Wabot se integra nativamente con las principales plataformas de mensajería:
+
+| Plataforma | Estado |
+|------------|--------|
+| 📱 **WhatsApp** | ✅ Soportado |
+| ✈️ **Telegram** | ✅ Soportado |
+| 🔌 **Socket** | ✅ Soportado |
+
+---
+
+## 🧠 Proveedores de IA
+
+Conecta tu bot con los principales modelos de lenguaje del mercado:
+
+| Proveedor | Modelos |
+|-----------|---------|
+| 🟢 **OpenAI** | GPT-4, GPT-3.5, y más |
+| 🔵 **Google** | Gemini Pro, Gemini Ultra |
+| 🟣 **Anthropic** | Claude 3  y más |
+
+---
+
+## 📚 Documentación
+
+Explora nuestra documentación completa para dominar Wabot:
+
+- 📖 **[Introducción](https://docs.wabot.dev)** - Conoce el framework
+- 🧠 **[Mentalidad del Bot](https://docs.wabot.dev/guides/mentality-of-your-bot/)** - Diseña bots inteligentes
+- ⚙️ **[Agregar Funcionalidades](https://docs.wabot.dev/guides/add-functions-modules/)** - Extiende tu bot con módulos
+- 🔍 **[Documentación Completa](https://docs.wabot.dev)** - Explora todas las guías
+
+---
+
+## 💡 Ejemplos
+
+💡 **Ver más ejemplos en la [documentación oficial](https://docs.wabot.dev)**
+
+---
+
+## 🛠️ Desarrollo y Contribución
+
+¿Quieres contribuir al proyecto? ¡Serás bienvenido!
+
+- 📦 **Repositorio:** [github.com/wabot-dev/wabot-ts](https://github.com/wabot-dev/wabot-ts)
+- 🐛 **Reportar bugs:** [Issues](https://github.com/wabot-dev/wabot-ts/issues)
+- 💬 **Discusiones:** [Discussions](https://github.com/wabot-dev/wabot-ts/discussions)
+
+---
+
+## 📞 Soporte
+
+¿Necesitas ayuda? Estamos aquí para ti:
+
+- 📧 **Email:** [soporte@wabot.dev](mailto:soporte@wabot.dev)
+- 🐛 **Issues:** [Reportar un problema](https://github.com/wabot-dev/wabot-ts/issues)
+- 📖 **Documentación:** [docs.wabot.dev](https://docs.wabot.dev)
+
+---
+
+## 📄 Licencia
+
+Este proyecto está licenciado bajo [Licencia MIT](https://github.com/wabot-dev/wabot-ts/blob/main/LICENSE).
+
+---
+
+<div align="center">
+
+**Hecho con ❤️ por el equipo de Wabot**
+
+[Sitio Web](https://wabot.dev) • [Documentación](https://docs.wabot.dev) • [GitHub](https://github.com/wabot-dev/wabot-ts) • [npm](https://www.npmjs.com/package/@wabot-dev/framework)
+
+</div>

package/dist/src/index.d.ts

@@ -317,6 +317,23 @@ interface ICrudRepository<T> {
     delete(item: T): Promise<void>;
 }
 
+declare function description(description: string): (target: any, propertyKey: string | symbol) => void;
+
+interface IDescriptionMetadata {
+    constructor: IConstructor<any>;
+    propertyName: string;
+    propertyType?: Function;
+    functionArgsTypes?: Function[];
+    functionReturnType?: Function;
+    description: string;
+}
+
+declare class DescriptionMetadataStore {
+    private descriptions;
+    saveDescriptionMetadata(metadata: IDescriptionMetadata): void;
+    getModelDescriptions(model: IConstructor<any>): IDescriptionMetadata[];
+}
+
 interface ICommandConfig {
     name?: string;
 }
@@ -481,21 +498,6 @@ interface IMindsetModuleMetadata {
     config?: IMindsetModuleConfig;
 }
 
-interface IDescriptionMetadata {
-    constructor: IConstructor<any>;
-    propertyName: string;
-    propertyType?: Function;
-    functionArgsTypes?: Function[];
-    functionReturnType?: Function;
-    description: string;
-}
-
-declare class DescriptionMetadataStore {
-    private descriptions;
-    saveDescriptionMetadata(metadata: IDescriptionMetadata): void;
-    getModelDescriptions(model: IConstructor<any>): IDescriptionMetadata[];
-}
-
 declare class MindsetMetadataStore {
     private descriptionMetadataStore;
     private validationMetadataStore;
@@ -1627,4 +1629,4 @@ declare function HtmlModule(options: IHtmlModuleOptions): {
     new (): {};
 };
 
-export { AnthropicChatAdapter, ApiKey, ApiKeyGuardMiddleware, ApiKeyHandshakeGuardMiddleware, ApiKeyRepository, Async, Auth, Chat, ChatAdapter, ChatBot, ChatBotMetadataStore, ChatItem, ChatMemory, ChatRepository, ChatResolver, CmdChannel, Command, CommandMetadataStore, Container, ControllerMetadataStore, CustomError, DeepSeekChatAdapter, EXPRESS_REQ, EXPRESS_RES, Entity, Env, EnvWhatsAppRepository, ExpressProvider, GoogleChatAdapter, type GoogleChatAdapterV2Options, HtmlModule, HttpServerProvider, type IApiKeyData, type IApiKeyRepository, type IArrayValidationError, type IArrayValidationResult, type IBotMessageItem, type IChannelMessage, type IChannelMetadata, type IChatAdapter, type IChatAdapterNextItemsReq, type IChatAdapterNextItemsRes, type IChatBot, type IChatBotMetadata, type IChatChannel, type IChatConnection, type IChatControllerMetadata, type IChatData, type IChatItem, type IChatItemData, type IChatItemType, type IChatMemory, type IChatMessage, type IChatRepository, type IChatType, type ICommandConfig, type ICommandHandler, type ICommandHandlerConfig, type IConstructor, type ICrudRepository, type ICustomErrorData, type IEndPointConfig, type IEndPointMetadata, type IEntityData, type IEnvType, type IFunctionCall, type IFunctionCallItem, type IGenerateApiKeyReq, type IGenerateApiKeyRes, type IGetWhatsAppTemplateRequest, type IHandshakeMiddleware, type IHandshakeMiddlewareMetadata, type IHtmlModuleOptions, type IHumanMessageItem, type IJobData, type IJobEvent, type IJobEventListener, type IJobRepository, type IJwtRefreshTokenData, type IJwtRefreshTokenRepository, type ILanguageModelUsage, type IListenWhatsAppMessageRequest, type IMessageContext, type IMiddleware, type IMiddlewareMetadata, type IMindset, type IMindsetConfig, type IMindsetIdentity, type IMindsetLlm, type IMindsetMetadata, type IMindsetModuleConfig, type IMindsetModuleMetadata, type IMindsetTool, type IMindsetToolParameter, type IModelValidationError, type IModelValidationResult, type IModelValidatorsInfo, type IMoneyData, type IPersistentData, type IPgRepositoryConfig, type IPrimitive, type IPropertyValidatorInfo, type IReceivedMessage, type IRemoteApiKeyFetcher, type IRestControllerConfig, type IRestControllerMetadata, type ISendWhatsAppRequest, type ISendWhatsAppTemplateRequest, type ISocketChannelConfig, type ISocketChannelReceivedMessage, type ISocketControllerConfig, type ISocketControllerMetadata, type ISocketEventConfig, type ISocketEventMetadata, type IStorableData, type ITelegramChannelConfig, type IValidateArrayOptions, type IValidateArrayOptionsWithItemsValidators, type IValidateInputShape, type IValidateIsInOptions, type IValidateIsRecordOptions, type IValidateMaxOptions, type IValidateMinOptions, type IValidationError, type IValidationResult, type IValidator, type IValidatorMetadata, type IWhatsAppBusinessAccount, type IWhatsAppBusinessNumber, type IWhatsAppCloudContact, type IWhatsAppCloudMessage, type IWhatsAppCloudMessageMetadata, type IWhatsAppCloudTemplate, type IWhatsAppCloudTemplateComponent, type IWhatsAppCloudTemplateMessage, type IWhatsAppCloudTemplateParameter, type IWhatsAppCloudTemplateResponse, type IWhatsAppCloudWebhookPayload, type IWhatsAppData, type IWhatsAppMessageListener, type IWhatsAppProxyListenMessageEventData, type IWhatsAppProxyListenMessageEventReq, type IWhatsAppProxyMessage, type IWhatsAppProxyMessageContent, type IWhatsAppProxyMessageEventReq, type IWhatsAppProxySendMessageEventReq, type IWhatsAppRepository, type IWhatsAppSenderOptions, type IWhatsappChannelConfig, type IchatControllerConfig, Job, JobRepository, JobRunner, JobsEventsHub, Jwt, JwtAccessAndRefreshTokenDto, JwtConfig, JwtGuardMiddleware, JwtHandshakeGuardMiddleware, JwtRefreshToken, JwtRefreshTokenRepository, JwtSigner, JwtTokenDto, Lifecycle, Logger, Mapper, Mindset, MindsetMetadataStore, MindsetOperator, Money, MoneyDto, OpenaiChatAdapter, Password, type PasswordHashOptions, Persistent, PgApiKeyRepository, PgChatMemory, PgChatRepository, PgCrudRepository, PgJobRepository, PgJwtRefreshTokenRepository, PgRepositoryBase, PgWhatsAppRepository, RamChatMemory, RamChatRepository, Random, RemoteApiKeyRepository, RestControllerMetadataStore, RestRequest, SocketChannel, SocketChannelConfig, SocketChannelReceivedMessage, SocketControllerMetadataStore, SocketServerProvider, Storable, TelegramChannel, TelegramChannelConfig, ValidationMetadataStore, WHATSAPP_MESSAGE_EVENT, WHATSAPP_PROXY_LISTEN_MESSAGE_EVENT, WHATSAPP_PROXY_SEND_MESSAGE_EVENT, WabotChatAdapter, WhatsApp, WhatsAppChannel, WhatsAppReceiver, WhatsAppReceiverByCloudApi, WhatsAppReceiverByWabotProxy, WhatsAppRepository, WhatsAppSender, WhatsAppSenderByCloudApi, WhatsAppSenderByWabotProxy, WhatsAppWabotProxyConnection, WhatsappChannelConfig, apiKeyGuard, apiKeyHandshakeGuard, chatBot, chatController, chatItemTypeOptions, cmd, command, commandHandler, container, handshakeMiddlewares, inject, injectable, isArray, isBoolean, isDate, isIn, isModel, isNotEmpty, isNumber, isOptional, isPresent, isRecord, isString, jwtGuard, jwtHandshakeGuard, max, middleware, min, mindset, mindsetModule, modelInfo, onDelete, onGet, onPost, onPut, onSocketEvent, readJsonFromFile, restController, runAsyncCommandHandlers, runChatControllers, runRestControllers, runSocketControllers, scoped, singleton, socket, socketController, telegram, validateAndTransform, validateArray, validateIsBoolean, validateIsDate, validateIsIn, validateIsNotEmpty, validateIsNumber, validateIsPresent, validateIsRecord, validateIsString, validateMax, validateMin, validateModel, whatsApp, writeJsonToFile };
+export { AnthropicChatAdapter, ApiKey, ApiKeyGuardMiddleware, ApiKeyHandshakeGuardMiddleware, ApiKeyRepository, Async, Auth, Chat, ChatAdapter, ChatBot, ChatBotMetadataStore, ChatItem, ChatMemory, ChatRepository, ChatResolver, CmdChannel, Command, CommandMetadataStore, Container, ControllerMetadataStore, CustomError, DeepSeekChatAdapter, DescriptionMetadataStore, EXPRESS_REQ, EXPRESS_RES, Entity, Env, EnvWhatsAppRepository, ExpressProvider, GoogleChatAdapter, type GoogleChatAdapterV2Options, HtmlModule, HttpServerProvider, type IApiKeyData, type IApiKeyRepository, type IArrayValidationError, type IArrayValidationResult, type IBotMessageItem, type IChannelMessage, type IChannelMetadata, type IChatAdapter, type IChatAdapterNextItemsReq, type IChatAdapterNextItemsRes, type IChatBot, type IChatBotMetadata, type IChatChannel, type IChatConnection, type IChatControllerMetadata, type IChatData, type IChatItem, type IChatItemData, type IChatItemType, type IChatMemory, type IChatMessage, type IChatRepository, type IChatType, type ICommandConfig, type ICommandHandler, type ICommandHandlerConfig, type IConstructor, type ICrudRepository, type ICustomErrorData, type IDescriptionMetadata, type IEndPointConfig, type IEndPointMetadata, type IEntityData, type IEnvType, type IFunctionCall, type IFunctionCallItem, type IGenerateApiKeyReq, type IGenerateApiKeyRes, type IGetWhatsAppTemplateRequest, type IHandshakeMiddleware, type IHandshakeMiddlewareMetadata, type IHtmlModuleOptions, type IHumanMessageItem, type IJobData, type IJobEvent, type IJobEventListener, type IJobRepository, type IJwtRefreshTokenData, type IJwtRefreshTokenRepository, type ILanguageModelUsage, type IListenWhatsAppMessageRequest, type IMessageContext, type IMiddleware, type IMiddlewareMetadata, type IMindset, type IMindsetConfig, type IMindsetIdentity, type IMindsetLlm, type IMindsetMetadata, type IMindsetModuleConfig, type IMindsetModuleMetadata, type IMindsetTool, type IMindsetToolParameter, type IModelValidationError, type IModelValidationResult, type IModelValidatorsInfo, type IMoneyData, type IPersistentData, type IPgRepositoryConfig, type IPrimitive, type IPropertyValidatorInfo, type IReceivedMessage, type IRemoteApiKeyFetcher, type IRestControllerConfig, type IRestControllerMetadata, type ISendWhatsAppRequest, type ISendWhatsAppTemplateRequest, type ISocketChannelConfig, type ISocketChannelReceivedMessage, type ISocketControllerConfig, type ISocketControllerMetadata, type ISocketEventConfig, type ISocketEventMetadata, type IStorableData, type ITelegramChannelConfig, type IValidateArrayOptions, type IValidateArrayOptionsWithItemsValidators, type IValidateInputShape, type IValidateIsInOptions, type IValidateIsRecordOptions, type IValidateMaxOptions, type IValidateMinOptions, type IValidationError, type IValidationResult, type IValidator, type IValidatorMetadata, type IWhatsAppBusinessAccount, type IWhatsAppBusinessNumber, type IWhatsAppCloudContact, type IWhatsAppCloudMessage, type IWhatsAppCloudMessageMetadata, type IWhatsAppCloudTemplate, type IWhatsAppCloudTemplateComponent, type IWhatsAppCloudTemplateMessage, type IWhatsAppCloudTemplateParameter, type IWhatsAppCloudTemplateResponse, type IWhatsAppCloudWebhookPayload, type IWhatsAppData, type IWhatsAppMessageListener, type IWhatsAppProxyListenMessageEventData, type IWhatsAppProxyListenMessageEventReq, type IWhatsAppProxyMessage, type IWhatsAppProxyMessageContent, type IWhatsAppProxyMessageEventReq, type IWhatsAppProxySendMessageEventReq, type IWhatsAppRepository, type IWhatsAppSenderOptions, type IWhatsappChannelConfig, type IchatControllerConfig, Job, JobRepository, JobRunner, JobsEventsHub, Jwt, JwtAccessAndRefreshTokenDto, JwtConfig, JwtGuardMiddleware, JwtHandshakeGuardMiddleware, JwtRefreshToken, JwtRefreshTokenRepository, JwtSigner, JwtTokenDto, Lifecycle, Logger, Mapper, Mindset, MindsetMetadataStore, MindsetOperator, Money, MoneyDto, OpenaiChatAdapter, Password, type PasswordHashOptions, Persistent, PgApiKeyRepository, PgChatMemory, PgChatRepository, PgCrudRepository, PgJobRepository, PgJwtRefreshTokenRepository, PgRepositoryBase, PgWhatsAppRepository, RamChatMemory, RamChatRepository, Random, RemoteApiKeyRepository, RestControllerMetadataStore, RestRequest, SocketChannel, SocketChannelConfig, SocketChannelReceivedMessage, SocketControllerMetadataStore, SocketServerProvider, Storable, TelegramChannel, TelegramChannelConfig, ValidationMetadataStore, WHATSAPP_MESSAGE_EVENT, WHATSAPP_PROXY_LISTEN_MESSAGE_EVENT, WHATSAPP_PROXY_SEND_MESSAGE_EVENT, WabotChatAdapter, WhatsApp, WhatsAppChannel, WhatsAppReceiver, WhatsAppReceiverByCloudApi, WhatsAppReceiverByWabotProxy, WhatsAppRepository, WhatsAppSender, WhatsAppSenderByCloudApi, WhatsAppSenderByWabotProxy, WhatsAppWabotProxyConnection, WhatsappChannelConfig, apiKeyGuard, apiKeyHandshakeGuard, chatBot, chatController, chatItemTypeOptions, cmd, command, commandHandler, container, description, handshakeMiddlewares, inject, injectable, isArray, isBoolean, isDate, isIn, isModel, isNotEmpty, isNumber, isOptional, isPresent, isRecord, isString, jwtGuard, jwtHandshakeGuard, max, middleware, min, mindset, mindsetModule, modelInfo, onDelete, onGet, onPost, onPut, onSocketEvent, readJsonFromFile, restController, runAsyncCommandHandlers, runChatControllers, runRestControllers, runSocketControllers, scoped, singleton, socket, socketController, telegram, validateAndTransform, validateArray, validateIsBoolean, validateIsDate, validateIsIn, validateIsNotEmpty, validateIsNumber, validateIsPresent, validateIsRecord, validateIsString, validateMax, validateMin, validateModel, whatsApp, writeJsonToFile };

package/dist/src/index.js

@@ -36,6 +36,8 @@ export { min } from './core/validation/validators/min/@min.js';
 export { validateMin } from './core/validation/validators/min/validateMin.js';
 export { isRecord } from './core/validation/validators/is-record/@isRecord.js';
 export { validateIsRecord } from './core/validation/validators/is-record/validateIsRecord.js';
+export { description } from './core/description/metadata/@description.js';
+export { DescriptionMetadataStore } from './core/description/metadata/DescriptionMetadataStore.js';
 export { command } from './feature/async/@command.js';
 export { commandHandler } from './feature/async/@commandHandler.js';
 export { Async } from './feature/async/Async.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wabot-dev/framework",
-  "version": "0.2.1-beta.2",
+  "version": "0.2.1",
   "description": "Framework for IA Chat Bots",
   "type": "module",
   "main": "dist/src/index.js",