Composables

useExport

Composable principale per generare ed eseguire un export.

Panoramica

useExport gestisce la selezione campi, formato, filtri, ordinamento, applicazione di template salvati e l'esecuzione dell'export. Distingue tra export sincrono (Blob restituito direttamente) e asincrono (server risponde con 202 Accepted e exportId, segue polling). In entrambi i casi il file viene scaricato automaticamente con downloadBlob.

Internamente usa useExportTemplates per la gestione dei modelli e usePolling per il tracking degli export asincroni.

Inizializzazione

import { useExport } from '@pzeta/vue-importexport'

const {
  loading, errore,
  risorsa, campiDisponibili, campiSelezionati,
  formato, nomeFile, filtri, ordinamento,
  exportResult, exportProgresso, isPolling,
  templateManager,
  loadMetadata, applyTemplate,
  toggleField, selectAllFields, deselectAllFields, moveField,
  executeExport, cancelExport, reset,
} = useExport()

Parametri

Parametro	Tipo	Default	Descrizione
`apiOverride`	`ImportExportApi`	`useApi()`	Istanza API

Stato reattivo

Proprietà	Tipo	Descrizione
`loading`	`Ref<boolean>`	Operazione in corso
`errore`	`Ref<string \| null>`	Messaggio errore
`risorsa`	`Ref<string>`	Codice risorsa
`campiDisponibili`	`Ref<CampoMetadato[]>`	Campi esportabili (caricati da `loadMetadata`)
`campiSelezionati`	`Ref<string[]>`	Nomi campo nell'ordine scelto dall'utente
`formato`	`Ref<FileFormato>`	`xlsx` (default), `csv`, `json`
`nomeFile`	`Ref<string>`	Nome file output (opzionale, default `export_{risorsa}`)
`filtri`	`Ref<Record<string, unknown>>`	Filtri server-side
`ordinamento`	`Ref<Array<{ campo, direzione }>>`	Ordinamento (passa il primo elemento al backend)
`exportResult`	`Ref<ExportResult \| null>`	Risultato finale (sync o async)
`exportProgresso`	`Ref<ExportProgresso \| null>`	Progresso polling per async
`isPolling`	`Ref<boolean>`	Polling attivo
`templateManager`	oggetto	Restituito da `useExportTemplates`

Metodi

`loadMetadata(codiceRisorsa)`

Imposta risorsa.value, carica campiDisponibili da getExportFieldMetadata e i template della risorsa via templateManager.loadTemplates.

await loadMetadata('anagrafica')
// campiDisponibili.value popolato
// templateManager.templates.value popolato

Costruisce ExportRequest da stato corrente (campi, filtri, ordinamento, modelloId, nomeFile)
Se la risposta è un Blob → download immediato + exportResult settato a { tipo: 'sincrono', stato: 'completato' }
Se la risposta è asincrona (202):
- stato: 'in_corso' → parte polling
- urlDownload presente → download immediato
- stato: 'errore' → errore propagato

interface ExportRequest {
  risorsa: string
  formato: FileFormato
  campi: string[]
  filtri?: Record<string, unknown>
  ordinamento?: Array<{ campo: string; direzione: 'asc' | 'desc' }>
  nomeFile?: string
  modelloId?: string
}

Tipo `ExportResult`

Discriminated union su tipo:

type ExportResult =
  | {
      tipo: 'sincrono'
      stato: 'completato'
      nomeFile: string
    }
  | {
      tipo: 'asincrono'
      exportId: string
      stato: 'completato' | 'in_corso' | 'errore'
      nomeFile?: string
      dimensione?: number
      righeEsportate?: number
      urlDownload?: string
      tempoEsecuzione?: number
    }

Type guard disponibile:

import { isAsyncExportResult } from '@pzeta/vue-importexport'

if (isAsyncExportResult(result)) {
  console.log('Export asincrono:', result.exportId)
}

Esempio

const exporter = useExport()

await exporter.loadMetadata('anagrafica')
exporter.selectAllFields()
exporter.formato.value = 'xlsx'
exporter.filtri.value = { attivo: true }
exporter.ordinamento.value = [{ campo: 'cognome', direzione: 'asc' }]

await exporter.executeExport()
// Sincrono: file scaricato, exportResult.value.stato = 'completato'
// Async: polling parte, exportProgresso.value si aggiorna

useImportStatus, useImportHistory, useExportTemplates

Polling import asincrono, storico importazioni e gestione template di export.

useFieldMapping

Stato del mapping colonne sorgente → campi destinazione con auto-suggest.

useExport

Panoramica

Inizializzazione

Parametri

Stato reattivo

Metodi

`loadMetadata(codiceRisorsa)`

`applyTemplate()`

`toggleField(campo)`, `selectAllFields()`, `deselectAllFields()`, `moveField(from, to)`

`executeExport()`

`cancelExport()`

`reset()`

Tipo `ExportRequest`

Tipo `ExportResult`

Esempio