@omnizap-system/omnizap 2.5.12

package/app/modules/playModule/commandConfig.json

@@ -0,0 +1,584 @@
+{
+  "schema_version": "2.0.0",
+  "module": "playModule",
+  "enabled": true,
+  "source_files": ["playCommand.js"],
+  "defaults": {
+    "inheritance_mode": "deep_merge_with_command_overrides",
+    "compatibility_mode": "legacy_and_v2_fields",
+    "legacy_field_aliases": {
+      "descricao": "description",
+      "metodos_de_uso": "usage",
+      "permissao_necessaria": "permission",
+      "local_de_uso": "contexts",
+      "informacoes_coletadas": "collected_data",
+      "pre_condicoes": "requirements",
+      "dependencias_externas": "dependencies",
+      "efeitos_colaterais": "side_effects",
+      "observabilidade": "observability",
+      "privacidade": "privacy",
+      "limite_uso_por_plano": "plan_limits",
+      "argumentos": "arguments",
+      "acesso": "access"
+    },
+    "command": {
+      "enabled": true,
+      "category": "midia",
+      "version": "1.0.0",
+      "stability": "stable",
+      "deprecated": false,
+      "replaced_by": null,
+      "risk_level": "medium"
+    },
+    "requirements": {
+      "require_group": false,
+      "require_group_admin": false,
+      "require_bot_owner": false,
+      "require_google_login": true,
+      "require_nsfw_enabled": false,
+      "require_media": false,
+      "require_reply_message": false,
+      "legacy": {
+        "requer_grupo": false,
+        "requer_admin": false,
+        "requer_admin_principal": false,
+        "requer_google_login": true,
+        "requer_nsfw": false,
+        "requer_midia": false,
+        "requer_mensagem_respondida": false
+      }
+    },
+    "pre_condicoes": {
+      "requer_grupo": false,
+      "requer_admin": false,
+      "requer_admin_principal": false,
+      "requer_google_login": true,
+      "requer_nsfw": false,
+      "requer_midia": false,
+      "requer_mensagem_respondida": false
+    },
+    "rate_limit": {
+      "max": null,
+      "janela_ms": null,
+      "escopo": "sem_rate_limit_explicito"
+    },
+    "dependencies": ["serviço YTDLS/Downloader", "ffmpeg", "ffprobe"],
+    "dependencias_externas": ["serviço YTDLS/Downloader", "ffmpeg", "ffprobe"],
+    "responses": {
+      "success": "Comando executado com sucesso.",
+      "usage_error": "Formato de uso inválido. Consulte metodos_de_uso.",
+      "permission_error": "Permissão insuficiente para executar este comando."
+    },
+    "respostas_padrao": {
+      "sucesso": "Comando executado com sucesso.",
+      "erro_uso": "Formato de uso inválido. Consulte metodos_de_uso.",
+      "erro_permissao": "Permissão insuficiente para executar este comando."
+    },
+    "observability": {
+      "event_name": "command.executed",
+      "log_level": "info",
+      "tags": ["whatsapp", "command", "playModule"]
+    },
+    "privacy": {
+      "data_categories": ["chat_identifier", "sender_identifier", "command_content"],
+      "retention_policy": "standard_app_logs",
+      "legal_basis": "service_execution_and_legitimate_interest"
+    },
+    "access": {
+      "premium_only": false,
+      "allowed_plans": ["comum", "premium"]
+    },
+    "acesso": {
+      "somente_premium": false,
+      "planos_permitidos": ["comum", "premium"]
+    },
+    "plan_limits": {
+      "comum": {
+        "max": 4,
+        "janela_ms": 600000,
+        "escopo": "usuario"
+      },
+      "premium": {
+        "max": 15,
+        "janela_ms": 600000,
+        "escopo": "usuario"
+      }
+    },
+    "limite_uso_por_plano": {
+      "comum": {
+        "max": 4,
+        "janela_ms": 600000,
+        "escopo": "usuario"
+      },
+      "premium": {
+        "max": 15,
+        "janela_ms": 600000,
+        "escopo": "usuario"
+      }
+    },
+    "behavior_templates": {
+      "toggle_on_off_status": {
+        "type": "toggle",
+        "allowed_actions": ["on", "off", "status"],
+        "action_argument": "acao"
+      },
+      "add_remove_list": {
+        "type": "list_management",
+        "allowed_actions": ["add", "remove", "list"],
+        "action_argument": "acao"
+      },
+      "approve_reject": {
+        "type": "moderation_decision",
+        "allowed_actions": ["approve", "reject"],
+        "action_argument": "acao",
+        "requires_targets": true
+      },
+      "set_status_reset": {
+        "type": "configuration_window",
+        "allowed_actions": ["set", "status", "reset"],
+        "action_argument": "valor"
+      }
+    }
+  },
+  "commands": [
+    {
+      "name": "tocar",
+      "aliases": ["musica", "play"],
+      "descricao": "Baixa/gera audio a partir de link ou busca no YouTube.",
+      "metodos_de_uso": ["<prefix>tocar <link>", "<prefix>tocar <termo de busca>"],
+      "mensagens_uso": {
+        "default": ["🎵 Uso: <prefix>tocar <link do YouTube ou termo de busca>"]
+      },
+      "permissao_necessaria": "usuario comum",
+      "limite_de_uso": "arquivo ate PLAY_MAX_MB (padrao 100 MB)",
+      "local_de_uso": ["privado", "grupo"],
+      "informacoes_coletadas": ["identificador do chat (remoteJid)", "identificador do remetente (senderJid)", "texto do comando e argumentos", "contexto da mensagem (citacao e mencoes, quando existir)", "link ou termo de busca enviado no comando", "metadados de fila/download retornados pelo servico de midia", "informacoes de tamanho do arquivo para validacao de limite"],
+      "enabled": true,
+      "categoria": "midia",
+      "subcomandos": [],
+      "argumentos": [
+        {
+          "nome": "consulta",
+          "tipo": "string",
+          "obrigatorio": true,
+          "validacao": "URL YouTube ou termo de busca",
+          "default": null
+        }
+      ],
+      "pre_condicoes": {
+        "requer_grupo": false,
+        "requer_admin": false,
+        "requer_admin_principal": false,
+        "requer_google_login": true,
+        "requer_nsfw": false,
+        "requer_midia": false,
+        "requer_mensagem_respondida": false
+      },
+      "rate_limit": {
+        "max": null,
+        "janela_ms": null,
+        "escopo": "sem_rate_limit_explicito"
+      },
+      "dependencias_externas": ["serviço YTDLS/Downloader", "ffmpeg", "ffprobe"],
+      "efeitos_colaterais": ["baixa mídia temporária", "envia áudio no chat"],
+      "respostas_padrao": {
+        "sucesso": "Comando executado com sucesso.",
+        "erro_uso": "Formato de uso inválido. Consulte metodos_de_uso.",
+        "erro_permissao": "Permissão insuficiente para executar este comando."
+      },
+      "observabilidade": {
+        "evento_analytics": "whatsapp_command_play",
+        "tags_log": ["whatsapp", "command", "playModule", "play"],
+        "nivel_log": "info"
+      },
+      "privacidade": {
+        "dados_sensiveis": ["identificador do chat", "identificador do remetente", "conteudo textual do comando"],
+        "retencao": "conforme políticas de logs, banco de dados e arquivos temporários da aplicação",
+        "base_legal": "execução do serviço solicitado e legítimo interesse operacional"
+      },
+      "capability_keywords": ["tocar", "midia", "privado", "grupo"],
+      "faq_patterns": ["como usar tocar", "o que faz tocar", "comando tocar"],
+      "user_phrasings": ["quero usar tocar", "me ajuda com tocar", "baixa/gera audio a partir"],
+      "suggestion_priority": 100,
+      "acesso": {
+        "somente_premium": false,
+        "planos_permitidos": ["comum", "premium"]
+      },
+      "limite_uso_por_plano": {
+        "comum": {
+          "max": 4,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        },
+        "premium": {
+          "max": 15,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        }
+      },
+      "id": "play.tocar",
+      "description": "Baixa/gera audio a partir de link ou busca no YouTube.",
+      "usage": ["<prefix>tocar <link>", "<prefix>tocar <termo de busca>"],
+      "docs": {
+        "summary": "Baixa/gera audio a partir de link ou busca no YouTube.",
+        "usage_examples": ["<prefix>tocar <link>", "<prefix>tocar <termo de busca>"],
+        "usage_variants": {
+          "default": ["🎵 Uso: <prefix>tocar <link do YouTube ou termo de busca>"]
+        }
+      },
+      "permission": "usuario comum",
+      "contexts": ["privado", "grupo"],
+      "collected_data": ["identificador do chat (remoteJid)", "identificador do remetente (senderJid)", "texto do comando e argumentos", "contexto da mensagem (citacao e mencoes, quando existir)", "link ou termo de busca enviado no comando", "metadados de fila/download retornados pelo servico de midia", "informacoes de tamanho do arquivo para validacao de limite"],
+      "requirements": {
+        "require_group": false,
+        "require_group_admin": false,
+        "require_bot_owner": false,
+        "require_google_login": true,
+        "require_nsfw_enabled": false,
+        "require_media": false,
+        "require_reply_message": false,
+        "legacy": {
+          "requer_grupo": false,
+          "requer_admin": false,
+          "requer_admin_principal": false,
+          "requer_google_login": true,
+          "requer_nsfw": false,
+          "requer_midia": false,
+          "requer_mensagem_respondida": false
+        }
+      },
+      "arguments": [
+        {
+          "name": "consulta",
+          "type": "string",
+          "required": true,
+          "default": null,
+          "enum": null,
+          "description": "URL YouTube ou termo de busca",
+          "position": 0,
+          "accepts_mentions": false,
+          "accepts_reply_target": false,
+          "greedy": false,
+          "validation": "URL YouTube ou termo de busca"
+        }
+      ],
+      "behavior": {
+        "type": "argument_driven",
+        "allowed_actions": []
+      },
+      "limits": {
+        "usage_description": "arquivo ate PLAY_MAX_MB (padrao 100 MB)",
+        "rate_limit": {
+          "max": null,
+          "janela_ms": null,
+          "escopo": "sem_rate_limit_explicito"
+        },
+        "access": {
+          "somente_premium": false,
+          "planos_permitidos": ["comum", "premium"]
+        },
+        "plan_limits": {
+          "comum": {
+            "max": 4,
+            "janela_ms": 600000,
+            "escopo": "usuario"
+          },
+          "premium": {
+            "max": 15,
+            "janela_ms": 600000,
+            "escopo": "usuario"
+          }
+        }
+      },
+      "dependencies": ["serviço YTDLS/Downloader", "ffmpeg", "ffprobe"],
+      "side_effects": ["baixa mídia temporária", "envia áudio no chat"],
+      "observability": {
+        "event_name": "command.executed",
+        "event_key": "play.tocar",
+        "analytics_event": "whatsapp_command_play",
+        "log_level": "info",
+        "tags": ["whatsapp", "command", "playModule", "play"],
+        "legacy": {
+          "evento_analytics": "whatsapp_command_play",
+          "tags_log": ["whatsapp", "command", "playModule", "play"],
+          "nivel_log": "info"
+        }
+      },
+      "privacy": {
+        "data_categories": ["chat_identifier", "sender_identifier", "command_content"],
+        "sensitive_fields": ["remoteJid", "senderJid", "text", "args"],
+        "retention_policy": "standard_app_logs",
+        "retention_notes": "conforme políticas de logs, banco de dados e arquivos temporários da aplicação",
+        "legal_basis": "service_execution_and_legitimate_interest",
+        "legal_basis_notes": "execução do serviço solicitado e legítimo interesse operacional",
+        "legacy": {
+          "dados_sensiveis": ["identificador do chat", "identificador do remetente", "conteudo textual do comando"],
+          "retencao": "conforme políticas de logs, banco de dados e arquivos temporários da aplicação",
+          "base_legal": "execução do serviço solicitado e legítimo interesse operacional"
+        }
+      },
+      "discovery": {
+        "keywords": ["tocar", "midia", "privado", "grupo"],
+        "faq_queries": ["como usar tocar", "o que faz tocar", "comando tocar"],
+        "user_phrasings": ["quero usar tocar", "me ajuda com tocar", "baixa/gera audio a partir"],
+        "suggestion_priority": 100
+      },
+      "access": {
+        "premium_only": false,
+        "allowed_plans": ["comum", "premium"],
+        "legacy": {
+          "somente_premium": false,
+          "planos_permitidos": ["comum", "premium"]
+        }
+      },
+      "plan_limits": {
+        "comum": {
+          "max": 4,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        },
+        "premium": {
+          "max": 15,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        }
+      },
+      "version": "1.0.0",
+      "stability": "stable",
+      "deprecated": false,
+      "replaced_by": null,
+      "risk_level": "low",
+      "handler": {
+        "file": "playCommand.js",
+        "method": "handlePlayCommand",
+        "command_case": "tocar"
+      },
+      "compatibility": {
+        "schema": "legacy_v1_and_v2",
+        "legacy_name": "tocar",
+        "legacy_fields_present": ["descricao", "metodos_de_uso", "permissao_necessaria", "local_de_uso", "informacoes_coletadas", "argumentos", "pre_condicoes", "dependencias_externas", "efeitos_colaterais", "observabilidade", "privacidade", "acesso", "limite_uso_por_plano"]
+      }
+    },
+    {
+      "name": "tocarvideo",
+      "aliases": ["playvid"],
+      "descricao": "Baixa video a partir de link ou busca no YouTube.",
+      "metodos_de_uso": ["<prefix>tocarvideo <link>", "<prefix>tocarvideo <termo de busca>"],
+      "mensagens_uso": {
+        "default": ["🎬 Uso: <prefix>tocarvideo <link do YouTube ou termo de busca>"]
+      },
+      "permissao_necessaria": "usuario comum",
+      "limite_de_uso": "arquivo ate PLAY_MAX_MB (padrao 100 MB)",
+      "local_de_uso": ["privado", "grupo"],
+      "informacoes_coletadas": ["identificador do chat (remoteJid)", "identificador do remetente (senderJid)", "texto do comando e argumentos", "contexto da mensagem (citacao e mencoes, quando existir)", "link ou termo de busca enviado no comando", "metadados de fila/download retornados pelo servico de midia", "informacoes de tamanho e formato de video para validacao"],
+      "enabled": true,
+      "categoria": "midia",
+      "subcomandos": [],
+      "argumentos": [
+        {
+          "nome": "consulta",
+          "tipo": "string",
+          "obrigatorio": true,
+          "validacao": "URL YouTube ou termo de busca",
+          "default": null
+        }
+      ],
+      "pre_condicoes": {
+        "requer_grupo": false,
+        "requer_admin": false,
+        "requer_admin_principal": false,
+        "requer_google_login": true,
+        "requer_nsfw": false,
+        "requer_midia": false,
+        "requer_mensagem_respondida": false
+      },
+      "rate_limit": {
+        "max": null,
+        "janela_ms": null,
+        "escopo": "sem_rate_limit_explicito"
+      },
+      "dependencias_externas": ["serviço YTDLS/Downloader", "ffmpeg", "ffprobe"],
+      "efeitos_colaterais": ["baixa mídia temporária", "envia vídeo no chat"],
+      "respostas_padrao": {
+        "sucesso": "Comando executado com sucesso.",
+        "erro_uso": "Formato de uso inválido. Consulte metodos_de_uso.",
+        "erro_permissao": "Permissão insuficiente para executar este comando."
+      },
+      "observabilidade": {
+        "evento_analytics": "whatsapp_command_playvid",
+        "tags_log": ["whatsapp", "command", "playModule", "playvid"],
+        "nivel_log": "info"
+      },
+      "privacidade": {
+        "dados_sensiveis": ["identificador do chat", "identificador do remetente", "conteudo textual do comando"],
+        "retencao": "conforme políticas de logs, banco de dados e arquivos temporários da aplicação",
+        "base_legal": "execução do serviço solicitado e legítimo interesse operacional"
+      },
+      "capability_keywords": ["tocarvideo", "midia", "privado", "grupo"],
+      "faq_patterns": ["como usar tocarvideo", "o que faz tocarvideo", "comando tocarvideo"],
+      "user_phrasings": ["quero usar tocarvideo", "me ajuda com tocarvideo", "baixa video a partir"],
+      "suggestion_priority": 100,
+      "acesso": {
+        "somente_premium": true,
+        "planos_permitidos": ["premium"]
+      },
+      "limite_uso_por_plano": {
+        "comum": {
+          "max": 4,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        },
+        "premium": {
+          "max": 15,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        }
+      },
+      "id": "play.tocarvideo",
+      "description": "Baixa video a partir de link ou busca no YouTube.",
+      "usage": ["<prefix>tocarvideo <link>", "<prefix>tocarvideo <termo de busca>"],
+      "docs": {
+        "summary": "Baixa video a partir de link ou busca no YouTube.",
+        "usage_examples": ["<prefix>tocarvideo <link>", "<prefix>tocarvideo <termo de busca>"],
+        "usage_variants": {
+          "default": ["🎬 Uso: <prefix>tocarvideo <link do YouTube ou termo de busca>"]
+        }
+      },
+      "permission": "usuario comum",
+      "contexts": ["privado", "grupo"],
+      "collected_data": ["identificador do chat (remoteJid)", "identificador do remetente (senderJid)", "texto do comando e argumentos", "contexto da mensagem (citacao e mencoes, quando existir)", "link ou termo de busca enviado no comando", "metadados de fila/download retornados pelo servico de midia", "informacoes de tamanho e formato de video para validacao"],
+      "requirements": {
+        "require_group": false,
+        "require_group_admin": false,
+        "require_bot_owner": false,
+        "require_google_login": true,
+        "require_nsfw_enabled": false,
+        "require_media": false,
+        "require_reply_message": false,
+        "legacy": {
+          "requer_grupo": false,
+          "requer_admin": false,
+          "requer_admin_principal": false,
+          "requer_google_login": true,
+          "requer_nsfw": false,
+          "requer_midia": false,
+          "requer_mensagem_respondida": false
+        }
+      },
+      "arguments": [
+        {
+          "name": "consulta",
+          "type": "string",
+          "required": true,
+          "default": null,
+          "enum": null,
+          "description": "URL YouTube ou termo de busca",
+          "position": 0,
+          "accepts_mentions": false,
+          "accepts_reply_target": false,
+          "greedy": false,
+          "validation": "URL YouTube ou termo de busca"
+        }
+      ],
+      "behavior": {
+        "type": "argument_driven",
+        "allowed_actions": []
+      },
+      "limits": {
+        "usage_description": "arquivo ate PLAY_MAX_MB (padrao 100 MB)",
+        "rate_limit": {
+          "max": null,
+          "janela_ms": null,
+          "escopo": "sem_rate_limit_explicito"
+        },
+        "access": {
+          "somente_premium": true,
+          "planos_permitidos": ["premium"]
+        },
+        "plan_limits": {
+          "comum": {
+            "max": 4,
+            "janela_ms": 600000,
+            "escopo": "usuario"
+          },
+          "premium": {
+            "max": 15,
+            "janela_ms": 600000,
+            "escopo": "usuario"
+          }
+        }
+      },
+      "dependencies": ["serviço YTDLS/Downloader", "ffmpeg", "ffprobe"],
+      "side_effects": ["baixa mídia temporária", "envia vídeo no chat"],
+      "observability": {
+        "event_name": "command.executed",
+        "event_key": "play.tocarvideo",
+        "analytics_event": "whatsapp_command_playvid",
+        "log_level": "info",
+        "tags": ["whatsapp", "command", "playModule", "playvid"],
+        "legacy": {
+          "evento_analytics": "whatsapp_command_playvid",
+          "tags_log": ["whatsapp", "command", "playModule", "playvid"],
+          "nivel_log": "info"
+        }
+      },
+      "privacy": {
+        "data_categories": ["chat_identifier", "sender_identifier", "command_content"],
+        "sensitive_fields": ["remoteJid", "senderJid", "text", "args"],
+        "retention_policy": "standard_app_logs",
+        "retention_notes": "conforme políticas de logs, banco de dados e arquivos temporários da aplicação",
+        "legal_basis": "service_execution_and_legitimate_interest",
+        "legal_basis_notes": "execução do serviço solicitado e legítimo interesse operacional",
+        "legacy": {
+          "dados_sensiveis": ["identificador do chat", "identificador do remetente", "conteudo textual do comando"],
+          "retencao": "conforme políticas de logs, banco de dados e arquivos temporários da aplicação",
+          "base_legal": "execução do serviço solicitado e legítimo interesse operacional"
+        }
+      },
+      "discovery": {
+        "keywords": ["tocarvideo", "midia", "privado", "grupo"],
+        "faq_queries": ["como usar tocarvideo", "o que faz tocarvideo", "comando tocarvideo"],
+        "user_phrasings": ["quero usar tocarvideo", "me ajuda com tocarvideo", "baixa video a partir"],
+        "suggestion_priority": 100
+      },
+      "access": {
+        "premium_only": true,
+        "allowed_plans": ["premium"],
+        "legacy": {
+          "somente_premium": true,
+          "planos_permitidos": ["premium"]
+        }
+      },
+      "plan_limits": {
+        "comum": {
+          "max": 4,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        },
+        "premium": {
+          "max": 15,
+          "janela_ms": 600000,
+          "escopo": "usuario"
+        }
+      },
+      "version": "1.0.0",
+      "stability": "stable",
+      "deprecated": false,
+      "replaced_by": null,
+      "risk_level": "low",
+      "handler": {
+        "file": "playCommand.js",
+        "method": "handlePlayVidCommand",
+        "command_case": "tocarvideo"
+      },
+      "compatibility": {
+        "schema": "legacy_v1_and_v2",
+        "legacy_name": "tocarvideo",
+        "legacy_fields_present": ["descricao", "metodos_de_uso", "permissao_necessaria", "local_de_uso", "informacoes_coletadas", "argumentos", "pre_condicoes", "dependencias_externas", "efeitos_colaterais", "observabilidade", "privacidade", "acesso", "limite_uso_por_plano"]
+      }
+    }
+  ],
+  "textos": {
+    "usage_header": ""
+  }
+}

package/app/modules/playModule/playAiHelpService.js

@@ -0,0 +1,14 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createModuleAiHelpWrapper } from '../../services/ai/moduleAiHelpWrapperFactory.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const playAiHelpWrapper = createModuleAiHelpWrapper({
+  moduleKey: 'play',
+  moduleLabel: 'comandos de musica e video',
+  envPrefix: 'PLAY_AI_HELP',
+  moduleDirPath: __dirname,
+  moduleNameFallback: 'playModule',
+});