@aintela/bi 0.2.0

package/dist/viewer/ScriptDashboardViewer.d.ts

@@ -0,0 +1,82 @@
+import { default as React } from 'react';
+import { Layout, LayoutItem } from 'react-grid-layout';
+import { SvgIconComponent } from '@mui/icons-material';
+import { BiClient } from '../client';
+import { Dashboard, CardSpecificType } from './models';
+import { DashboardWaitingOptions } from './useDashboardBundle';
+export type { DashboardWaitingOptions };
+export interface ScriptDashboardExportArgs {
+    dashboard: Dashboard;
+    /** Current filter values, as the cards see them. */
+    parameters: Record<string, string | string[]>;
+    datasetOverride?: string;
+}
+export interface ScriptDashboardHeaderRenderArgs {
+    name?: string;
+    iconName?: string;
+    /** Already-built filter elements ready to drop into the host's chrome. */
+    filters: React.ReactNode | null;
+    hasFilters: boolean;
+    /** Trigger the host's PDF export (`onExportPdf`), or `undefined` when none was given. */
+    onExportPdf?: () => void;
+    /** Open the host's schedule UI (`onSchedule`), or `undefined`. */
+    onSchedule?: () => void;
+    /** Navigate to the host's editor (`onEdit`), or `undefined`. */
+    onEdit?: () => void;
+    exporting: boolean;
+    readonly: boolean;
+    canEdit: boolean;
+    canSchedule: boolean;
+    dashboard: Dashboard | null;
+    /** The host's dataset control (`datasetOverrideControl` prop), `null` unless admin + parameterised. */
+    datasetOverrideControl: React.ReactNode | null;
+}
+export interface ScriptDashboardViewerProps {
+    /** Defaults to the ambient `BiClientProvider`. */
+    client?: BiClient;
+    dashboardId?: string;
+    parameters?: Record<string, string | string[]>;
+    height?: number | string;
+    dragLocked?: boolean;
+    /** Provide the dashboard document directly instead of fetching it. */
+    dashboard?: Dashboard;
+    /** When true, layout items are resizable and `onLayoutCommit` receives user edits. */
+    editable?: boolean;
+    /** Render the classic title row + buttons + filters bar instead of the compact filters-only bar. */
+    useClassicHeader?: boolean;
+    onDashloadLoaded?: (dashboard: Dashboard) => void;
+    onFiltersChanged?: (filters: Record<string, unknown>) => void;
+    /** Replace the built-in header with a host-rendered bar. Receives the built filters + handlers. */
+    headerRender?: (args: ScriptDashboardHeaderRenderArgs) => React.ReactNode;
+    /** Show the "waiting for generation" overlay and poll the sub-agent. */
+    dashboardWaiting?: DashboardWaitingOptions;
+    /** Data-refresh tick → cards refetch with `noCache`. Does NOT re-instantiate the bundle. */
+    llmRenderCount?: number;
+    /** Bundle re-instantiation trigger — bump only on real code (re)generation. */
+    codeGeneration?: number;
+    /** Print / read-only preview (was the `?printPreview=true` URL flag). */
+    isPrintPreview?: boolean;
+    /** Export the dashboard (e.g. call your PDF endpoint). The viewer tracks the `exporting` state around it. */
+    onExportPdf?: (args: ScriptDashboardExportArgs) => Promise<void> | void;
+    /** Open your scheduling UI. */
+    onSchedule?: () => void;
+    scheduleLabel?: string;
+    /** Navigate to your editor. */
+    onEdit?: () => void;
+    /** User finished a resize / drag (never fired on prop syncs). */
+    onLayoutCommit?: (layout: Layout, oldItem: LayoutItem, newItem: LayoutItem) => void;
+    /** Admin-only runtime dataset override threaded into every data fetch. */
+    datasetOverride?: string;
+    /** Whether the viewer is shown to an admin (gates `datasetOverrideControl`). */
+    isAdmin?: boolean;
+    /** A ready-to-render dataset picker the host owns; shown when `isAdmin` and the dashboard is parameterised. */
+    datasetOverrideControl?: React.ReactNode;
+    /** Icon for a card's header, by its specific type. Default: no icon. */
+    resolveCardIcon?: (specificType: CardSpecificType) => string | SvgIconComponent | undefined;
+    /** Series palette for every chart in this dashboard (defaults to `theme.palette.bi.series`). */
+    chartPalette?: readonly string[];
+    /** Show the floating zoom slider (default true outside print preview). */
+    showZoomControl?: boolean;
+}
+export declare const ScriptDashboardViewer: React.FC<ScriptDashboardViewerProps>;
+export default ScriptDashboardViewer;

package/dist/viewer/ScriptDashboardViewerVertical.d.ts

@@ -0,0 +1,24 @@
+import { default as React } from 'react';
+import { SvgIconComponent } from '@mui/icons-material';
+import { BiClient } from '../client';
+import { Dashboard, CardSpecificType } from './models';
+import { DashboardWaitingOptions } from './useDashboardBundle';
+export interface ScriptDashboardViewerVerticalProps {
+    client?: BiClient;
+    dashboardId?: string;
+    parameters?: Record<string, string | string[]>;
+    height?: number | string;
+    dashboard?: Dashboard;
+    onDashloadLoaded?: (dashboard: Dashboard) => void;
+    onFiltersChanged?: (filters: Record<string, unknown>) => void;
+    dashboardWaiting?: DashboardWaitingOptions;
+    /** Data-refresh tick → `refreshTick` (cards refetch). Does NOT re-instantiate the bundle. */
+    llmRenderCount?: number;
+    /** Bundle re-instantiation trigger — bump only on real code (re)generation. */
+    codeGeneration?: number;
+    isPrintPreview?: boolean;
+    datasetOverride?: string;
+    resolveCardIcon?: (specificType: CardSpecificType) => string | SvgIconComponent | undefined;
+}
+export declare const ScriptDashboardViewerVertical: React.FC<ScriptDashboardViewerVerticalProps>;
+export default ScriptDashboardViewerVertical;

package/dist/viewer/cardMetadata.d.ts

@@ -0,0 +1,15 @@
+import { GridCardColor } from '../grid/GridCard';
+import { DashboardCardDefinition } from '../runtime/IDashboardDefinition';
+import { CardCategory, CardSpecificType, Dashboard } from './models';
+/** Card category → GridCard accent variant. */
+export declare const CATEGORY_PREFIXES: Record<CardCategory, GridCardColor>;
+/**
+ * Per-card metadata: the sketch (`dashboard.cards[i]`) overrides the bundle's
+ * hardcoded title / specificType / category; the bundle's values are the
+ * fallback.
+ */
+export declare function resolveCardMetadata(card: DashboardCardDefinition, dashboard: Dashboard | undefined): {
+    title: string | undefined;
+    specificType: CardSpecificType | undefined;
+    category: CardCategory | undefined;
+};

package/dist/viewer/index.d.ts

@@ -0,0 +1,8 @@
+export { useDashboardBundle } from './useDashboardBundle';
+export type { UseDashboardBundleOptions, DashboardBundleResult as UseDashboardBundleResult, DashboardBundleSnackbarState, DashboardWaitingOptions } from './useDashboardBundle';
+export { ScriptDashboardViewer } from './ScriptDashboardViewer';
+export type { ScriptDashboardViewerProps, ScriptDashboardHeaderRenderArgs, ScriptDashboardExportArgs } from './ScriptDashboardViewer';
+export { ScriptDashboardViewerVertical } from './ScriptDashboardViewerVertical';
+export type { ScriptDashboardViewerVerticalProps } from './ScriptDashboardViewerVertical';
+export { CATEGORY_PREFIXES, resolveCardMetadata } from './cardMetadata';
+export type { Dashboard, SketchCardItem, CardCategory, CardSpecificType, VizFilterComponent, VizAutoCompleteComponent, VizDateRangePickerComponent, VizBaseComponent } from './models';

package/dist/viewer/models.d.ts

@@ -0,0 +1,67 @@
+import { LayoutItem, ResponsiveLayouts } from 'react-grid-layout';
+import { TodoItem } from '@aintela/chat/models';
+import { GridConfig } from '../grid/gridModels';
+import { SketchedFilter } from '../filters/filterFactory';
+export type CardCategory = 'Generic' | 'Métrica' | 'Tabela' | 'Gráfico' | 'Mapa' | 'Árvore' | 'Medidor';
+export type CardSpecificType = 'Generic' | 'MetricComparison' | 'TableAuto' | 'TableBars' | 'TableHeatmap' | 'TableLarge' | 'ChartAuto' | 'ChartLine' | 'ChartBarH' | 'ChartBarV' | 'ChartArea' | 'ChartStackedArea' | 'ChartStackedBar' | 'ChartCombo' | 'ChartPie' | 'ChartDonut' | 'Scatter' | 'MapBubbles' | 'MapConnections' | 'Treemap' | 'Gauge';
+/** A card on the dashboard sketch: its grid item plus authoring metadata. */
+export interface SketchCardItem extends LayoutItem {
+    name?: string;
+    todoItem?: TodoItem;
+    muiIconName?: string;
+    color?: string;
+    turnOpen?: boolean;
+    actionDescription?: string;
+    category?: CardCategory;
+    specificType?: CardSpecificType;
+}
+/** Base filter component with `$type` discriminator. */
+export interface VizBaseComponent {
+    name: string;
+    parameter_name: string;
+    $type: string;
+}
+export interface VizAutoCompleteComponent extends VizBaseComponent {
+    $type: 'VizAutoComplete';
+    name: 'VizAutoComplete';
+    multipleSelection: boolean;
+    valueFieldName: string;
+    queryHash?: string | null;
+    displayFieldName?: string | null;
+}
+export interface VizDateRangePickerComponent extends VizBaseComponent {
+    $type: 'VizDateRangePicker';
+    name: 'VizDateRangePicker';
+    initialStartValue: string;
+    initialEndValue: string;
+    parameterStartDateName: string;
+    parameterEndDateName: string;
+}
+export type VizFilterComponent = VizAutoCompleteComponent | VizDateRangePickerComponent;
+export interface Dashboard {
+    id?: string;
+    name: string;
+    remarks?: string;
+    userPrompt?: string;
+    layoutType?: 'Naked' | 'Boxed';
+    /** Session whose workspace holds the compiled bundle. */
+    originalSessionId?: string | null;
+    jsFileName?: string;
+    clientId?: string;
+    muiIconName?: string;
+    grid_definition?: GridConfig | null;
+    dashboardFolderId?: string;
+    updated_grid_definition?: ResponsiveLayouts;
+    filter_components?: VizFilterComponent[];
+    cards?: SketchCardItem[];
+    filters?: SketchedFilter[];
+    updatedAt?: Date | null;
+    created?: Date | null;
+    description?: string | null;
+    userId?: string | null;
+    accountId?: string | null;
+    pinned?: boolean;
+    /** Authored against a template dataset; every query uses `{{DATASET}}`. */
+    isDatasetParameterized?: boolean;
+    defaultDatasetName?: string;
+}

package/dist/viewer/useDashboardBundle.d.ts

@@ -0,0 +1,73 @@
+import { MutableRefObject, ReactNode, Dispatch, SetStateAction } from 'react';
+import { LayoutItem } from 'react-grid-layout';
+import { SubAgentDto } from '@aintela/chat/models';
+import { BiClient } from '../client';
+import { DashboardCardDefinition } from '../runtime/IDashboardDefinition';
+import { Dashboard } from './models';
+export interface DashboardWaitingOptions {
+    /** Id of the SubAgent currently generating this dashboard. */
+    subAgentId: string;
+    /**
+     * Chat session the sub-agent runs in. Falls back to
+     * `dashboard.originalSessionId` (undefined while the dashboard is still
+     * being generated — pass it explicitly for the waiting case).
+     */
+    sessionId?: string;
+    /** Polling interval in ms while the sub-agent is running. Minimum / default 10000. */
+    pollIntervalMs?: number;
+}
+export interface UseDashboardBundleOptions {
+    /** Defaults to the ambient `BiClientProvider`. */
+    client?: BiClient;
+    dashboardId?: string;
+    parameters?: Record<string, string | string[]>;
+    dashboard?: Dashboard;
+    dashboardWaiting?: DashboardWaitingOptions;
+    /**
+     * Re-instantiation trigger: bump ONLY when the bundle CODE is (re)generated,
+     * loaded or explicitly refreshed. Not for per-edit layout commits — the
+     * agent-emitted JS only changes on a rebuild, and the server derives the
+     * filename from the dashboard NAME so `jsFileName` cannot signal one.
+     */
+    codeGeneration?: number;
+    onDashloadLoaded?: (dashboard: Dashboard) => void;
+    onFiltersChanged?: (filters: Record<string, unknown>) => void;
+    /** Keep `isResizable` on layout items (read-only viewers leave it false). */
+    editable?: boolean;
+    /** Print / read-only preview (was the `?printPreview=true` URL flag). */
+    isPrintPreview?: boolean;
+}
+export interface DashboardBundleSnackbarState {
+    open: boolean;
+    message: string;
+    severity: 'success' | 'error';
+}
+export interface DashboardBundleResult {
+    dashboard: Dashboard | undefined;
+    cards: DashboardCardDefinition[] | null;
+    style: ReactNode | null;
+    loading: boolean;
+    error: string | null;
+    setError: (e: string | null) => void;
+    filters: ReactNode;
+    filterOptions: {
+        onChange: (key: string, value: string | string[]) => void;
+        parameters: Record<string, string | string[]>;
+        readonly: boolean;
+    };
+    stateParameters: Record<string, string | string[]>;
+    handleParameterChange: (key: string, value: string | string[]) => void;
+    containerRef: MutableRefObject<HTMLDivElement | null>;
+    containerWidth: number;
+    rawLayoutDefinition: LayoutItem[] | undefined;
+    layoutDefinition: LayoutItem[] | undefined;
+    effectiveDashboardId: string | undefined;
+    isPrintPreview: boolean;
+    snackbar: DashboardBundleSnackbarState;
+    setSnackbar: Dispatch<SetStateAction<DashboardBundleSnackbarState>>;
+    subAgentStatus: SubAgentDto | null;
+    isSubAgentTracked: boolean;
+    subAgentDone: boolean;
+    subAgentFailed: boolean;
+}
+export declare function useDashboardBundle(options: UseDashboardBundleOptions): DashboardBundleResult;

package/dist/viewer.d.ts

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

package/dist/viewer.js

@@ -0,0 +1,9 @@
+import { b as e, K as s, L as d, ar as o, aL as t } from "./index-C6JQ6770.js";
+export {
+  e as CATEGORY_PREFIXES,
+  s as ScriptDashboardViewer,
+  d as ScriptDashboardViewerVertical,
+  o as resolveCardMetadata,
+  t as useDashboardBundle
+};
+//# sourceMappingURL=viewer.js.map

package/dist/viewer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewer.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/package.json

@@ -0,0 +1,196 @@
+{
+  "name": "@aintela/bi",
+  "version": "0.2.0",
+  "description": "BI visualisation components, dashboard grid, hooks, the dashboard composer (sketch pad + authoring view) and the LLM runtime registry for the AIA platform (extracted from Envision's dashboard app).",
+  "type": "module",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./data": {
+      "types": "./dist/data.d.ts",
+      "import": "./dist/data.js"
+    },
+    "./inline": {
+      "types": "./dist/inline.d.ts",
+      "import": "./dist/inline.js"
+    },
+    "./cards": {
+      "types": "./dist/cards.d.ts",
+      "import": "./dist/cards.js"
+    },
+    "./grid": {
+      "types": "./dist/grid.d.ts",
+      "import": "./dist/grid.js"
+    },
+    "./runtime": {
+      "types": "./dist/runtime.d.ts",
+      "import": "./dist/runtime.js"
+    },
+    "./hooks": {
+      "types": "./dist/hooks.d.ts",
+      "import": "./dist/hooks.js"
+    },
+    "./filters": {
+      "types": "./dist/filters.d.ts",
+      "import": "./dist/filters.js"
+    },
+    "./viewer": {
+      "types": "./dist/viewer.d.ts",
+      "import": "./dist/viewer.js"
+    },
+    "./theme": {
+      "types": "./dist/theme.d.ts",
+      "import": "./dist/theme.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js"
+    },
+    "./composer": {
+      "types": "./dist/composer.d.ts",
+      "import": "./dist/composer.js"
+    },
+    "./style": "./dist/style.css",
+    "./style.css": "./dist/style.css"
+  },
+  "typesVersions": {
+    "*": {
+      "data": [
+        "./dist/data.d.ts"
+      ],
+      "inline": [
+        "./dist/inline.d.ts"
+      ],
+      "cards": [
+        "./dist/cards.d.ts"
+      ],
+      "grid": [
+        "./dist/grid.d.ts"
+      ],
+      "runtime": [
+        "./dist/runtime.d.ts"
+      ],
+      "hooks": [
+        "./dist/hooks.d.ts"
+      ],
+      "filters": [
+        "./dist/filters.d.ts"
+      ],
+      "viewer": [
+        "./dist/viewer.d.ts"
+      ],
+      "theme": [
+        "./dist/theme.d.ts"
+      ],
+      "client": [
+        "./dist/client.d.ts"
+      ],
+      "composer": [
+        "./dist/composer.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint \"src/**/*.{ts,tsx}\" && stylelint \"src/**/*.css\"",
+    "prepack": "vite build"
+  },
+  "peerDependencies": {
+    "@aintela/chat": "^0.4.25",
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.0",
+    "@mui/icons-material": "^7.0.0",
+    "@mui/material": "^7.0.0",
+    "@mui/x-data-grid-pro": "^8.0.0",
+    "@mui/x-date-pickers": "^8.0.0",
+    "@mui/x-date-pickers-pro": "^8.0.0",
+    "dayjs": "^1.11.0",
+    "framer-motion": "^11.18.0 || ^12.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-grid-layout": "^2.2.0",
+    "react-simple-maps": "^3.0.0",
+    "recharts": "^2.15.0 || ^3.0.0",
+    "zustand": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@mui/x-date-pickers": {
+      "optional": true
+    },
+    "@mui/x-date-pickers-pro": {
+      "optional": true
+    },
+    "zustand": {
+      "optional": true
+    },
+    "framer-motion": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@aintela/chat": "0.4.25",
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.1",
+    "@eslint/js": "^9.39.0",
+    "@mui/icons-material": "^7.3.0",
+    "@mui/material": "^7.3.0",
+    "@mui/x-data-grid-pro": "^8.29.0",
+    "@mui/x-date-pickers": "^8.29.0",
+    "@mui/x-date-pickers-pro": "^8.29.0",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.0",
+    "@types/node": "^22.18.0",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "@types/react-simple-maps": "^3.0.6",
+    "@vitejs/plugin-react": "^4.5.2",
+    "axios": "^1.11.0",
+    "date-fns": "^4.1.0",
+    "dayjs": "^1.11.19",
+    "eslint": "^9.39.0",
+    "framer-motion": "^11.18.2",
+    "globals": "^16.2.0",
+    "happy-dom": "^20.11.0",
+    "lodash": "^4.17.21",
+    "notistack": "^3.0.2",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-grid-layout": "^2.2.2",
+    "react-markdown": "^10.1.0",
+    "react-router-dom": "^7.8.2",
+    "react-simple-maps": "^3.0.0",
+    "react-syntax-highlighter": "^16.1.0",
+    "recharts": "^2.15.4",
+    "reflect-metadata": "^0.2.2",
+    "rehype-raw": "^7.0.0",
+    "remark-gfm": "^4.0.1",
+    "stylelint": "^16.26.0",
+    "typedjson": "^1.8.0",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.34.1",
+    "use-debounce": "^10.0.5",
+    "vite": "^6.3.5",
+    "vite-plugin-dts": "^4.5.0",
+    "vitest": "^3.2.4",
+    "zustand": "^5.0.8"
+  }
+}