web / lib/types/import-wizard
lib/types/import-wizard
Canonical domain types for the import wizard.
All import wizard types are defined here as the single source of truth. Other modules (API routes, UI components, services) import from this file instead of defining their own copies.
Interfaces
FieldMappingSuggestion
A field mapping suggestion with confidence information
Properties
path
path:
string|null
confidence
confidence:
number
confidenceLevel
confidenceLevel:
ConfidenceLevel
SuggestedMappings
Suggested field mappings from auto-detection
Properties
language
language:
LanguageDetectionResult
mappings
mappings:
object
titlePath
titlePath:
FieldMappingSuggestion
descriptionPath
descriptionPath:
FieldMappingSuggestion
locationNamePath
locationNamePath:
FieldMappingSuggestion
timestampPath
timestampPath:
FieldMappingSuggestion
latitudePath
latitudePath:
FieldMappingSuggestion
longitudePath
longitudePath:
FieldMappingSuggestion
locationPath
locationPath:
FieldMappingSuggestion
SheetInfo
Information about a single sheet from a preview file
Properties
index
index:
number
name
name:
string
rowCount
rowCount:
number
headers
headers:
string[]
sampleData
sampleData:
Record<string,unknown>[]
suggestedMappings?
optionalsuggestedMappings:SuggestedMappings
AuthConfig
Auth configuration for imports (matches ScheduledImport authConfig structure)
Properties
type
type:
"none"|"api-key"|"bearer"|"basic"
apiKey?
optionalapiKey:string
apiKeyHeader?
optionalapiKeyHeader:string
bearerToken?
optionalbearerToken:string
username?
optionalusername:string
password?
optionalpassword:string
customHeaders?
optionalcustomHeaders:string|Record<string,string>
SheetMapping
Mapping of a file sheet to a dataset
Properties
sheetIndex
sheetIndex:
number
datasetId
datasetId:
number|"new"
newDatasetName
newDatasetName:
string
similarityScore?
optionalsimilarityScore:number|null
UI-only: similarity score for dataset matching (not sent to API)
FieldMapping
Mapping of file columns to event fields
Properties
sheetIndex
sheetIndex:
number
titleField
titleField:
string|null
descriptionField
descriptionField:
string|null
locationNameField
locationNameField:
string|null
dateField
dateField:
string|null
idField
idField:
string|null
idStrategy
idStrategy:
"external"|"computed"|"auto"|"hybrid"
locationField
locationField:
string|null
latitudeField
latitudeField:
string|null
longitudeField
longitudeField:
string|null
CreateScheduleConfig
Schedule creation configuration
Properties
enabled
enabled:
boolean
sourceUrl
sourceUrl:
string
name
name:
string
scheduleType
scheduleType:
"frequency"|"cron"
frequency?
optionalfrequency:"hourly"|"daily"|"weekly"|"monthly"
cronExpression?
optionalcronExpression:string
schemaMode
schemaMode:
"strict"|"additive"|"flexible"
authConfig?
optionalauthConfig:AuthConfig
ConfigureImportRequest
Full request body for the configure-import endpoint
Properties
previewId
previewId:
string
catalogId
catalogId:
number|"new"
newCatalogName?
optionalnewCatalogName:string
sheetMappings
sheetMappings:
SheetMapping[]
fieldMappings
fieldMappings:
FieldMapping[]
deduplicationStrategy
deduplicationStrategy:
"update"|"version"|"skip"
geocodingEnabled
geocodingEnabled:
boolean
createSchedule?
optionalcreateSchedule:CreateScheduleConfig
transforms?
optionaltransforms:object[]
sheetIndex
sheetIndex:
number
transforms
transforms:
ImportTransform[]
DatasetMappingEntry
Entry in the dataset mapping metadata for import jobs
Properties
sheetIdentifier
sheetIdentifier:
string
dataset
dataset:
number
skipIfMissing
skipIfMissing:
boolean
PreviewMetadata
Preview metadata persisted to disk during the wizard flow
Properties
previewId
previewId:
string
userId
userId:
number
originalName
originalName:
string
filePath
filePath:
string
mimeType
mimeType:
string
fileSize
fileSize:
number
createdAt
createdAt:
string
expiresAt
expiresAt:
string
sourceUrl?
optionalsourceUrl:string
authConfig?
optionalauthConfig:AuthConfig
Type Aliases
ConfidenceLevel
ConfidenceLevel =
"high"|"medium"|"low"|"none"
Confidence level for a field mapping suggestion
UrlAuthConfig
UrlAuthConfig =
Omit<AuthConfig,"customHeaders">
Narrowed auth config for URL imports (UI does not expose customHeaders)
References
ImportTransform
Re-exports ImportTransform
LanguageDetectionResult
Re-exports LanguageDetectionResult