​

React SDK Reference

API reference for the Prequel Import React SDK. Includes the provider, client helpers, hooks, and utilities intended for application code.

​

Setup

​

ImportProvider()

ImportProvider(__namedParameters: ImportProviderProps): FunctionComponentElement<ProviderProps<ImportContextValue | null>>

Makes the Import SDK client available to all hooks below it in the React tree.

​

Parameters

​

Returns

FunctionComponentElement<ProviderProps<ImportContextValue | null>>

​

Client

​

DEFAULT_IMPORT_API_BASE_URL

const DEFAULT_IMPORT_API_BASE_URL: "https://api.prequel.co" = "https://api.prequel.co"

Default base URL for Prequel’s Import API.

---

​

createDefaultClient()

createDefaultClient(config: DefaultClientConfig): ImportClient

Creates the default browser client used by ImportProvider. The client calls fetchToken to get short-lived scoped Import API tokens, caches provider-scoped tokens, and retries once with a fresh token after a 401 response. Source-claim routes automatically request a token for the source payload being sent.

​

Parameters

​

Returns

ImportClient

​

Dataset hooks

​

useListDatasets()

useListDatasets(options?: PaginatedImportQueryOptions): UseListDatasetsResult

Lists import datasets with cursor pagination helpers.

​

Parameters

​

Returns

UseListDatasetsResult

---

​

useDataset()

useDataset(id: string): UseDatasetResult

Fetches one import dataset by ID.

​

Parameters

​

Returns

UseDatasetResult

---

​

useDatasetSchema()

useDatasetSchema(datasetId: string | undefined): UseDatasetSchemaResult

Fetches the inferred schema for a dataset. Pass undefined while the dataset ID is not available.

​

Parameters

​

Returns

UseDatasetSchemaResult

---

​

useRandomSampleDataset()

useRandomSampleDataset(): UseRandomSampleDatasetResult

Creates a random sample for a dataset and exposes action state for the request.

​

Returns

UseRandomSampleDatasetResult

---

​

useCreateDataset()

useCreateDataset(): UseCreateDatasetResult

Creates an import dataset.

​

Returns

UseCreateDatasetResult

​

Source hooks

​

useSourceForm()

useSourceForm(options: UseSourceFormOptions): UseSourceFormResult

Builds source connection forms from Prequel’s vendor-specific form metadata. Use this when you need the editable source draft, field definitions, and helpers for producing a create/update payload.

​

Parameters

​

Returns

UseSourceFormResult

---

​

useSourceFormFields()

useSourceFormFields(options: UseSourceFormOptions): UseSourceFormResult

Alias for useSourceForm kept for form-field oriented integrations.

​

Parameters

​

Returns

UseSourceFormResult

---

​

useListSources()

useListSources(options?: ListSourcesOptions): UseListSourcesResult

Lists import sources with optional provider filtering and cursor pagination helpers.

​

Parameters

​

Returns

UseListSourcesResult

---

​

useSource()

useSource(id: string): UseSourceResult

Fetches one import source by ID.

​

Parameters

​

Returns

UseSourceResult

---

​

useSourceTables()

useSourceTables(sourceId: string | undefined): UseSourceTablesResult

Lists tables available from a source. Pass undefined while the source ID is not available.

​

Parameters

​

Returns

UseSourceTablesResult

---

​

useSourceSchema()

useSourceSchema(sourceId: string | undefined, request: SourcePreviewOptions | undefined): UseSourceSchemaResult

Fetches the schema for a source table, SQL query, or object-storage glob. Pass undefined for either argument until the source and preview request are ready.

​

Parameters

​

Returns

UseSourceSchemaResult

---

​

usePreviewSourceRows()

usePreviewSourceRows(): UsePreviewSourceRowsResult

Previews rows from a source table, SQL query, or object-storage glob.

​

Returns

UsePreviewSourceRowsResult

---

​

useCreateSource()

useCreateSource(): UseCreateSourceResult

Creates an import source.

​

Returns

UseCreateSourceResult

---

​

useUpdateSource()

useUpdateSource(): UseUpdateSourceResult

Updates an import source.

​

Returns

UseUpdateSourceResult

---

​

useTestNewSource()

useTestNewSource(): UseTestNewSourceResult

Tests connection settings before creating a source.

​

Returns

UseTestNewSourceResult

---

​

useTestExistingSource()

useTestExistingSource(): UseTestExistingSourceResult

Tests an existing source, optionally with pending updates.

​

Returns

UseTestExistingSourceResult

​

Stream hooks

​

useListStreams()

useListStreams(options?: PaginatedImportQueryOptions): UseListStreamsResult

Lists import streams with cursor pagination helpers.

​

Parameters

​

Returns

UseListStreamsResult

---

​

useStream()

useStream(id: string): UseStreamResult

Fetches one import stream by ID.

​

Parameters

​

Returns

UseStreamResult

---

​

useCreateStream()

useCreateStream(): UseCreateStreamResult

Creates an import stream.

​

Returns

UseCreateStreamResult

---

​

useUpdateStream()

useUpdateStream(): UseUpdateStreamResult

Updates an import stream.

​

Returns

UseUpdateStreamResult

---

​

useTestNewStream()

useTestNewStream(): UseTestNewStreamResult

Tests stream mappings before creating a stream.

​

Returns

UseTestNewStreamResult

---

​

useTestExistingStream()

useTestExistingStream(): UseTestExistingStreamResult

Tests mapping changes against an existing stream.

​

Returns

UseTestExistingStreamResult

---

​

useTestExpression()

useTestExpression(): UseTestExpressionResult

Evaluates a single mapping expression against a sample record.

​

Returns

UseTestExpressionResult

​

Destination hooks

​

useListDestinations()

useListDestinations(options?: PaginatedImportQueryOptions): UseListDestinationsResult

Lists import destinations with cursor pagination helpers.

​

Parameters

​

Returns

UseListDestinationsResult

---

​

useDestination()

useDestination(id: string | undefined): UseDestinationResult

Fetches one import destination by ID. Pass undefined while the destination ID is not available.

​

Parameters

​

Returns

UseDestinationResult

​

Extract hooks

​

useListExtracts()

useListExtracts(datasetId: string, options?: PaginatedImportQueryOptions): UseListExtractsResult

Lists extracts for a dataset with cursor pagination helpers.

​

Parameters

​

Returns

UseListExtractsResult

---

​

useExtractDebug()

useExtractDebug(extractId: string, options?: PaginatedImportQueryOptions, filters?: Record<string, string>): UseExtractDebugResult

Lists debug records for an extract with optional filters and cursor pagination helpers.

​

Parameters

​

Returns

UseExtractDebugResult

---

​

useExtract()

useExtract(id: string): UseExtractResult

Fetches one extract by ID.

​

Parameters

​

Returns

UseExtractResult

​

Load hooks

​

useListLoads()

useListLoads(streamId: string, options?: PaginatedImportQueryOptions): UseListLoadsResult

Lists loads for a stream with cursor pagination helpers.

​

Parameters

​

Returns

UseListLoadsResult

---

​

useLoad()

useLoad(id: string): UseLoadResult

Fetches one load by ID.

​

Parameters

​

Returns

UseLoadResult

​

Utilities

​

isImportApiError()

isImportApiError(error: unknown): error is ImportApiError

Returns true when an unknown error has the normalized Import API error shape.

​

Parameters

​

Returns

error is ImportApiError

---

​

toImportApiError()

toImportApiError(error: unknown): ImportApiError

Converts an unknown thrown value into a normalized Import API error.

​

Parameters

​

Returns

ImportApiError

---

​

useImportContext()

useImportContext(): ImportContextValue

Returns the SDK APIs registered by ImportProvider. Use this only when the built-in hooks do not cover a custom workflow.

​

Returns

ImportContextValue