​

React SDK Common Types

Common TypeScript types used by the Prequel Import React SDK hooks and client helpers.

​

ImportApiError

ImportApiError = object

​

Properties

code

code: string

message

message: string

statusCode

statusCode: number

---

​

DefaultClientConfig

DefaultClientConfig = object

​

Properties

baseUrl?

optional baseUrl?: string

Prequel Import API base URL. Defaults to Prequel’s hosted API.

providerId

providerId: string

Provider ID the browser client should be scoped to.

fetchToken

fetchToken: FetchAuthToken

Returns a short-lived Import API scoped auth token for the current provider or source request.

appId?

optional appId?: string

Application identifier sent with the scoped auth token.

headers?

optional headers?: ClientHeadersProvider

Additional headers to send with every Import API request.

credentials?

optional credentials?: RequestCredentials

Fetch credentials mode for Import API requests.

---

​

ImportProviderProps

ImportProviderProps = object

​

Properties

client

client: ImportClient

routes?

optional routes?: ImportApiRouteOverrides

children

children: React.ReactNode

---

​

UseListDatasetsResult

UseListDatasetsResult = PaginatedImportQueryResult<DatasetResource>

---

​

UseDatasetResult

UseDatasetResult = ImportQueryResult<DatasetResource>

---

​

UseDatasetSchemaResult

UseDatasetSchemaResult = ImportQueryResultWithAlias<DatasetSchemaColumn[] | undefined, "schema">

---

​

UseRandomSampleDatasetResult

UseRandomSampleDatasetResult = ImportActionResult<[DatasetRandomSampleParams], DatasetRandomSampleResponse> & object

​

Type Declaration

randomSampleDataset

randomSampleDataset: (params: DatasetRandomSampleParams) => Promise<DatasetRandomSampleResponse>

Parameters

Returns

Promise<DatasetRandomSampleResponse>

sample

sample: DatasetRandomSampleResponse | undefined

isSampling

isSampling: boolean

---

​

UseCreateDatasetResult

UseCreateDatasetResult = ImportActionResult<[DatasetOptions], DatasetResource> & object

​

Type Declaration

createDataset

createDataset: (dataset: DatasetOptions) => Promise<DatasetResource>

Parameters

Returns

Promise<DatasetResource>

dataset

dataset: DatasetResource | undefined

isCreating

isCreating: boolean

---

​

UseListDestinationsResult

UseListDestinationsResult = PaginatedImportQueryResult<DestinationResource>

---

​

UseDestinationResult

UseDestinationResult = ImportQueryResult<DestinationResource | undefined>

---

​

UseListExtractsResult

UseListExtractsResult = PaginatedImportQueryResult<ExtractResource>

---

​

UseExtractDebugResult

UseExtractDebugResult = PaginatedImportQueryResult<ExtractDebugRecord>

---

​

UseExtractResult

UseExtractResult = ImportQueryResult<ExtractResource>

---

​

UseListLoadsResult

UseListLoadsResult = PaginatedImportQueryResult<LoadResource>

---

​

UseLoadResult

UseLoadResult = ImportQueryResult<LoadResource>

---

​

UseSourceFormOptions

UseSourceFormOptions = object

​

Properties

providerId

providerId: string

vendor

vendor: string

initialSource?

optional initialSource?: SourceFormSource

enabled?

optional enabled?: boolean

---

​

UseSourceFormFieldsOptions

UseSourceFormFieldsOptions = UseSourceFormOptions

---

​

UseSourceFormResult

UseSourceFormResult = object

​

Properties

source

source: SourceFormSource

draft

draft: SourceFormSource

fields

fields: SourceFormField[]

setSourceField

setSourceField: (fieldOrPath: SourceFormField | string, value: unknown) => void

Parameters

Returns

void

getSource

getSource: (overrides?: SourceFormSource) => SourceOptions

Parameters

Returns

SourceOptions

isLoading

isLoading: boolean

isRefetching

isRefetching: boolean

error

error: unknown

---

​

UseSourceFormFieldsResult

UseSourceFormFieldsResult = UseSourceFormResult

---

​

ListSourcesOptions

ListSourcesOptions = PaginatedImportQueryOptions & object

​

Type Declaration

providerId?

optional providerId?: string

---

​

UseListSourcesResult

UseListSourcesResult = PaginatedImportQueryResult<SourceResource>

---

​

UseSourceResult

UseSourceResult = ImportQueryResult<SourceResource>

---

​

UseSourceTablesResult

UseSourceTablesResult = ImportQueryResultWithAlias<SourceTable[] | undefined, "tables">

---

​

UseSourceSchemaResult

UseSourceSchemaResult = ImportQueryResultWithAlias<SourcePreviewSchemaField[] | undefined, "schema">

---

​

UsePreviewSourceRowsResult

UsePreviewSourceRowsResult = ImportActionResult<[string, SourcePreviewOptions], SourcePreviewResponse> & object

​

Type Declaration

previewSourceRows

previewSourceRows: (id: string, source: SourcePreviewOptions) => Promise<SourcePreviewResponse>

Parameters

Returns

Promise<SourcePreviewResponse>

preview

preview: SourcePreviewResponse | undefined

isPreviewing

isPreviewing: boolean

---

​

UseCreateSourceResult

UseCreateSourceResult = ImportActionResult<[SourceOptions], SourceResource> & object

​

Type Declaration

createSource

createSource: (source: SourceOptions) => Promise<SourceResource>

Parameters

Returns

Promise<SourceResource>

source

source: SourceResource | undefined

isCreating

isCreating: boolean

---

​

UseUpdateSourceResult

UseUpdateSourceResult = ImportActionResult<[string, UpdateSourceOptions], SourceResource> & object

​

Type Declaration

updateSource

updateSource: (id: string, source: UpdateSourceOptions) => Promise<SourceResource>

Parameters

Returns

Promise<SourceResource>

source

source: SourceResource | undefined

isUpdating

isUpdating: boolean

---

​

UseTestNewSourceResult

UseTestNewSourceResult = ImportActionResult<[SourceOptions], SourceConnectionTestResult> & object

​

Type Declaration

testNewSource

testNewSource: (source: SourceOptions) => Promise<SourceConnectionTestResult>

Parameters

Returns

Promise<SourceConnectionTestResult>

result

result: SourceConnectionTestResult | undefined

isTesting

isTesting: boolean

---

​

UseTestExistingSourceResult

UseTestExistingSourceResult = ImportActionResult<[string, UpdateSourceOptions | undefined], SourceConnectionTestResult> & object

​

Type Declaration

testExistingSource

testExistingSource: (id: string, source?: UpdateSourceOptions) => Promise<SourceConnectionTestResult>

Parameters

Returns

Promise<SourceConnectionTestResult>

result

result: SourceConnectionTestResult | undefined

isTesting

isTesting: boolean

---

​

UseListStreamsResult

UseListStreamsResult = PaginatedImportQueryResult<StreamResource>

---

​

UseStreamResult

UseStreamResult = ImportQueryResult<StreamResource>

---

​

UseCreateStreamResult

UseCreateStreamResult = ImportActionResult<[StreamOptions], StreamResource> & object

​

Type Declaration

createStream

createStream: (stream: StreamOptions) => Promise<StreamResource>

Parameters

Returns

Promise<StreamResource>

stream

stream: StreamResource | undefined

isCreating

isCreating: boolean

---

​

UseUpdateStreamResult

UseUpdateStreamResult = ImportActionResult<[string, UpdateStreamOptions], StreamResource> & object

​

Type Declaration

updateStream

updateStream: (id: string, stream: UpdateStreamOptions) => Promise<StreamResource>

Parameters

Returns

Promise<StreamResource>

stream

stream: StreamResource | undefined

isUpdating

isUpdating: boolean

---

​

UseTestNewStreamResult

UseTestNewStreamResult = ImportActionResult<[TestNewStreamRequest], TestStreamTransformResponse> & object

​

Type Declaration

testNewStream

testNewStream: (request: TestNewStreamRequest) => Promise<TestStreamTransformResponse>

Parameters

Returns

Promise<TestStreamTransformResponse>

result

result: TestStreamTransformResponse | undefined

isTesting

isTesting: boolean

---

​

UseTestExistingStreamResult

UseTestExistingStreamResult = ImportActionResult<[string, TestStreamTransformRequest], TestStreamTransformResponse> & object

​

Type Declaration

testExistingStream

testExistingStream: (id: string, request: TestStreamTransformRequest) => Promise<TestStreamTransformResponse>

Parameters

Returns

Promise<TestStreamTransformResponse>

result

result: TestStreamTransformResponse | undefined

isTesting

isTesting: boolean

---

​

UseTestExpressionResult

UseTestExpressionResult = ImportActionResult<[TestExpressionRequest], TestExpressionResponse> & object

​

Type Declaration

testExpression

testExpression: (request: TestExpressionRequest) => Promise<TestExpressionResponse>

Parameters

Returns

Promise<TestExpressionResponse>

result

result: TestExpressionResponse | undefined

isTesting

isTesting: boolean

---

​

PaginatedImportQueryOptions

PaginatedImportQueryOptions = object

​

Properties

pageSize?

optional pageSize?: number

initialCursor?

optional initialCursor?: string

resetKey?

optional resetKey?: string

---

​

PaginatedImportPageInfo

PaginatedImportPageInfo = object

​

Properties

cursor

cursor: string | undefined

nextCursor

nextCursor: string | undefined

pageSize

pageSize: number | undefined

---

​

PaginatedImportQueryResult

PaginatedImportQueryResult<T> = object

​

Type Parameters

​

Properties

data

data: T[] | undefined

isLoading

isLoading: boolean

error

error: unknown

refetch

refetch: () => void

Returns

void

items

items: T[]

pageInfo

pageInfo: PaginatedImportPageInfo

hasNextPage

hasNextPage: boolean

hasPreviousPage

hasPreviousPage: boolean

fetchNextPage

fetchNextPage: () => void

Returns

void

fetchPreviousPage

fetchPreviousPage: () => void

Returns

void

fetchPage

fetchPage: (nextPageCursor: string | undefined) => void

Parameters

Returns

void