Referencia del SDK y API Programática

El paquete @fromeroc9/testform@beta expone una API programática de TypeScript / JavaScript diseñada para desarrolladores, ingenieros de plataforma QA y creadores de extensiones.

Permite registrar políticas de calidad personalizadas, plantillas de recursos de pruebas, backends de almacenamiento distribuido, adaptadores de proveedores y evaluar expresiones de configuración de forma programática.

---

Instalación del SDK

Para interactuar con la API de Testform en tus scripts de automatización o paquetes de plugins:

npm install @fromeroc9/testform@beta --save-dev

O si usas Yarn / pnpm:

pnpm add -D @fromeroc9/testform@beta

---

Exportaciones Principales

import {
  // Políticas y Reglas de Calidad
  registerPolicy,
  policy,

  // Plantillas de Recursos (Gherkin -> QA Management)
  registerResource,
  resource,

  // Motor de Expresiones y Variables
  evaluateExpression,
  interpolateExpressions,
  VariableParser,

  // Configuración y Estado
  Config,
  State,
} from '@fromeroc9/testform@beta';

---

Módulos de la API

La API de Testform está dividida en los siguientes bloques funcionales:

1. Políticas (registerPolicy)

Extiende el analizador estático para validar convenciones de nomenclatura, tags obligatorios, estructura de escenarios Gherkin o integración con tickets corporativos antes de generar planes.

2. Recursos (registerResource)

Registra mapeadores personalizados para traducir escenarios Gherkin a entidades externas (Jira, Zephyr, Azure DevOps, TestRail o servicios propietarios).

3. Backends (IBackend)

Implementa conectores de almacenamiento de estado personalizados (backend.custom) para guardar el archivo testform.state y controlar bloqueos concurrentes en cualquier sistema distribuido (Vault, Redis, Firestore, etc.).

4. Proveedores (IProvider)

Implementa conectores para sincronizar el ciclo de vida de casos de prueba, corridas y planes contra APIs de gestión de proyectos.

5. Evaluador de Expresiones (evaluateExpression)

Evalúa expresiones tipo HCL ${...}, llamadas a funciones estándar y lógica condicional programáticamente en Node.js.

6. Gestor de Estado (State)

Lee, inspecciona, bloquea y actualiza el archivo testform.state con control de linaje (lineage) y números de serie.

7. Funciones Integradas

Catálogo completo de funciones matemáticas, cadenas, colecciones y utilidades del sistema (uuid(), trim(), jsonencode(), etc.).