funifier-mcp 0.2.0 → 0.2.3

package/datasource-funifier-docs/knowledge/guides/java-entities.md

@@ -1,373 +1,373 @@
-# Java Entities — Referência
-
-As entidades são os objetos Java (POJOs) que representam os dados armazenados no MongoDB. Cada entidade mapeia para uma coleção no banco de dados.
-
----
-
-## Entidades Principais
-
-### Player
-
-**Coleção MongoDB:** `player`
-**Classe:** `com.funifier.engine.player.Player`
-
-```java
-// Campos principais
-String _id;          // ID do jogador (ex: "john")
-String name;         // Nome do jogador
-String email;        // Email
-String password;     // Senha (hash)
-Map<String, Object> extra;  // Campos customizados (ex: department, country)
-List<String> teams;  // IDs das equipes
-List<String> friends; // IDs dos amigos
-ImageSet image;      // Imagens (small, medium, original)
-Date created;        // Data de cadastro
-```
-
-```json
-{"_id": "john", "name": "John Travolta", "email": "john@funifier.com", "teams": ["sales"], "extra": {"country": "USA", "department": "IT"}, "image": {"small": {"url": "..."}, "medium": {"url": "..."}, "original": {"url": "..."}}}
-```
-
----
-
-### Achievement
-
-**Coleção MongoDB:** `achievement`
-**Classe:** `com.funifier.engine.achievement.Achievement`
-
-Representa qualquer conquista do jogador: pontos ganhos, desafios completados, itens comprados, níveis alcançados.
-
-```java
-// Campos principais
-String _id;       // ID da conquista
-String player;    // ID do jogador
-double total;     // Quantidade (pontos, unidades)
-int type;         // Tipo (0=Point, 1=Challenge, 2=VirtualGood, 3=Level)
-String item;      // ID do item (point_category, challenge, catalog_item, level)
-Date time;        // Data da conquista
-
-// Constantes de tipo
-static final int TYPE_POINT = 0;
-static final int TYPE_CHALLENGE = 1;
-static final int TYPE_VIRTUAL_GOOD = 2;
-static final int TYPE_LEVEL = 3;
-```
-
-```json
-{"_id": "64a5d2", "player": "john", "total": 25.0, "type": 0, "item": "xp", "time": {"$date": "2023-07-05T20:57:33.303Z"}}
-```
-
----
-
-### ActionLog
-
-**Coleção MongoDB:** `action_log`
-**Classe:** `com.funifier.engine.action.ActionLog`
-
-Registo de uma ação executada por um jogador.
-
-```java
-// Campos principais
-String _id;       // ID do log
-String actionId;  // ID da ação (ex: "sell")
-String userId;    // ID do jogador (ex: "john")
-Date time;        // Data da execução
-Map<String, Object> attributes; // Atributos da ação (ex: product, price)
-```
-
-```json
-{"_id": "64a5d92", "actionId": "sell", "userId": "john", "time": {"$date": "2023-07-05T20:57:33.303Z"}, "attributes": {"product": "book", "price": 120}}
-```
-
----
-
-### Action
-
-**Coleção MongoDB:** `action`
-**Classe:** `com.funifier.engine.action.Action`
-
-Definição de um tipo de ação.
-
-```java
-// Campos principais
-String _id;       // ID da ação (ex: "sell")
-String action;    // Nome da ação (ex: "Sell")
-boolean active;   // Se está ativa
-List<ActionAttribute> attributes; // Definição dos atributos (name, type)
-```
-
-```json
-{"_id": "sell", "action": "Sell", "attributes": [{"name": "product", "type": "String"}, {"name": "price", "type": "Number"}], "active": true}
-```
-
----
-
-### Challenge
-
-**Coleção MongoDB:** `challenge`
-**Classe:** `com.funifier.engine.challenge.Challenge`
-
-Definição de um desafio.
-
-```java
-// Campos principais
-String _id;          // ID do desafio
-String challenge;    // Nome do desafio
-boolean active;      // Se está ativo
-List<Rule> rules;    // Regras (ação, operador, total)
-List<Reward> points; // Recompensas (pontos, operação)
-```
-
-```json
-{"_id": "DTo8dS3", "challenge": "Watch Video", "active": true, "rules": [{"actionId": "watch_video", "operator": 5, "total": 0}], "points": [{"total": 10.0, "category": "xp", "operation": 0}]}
-```
-
----
-
-### CatalogItem
-
-**Coleção MongoDB:** `catalog_item`
-**Classe:** `com.funifier.engine.catalog.CatalogItem`
-
-Item da loja virtual.
-
-```java
-// Campos principais
-String _id;           // ID do item
-String catalogId;     // ID do catálogo
-String name;          // Nome do item
-int amount;           // Quantidade disponível
-boolean active;       // Se está ativo
-Requirement[] requires; // Requisitos para compra (pontos necessários)
-```
-
-```json
-{"_id": "prd1", "catalogId": "gifts", "name": "T-shirt", "amount": 100, "active": true, "requires": [{"total": 15, "type": 0, "item": "coin", "operation": 1}]}
-```
-
----
-
-### Team
-
-**Coleção MongoDB:** `team`
-**Classe:** `com.funifier.engine.team.Team`
-
-```java
-String _id;     // ID da equipe
-String name;    // Nome da equipe
-```
-
----
-
-### Level
-
-**Coleção MongoDB:** `level`
-**Classe:** `com.funifier.engine.level.Level`
-
-```java
-String _id;     // ID do nível
-String level;   // Nome do nível
-int position;   // Posição (ordem)
-```
-
----
-
-### PointCategory
-
-**Coleção MongoDB:** `point_category`
-**Classe:** `com.funifier.engine.point.PointCategory`
-
-```java
-String _id;       // ID da categoria (ex: "xp")
-String category;  // Nome (ex: "Experience Points")
-String shortName; // Abreviação (ex: "XP")
-Map extra;        // Campos extras
-```
-
----
-
-### Lottery
-
-**Coleção MongoDB:** `lottery`
-**Classe:** `com.funifier.engine.lottery.Lottery`
-
-```java
-String _id;     // ID do sorteio
-String title;   // Título
-boolean active; // Se está ativo
-```
-
----
-
-### LotteryTicket
-
-**Coleção MongoDB:** `lottery_ticket`
-**Classe:** `com.funifier.engine.lottery.LotteryTicket`
-
-```java
-String _id;      // ID do ticket
-String lottery;  // ID do sorteio
-String player;   // ID do jogador
-```
-
----
-
-### MysteryBox
-
-**Coleção MongoDB:** `mystery_box`
-**Classe:** `com.funifier.engine.mystery.MysteryBox`
-
-```java
-String _id;     // ID da caixa
-String title;   // Título
-boolean active; // Se está ativa
-```
-
----
-
-### Competition
-
-**Coleção MongoDB:** `competition`
-**Classe:** `com.funifier.engine.competition.Competition`
-
-```java
-String _id;     // ID da competição
-boolean active; // Se está ativa
-```
-
----
-
-### Question
-
-**Coleção MongoDB:** `question`
-**Classe:** `com.funifier.engine.question.Question`
-
-```java
-String _id;      // ID da pergunta
-String question; // Texto da pergunta
-```
-
----
-
-### QuestionLog
-
-**Coleção MongoDB:** `question_log`
-**Classe:** `com.funifier.engine.question.QuestionLog`
-
-```java
-String _id;      // ID do log
-String player;   // ID do jogador
-String question; // ID da pergunta
-```
-
----
-
-### Quiz / QuizLog
-
-**Coleções:** `quiz` / `quiz_log`
-
----
-
-### Notification
-
-**Coleção MongoDB:** `notification`
-**Classe:** `com.funifier.engine.notify.Notification`
-
-```java
-String _id;     // ID da notificação
-String player;  // ID do jogador destino
-String title;   // Título
-String message; // Mensagem
-Date time;      // Data
-```
-
----
-
-### Swap
-
-**Coleção MongoDB:** `swap`
-**Classe:** `com.funifier.engine.swap.Swap`
-
----
-
-### Trigger
-
-**Coleção MongoDB:** `trigger`
-**Classe:** `com.funifier.engine.integration.trigger.Trigger`
-
-```java
-String _id;      // ID da trigger
-String name;     // Nome
-String entity;   // Entidade (ex: "player", "achievement")
-String event;    // Evento (ex: "before_create", "after_win")
-String script;   // Código Java
-```
-
----
-
-### SchedulerConfig
-
-**Coleção MongoDB:** `scheduler`
-**Classe:** `com.funifier.engine.integration.scheduler.SchedulerConfig`
-
----
-
-### PublicEndpoint
-
-**Coleção MongoDB:** `public_endpoint`
-**Classe:** `com.funifier.engine.pub.PublicEndpoint`
-
----
-
-### Webhook
-
-**Coleção MongoDB:** `webhook`
-**Classe:** `com.funifier.engine.webhook.Webhook`
-
----
-
-## Mapeamento Completo Entidade → Coleção
-
-| Entidade | Coleção MongoDB | Classe Java |
-|----------|----------------|-------------|
-| PLAYER | `player` | Player |
-| PLAYER_STATUS | `player_status` | PlayerStatus |
-| TEAM | `team` | Team |
-| TEAM_PLAYER | `team_player` | TeamLink |
-| ACHIEVEMENT | `achievement` | Achievement |
-| CHALLENGE | `challenge` | Challenge |
-| ACTION_LOG | `action_log` | ActionLog |
-| ACTION | `action` | Action |
-| CATALOG | `catalog` | Catalog |
-| CATALOG_ITEM | `catalog_item` | CatalogItem |
-| PURCHASE | `purchase` | Purchase |
-| POINT_CATEGORY | `point_category` | PointCategory |
-| LEVEL | `level` | Level |
-| LEVEL_CONFIG | `level_config` | LevelConfig |
-| LEADERBOARD | `leaderboard` | LeaderBoard_V2 |
-| LEADER | `leader` | Leader |
-| LOTTERY | `lottery` | Lottery |
-| LOTTERY_TICKET | `lottery_ticket` | LotteryTicket |
-| MYSTERY_BOX | `mystery_box` | MysteryBox |
-| MYSTERY_BOX_LOG | `mystery_box_log` | MysteryBoxLog |
-| NOTIFICATION | `notification` | Notification |
-| QUESTION | `question` | Question |
-| QUESTION_LOG | `question_log` | QuestionLog |
-| QUIZ | `quiz` | Quiz |
-| QUIZ_LOG | `quiz_log` | QuizLog |
-| COMPETITION | `competition` | Competition |
-| COMPETITION_JOIN | `competition_join` | CompetitionJoin |
-| SWAP | `swap` | Swap |
-| FOLDER | `folder` | Folder |
-| TRIGGER | `trigger` | Trigger |
-| TRIGGER_LOG | `trigger_log` | TriggerLog |
-| SCHEDULER | `scheduler` | SchedulerConfig |
-| SCHEDULER_LOG | `scheduler_log` | SchedulerLog |
-| PUBLIC_ENDPOINT | `public_endpoint` | PublicEndpoint |
-| WEBHOOK | `webhook` | Webhook |
-| WEBSOCKET | `websocket` | WebSocket |
-| STUDIO_PAGE | `studio_page` | StudioPage |
-| BACKUP | `backup` | Backup |
-| COMPACT | `compact` | Compact |
-
-> **Nota:** Coleções customizadas (Custom Objects) usam o sufixo `__c` (ex: `car__c`, `email__c`) e são acessadas como `HashMap`.
+# Java Entities — Referência
+
+As entidades são os objetos Java (POJOs) que representam os dados armazenados no MongoDB. Cada entidade mapeia para uma coleção no banco de dados.
+
+---
+
+## Entidades Principais
+
+### Player
+
+**Coleção MongoDB:** `player`
+**Classe:** `com.funifier.engine.player.Player`
+
+```java
+// Campos principais
+String _id;          // ID do jogador (ex: "john")
+String name;         // Nome do jogador
+String email;        // Email
+String password;     // Senha (hash)
+Map<String, Object> extra;  // Campos customizados (ex: department, country)
+List<String> teams;  // IDs das equipes
+List<String> friends; // IDs dos amigos
+ImageSet image;      // Imagens (small, medium, original)
+Date created;        // Data de cadastro
+```
+
+```json
+{"_id": "john", "name": "John Travolta", "email": "john@funifier.com", "teams": ["sales"], "extra": {"country": "USA", "department": "IT"}, "image": {"small": {"url": "..."}, "medium": {"url": "..."}, "original": {"url": "..."}}}
+```
+
+---
+
+### Achievement
+
+**Coleção MongoDB:** `achievement`
+**Classe:** `com.funifier.engine.achievement.Achievement`
+
+Representa qualquer conquista do jogador: pontos ganhos, desafios completados, itens comprados, níveis alcançados.
+
+```java
+// Campos principais
+String _id;       // ID da conquista
+String player;    // ID do jogador
+double total;     // Quantidade (pontos, unidades)
+int type;         // Tipo (0=Point, 1=Challenge, 2=VirtualGood, 3=Level)
+String item;      // ID do item (point_category, challenge, catalog_item, level)
+Date time;        // Data da conquista
+
+// Constantes de tipo
+static final int TYPE_POINT = 0;
+static final int TYPE_CHALLENGE = 1;
+static final int TYPE_VIRTUAL_GOOD = 2;
+static final int TYPE_LEVEL = 3;
+```
+
+```json
+{"_id": "64a5d2", "player": "john", "total": 25.0, "type": 0, "item": "xp", "time": {"$date": "2023-07-05T20:57:33.303Z"}}
+```
+
+---
+
+### ActionLog
+
+**Coleção MongoDB:** `action_log`
+**Classe:** `com.funifier.engine.action.ActionLog`
+
+Registo de uma ação executada por um jogador.
+
+```java
+// Campos principais
+String _id;       // ID do log
+String actionId;  // ID da ação (ex: "sell")
+String userId;    // ID do jogador (ex: "john")
+Date time;        // Data da execução
+Map<String, Object> attributes; // Atributos da ação (ex: product, price)
+```
+
+```json
+{"_id": "64a5d92", "actionId": "sell", "userId": "john", "time": {"$date": "2023-07-05T20:57:33.303Z"}, "attributes": {"product": "book", "price": 120}}
+```
+
+---
+
+### Action
+
+**Coleção MongoDB:** `action`
+**Classe:** `com.funifier.engine.action.Action`
+
+Definição de um tipo de ação.
+
+```java
+// Campos principais
+String _id;       // ID da ação (ex: "sell")
+String action;    // Nome da ação (ex: "Sell")
+boolean active;   // Se está ativa
+List<ActionAttribute> attributes; // Definição dos atributos (name, type)
+```
+
+```json
+{"_id": "sell", "action": "Sell", "attributes": [{"name": "product", "type": "String"}, {"name": "price", "type": "Number"}], "active": true}
+```
+
+---
+
+### Challenge
+
+**Coleção MongoDB:** `challenge`
+**Classe:** `com.funifier.engine.challenge.Challenge`
+
+Definição de um desafio.
+
+```java
+// Campos principais
+String _id;          // ID do desafio
+String challenge;    // Nome do desafio
+boolean active;      // Se está ativo
+List<Rule> rules;    // Regras (ação, operador, total)
+List<Reward> points; // Recompensas (pontos, operação)
+```
+
+```json
+{"_id": "DTo8dS3", "challenge": "Watch Video", "active": true, "rules": [{"actionId": "watch_video", "operator": 5, "total": 0}], "points": [{"total": 10.0, "category": "xp", "operation": 0}]}
+```
+
+---
+
+### CatalogItem
+
+**Coleção MongoDB:** `catalog_item`
+**Classe:** `com.funifier.engine.catalog.CatalogItem`
+
+Item da loja virtual.
+
+```java
+// Campos principais
+String _id;           // ID do item
+String catalogId;     // ID do catálogo
+String name;          // Nome do item
+int amount;           // Quantidade disponível
+boolean active;       // Se está ativo
+Requirement[] requires; // Requisitos para compra (pontos necessários)
+```
+
+```json
+{"_id": "prd1", "catalogId": "gifts", "name": "T-shirt", "amount": 100, "active": true, "requires": [{"total": 15, "type": 0, "item": "coin", "operation": 1}]}
+```
+
+---
+
+### Team
+
+**Coleção MongoDB:** `team`
+**Classe:** `com.funifier.engine.team.Team`
+
+```java
+String _id;     // ID da equipe
+String name;    // Nome da equipe
+```
+
+---
+
+### Level
+
+**Coleção MongoDB:** `level`
+**Classe:** `com.funifier.engine.level.Level`
+
+```java
+String _id;     // ID do nível
+String level;   // Nome do nível
+int position;   // Posição (ordem)
+```
+
+---
+
+### PointCategory
+
+**Coleção MongoDB:** `point_category`
+**Classe:** `com.funifier.engine.point.PointCategory`
+
+```java
+String _id;       // ID da categoria (ex: "xp")
+String category;  // Nome (ex: "Experience Points")
+String shortName; // Abreviação (ex: "XP")
+Map extra;        // Campos extras
+```
+
+---
+
+### Lottery
+
+**Coleção MongoDB:** `lottery`
+**Classe:** `com.funifier.engine.lottery.Lottery`
+
+```java
+String _id;     // ID do sorteio
+String title;   // Título
+boolean active; // Se está ativo
+```
+
+---
+
+### LotteryTicket
+
+**Coleção MongoDB:** `lottery_ticket`
+**Classe:** `com.funifier.engine.lottery.LotteryTicket`
+
+```java
+String _id;      // ID do ticket
+String lottery;  // ID do sorteio
+String player;   // ID do jogador
+```
+
+---
+
+### MysteryBox
+
+**Coleção MongoDB:** `mystery_box`
+**Classe:** `com.funifier.engine.mystery.MysteryBox`
+
+```java
+String _id;     // ID da caixa
+String title;   // Título
+boolean active; // Se está ativa
+```
+
+---
+
+### Competition
+
+**Coleção MongoDB:** `competition`
+**Classe:** `com.funifier.engine.competition.Competition`
+
+```java
+String _id;     // ID da competição
+boolean active; // Se está ativa
+```
+
+---
+
+### Question
+
+**Coleção MongoDB:** `question`
+**Classe:** `com.funifier.engine.question.Question`
+
+```java
+String _id;      // ID da pergunta
+String question; // Texto da pergunta
+```
+
+---
+
+### QuestionLog
+
+**Coleção MongoDB:** `question_log`
+**Classe:** `com.funifier.engine.question.QuestionLog`
+
+```java
+String _id;      // ID do log
+String player;   // ID do jogador
+String question; // ID da pergunta
+```
+
+---
+
+### Quiz / QuizLog
+
+**Coleções:** `quiz` / `quiz_log`
+
+---
+
+### Notification
+
+**Coleção MongoDB:** `notification`
+**Classe:** `com.funifier.engine.notify.Notification`
+
+```java
+String _id;     // ID da notificação
+String player;  // ID do jogador destino
+String title;   // Título
+String message; // Mensagem
+Date time;      // Data
+```
+
+---
+
+### Swap
+
+**Coleção MongoDB:** `swap`
+**Classe:** `com.funifier.engine.swap.Swap`
+
+---
+
+### Trigger
+
+**Coleção MongoDB:** `trigger`
+**Classe:** `com.funifier.engine.integration.trigger.Trigger`
+
+```java
+String _id;      // ID da trigger
+String name;     // Nome
+String entity;   // Entidade (ex: "player", "achievement")
+String event;    // Evento (ex: "before_create", "after_win")
+String script;   // Código Java
+```
+
+---
+
+### SchedulerConfig
+
+**Coleção MongoDB:** `scheduler`
+**Classe:** `com.funifier.engine.integration.scheduler.SchedulerConfig`
+
+---
+
+### PublicEndpoint
+
+**Coleção MongoDB:** `public_endpoint`
+**Classe:** `com.funifier.engine.pub.PublicEndpoint`
+
+---
+
+### Webhook
+
+**Coleção MongoDB:** `webhook`
+**Classe:** `com.funifier.engine.webhook.Webhook`
+
+---
+
+## Mapeamento Completo Entidade → Coleção
+
+| Entidade | Coleção MongoDB | Classe Java |
+|----------|----------------|-------------|
+| PLAYER | `player` | Player |
+| PLAYER_STATUS | `player_status` | PlayerStatus |
+| TEAM | `team` | Team |
+| TEAM_PLAYER | `team_player` | TeamLink |
+| ACHIEVEMENT | `achievement` | Achievement |
+| CHALLENGE | `challenge` | Challenge |
+| ACTION_LOG | `action_log` | ActionLog |
+| ACTION | `action` | Action |
+| CATALOG | `catalog` | Catalog |
+| CATALOG_ITEM | `catalog_item` | CatalogItem |
+| PURCHASE | `purchase` | Purchase |
+| POINT_CATEGORY | `point_category` | PointCategory |
+| LEVEL | `level` | Level |
+| LEVEL_CONFIG | `level_config` | LevelConfig |
+| LEADERBOARD | `leaderboard` | LeaderBoard_V2 |
+| LEADER | `leader` | Leader |
+| LOTTERY | `lottery` | Lottery |
+| LOTTERY_TICKET | `lottery_ticket` | LotteryTicket |
+| MYSTERY_BOX | `mystery_box` | MysteryBox |
+| MYSTERY_BOX_LOG | `mystery_box_log` | MysteryBoxLog |
+| NOTIFICATION | `notification` | Notification |
+| QUESTION | `question` | Question |
+| QUESTION_LOG | `question_log` | QuestionLog |
+| QUIZ | `quiz` | Quiz |
+| QUIZ_LOG | `quiz_log` | QuizLog |
+| COMPETITION | `competition` | Competition |
+| COMPETITION_JOIN | `competition_join` | CompetitionJoin |
+| SWAP | `swap` | Swap |
+| FOLDER | `folder` | Folder |
+| TRIGGER | `trigger` | Trigger |
+| TRIGGER_LOG | `trigger_log` | TriggerLog |
+| SCHEDULER | `scheduler` | SchedulerConfig |
+| SCHEDULER_LOG | `scheduler_log` | SchedulerLog |
+| PUBLIC_ENDPOINT | `public_endpoint` | PublicEndpoint |
+| WEBHOOK | `webhook` | Webhook |
+| WEBSOCKET | `websocket` | WebSocket |
+| STUDIO_PAGE | `studio_page` | StudioPage |
+| BACKUP | `backup` | Backup |
+| COMPACT | `compact` | Compact |
+
+> **Nota:** Coleções customizadas (Custom Objects) usam o sufixo `__c` (ex: `car__c`, `email__c`) e são acessadas como `HashMap`.