@fayz-ai/plugin-reports 0.9.0 → 0.10.0

package/src/hooks/useReportData.ts

@@ -1,123 +0,0 @@
-import { useState, useCallback, useRef } from 'react'
-import type { ReportDef, ReportQueryState, ReportDateRange } from '../types'
-import type { ReportDataProvider, ReportResult } from '../data/types'
-import { dedup } from '@fayz-ai/saas'
-
-function defaultDateRange(): ReportDateRange {
-  const now = new Date()
-  const from = `${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, '0')}-01`
-  const to = `${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, '0')}-${String(now.getDate()).padStart(2, '0')}`
-  return { from, to }
-}
-
-function buildDefaultFilters(report: ReportDef): Record<string, any> {
-  const filters: Record<string, any> = {}
-  for (const f of report.filters ?? []) {
-    if (f.defaultValue !== undefined) filters[f.key] = f.defaultValue
-  }
-  return filters
-}
-
-export interface UseReportDataReturn {
-  data: Record<string, any>[]
-  total: number
-  loading: boolean
-  generated: boolean
-  error: string | null
-  query: ReportQueryState
-  generate: () => void
-  setDateRange: (range: ReportDateRange) => void
-  setFilter: (key: string, value: any) => void
-  setSort: (sortBy: string) => void
-  setPage: (page: number) => void
-  setPageSize: (size: number) => void
-  setSearch: (search: string) => void
-}
-
-export function useReportData(
-  report: ReportDef,
-  provider: ReportDataProvider,
-  defaultPageSize: number = 50,
-): UseReportDataReturn {
-  const [query, setQuery] = useState<ReportQueryState>({
-    dateRange: defaultDateRange(),
-    filters: buildDefaultFilters(report),
-    sortBy: report.dataSource.defaultSort,
-    sortDir: report.dataSource.defaultSortDir ?? 'desc',
-    page: 1,
-    pageSize: defaultPageSize,
-  })
-
-  const [result, setResult] = useState<ReportResult>({ data: [], total: 0 })
-  const [loading, setLoading] = useState(false)
-  const [generated, setGenerated] = useState(false)
-  const [error, setError] = useState<string | null>(null)
-  const queryRef = useRef(query)
-  queryRef.current = query
-
-  const fetchData = useCallback(async (q: ReportQueryState) => {
-    setLoading(true)
-    setError(null)
-    try {
-      const res = await dedup(`report:${report.id}:${JSON.stringify(q)}`, () =>
-        provider.fetch(report, q),
-      )
-      setResult(res)
-      setGenerated(true)
-    } catch (err: any) {
-      setError(err?.message ?? 'Failed to load report')
-      setResult({ data: [], total: 0 })
-    } finally {
-      setLoading(false)
-    }
-  }, [report, provider])
-
-  const generate = useCallback(() => {
-    fetchData(queryRef.current)
-  }, [fetchData])
-
-  const setDateRange = useCallback((dateRange: ReportDateRange) => {
-    setQuery((q) => ({ ...q, dateRange, page: 1 }))
-  }, [])
-
-  const setFilter = useCallback((key: string, value: any) => {
-    setQuery((q) => ({ ...q, filters: { ...q.filters, [key]: value }, page: 1 }))
-  }, [])
-
-  const setSort = useCallback((sortBy: string) => {
-    setQuery((q) => ({
-      ...q,
-      sortBy,
-      sortDir: q.sortBy === sortBy && q.sortDir === 'asc' ? 'desc' : 'asc',
-      page: 1,
-    }))
-  }, [])
-
-  const setPage = useCallback((page: number) => {
-    setQuery((q) => ({ ...q, page }))
-  }, [])
-
-  const setPageSize = useCallback((pageSize: number) => {
-    setQuery((q) => ({ ...q, pageSize, page: 1 }))
-  }, [])
-
-  const setSearch = useCallback((search: string) => {
-    setQuery((q) => ({ ...q, search, page: 1 }))
-  }, [])
-
-  return {
-    data: result.data,
-    total: result.total,
-    loading,
-    generated,
-    error,
-    query,
-    generate,
-    setDateRange,
-    setFilter,
-    setSort,
-    setPage,
-    setPageSize,
-    setSearch,
-  }
-}

package/src/index.ts

@@ -1,142 +0,0 @@
-import React from 'react'
-import type { PluginManifest, PluginScope, VerticalId } from '@fayz-ai/core'
-import { createSafeDataProvider, registerTranslations } from '@fayz-ai/core'
-import { ReportsPage } from './ReportsPage'
-import type { ReportDataProvider } from './data/types'
-import { createSupabaseReportProvider } from './data/supabase'
-import { createMockReportProvider } from './data/mock'
-import { getReportsTenantId } from './lib/tenant'
-import { reportsLocales } from './locales'
-import type {
-  ReportsPluginOptions,
-  ReportsPluginLabels,
-  ResolvedReportsConfig,
-} from './types'
-
-// ---------------------------------------------------------------------------
-// Defaults
-// ---------------------------------------------------------------------------
-
-const DEFAULT_LABELS: ReportsPluginLabels = {
-  pageTitle: 'Reports',
-  pageSubtitle: 'Access complete reports for analysis and decision making',
-  allReports: 'All Reports',
-  dateRange: 'Date Range',
-  from: 'From',
-  to: 'To',
-  export: 'Export',
-  exportCsv: 'Export CSV',
-  exportExcel: 'Export Excel',
-  exportPdf: 'Export PDF',
-  noResults: 'No results found.',
-  backToReports: 'Back',
-  reports: 'reports',
-  search: 'Search reports...',
-  today: 'Today',
-  yesterday: 'Yesterday',
-  last7Days: 'Last 7 days',
-  thisMonth: 'This month',
-  lastMonth: 'Last month',
-  thisQuarter: 'This quarter',
-  custom: 'Custom',
-  generate: 'Generate',
-  print: 'Print',
-  filterFrom: 'From',
-  filterTo: 'To',
-  filterResults: 'Results',
-  emptyStateTitle: 'Ready to generate',
-  emptyStateDescription: 'Select a date range and filters, then click Generate to view the report.',
-  unavailableTitle: 'Coming soon',
-  unavailableDescription: 'This report is not available yet. It will be enabled in a future update.',
-}
-
-const DEFAULT_CURRENCY = { code: 'BRL', locale: 'pt-BR', symbol: 'R$' }
-
-// ---------------------------------------------------------------------------
-// Config resolver
-// ---------------------------------------------------------------------------
-
-function resolveConfig(options: ReportsPluginOptions): ResolvedReportsConfig {
-  return {
-    labels: { ...DEFAULT_LABELS, ...options.labels },
-    currency: { ...DEFAULT_CURRENCY, ...options.currency },
-    reports: options.reports,
-    defaultPageSize: options.defaultPageSize ?? 50,
-    showHeader: options.showHeader !== false,
-  }
-}
-
-// ---------------------------------------------------------------------------
-// Factory
-// ---------------------------------------------------------------------------
-
-export function createReportsPlugin(options: ReportsPluginOptions): PluginManifest {
-  const config = resolveConfig(options)
-  registerTranslations(reportsLocales)
-  const provider: ReportDataProvider = options.dataProvider ?? createSafeDataProvider(
-    () => createSupabaseReportProvider({ tenantId: () => getReportsTenantId() }),
-    () => createMockReportProvider(),
-  )
-
-  const PageComponent: React.FC<any> = () =>
-    React.createElement(ReportsPage, { config, provider })
-
-  return {
-    id: 'reports',
-    name: config.labels.pageTitle,
-    icon: 'BarChart3',
-    version: '1.0.0',
-    scope: options.scope ?? 'universal',
-    verticalId: options.verticalId,
-    defaultEnabled: true,
-    dependencies: [],
-    declaredFeatures: [
-      { id: 'reports', label: config.labels.pageTitle, group: config.labels.pageTitle },
-    ],
-    navigation: [
-      {
-        section: options.navSection ?? 'main',
-        position: options.navPosition ?? 9,
-        label: config.labels.pageTitle,
-        route: '/reports',
-        icon: 'BarChart3',
-        permission: { feature: 'reports', action: 'read' as const },
-      },
-    ],
-    routes: [
-      {
-        path: '/reports',
-        component: PageComponent,
-        permission: { feature: 'reports', action: 'read' as const },
-      },
-    ],
-    widgets: [],
-    registries: [],
-    locales: reportsLocales,
-  }
-}
-
-// ---------------------------------------------------------------------------
-// Re-exports
-// ---------------------------------------------------------------------------
-
-export type {
-  ReportDef,
-  ReportColumnDef,
-  ReportFilterDef,
-  ReportDateRange,
-  ReportQueryState,
-  ReportBadge,
-  ReportDataSource,
-  ReportGrain,
-  ReportAllowedAction,
-  ReportFilterOption,
-  ReportsPluginOptions,
-  ReportsPluginLabels,
-  ResolvedReportsConfig,
-} from './types'
-
-export type { ReportDataProvider, ReportResult } from './data/types'
-export { createSupabaseReportProvider } from './data/supabase'
-export type { SupabaseReportProviderConfig } from './data/supabase'
-export { createMockReportProvider } from './data/mock'

package/src/lib/columns.ts

@@ -1,130 +0,0 @@
-import React from 'react'
-import type { ColumnDef } from '@tanstack/react-table'
-import type { ReportColumnDef } from '../types'
-import { PersonLink } from '@fayz-ai/saas'
-import {
-  formatCurrency as formatCurrencyLocale,
-  formatDate as formatDateLocale,
-  formatDateTime as formatDateTimeLocale,
-} from '@fayz-ai/core'
-
-// ---------------------------------------------------------------------------
-// Formatters (mirrors fieldToColumn.tsx logic)
-// ---------------------------------------------------------------------------
-
-function formatCurrency(value: any, currency?: string): string {
-  const num = typeof value === 'number' ? value : parseFloat(value)
-  if (isNaN(num)) return '—'
-  return formatCurrencyLocale(num, currency)
-}
-
-function formatDate(value: any): string {
-  if (!value) return '—'
-  return formatDateLocale(value)
-}
-
-function formatDateTime(value: any): string {
-  if (!value) return '—'
-  return formatDateTimeLocale(value)
-}
-
-function formatNumber(value: any): string {
-  if (value == null) return '—'
-  return typeof value === 'number' ? value.toLocaleString() : String(value)
-}
-
-// ---------------------------------------------------------------------------
-// Plain-text formatter for exports
-// ---------------------------------------------------------------------------
-
-export function formatValuePlain(value: any, col: ReportColumnDef, currency?: string): string {
-  if (value == null || value === '') return ''
-  switch (col.type) {
-    case 'currency':
-      return formatCurrency(value, col.currency ?? currency)
-    case 'date':
-      return formatDate(value)
-    case 'datetime':
-      return formatDateTime(value)
-    case 'number':
-      return formatNumber(value)
-    case 'boolean':
-      return value ? 'Yes' : 'No'
-    default:
-      return String(value)
-  }
-}
-
-// ---------------------------------------------------------------------------
-// ReportColumnDef[] → TanStack ColumnDef[]
-// ---------------------------------------------------------------------------
-
-export function reportColumnsToTanstack(
-  columns: ReportColumnDef[],
-  currency?: string,
-): ColumnDef<Record<string, any>>[] {
-  return columns
-    .filter((c) => c.visible !== false)
-    .map((col): ColumnDef<Record<string, any>> => {
-      const sortable = col.sortable ?? ['text', 'number', 'currency', 'date', 'datetime', 'email'].includes(col.type)
-      const alignRight = col.align === 'right' || (!col.align && (col.type === 'currency' || col.type === 'number'))
-      const alignCenter = col.align === 'center'
-
-      return {
-        accessorKey: col.key,
-        header: col.label,
-        enableSorting: sortable,
-        cell: (ctx) => {
-          const value = ctx.getValue()
-          const row = ctx.row.original
-
-          if (col.renderCell) {
-            return col.renderCell(value, row)
-          }
-
-          if (value == null || value === '') {
-            return React.createElement('span', { className: 'text-muted-foreground' }, '—')
-          }
-
-          let content: React.ReactNode
-          switch (col.type) {
-            case 'person':
-              content = React.createElement(PersonLink, {
-                personId: col.idKey ? row[col.idKey] : null,
-                name: String(value),
-                size: 'sm',
-                className: 'text-xs',
-              })
-              break
-            case 'currency':
-              content = formatCurrency(value, col.currency ?? currency)
-              break
-            case 'date':
-              content = formatDate(value)
-              break
-            case 'datetime':
-              content = formatDateTime(value)
-              break
-            case 'boolean':
-              content = value
-                ? React.createElement('svg', { className: 'h-4 w-4 text-success', viewBox: '0 0 24 24', fill: 'none', stroke: 'currentColor', strokeWidth: '2' },
-                    React.createElement('polyline', { points: '20 6 9 17 4 12' }),
-                  )
-                : React.createElement('span', { className: 'text-muted-foreground' }, '—')
-              break
-            case 'number':
-              content = formatNumber(value)
-              break
-            default:
-              content = String(value)
-          }
-
-          const cls = alignRight ? 'text-right' : alignCenter ? 'text-center' : undefined
-          return cls
-            ? React.createElement('div', { className: cls }, content)
-            : React.createElement(React.Fragment, null, content)
-        },
-        meta: { align: alignRight ? 'right' : alignCenter ? 'center' : 'left' },
-      }
-    })
-}

package/src/lib/tenant.ts

@@ -1,3 +0,0 @@
-let t: string | undefined
-export function setReportsTenantId(id: string | undefined){ t = id }
-export function getReportsTenantId(): string | undefined { return t }

package/src/locales/en.ts

@@ -1,28 +0,0 @@
-export const en: Record<string, string> = {
-  'reports.pageTitle': 'Reports',
-  'reports.pageSubtitle': 'Access complete reports for analysis and decision making',
-  'reports.allReports': 'All Reports',
-  'reports.dateRange': 'Date Range',
-  'reports.from': 'From',
-  'reports.to': 'To',
-  'reports.export': 'Export',
-  'reports.exportCsv': 'Export CSV',
-  'reports.exportExcel': 'Export Excel',
-  'reports.exportPdf': 'Export PDF',
-  'reports.noResults': 'No results found.',
-  'reports.backToReports': 'Back',
-  'reports.reports': 'reports',
-  'reports.search': 'Search reports...',
-  'reports.today': 'Today',
-  'reports.yesterday': 'Yesterday',
-  'reports.last7Days': 'Last 7 days',
-  'reports.thisMonth': 'This month',
-  'reports.lastMonth': 'Last month',
-  'reports.thisQuarter': 'This quarter',
-  'reports.custom': 'Custom',
-  'reports.generate': 'Generate',
-  'reports.emptyStateTitle': 'Ready to generate',
-  'reports.emptyStateDescription': 'Select a date range and filters, then click Generate to view the report.',
-  'reports.unavailableTitle': 'Coming soon',
-  'reports.unavailableDescription': 'This report is not available yet. It will be enabled in a future update.',
-}

package/src/locales/index.ts

@@ -1,7 +0,0 @@
-import { en } from './en'
-import { ptBR } from './pt-BR'
-
-export const reportsLocales: Record<string, Record<string, string>> = {
-  en,
-  'pt-BR': ptBR,
-}

package/src/locales/pt-BR.ts

@@ -1,28 +0,0 @@
-export const ptBR: Record<string, string> = {
-  'reports.pageTitle': 'Relatórios',
-  'reports.pageSubtitle': 'Acesse relatórios completos para análise e tomada de decisão',
-  'reports.allReports': 'Todos os Relatórios',
-  'reports.dateRange': 'Período',
-  'reports.from': 'De',
-  'reports.to': 'Até',
-  'reports.export': 'Exportar',
-  'reports.exportCsv': 'Exportar CSV',
-  'reports.exportExcel': 'Exportar Excel',
-  'reports.exportPdf': 'Exportar PDF',
-  'reports.noResults': 'Nenhum resultado encontrado.',
-  'reports.backToReports': 'Voltar',
-  'reports.reports': 'relatórios',
-  'reports.search': 'Buscar relatórios...',
-  'reports.today': 'Hoje',
-  'reports.yesterday': 'Ontem',
-  'reports.last7Days': 'Últimos 7 dias',
-  'reports.thisMonth': 'Este mês',
-  'reports.lastMonth': 'Mês passado',
-  'reports.thisQuarter': 'Este trimestre',
-  'reports.custom': 'Personalizado',
-  'reports.generate': 'Gerar',
-  'reports.emptyStateTitle': 'Pronto para gerar',
-  'reports.emptyStateDescription': 'Selecione o período e os filtros desejados, depois clique em Gerar para visualizar o relatório.',
-  'reports.unavailableTitle': 'Em breve',
-  'reports.unavailableDescription': 'Este relatório ainda não está disponível. Será habilitado em uma atualização futura.',
-}

package/src/types.ts

@@ -1,171 +0,0 @@
-import type React from 'react'
-import type { FieldType } from '@fayz-ai/core'
-
-// ---------------------------------------------------------------------------
-// Report column
-// ---------------------------------------------------------------------------
-
-export type ReportFieldType = FieldType | 'person'
-
-export interface ReportColumnDef {
-  key: string
-  label: string
-  type: ReportFieldType
-  sortable?: boolean
-  currency?: string
-  /** For type 'person': the row key containing the person UUID */
-  idKey?: string
-  renderCell?: (value: any, row: any) => React.ReactNode
-  /** Include in export but hide in table. Default: true */
-  visible?: boolean
-  /** Text alignment. Currency/number default to 'right' */
-  align?: 'left' | 'center' | 'right'
-  /** Aggregate for optional summary row */
-  aggregate?: 'sum' | 'avg' | 'count' | 'min' | 'max'
-}
-
-// ---------------------------------------------------------------------------
-// Report filter
-// ---------------------------------------------------------------------------
-
-export type ReportFilterOption = { label: string; value: string }
-
-export interface ReportFilterDef {
-  key: string
-  label: string
-  type: 'select' | 'multiselect' | 'text' | 'boolean' | 'number'
-  options?: ReportFilterOption[] | (() => Promise<ReportFilterOption[]>)
-  defaultValue?: any
-  placeholder?: string
-}
-
-// ---------------------------------------------------------------------------
-// Report definition
-// ---------------------------------------------------------------------------
-
-export type ReportBadge = 'popular' | 'essential' | 'new' | (string & {})
-
-export type ReportDataSourceKind = 'view' | 'rpc'
-
-export interface ReportDataSource {
-  kind: ReportDataSourceKind
-  /** View name (e.g. 'rep_appointments_by_period') or RPC function name */
-  name: string
-  /** Column for date range filtering. Default: 'created_at' */
-  dateColumn?: string
-  defaultSort?: string
-  defaultSortDir?: 'asc' | 'desc'
-  /** snake_case DB → camelCase JS column mapping */
-  columnMap?: Record<string, string>
-}
-
-export type ReportGrain = 'order' | 'order_item' | 'booking' | 'ledger_movement' | 'event'
-
-export type ReportAllowedAction = 'read'
-
-export interface ReportDef {
-  id: string
-  name: string
-  description?: string
-  icon: string
-  category: string
-  badge?: ReportBadge
-  columns: ReportColumnDef[]
-  filters?: ReportFilterDef[]
-  dataSource: ReportDataSource
-  /** Canonical read model/view used by the report. Defaults to dataSource.name. */
-  sourceView?: string
-  /** Business grain of each report row, used to prevent double counting. */
-  grain?: ReportGrain
-  /** Plugin that owns the report UI/definition. */
-  ownerPlugin?: string
-  /** Canonical data owner/spine for this report's facts. */
-  canonicalOwner?: string
-  /** Reports are normally read-only; explicit actions make that contract visible. */
-  allowedActions?: ReportAllowedAction[]
-  permission?: { feature: string; action: 'read' }
-  /** Show aggregate summary row */
-  showSummary?: boolean
-  /** Whether the backing view/RPC exists. Default: true */
-  available?: boolean
-}
-
-// ---------------------------------------------------------------------------
-// Query state
-// ---------------------------------------------------------------------------
-
-export interface ReportDateRange {
-  from: string // YYYY-MM-DD
-  to: string   // YYYY-MM-DD
-}
-
-export interface ReportQueryState {
-  dateRange: ReportDateRange
-  filters: Record<string, any>
-  sortBy?: string
-  sortDir?: 'asc' | 'desc'
-  page: number
-  pageSize: number
-  search?: string
-}
-
-// ---------------------------------------------------------------------------
-// Plugin options
-// ---------------------------------------------------------------------------
-
-export interface ReportsPluginLabels {
-  pageTitle: string
-  pageSubtitle: string
-  allReports: string
-  dateRange: string
-  from: string
-  to: string
-  export: string
-  exportCsv: string
-  exportExcel: string
-  exportPdf: string
-  noResults: string
-  backToReports: string
-  reports: string
-  search: string
-  today: string
-  yesterday: string
-  last7Days: string
-  thisMonth: string
-  lastMonth: string
-  thisQuarter: string
-  custom: string
-  generate: string
-  print: string
-  filterFrom: string
-  filterTo: string
-  filterResults: string
-  emptyStateTitle: string
-  emptyStateDescription: string
-  unavailableTitle: string
-  unavailableDescription: string
-}
-
-export interface ReportsPluginOptions {
-  reports: ReportDef[]
-  labels?: Partial<ReportsPluginLabels>
-  currency?: { code?: string; locale?: string; symbol?: string }
-  dataProvider?: import('./data/types').ReportDataProvider
-  navPosition?: number
-  navSection?: 'main' | 'secondary'
-  scope?: import('@fayz-ai/core').PluginScope
-  verticalId?: import('@fayz-ai/core').VerticalId
-  /** Default page size. Default: 50 */
-  defaultPageSize?: number
-  /** Render the in-content title/subtitle. Set false when the app shell owns the
-   *  page title (sidebar/GHL-style layouts). Default: true. */
-  showHeader?: boolean
-}
-
-export interface ResolvedReportsConfig {
-  labels: ReportsPluginLabels
-  currency: { code: string; locale: string; symbol: string }
-  reports: ReportDef[]
-  defaultPageSize: number
-  showHeader: boolean
-}