plazbot-cli 0.2.26 → 0.3.1

package/dist/commands/auth/index.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.authCommands = void 0;
-const login_1 = require("./login");
-const logout_1 = require("./logout");
-const status_1 = require("./status");
-exports.authCommands = [
-    login_1.loginCommand,
-    logout_1.logoutCommand,
-    status_1.statusCommand
+import { loginCommand } from './login.js';
+import { logoutCommand } from './logout.js';
+import { statusCommand } from './status.js';
+export const authCommands = [
+    loginCommand,
+    logoutCommand,
+    statusCommand
 ];

package/dist/commands/auth/login.js

@@ -1,53 +1,66 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loginCommand = void 0;
-const commander_1 = require("commander");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-exports.loginCommand = new commander_1.Command('init')
-    .description('Guarda la API Key y correo del usuario localmente')
-    .requiredOption('-e, --email <email>', 'Correo del usuario')
-    .requiredOption('-k, --api-key <apiKey>', 'API Key del usuario')
-    .requiredOption('-w, --workspace <workspace>', 'ID del workspace')
-    .requiredOption('-z, --zone <zone>', 'Zona (LA o EU)')
-    .option('--dev', 'Usar ambiente de desarrollo', false)
+import { Command } from 'commander';
+import { saveCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+export const loginCommand = new Command('init')
+    .description('Save the API key and user email locally')
+    .option('-e, --email <email>', 'User email (optional)')
+    .requiredOption('-k, --api-key <apiKey>', 'User API key')
+    .requiredOption('-w, --workspace <workspace>', 'Workspace ID')
+    .requiredOption('-z, --zone <zone>', 'Zone (LA or EU)')
+    .option('-u, --user-id <userId>', 'User ID for x-user-id (optional, used by studio)')
+    .option('--dev', 'Use development environment', false)
     .action(async (options) => {
     try {
         // Limpiar la pantalla
         console.clear();
         // Banner de bienvenida
-        logger_1.logger.info('┌' + '─'.repeat(70) + '┐');
-        logger_1.logger.info('│' + ' Bienvenido a Plazbot CLI'.padEnd(69) + '│');
-        logger_1.logger.info('│' + ''.padEnd(69) + '│');
-        logger_1.logger.info('│' + ' Con esta herramienta podrás:'.padEnd(69) + '│');
-        logger_1.logger.info('│' + '   Crear y actualizar agentes'.padEnd(69) + '│');
-        logger_1.logger.info('│' + '   Gestionar configuraciones'.padEnd(69) + '│');
-        logger_1.logger.info('│' + '   Interactuar con tus agentes'.padEnd(69) + '│');
-        logger_1.logger.info('│' + '   Activar todas sus capacidades'.padEnd(69) + '│');
-        logger_1.logger.info('└' + '─'.repeat(70) + '┘\n');
-        await (0, credentials_1.saveCredentials)({
-            email: options.email,
+        logger.info('┌' + '─'.repeat(70) + '┐');
+        logger.info('│' + ' Welcome to Plazbot CLI'.padEnd(69) + '│');
+        logger.info('│' + ''.padEnd(69) + '│');
+        logger.info('│' + ' With this tool you can:'.padEnd(69) + '│');
+        logger.info('│' + '   Create and update agents'.padEnd(69) + '│');
+        logger.info('│' + '   Manage configurations'.padEnd(69) + '│');
+        logger.info('│' + '   Interact with your agents'.padEnd(69) + '│');
+        logger.info('│' + '   Activate all their capabilities'.padEnd(69) + '│');
+        logger.info('└' + '─'.repeat(70) + '┘\n');
+        await saveCredentials({
+            email: options.email || '',
             apiKey: options.apiKey,
             workspace: options.workspace,
-            zone: options.zone
+            zone: options.zone,
+            userId: options.userId
         });
-        logger_1.logger.success('Configuración guardada exitosamente:');
-        logger_1.logger.label('Email', options.email);
-        logger_1.logger.label('Workspace', options.workspace);
-        logger_1.logger.label('Zona', options.zone);
-        logger_1.logger.title('Puedes comenzar usando los siguientes comandos');
-        logger_1.logger.dim('plazbot agent list        - Ver tus agentes');
-        logger_1.logger.dim('plazbot agent templates   - Crear agente desde plantilla');
-        logger_1.logger.dim('plazbot agent chat        - Chatear con un agente');
-        logger_1.logger.dim('plazbot --help            - Ver todos los comandos');
+        logger.success('Configuration saved successfully:');
+        if (options.email)
+            logger.label('Email', options.email);
+        logger.label('Workspace', options.workspace);
+        logger.label('Zone', options.zone);
+        if (options.userId)
+            logger.label('UserId', options.userId);
+        logger.title('You can start by using the following commands');
+        logger.dim('plazbot agent list        - View your agents');
+        logger.dim('plazbot agent templates   - Create an agent from a template');
+        logger.dim('plazbot agent chat        - Chat with an agent');
+        logger.dim('plazbot --help            - View all commands');
         console.log();
         if (options.dev) {
-            logger_1.logger.warning('Ambiente: desarrollo');
+            logger.warning('Environment: development');
         }
     }
     catch (error) {
-        const message = error instanceof Error ? error.message : 'Error desconocido';
-        logger_1.logger.error(message);
+        const message = error instanceof Error ? error.message : 'Unknown error';
+        logger.error(message);
         process.exit(1);
     }
 });
+addExamples(loginCommand, [
+    { description: 'Save credentials for a LA workspace',
+        command: 'plazbot init -e you@company.com -k <jwt> -w wok_AbcDef123 -z LA' },
+    { description: 'Save credentials for an EU workspace',
+        command: 'plazbot init -k <jwt> -w wok_AbcDef123 -z EU' },
+    { description: 'Include userId (used by studio support mode)',
+        command: 'plazbot init -k <jwt> -w wok_AbcDef123 -z LA -u usr_AbcDef123' },
+    { description: 'Target the local backend (dev mode)',
+        command: 'plazbot init -k <jwt> -w wok_AbcDef123 -z LA --dev' },
+]);

package/dist/commands/auth/logout.js

@@ -1,23 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.logoutCommand = void 0;
-const commander_1 = require("commander");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-exports.logoutCommand = new commander_1.Command('finish')
-    .description('Elimina la configuración local del usuario')
-    .option('--dev', 'Usar ambiente de desarrollo', false)
+import { Command } from 'commander';
+import { removeCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+export const logoutCommand = new Command('finish')
+    .description('Remove the local user configuration')
+    .option('--dev', 'Use development environment', false)
     .action(async (options) => {
     try {
-        await (0, credentials_1.removeCredentials)();
-        logger_1.logger.success('Has cerrado sesión correctamente');
+        await removeCredentials();
+        logger.success('You have been signed out successfully');
         if (options.dev) {
-            logger_1.logger.warning('Ambiente: desarrollo');
+            logger.warning('Environment: development');
         }
     }
     catch (error) {
-        const message = error instanceof Error ? error.message : 'Error desconocido al cerrar sesión';
-        logger_1.logger.error(message);
+        const message = error instanceof Error ? error.message : 'Unknown error while signing out';
+        logger.error(message);
         process.exit(1);
     }
 });
+addExamples(logoutCommand, [
+    { description: 'Remove the local configuration (~/.plazbot/config.json)',
+        command: 'plazbot finish' },
+]);

package/dist/commands/auth/status.js

@@ -1,24 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCommand = void 0;
-const commander_1 = require("commander");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-const ui_1 = require("../../utils/ui");
-exports.statusCommand = new commander_1.Command('status')
-    .description('Muestra la sesion activa (workspace, email, zona)')
+import { Command } from 'commander';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+import { section } from '../../utils/ui.js';
+export const statusCommand = new Command('status')
+    .description('Show the active session (workspace, email, zone)')
     .action(async () => {
     try {
-        const credentials = await (0, credentials_1.getStoredCredentials)();
-        console.log((0, ui_1.section)('Sesion activa'));
-        logger_1.logger.label('Email', credentials.email);
-        logger_1.logger.label('Workspace', credentials.workspace);
-        logger_1.logger.label('Zona', credentials.zone === 'LA' ? 'Latinoamerica (LA)' : 'Europa (EU)');
-        logger_1.logger.label('API', credentials.zone === 'EU' ? 'https://apieu.plazbot.com' : 'https://api.plazbot.com');
+        const credentials = await getStoredCredentials();
+        console.log(section('Active session'));
+        if (credentials.email)
+            logger.label('Email', credentials.email);
+        logger.label('Workspace', credentials.workspace);
+        logger.label('Zone', credentials.zone === 'LA' ? 'Latin America (LA)' : 'Europe (EU)');
+        logger.label('API', credentials.zone === 'EU' ? 'https://apieu.plazbot.com' : 'https://api.plazbot.com');
         console.log();
     }
     catch {
-        logger_1.logger.error("No hay sesion activa. Ejecuta 'plazbot init' para conectarte.");
+        logger.error("No active session. Run 'plazbot init' to sign in.");
         process.exit(1);
     }
 });
+addExamples(statusCommand, [
+    { description: 'Show the active workspace, email and zone',
+        command: 'plazbot status' },
+]);

package/dist/commands/portal/add-agent.js

@@ -1,20 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addAgentCommand = void 0;
-const commander_1 = require("commander");
-const plazbot_1 = require("plazbot");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-exports.addAgentCommand = new commander_1.Command('add-agent-portal')
-    .description('Agrega un agente existente a un portal')
-    .requiredOption('-p, --portal-id <portalId>', 'ID del portal')
-    .requiredOption('-a, --agent-id <agentId>', 'ID del agente a agregar')
-    .option('--dev', 'Usar ambiente de desarrollo', false)
+import { Command } from 'commander';
+import { Portal, Agent } from 'plazbot';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+export const addAgentCommand = new Command('add-agent-portal')
+    .description('Add an existing agent to a portal')
+    .requiredOption('-p, --portal-id <portalId>', 'Portal ID')
+    .requiredOption('-a, --agent-id <agentId>', 'ID of the agent to add')
+    .option('--dev', 'Use development environment', false)
     .action(async (options) => {
     try {
         // Obtener credenciales guardadas
-        const credentials = await (0, credentials_1.getStoredCredentials)();
-        const portal = new plazbot_1.Portal({
+        const credentials = await getStoredCredentials();
+        const portal = new Portal({
             workspaceId: credentials.workspace,
             apiKey: credentials.apiKey,
             zone: credentials.zone,
@@ -23,7 +21,7 @@ exports.addAgentCommand = new commander_1.Command('add-agent-portal')
         // Obtener detalles del portal
         const portalDetails = await portal.getPortal(options.portalId);
         // Crear instancia del agente para obtener sus detalles
-        const agent = new plazbot_1.Agent({
+        const agent = new Agent({
             workspaceId: credentials.workspace,
             apiKey: credentials.apiKey,
             zone: credentials.zone,
@@ -31,23 +29,27 @@ exports.addAgentCommand = new commander_1.Command('add-agent-portal')
         });
         // Obtener detalles del agente
         const agentDetails = await agent.getAgentById({ id: options.agentId });
-        logger_1.logger.title('Detalles de la operacion');
-        logger_1.logger.label('Portal ID', portalDetails.portal?.id || options.portalId);
-        logger_1.logger.label('Portal Nombre', portalDetails.portal?.name || 'N/A');
-        logger_1.logger.label('Agente ID', agentDetails.id);
-        logger_1.logger.label('Agente Nombre', agentDetails.name);
+        logger.title('Operation details');
+        logger.label('Portal ID', portalDetails.portal?.id || options.portalId);
+        logger.label('Portal Name', portalDetails.portal?.name || 'N/A');
+        logger.label('Agent ID', agentDetails.id);
+        logger.label('Agent Name', agentDetails.name);
         await portal.addAgentToPortal({
             portalId: options.portalId,
             id: options.agentId
         });
-        logger_1.logger.success('Agente agregado exitosamente al portal');
+        logger.success('Agent added to the portal successfully');
         if (options.dev) {
-            logger_1.logger.warning('Ambiente: desarrollo');
+            logger.warning('Environment: development');
         }
     }
     catch (error) {
-        const message = error instanceof Error ? error.message : 'Error desconocido';
-        logger_1.logger.error(message);
+        const message = error instanceof Error ? error.message : 'Unknown error';
+        logger.error(message);
         process.exit(1);
     }
 });
+addExamples(addAgentCommand, [
+    { description: 'Attach an existing agent to a portal',
+        command: 'plazbot portal add-agent-portal -p prt_AbcDef123 -a agt_AbcDef123' },
+]);

package/dist/commands/portal/add-link.js

@@ -1,20 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addLinkCommand = void 0;
-const commander_1 = require("commander");
-const plazbot_1 = require("plazbot");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-exports.addLinkCommand = new commander_1.Command('add-link')
-    .description('Agregar un enlace al portal')
-    .argument('<portalId>', 'ID del portal')
-    .requiredOption('-t, --title <title>', 'Título del enlace')
-    .requiredOption('-u, --url <url>', 'URL del enlace')
-    .option('--dev', 'Usar entorno de desarrollo')
+import { Command } from 'commander';
+import { Portal } from 'plazbot';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+export const addLinkCommand = new Command('add-link')
+    .description('Add a link to the portal')
+    .argument('<portalId>', 'Portal ID')
+    .requiredOption('-t, --title <title>', 'Link title')
+    .requiredOption('-u, --url <url>', 'Link URL')
+    .option('--dev', 'Use development environment')
     .action(async (portalId, options) => {
     try {
-        const credentials = await (0, credentials_1.getStoredCredentials)();
-        const portal = new plazbot_1.Portal({
+        const credentials = await getStoredCredentials();
+        const portal = new Portal({
             workspaceId: credentials.workspace,
             apiKey: credentials.apiKey,
             zone: credentials.zone,
@@ -25,10 +23,16 @@ exports.addLinkCommand = new commander_1.Command('add-link')
             value: options.title,
             url: options.url
         });
-        logger_1.logger.success('Enlace agregado exitosamente');
+        logger.success('Link added successfully');
     }
     catch (error) {
-        logger_1.logger.error(error.message);
+        logger.error(error.message);
         process.exit(1);
     }
 });
+addExamples(addLinkCommand, [
+    { description: 'Add a documentation link to the portal',
+        command: 'plazbot portal add-link prt_AbcDef123 -t "Docs" -u https://docs.example.com' },
+    { description: 'Add a support link',
+        command: 'plazbot portal add-link prt_AbcDef123 -t "Contact us" -u https://example.com/contact' },
+]);

package/dist/commands/portal/clear-links.js

@@ -1,28 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.clearLinksCommand = void 0;
-const commander_1 = require("commander");
-const plazbot_1 = require("plazbot");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-exports.clearLinksCommand = new commander_1.Command('clear-links')
-    .description('Eliminar todos los enlaces del portal')
-    .argument('<portalId>', 'ID del portal')
-    .option('--dev', 'Usar entorno de desarrollo')
+import { Command } from 'commander';
+import { Portal } from 'plazbot';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+export const clearLinksCommand = new Command('clear-links')
+    .description('Remove all links from the portal')
+    .argument('<portalId>', 'Portal ID')
+    .option('--dev', 'Use development environment')
     .action(async (portalId, options) => {
     try {
-        const credentials = await (0, credentials_1.getStoredCredentials)();
-        const portal = new plazbot_1.Portal({
+        const credentials = await getStoredCredentials();
+        const portal = new Portal({
             workspaceId: credentials.workspace,
             apiKey: credentials.apiKey,
             zone: credentials.zone,
             ...(options.dev && { customUrl: "http://localhost:5090" })
         });
         await portal.clearLinks(portalId);
-        logger_1.logger.success('Enlaces eliminados exitosamente');
+        logger.success('Links removed successfully');
     }
     catch (error) {
-        logger_1.logger.error(error.message);
+        logger.error(error.message);
         process.exit(1);
     }
 });
+addExamples(clearLinksCommand, [
+    { description: 'Remove every link from a portal',
+        command: 'plazbot portal clear-links prt_AbcDef123' },
+]);

package/dist/commands/portal/create.js

@@ -1,20 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCommand = void 0;
-const commander_1 = require("commander");
-const plazbot_1 = require("plazbot");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-exports.createCommand = new commander_1.Command('create')
-    .description('Crea un nuevo portal con configuración simplificada')
-    .requiredOption('-n, --name <name>', 'Nombre del portal')
-    .requiredOption('-t, --title <title>', 'Título de bienvenida del portal')
-    .option('--dev', 'Usar ambiente de desarrollo', false)
+import { Command } from 'commander';
+import { Portal } from 'plazbot';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+export const createCommand = new Command('create')
+    .description('Create a new portal with a simplified configuration')
+    .requiredOption('-n, --name <name>', 'Portal name')
+    .requiredOption('-t, --title <title>', 'Portal welcome title')
+    .option('--dev', 'Use development environment', false)
     .action(async (options) => {
     try {
         // Obtener credenciales guardadas
-        const credentials = await (0, credentials_1.getStoredCredentials)();
-        const portal = new plazbot_1.Portal({
+        const credentials = await getStoredCredentials();
+        const portal = new Portal({
             workspaceId: credentials.workspace,
             apiKey: credentials.apiKey,
             zone: credentials.zone,
@@ -31,17 +29,23 @@ exports.createCommand = new commander_1.Command('create')
             disabled: false,
             brandOff: false
         });
-        logger_1.logger.success('Portal creado exitosamente');
-        logger_1.logger.title('Detalles del portal');
-        logger_1.logger.label('ID', portalCreated.id);
-        logger_1.logger.label('URL', portalCreated.url);
+        logger.success('Portal created successfully');
+        logger.title('Portal details');
+        logger.label('ID', portalCreated.id);
+        logger.label('URL', portalCreated.url);
         if (options.dev) {
-            logger_1.logger.warning('\nAmbiente: desarrollo');
+            logger.warning('\nEnvironment: development');
         }
     }
     catch (error) {
-        const message = error instanceof Error ? error.message : 'Error desconocido al crear el portal';
-        logger_1.logger.error(message);
+        const message = error instanceof Error ? error.message : 'Unknown error while creating the portal';
+        logger.error(message);
         process.exit(1);
     }
 });
+addExamples(createCommand, [
+    { description: 'Create a portal with name and welcome title',
+        command: 'plazbot portal create -n "Customer Portal" -t "Welcome to our help center"' },
+    { description: 'Create against the local backend',
+        command: 'plazbot portal create -n "Test" -t "Hello" --dev' },
+]);

package/dist/commands/portal/delete.js

@@ -1,24 +1,19 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteCommand = void 0;
-const commander_1 = require("commander");
-const plazbot_1 = require("plazbot");
-const credentials_1 = require("../../utils/credentials");
-const logger_1 = require("../../utils/logger");
-const inquirer_1 = __importDefault(require("inquirer"));
-exports.deleteCommand = new commander_1.Command('delete')
-    .description('Elimina un portal')
-    .argument('<portalId>', 'ID del portal')
-    .option('--force', 'Eliminar sin confirmación', false)
-    .option('--dev', 'Usar ambiente de desarrollo', false)
+import { Command } from 'commander';
+import { Portal } from 'plazbot';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+import inquirer from 'inquirer';
+export const deleteCommand = new Command('delete')
+    .description('Delete a portal')
+    .argument('<portalId>', 'Portal ID')
+    .option('--force', 'Delete without confirmation', false)
+    .option('--dev', 'Use development environment', false)
     .action(async (portalId, options) => {
     try {
         // Obtener credenciales guardadas
-        const credentials = await (0, credentials_1.getStoredCredentials)();
-        const portal = new plazbot_1.Portal({
+        const credentials = await getStoredCredentials();
+        const portal = new Portal({
             workspaceId: credentials.workspace,
             apiKey: credentials.apiKey,
             zone: credentials.zone,
@@ -26,32 +21,38 @@ exports.deleteCommand = new commander_1.Command('delete')
         });
         // Obtener detalles del portal para mostrar qué se va a eliminar
         const portalDetails = await portal.getPortal(portalId);
-        logger_1.logger.title('Portal a eliminar');
-        logger_1.logger.label('ID', portalDetails.portal.id);
-        logger_1.logger.label('Nombre', portalDetails.portal.name);
-        logger_1.logger.label('URL', portalDetails.portal.url);
+        logger.title('Portal to delete');
+        logger.label('ID', portalDetails.portal.id);
+        logger.label('Name', portalDetails.portal.name);
+        logger.label('URL', portalDetails.portal.url);
         if (!options.force) {
-            const { confirm } = await inquirer_1.default.prompt([{
+            const { confirm } = await inquirer.prompt([{
                     type: 'confirm',
                     name: 'confirm',
-                    message: '¿Estás seguro de que quieres eliminar este portal?',
+                    message: 'Are you sure you want to delete this portal?',
                     default: false
                 }]);
             if (!confirm) {
-                logger_1.logger.info('Operación cancelada.');
+                logger.info('Operation cancelled.');
                 return;
             }
         }
-        logger_1.logger.dim('Eliminando portal...');
+        logger.dim('Deleting portal...');
         await portal.deletePortal(portalId);
-        logger_1.logger.success('Portal eliminado exitosamente');
+        logger.success('Portal deleted successfully');
         if (options.dev) {
-            logger_1.logger.warning('\nAmbiente: desarrollo');
+            logger.warning('\nEnvironment: development');
         }
     }
     catch (error) {
-        const message = error instanceof Error ? error.message : 'Error desconocido al eliminar el portal';
-        logger_1.logger.error(message);
+        const message = error instanceof Error ? error.message : 'Unknown error while deleting the portal';
+        logger.error(message);
         process.exit(1);
     }
 });
+addExamples(deleteCommand, [
+    { description: 'Delete a portal with confirmation prompt',
+        command: 'plazbot portal delete prt_AbcDef123' },
+    { description: 'Delete without confirmation (use in scripts)',
+        command: 'plazbot portal delete prt_AbcDef123 --force' },
+]);