web / lib/services/data-export-types
lib/services/data-export-types
Types for the data export service.
Defines interfaces for export summaries, results, and data structures used when exporting user data to a downloadable archive.
Interfaces
ExportSummary
Summary of data counts that will be exported.
Properties
catalogs
catalogs:
number
datasets
datasets:
number
events
events:
number
importFiles
importFiles:
number
importJobs
importJobs:
number
scheduledImports
scheduledImports:
number
mediaFiles
mediaFiles:
number
CreateExportResult
Result of initiating an export request.
Properties
success
success:
boolean
exportId
exportId:
number
summary
summary:
ExportSummary
ExecuteExportResult
Result of executing the export job.
Properties
success
success:
boolean
exportId
exportId:
number
filePath
filePath:
string
fileSize
fileSize:
number
recordCounts
recordCounts:
ExportSummary
UserExportData
User profile data for export (sanitized).
Properties
id
id:
number
email:
string
firstName?
optionalfirstName:string|null
lastName?
optionallastName:string|null
role?
optionalrole:string|null
trustLevel?
optionaltrustLevel:string|null
createdAt
createdAt:
string
lastLoginAt?
optionallastLoginAt:string|null
CatalogExportData
Catalog data for export.
Properties
id
id:
number
name
name:
string
description?
optionaldescription:unknown
slug?
optionalslug:string|null
isPublic
isPublic:
boolean
createdAt
createdAt:
string
updatedAt
updatedAt:
string
DatasetExportData
Dataset data for export.
Properties
id
id:
number
name
name:
string
description?
optionaldescription:unknown
slug?
optionalslug:string|null
isPublic
isPublic:
boolean
language?
optionallanguage:string|null
catalogId
catalogId:
number
schemaConfig?
optionalschemaConfig:unknown
createdAt
createdAt:
string
updatedAt
updatedAt:
string
EventExportData
Event data for export.
Properties
id
id:
number
datasetId
datasetId:
number
eventTimestamp?
optionaleventTimestamp:string|null
data
data:
unknown
location?
optionallocation:{ latitude?: number \| null; longitude?: number \| null; }|null
geocodingStatus?
optionalgeocodingStatus:string|null
validationStatus?
optionalvalidationStatus:string|null
createdAt
createdAt:
string
updatedAt
updatedAt:
string
ImportFileExportData
Import file metadata for export.
Properties
id
id:
number
originalName?
optionaloriginalName:string|null
mimeType?
optionalmimeType:string|null
filesize?
optionalfilesize:number|null
status?
optionalstatus:string|null
createdAt
createdAt:
string
ImportJobExportData
Import job data for export.
Properties
id
id:
number
importFileId
importFileId:
number
datasetId
datasetId:
number
stage?
optionalstage:string|null
progress?
optionalprogress:unknown
createdAt
createdAt:
string
updatedAt
updatedAt:
string
ScheduledImportExportData
Scheduled import configuration for export.
Properties
id
id:
number
name
name:
string
sourceUrl
sourceUrl:
string
enabled
enabled:
boolean
scheduleType?
optionalscheduleType:string|null
frequency?
optionalfrequency:string|null
cronExpression?
optionalcronExpression:string|null
lastRun?
optionallastRun:string|null
nextRun?
optionalnextRun:string|null
createdAt
createdAt:
string
updatedAt
updatedAt:
string
MediaExportData
Media file metadata for export.
Properties
id
id:
number
filename
filename:
string
mimeType?
optionalmimeType:string|null
filesize?
optionalfilesize:number|null
width?
optionalwidth:number|null
height?
optionalheight:number|null
alt?
optionalalt:string|null
createdAt
createdAt:
string
ExportData
Complete export data structure.
Properties
exportedAt
exportedAt:
string
version
version:
string
user
user:
UserExportData
catalogs
catalogs:
CatalogExportData[]
datasets
datasets:
DatasetExportData[]
events
events:
EventExportData[]
importFiles
importFiles:
ImportFileExportData[]
importJobs
importJobs:
ImportJobExportData[]
scheduledImports
scheduledImports:
ScheduledImportExportData[]
media
media:
MediaExportData[]
ExportManifest
Manifest file structure for the export ZIP.
Properties
exportedAt
exportedAt:
string
version
version:
string
userId
userId:
number
recordCounts
recordCounts:
ExportSummary
Type Aliases
DataExportStatus
DataExportStatus =
"pending"|"processing"|"ready"|"failed"|"expired"
Status of a data export request.