CLM SDK

Cliente TypeScript para consumir la API de ZeroCLM.

Instalación

npm install @zero/clm-sdk

Uso básico

import { ClmSdk } from '@zero/clm-sdk';

// Crear instancia del SDK
const sdk = new ClmSdk({
  baseUrl: 'https://api.clm-app.com/api',  // URL base de la API
  organization: 'mi-organizacion',        // ID de organización
  token: 'jwt-token-opcional'             // Token JWT (opcional)
});

// Login
async function login() {
  try {
    const response = await sdk.auth.login({
      email: '[email protected]',
      password: 'contraseña'
    });
    
    console.log('Usuario logueado:', response.user);
    // El token se establece automáticamente para futuras peticiones
  } catch (error) {
    console.error('Error de login:', error);
  }
}

// Obtener configuraciones
async function getSettings() {
  try {
    const settings = await sdk.settings.getAll({
      group: 'general',
      enabled: true
    });
    
    console.log('Configuraciones:', settings);
  } catch (error) {
    console.error('Error al obtener configuraciones:', error);
  }
}

Módulos disponibles

Auth

Gestión de autenticación y tokens:

// Login
const loginResponse = await sdk.auth.login({ email, password });

// Refresh token
const refreshResponse = await sdk.auth.refreshToken({ refreshToken });

// Logout
await sdk.auth.logout();

// Verificar si está autenticado
const isAuthenticated = sdk.auth.isAuthenticated();

Settings

Gestión de configuraciones:

// Obtener todas las configuraciones
const settings = await sdk.settings.getAll();

// Obtener configuración por ID
const setting = await sdk.settings.getById('config-id');

// Obtener por grupo y nombre
const appName = await sdk.settings.getByName('general', 'app_name');

// Crear configuración
const newSetting = await sdk.settings.create({
  group_name: 'app',
  name: 'theme',
  value: 'dark',
  data_type: 'string',
  description: 'Tema de la aplicación'
});

// Actualizar configuración
await sdk.settings.update('config-id', { value: 'nuevo-valor' });

// Activar/desactivar configuración
await sdk.settings.toggleEnabled('config-id', true);

// Eliminar configuración
await sdk.settings.delete('config-id');

Manejo de errores

El SDK incluye un sistema de manejo de errores personalizado:

import { ApiError, ErrorType } from '@zero/clm-sdk';

try {
  await sdk.settings.getById('id-inexistente');
} catch (error) {
  if (error instanceof ApiError) {
    console.log('Código de estado:', error.statusCode);
    console.log('Tipo de error:', error.type);
    console.log('Es error de autenticación:', error.isAuthenticationError);
    console.log('Detalles:', error.details);
  }
}

Eventos

El SDK emite eventos que puedes escuchar:

// Escuchar cambios de token
const subscription = sdk.on('tokenChanged', (token) => {
  console.log('Token cambiado:', token);
});

// Escuchar errores de autenticación
sdk.on('authError', (error) => {
  console.log('Error de autenticación:', error);
  // Redirigir a login, etc.
});

// Cancelar suscripción cuando ya no sea necesaria
subscription.unsubscribe();

Caché

El SDK incluye un sistema de caché para optimizar peticiones:

// Limpiar toda la caché
sdk.cache.clear();

// Limpiar sólo caché de settings
sdk.cache.clearByPrefix('/settings');

Configuración avanzada

const sdk = new ClmSdk({
  baseUrl: 'https://api.clm-app.com/api',
  organization: 'mi-organizacion',
  cache: {
    enabled: true,    // Activar/desactivar caché
    ttl: 60000        // Tiempo de vida en ms (default: 1 minuto)
  },
  debug: true         // Activar logs de depuración
});

Desarrollo

Instalación de dependencias

npm install

Ejecutar tests

npm test               # Ejecutar tests
npm run test:watch     # Ejecutar tests en modo watch
npm run test:coverage  # Generar reporte de cobertura

Compilación

npm run build          # Compilar a JavaScript
npm run dev            # Compilar en modo watch

Lint

npm run lint

Licencia

MIT