nexabase-report 0.1.0

package/README.md

@@ -0,0 +1,106 @@
+# NexaBase Report (Designer + Viewer)
+
+Librería para diseñar y visualizar reportes tipo banded (inspirada en Stimulsoft) con exportación a PDF/Excel/Word.
+
+## Instalación
+
+```bash
+npm install nexabase-report
+```
+
+## Uso rápido: Viewer (apps externas)
+
+El Viewer se expone como Custom Element: `<nexa-viewer />`.
+
+### 1) Vue 3
+
+```ts
+import { registerNexaReport } from 'nexabase-report';
+import 'nexabase-report/style.css';
+
+registerNexaReport();
+```
+
+```vue
+<template>
+  <nexa-viewer
+    :definition="definition"
+    :data="data"
+    :parameters="{ fechaDesde: '2026-01-01' }"
+    minimal
+    skip-params-dialog
+  />
+</template>
+```
+
+### 2) React
+
+```tsx
+import { useEffect, useRef } from 'react';
+import { registerNexaReport } from 'nexabase-report';
+import 'nexabase-report/style.css';
+
+registerNexaReport();
+
+export function ReportViewer({ definition, data, parameters }: any) {
+  const ref = useRef<any>(null);
+  useEffect(() => {
+    if (!ref.current) return;
+    ref.current.definition = definition;
+    ref.current.data = data;
+    ref.current.parameters = parameters;
+  }, [definition, data, parameters]);
+
+  return <nexa-viewer ref={ref} minimal />;
+}
+```
+
+### 3) HTML puro (CDN / UMD)
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/nexabase-report@0.1.0/dist/style.css">
+<script src="https://unpkg.com/nexabase-report@0.1.0/dist/nexabase-report.umd.js"></script>
+<script>
+  window.NexaReport.registerNexaReport();
+</script>
+
+<nexa-viewer id="viewer"></nexa-viewer>
+<script>
+  const v = document.getElementById('viewer');
+  v.definition = {/* ... */};
+  v.data = [{/* ... */}];
+</script>
+```
+
+## Probar sin publicar (recomendado)
+
+Desde este repo:
+
+```bash
+npm run build
+npm pack
+```
+
+En el proyecto externo:
+
+```bash
+npm install /ruta/al/nexabase-report-0.1.0.tgz
+```
+
+## Publicar en npm
+
+Guía paso a paso: [docs/PUBLISHING.md](docs/PUBLISHING.md)
+
+Resumen:
+
+```bash
+npm run build
+npm pack --dry-run
+npm version patch
+npm publish --access public
+```
+
+## Documentación
+
+- API del Viewer: [docs/VIEWER_API.md](docs/VIEWER_API.md)
+- Integración externa: [docs/EXTERNAL_INTEGRATION.md](docs/EXTERNAL_INTEGRATION.md)