---
title: "adonia-import-export API"
image: "https://adonia.pages.dev/og.png"
version: "next"
---

> Documentation Index
> Fetch the complete documentation index at: https://adonia.pages.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# adonia-import-export API

<!-- Generated by docs/site/scripts/generate_api.ts. Do not edit. -->

Canonical inventory of every public subpath and TypeScript export in `adonia-import-export`.

## `adonia-import-export`

| Export | Kind | Source | Summary |
| --- | --- | --- | --- |
| `ADONIA_IMPORT_EXPORT_CONTROLLER_BINDING` | constant | `packages/import-export/src/index.ts:92` | Container binding for the host's authenticated HTTP controller adapter. |
| `ADONIA_IMPORT_EXPORT_WORKER_BINDING` | constant | `packages/import-export/src/index.ts:94` | Container binding for the host-configured queued transfer runtime. |
| `ColumnMapping` | type-only interface | `packages/import-export/src/mapping.ts:40` | Explicit source-heading to descriptor-key mapping selected by a user. |
| `columnMappingDescriptor` | function | `packages/import-export/src/index.ts:44` | Builds the protocol-v1 field node consumed by the client mapping workflow. |
| `ColumnValidationFailure` | type-only interface | `packages/import-export/src/mapping.ts:7` | A value validation failure returned by a column validator. |
| `createExportAction` | function | `packages/import-export/src/actions.ts:164` | Creates a row/bulk action that queues one export for the authorized records resolved by Adonia. Identity and column allowlists are supplied by the host; client form state may choose only an allowed format, filename, and columns. |
| `createImportAction` | function | `packages/import-export/src/actions.ts:130` | Creates a page action that confirms an already uploaded import source. |
| `CsvExportOptions` | type-only interface | `packages/import-export/src/csv.ts:32` | CSV export limits and cancellation. |
| `CsvImportOptions` | type-only interface | `packages/import-export/src/csv.ts:14` | CSV import limits and cancellation. |
| `CsvSource` | type-only type | `packages/import-export/src/csv.ts:11` | Binary/text chunks accepted by the CSV importer. |
| `defineTransferColumns` | function | `packages/import-export/src/mapping.ts:103` | Defines a duplicate-safe explicit descriptor allowlist. |
| `DriveArtifactStore` | class | `packages/import-export/src/storage.ts:360` | S3-capable artifact storage backed by an `@adonisjs/drive` disk. |
| `DriveSourceStore` | class | `packages/import-export/src/storage.ts:566` | S3-capable private import source store backed by Drive plus durable metadata. |
| `DriveTransferDisk` | type-only interface | `packages/import-export/src/storage.ts:306` | Streaming subset of an `@adonisjs/drive` disk used by transfer stores. |
| `ExportActionOptions` | type-only interface | `packages/import-export/src/actions.ts:45` | Configuration for `createExportAction`. |
| `ExportArtifact` | type-only interface | `packages/import-export/src/storage.ts:88` | Open bounded-memory artifact target. |
| `ExportArtifactStore` | type-only interface | `packages/import-export/src/storage.ts:98` | Artifact storage and time-limited opaque download boundary. |
| `ExportCancelEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:48` | Owned lookup accepted by an export cancellation endpoint. |
| `ExportColumnResolver` | type-only type | `packages/import-export/src/queue.ts:82` | Resolves the server-owned descriptor allowlist for a resource slug. |
| `ExportCompression` | type-only type | `packages/import-export/src/storage.ts:38` | Optional export artifact encoding. |
| `exportCsv` | function | `packages/import-export/src/csv.ts:250` | Streams CSV chunks without retaining earlier rows in memory. |
| `ExportDownloadEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:54` | Owned lookup accepted before redirecting to an export's signed download URL. |
| `ExportFormat` | type-only type | `packages/import-export/src/storage.ts:35` | Supported transfer formats. |
| `exportInline` | function | `packages/import-export/src/inline.ts:30` | Runs an export inline only after the application explicitly allows it and supplies a count within its small-job threshold. Larger jobs must use queue. |
| `ExportJobOwner` | type-only interface | `packages/import-export/src/storage.ts:41` | Authorization scope persisted with a queued export. |
| `ExportJobRepository` | type-only interface | `packages/import-export/src/storage.ts:76` | Persistence boundary used by web and worker processes. |
| `ExportJobStatus` | type-only interface | `packages/import-export/src/storage.ts:51` | Durable queued-export state exposed to a progress endpoint. |
| `ExportPreset` | type-only interface | `packages/import-export/src/storage.ts:943` | Named reusable export column and filter selection. |
| `ExportPresetDeleteEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:104` | Owned export preset deletion request. |
| `ExportPresetListEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:81` | Scope-bound export preset listing request. |
| `ExportPresetRepository` | type-only interface | `packages/import-export/src/storage.ts:955` | Persistence boundary for reusable export presets. |
| `ExportPresetRunEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:98` | Owned preset execution request using its persisted columns and filters. |
| `ExportPresetSaveEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:88` | Body accepted when creating or updating an owned export preset. |
| `ExportRegenerateEndpointRequest` | type-only type | `packages/import-export/src/endpoints.ts:60` | Owned lookup that issues a fresh signed link for an existing export artifact. |
| `ExportRowLoader` | type-only type | `packages/import-export/src/queue.ts:76` | Streams scoped rows for the serialized targets in a worker process. |
| `ExportStatusEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:42` | Owned lookup accepted by an export status endpoint. |
| `exportXlsx` | function | `packages/import-export/src/xlsx.ts:287` | Streams an XLSX workbook directly to a writable destination. |
| `FileExportArtifactStore` | class | `packages/import-export/src/storage.ts:203` | Local/private-volume artifact store with HMAC-signed opaque download URLs. |
| `FileExportJobRepository` | class | `packages/import-export/src/storage.ts:117` | JSON-file repository suitable for a shared persistent volume. |
| `FileExportPresetRepository` | class | `packages/import-export/src/storage.ts:963` | JSON-file export presets suitable for a shared persistent volume. |
| `FileImportJobRepository` | class | `packages/import-export/src/storage.ts:709` | JSON-file import history suitable for a shared persistent volume. |
| `FileImportSourceStore` | class | `packages/import-export/src/import.ts:137` | Private-volume source store that streams uploads without buffering them in memory. |
| `IMPORT_ACTION` | constant | `packages/import-export/src/import.ts:31` | Stable action name applications may expose from an authenticated import controller. |
| `IMPORT_EXPORT_ACTION` | constant | `packages/import-export/src/queue.ts:45` | Reserved action identity intercepted before the normal Adonia action worker. |
| `IMPORT_EXPORT_MIGRATIONS` | constant | `packages/import-export/src/index.ts:26` | Absolute directory containing import/export persistence migrations. |
| `IMPORT_EXPORT_VERSION` | constant | `packages/import-export/src/version.ts:2` | Package version generated from package.json; do not edit directly. |
| `ImportActionOptions` | type-only interface | `packages/import-export/src/actions.ts:32` | Configuration for `createImportAction`. |
| `ImportBatchWriter` | type-only type | `packages/import-export/src/import.ts:275` | Writes one validated, bounded create batch inside the application's transaction policy. |
| `ImportConfirmation` | type-only interface | `packages/import-export/src/import.ts:259` | Confirmed mapping and write semantics submitted by the client. |
| `ImportConfirmEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:36` | Body and authenticated scope accepted by an import confirmation endpoint. |
| `ImportConflictPolicy` | type-only type | `packages/import-export/src/import.ts:256` | Existing-row behavior for an upsert match. |
| `importCsv` | function | `packages/import-export/src/csv.ts:196` | Imports CSV rows through an already user-confirmed descriptor mapping. Only mapped allowlisted keys reach `sink`; unmapped cells are never copied. |
| `ImportEndpointAccess` | type-only type | `packages/import-export/src/endpoints.ts:27` | Import scope without the resource member persisted on source/job owners. |
| `ImportEndpointScope` | type-only interface | `packages/import-export/src/endpoints.ts:18` | Authenticated panel/resource scope that a host must bind to an opaque import source. |
| `ImportExportControllerContract` | type-only interface | `packages/import-export/src/endpoints.ts:116` | Framework-neutral HTTP controller boundary implemented by the host application. |
| `importExportDoctorCheck` | constant | `packages/import-export/src/index.ts:131` | Doctor check for the separate queue worker required by queued exports. |
| `importExportManifest` | constant | `packages/import-export/src/index.ts:246` | Installable package manifest. Routes resolve a host-owned authenticated controller, while reserved transfer actions resolve a host-owned worker runtime; attaching the manifest replaces manual route/worker routing. |
| `importExportPlugin` | function | `packages/import-export/src/index.ts:276` | Builds a manifest whose contributed routes match the supplied controller's capabilities. Without a controller, only the required binding-backed routes are contributed. |
| `ImportExportResourceClass` | type-only type | `packages/import-export/src/index.ts:31` | Resource class that opts into descriptor-owned import/export columns. |
| `ImportExportRouteContext` | type-only interface | `packages/import-export/src/index.ts:67` | Request context resolved by manifest-contributed import/export routes. |
| `ImportExportRouteController` | type-only interface | `packages/import-export/src/index.ts:75` | Host controller invoked by the manifest's guarded panel routes. |
| `ImportExportSqlClient` | type-only interface | `packages/import-export/src/storage.ts:456` | Structural client shared by Lucid's database service and transaction clients. |
| `ImportExportSqlQuery` | type-only interface | `packages/import-export/src/storage.ts:442` | Structural Lucid/Knex query builder used by the durable repositories. |
| `importExportWorkerHandler` | constant | `packages/import-export/src/index.ts:116` | Queue handler that resolves the host's transfer runtime inside the worker process. |
| `ImportFormat` | type-only type | `packages/import-export/src/import.ts:34` | Supported uploaded source formats. |
| `ImportHistoryEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:63` | Scope-bound import history listing request. |
| `ImportJobRepository` | type-only interface | `packages/import-export/src/storage.ts:697` | Persistence boundary shared by web and queued import worker processes. |
| `ImportJobStatus` | type-only interface | `packages/import-export/src/storage.ts:679` | Durable queued-import state and history entry. |
| `ImportMatchResolver` | type-only type | `packages/import-export/src/import.ts:289` | Resolves which candidate rows already exist without trusting client-supplied identifiers. |
| `ImportMode` | type-only type | `packages/import-export/src/import.ts:253` | Import persistence mode selected after mapping confirmation. |
| `ImportPreparation` | type-only interface | `packages/import-export/src/import.ts:242` | Mapping screen payload returned after bounded source upload and heading inspection. |
| `ImportPrepareEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:30` | Body and authenticated scope accepted by an import preparation/upload endpoint. |
| `ImportResult` | type-only interface | `packages/import-export/src/mapping.ts:75` | Result counts and bounded structured failures from an import. |
| `ImportRetryEndpointRequest` | type-only interface | `packages/import-export/src/endpoints.ts:70` | Owned import retry using a newly uploaded corrected failure source. |
| `ImportRowError` | type-only interface | `packages/import-export/src/mapping.ts:59` | Structured error for one rejected source row or cell. |
| `ImportRowSink` | type-only type | `packages/import-export/src/csv.ts:44` | Called once for every fully validated allowlisted import row. |
| `ImportScopeIdentity` | type-only interface | `packages/import-export/src/import.ts:37` | Authenticated identity that owns an uploaded source and every import derived from it. |
| `ImportService` | class | `packages/import-export/src/import.ts:369` | Authenticated controller-facing API for upload, preview, upsert, and bounded writes. |
| `ImportServiceOptions` | type-only interface | `packages/import-export/src/import.ts:305` | Runtime import orchestration options. |
| `ImportSourceMetadata` | type-only type | `packages/import-export/src/import.ts:63` | Metadata accepted when persisting one private import source. |
| `ImportSourceRecord` | type-only interface | `packages/import-export/src/import.ts:49` | Persisted opaque upload metadata, including its complete authorization scope. |
| `ImportSourceRecordStore` | type-only interface | `packages/import-export/src/storage.ts:504` | Metadata persistence boundary used by shared Drive import sources. |
| `ImportSourceStore` | type-only interface | `packages/import-export/src/import.ts:69` | Private source storage used between upload and mapping confirmation requests. |
| `ImportUploadRequest` | type-only interface | `packages/import-export/src/import.ts:232` | Upload request accepted by the import API. |
| `ImportUploadSource` | type-only type | `packages/import-export/src/import.ts:60` | Source bytes accepted by the upload API. |
| `ImportUpsertRow` | type-only interface | `packages/import-export/src/import.ts:282` | One create-or-update operation resolved against server-owned match columns. |
| `ImportUpsertWriter` | type-only type | `packages/import-export/src/import.ts:297` | Applies a bounded create-or-update batch inside the application's transaction policy. |
| `importXlsx` | function | `packages/import-export/src/xlsx.ts:196` | Streams bounded worksheets from an XLSX source and validates each row. ExcelJS's streaming reader discards committed rows, keeping memory bounded. |
| `InlineExportRequest` | type-only interface | `packages/import-export/src/inline.ts:12` | Small-job export request guarded by an explicit policy and known row count. |
| `inspectXlsxSource` | function | `packages/import-export/src/xlsx.ts:142` | Validates worksheet, row, column, and cell limits before import persistence. The source store is reopened for the actual streaming import. |
| `LucidExportPresetRepository` | class | `packages/import-export/src/storage.ts:1015` | Lucid-backed export preset repository. |
| `LucidImportJobRepository` | class | `packages/import-export/src/storage.ts:833` | Lucid-backed queued import repository and per-scope history. |
| `LucidSourceRecordStore` | class | `packages/import-export/src/storage.ts:512` | Lucid-backed source metadata store for horizontally scaled applications. |
| `PersistedImportConfirmation` | type-only interface | `packages/import-export/src/storage.ts:668` | Serializable confirmation subset retained by queued import history. |
| `QueuedExportAccess` | type-only type | `packages/import-export/src/queue.ts:73` | Authenticated scope required to read or cancel an export. |
| `QueuedExportIdentity` | type-only interface | `packages/import-export/src/queue.ts:48` | Stable authenticated identity placed in a queued export job. |
| `QueuedExportRequest` | type-only interface | `packages/import-export/src/queue.ts:59` | Request used to create a queued export. |
| `QueuedExportService` | class | `packages/import-export/src/queue.ts:337` | Web-process dispatcher, preset manager, and progress/cancellation facade. |
| `QueuedExportWorker` | class | `packages/import-export/src/queue.ts:145` | Production queued-export worker with cooperative cancellation and durable progress. |
| `QueuedExportWorkerOptions` | type-only interface | `packages/import-export/src/queue.ts:87` | Queued worker options. |
| `QueuedImportAccess` | type-only type | `packages/import-export/src/queue.ts:607` | Authenticated scope required to inspect, cancel, or retry an import. |
| `QueuedImportRequest` | type-only interface | `packages/import-export/src/queue.ts:599` | Request used to dispatch a scope-bound import through the action-job queue. |
| `QueuedImportService` | class | `packages/import-export/src/queue.ts:780` | Web-process queued import dispatcher and scope-bound history facade. |
| `QueuedImportServiceResolver` | type-only type | `packages/import-export/src/queue.ts:610` | Resolves the request-scoped import runtime reconstructed by a worker. |
| `QueuedImportWorker` | class | `packages/import-export/src/queue.ts:637` | Queued import worker with identity replay, durable progress, and idempotent claims. |
| `QueuedImportWorkerOptions` | type-only interface | `packages/import-export/src/queue.ts:616` | Background import worker options. |
| `readCsvHeaders` | function | `packages/import-export/src/csv.ts:174` | Reads only the first CSV row so a client can confirm an explicit mapping. |
| `readXlsxHeaders` | function | `packages/import-export/src/xlsx.ts:103` | Reads the first worksheet heading row for the explicit mapping screen. |
| `resolveColumnMapping` | function | `packages/import-export/src/mapping.ts:145` | Validates a user-confirmed mapping against source headings and the descriptor allowlist. |
| `ResolvedMapping` | type-only interface | `packages/import-export/src/mapping.ts:48` | Validated immutable mapping consumed by import adapters. |
| `routeImportExportWorker` | function | `packages/import-export/src/queue.ts:933` | Routes reserved transfer jobs while preserving the application's normal action worker. |
| `SaveExportPresetRequest` | type-only interface | `packages/import-export/src/queue.ts:329` | Request used to create or update one named export preset. |
| `suggestColumnMapping` | function | `packages/import-export/src/mapping.ts:121` | Returns case-insensitive mapping suggestions for review by the client. |
| `TransferActionPresentation` | type-only interface | `packages/import-export/src/actions.ts:20` | Common presentation overrides accepted by both action factories. |
| `TransferColumn` | type-only interface | `packages/import-export/src/mapping.ts:15` | One explicitly allowlisted import/export column. |
| `transferColumnsFor` | function | `packages/import-export/src/index.ts:37` | Reads and validates the allowlist declared by one resource. |
| `TransferValue` | type-only type | `packages/import-export/src/mapping.ts:4` | Scalar values accepted by import/export adapters. |
| `XlsxExportOptions` | type-only interface | `packages/import-export/src/xlsx.ts:35` | XLSX export limits and cancellation. |
| `XlsxImportOptions` | type-only interface | `packages/import-export/src/xlsx.ts:15` | XLSX import limits and cancellation. |
| `XlsxImportSink` | type-only type | `packages/import-export/src/xlsx.ts:46` | Called for each validated XLSX row. |
| `XlsxSourceInspection` | type-only interface | `packages/import-export/src/xlsx.ts:132` | Bounded preflight result used before any XLSX writer is invoked. |

## `adonia-import-export/client`

| Export | Kind | Source | Summary |
| --- | --- | --- | --- |
| `COLUMN_MAPPING_COMPONENT` | constant | `packages/import-export/src/client.tsx:16` | Registry type used by descriptor nodes that request the mapping workflow. |
| `ColumnMappingField` | function | `packages/import-export/src/client.tsx:48` | Accessible explicit heading-to-descriptor mapping editor. |
| `importExportUiPlugin` | constant | `packages/import-export/src/client.tsx:379` | Client half installed with `registry.use(importExportUiPlugin)`. |
| `ImportWorkflow` | function | `packages/import-export/src/client.tsx:119` | Complete accessible upload, preview, mapping, upsert, and result workflow. |
| `ImportWorkflowConfirmationOptions` | type-only interface | `packages/import-export/src/client.tsx:99` | Options submitted after explicit mapping confirmation. |
| `ImportWorkflowProps` | type-only interface | `packages/import-export/src/client.tsx:107` | Transport callbacks supplied by an authenticated application import controller. |

Source: https://adonia.pages.dev/reference/api/import-export/index.mdx