@gabrielkf/gk-dsl-viewer 1.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gabriel Ko. Freitag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,87 @@
+# @gabrielkf/gk-dsl-viewer
+
+Componente de visualização para relatórios definidos em GK-DSL.
+
+## Instalação
+
+Core e Viewer usam o escopo npm pessoal `@gabrielkf` e não precisam de credenciais
+GitHub para consumo. A versão coordenada `1.4.0` deve estar disponível no registro
+público npm antes de instalar:
+
+```bash
+pnpm add @gabrielkf/gk-dsl-core@1.4.0 @gabrielkf/gk-dsl-viewer@1.4.0
+```
+
+O repositório de origem continua privado em `gabrielkofreitag/gk-dsl`. A IDE e o
+workspace não são publicados.
+
+### Migração de identificadores
+
+Os nomes anteriores no escopo `@gabrielkofreitag` não serão mantidos como aliases.
+Atualize dependências e imports:
+
+```diff
+- import { GKReportProvider } from '@gabrielkofreitag/gk-dsl-viewer';
++ import { GKReportProvider } from '@gabrielkf/gk-dsl-viewer';
+- import type { GKReport } from '@gabrielkofreitag/gk-dsl-core';
++ import type { GKReport } from '@gabrielkf/gk-dsl-core';
+```
+
+## Uso
+
+O visualizador é baseado em React 19 e utiliza Mantine 9 para a interface.
+
+```tsx
+import { GKReportProvider, MultiPagePreview } from '@gabrielkf/gk-dsl-viewer';
+import type {
+  DataSourceData,
+  GKDataSource,
+  GKReport,
+  SourceDataProvider,
+} from '@gabrielkf/gk-dsl-core';
+
+function MyReport({ schema }: { schema: GKReport }) {
+  return (
+    <GKReportProvider schema={schema} onFetchDataBySource={fetchData}>
+      <MultiPagePreview />
+    </GKReportProvider>
+  );
+}
+
+const fetchData: SourceDataProvider = async (sourceId, source, params, signal) => {
+  const response = await fetch(`/api/reports/${sourceId}`, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({ source, params }),
+    signal,
+  });
+  if (!response.ok) throw new Error(`Report data request failed: ${response.status}`);
+  return response.json() as Promise<DataSourceData[]>;
+};
+```
+
+## Funcionalidades
+
+- **Renderização Dinâmica**: Processa bandas (Header, Body, Footer, Repeat) dinamicamente.
+- **Gráficos Integrados**: Suporte a Recharts para widgets do tipo `chart`.
+- **Tabelas Financeiras**: Utiliza `mantine-datatable` para visualização de grades complexas.
+- **Exportação**: Preparado para geração de PDF paginado.
+
+## API pública de geração
+
+`useGKReportContext()` expõe `generate(request?)` e `exportCurrent('pdf' | 'xlsx')`.
+Uma geração captura definição, parâmetros, dados por fonte e `referenceAt` uma
+única vez. `onFetchData` continua sendo o adaptador legado de fonte única; para
+várias fontes use apenas `onFetchDataBySource`. `exportColumns` permanece aceito
+por compatibilidade, mas não compõe o novo XLSX. O catálogo disponível e o
+tradutor `translateExpressionToExcel` são exportados pelo pacote core.
+Esta integração não amplia o schema: a propriedade `source` existente identifica
+as tabelas e gráficos por fonte.
+
+## Testes
+
+Os testes de integração deste pacote verificam se os relatórios são renderizados corretamente em um ambiente JSDOM, validando inclusive o motor de expressões em tempo real.
+
+```bash
+pnpm exec vitest run src/viewer-export.test.tsx
+```

package/dist/index.css

@@ -0,0 +1,2 @@
+.gk-page-wrapper{background-color:#0000;justify-content:center;display:flex}.gk-page-canvas{box-sizing:border-box;-webkit-user-select:none;user-select:none;flex-direction:column;transition:transform .2s;display:flex;position:relative;overflow:hidden;background-color:#fff!important}.gk-page-body-container{flex:1;width:100%}.gk-page-header-container,.gk-page-footer-container{width:100%}@media screen{.print-only{display:none!important}}@media print{@page{margin:0!important}.gk-page-wrapper{background-color:#fff!important;margin:0!important;padding:0!important;display:block!important}.gk-page-wrapper:not(:last-of-type){page-break-after:always!important;break-after:page!important}.gk-page-wrapper:last-of-type{page-break-after:auto!important;break-after:auto!important}.gk-page-canvas{box-shadow:none!important;border:none!important;width:100vw!important;height:100vh!important;margin:0!important;overflow:visible!important}}.gk-page-canvas.is-thumbnail{cursor:pointer;box-shadow:0 1px 4px #0003!important}.gk-page-canvas.is-thumbnail:hover{box-shadow:0 4px 12px #0000004d!important}
+/*$vite$:1*/

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './packages/viewer/src/index.js'
+export {}