@squonk/data-manager-client 3.1.0-beta.2 → 3.1.0

package/dataset/dataset.d.ts

@@ -1,5 +1,4 @@
-import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
-import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
+import { UseMutationOptions, UseMutationResult, UseQueryOptions, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
 import { DatasetPutBodyBody, customInstance, DatasetPutPostResponse, ErrorType, DmError, DatasetPostBodyBody, GetDatasetsParams, DatasetsGetResponse, GetVersionsParams, DatasetDetail, DeleteDatasetParams, TaskIdentity, DatasetSchemaGetResponse } from '../index.js';
 import 'axios';
 
@@ -15,11 +14,11 @@ Behaves like the corresponding **POST** method except the file is expected to ex
  */
 declare const createDatasetFromFile: (datasetPutBodyBody: DatasetPutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
 declare const getCreateDatasetFromFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
         data: DatasetPutBodyBody;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<DatasetPutPostResponse, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
     data: DatasetPutBodyBody;
 }, TContext>;
 type CreateDatasetFromFileMutationResult = NonNullable<Awaited<ReturnType<typeof createDatasetFromFile>>>;
@@ -29,11 +28,11 @@ type CreateDatasetFromFileMutationError = ErrorType<void | DmError>;
 * @summary Create a Dataset from a file in a Project
 */
 declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
         data: DatasetPutBodyBody;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<DatasetPutPostResponse, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
     data: DatasetPutBodyBody;
 }, TContext>;
 /**
@@ -51,11 +50,11 @@ Datasets undergo some processing in an asynchronous **Task** after control retur
 */
 declare const uploadDataset: (datasetPostBodyBody: DatasetPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
 declare const getUploadDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
         data: DatasetPostBodyBody;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<DatasetPutPostResponse, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
     data: DatasetPostBodyBody;
 }, TContext>;
 type UploadDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof uploadDataset>>>;
@@ -65,11 +64,11 @@ type UploadDatasetMutationError = ErrorType<void | DmError>;
 * @summary Upload an external file as a Dataset
 */
 declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
         data: DatasetPostBodyBody;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<DatasetPutPostResponse, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof uploadDataset>>, TError, {
     data: DatasetPostBodyBody;
 }, TContext>;
 /**
@@ -86,37 +85,55 @@ Note that if `editors` are combined with `owner username`, then the datasets wil
 declare const getDatasets: (params?: GetDatasetsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetsGetResponse>;
 declare const getGetDatasetsQueryKey: (params?: GetDatasetsParams) => readonly ["data-manager-api", "/dataset", ...GetDatasetsParams[]];
 declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
-    query?: Partial<UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> & {
+}) => UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetDatasetsQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
 type GetDatasetsQueryError = ErrorType<void | DmError>;
-/**
- * @summary Get Datasets that are available to you
- */
-declare const useGetDatasets: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
-    query?: Partial<UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
+declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params: undefined | GetDatasetsParams, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>, 'initialData'>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryResult<TData, TError> & {
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 declare const getGetDatasetsSuspenseQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
-    query?: Partial<UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> & {
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetDatasetsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
 type GetDatasetsSuspenseQueryError = ErrorType<void | DmError>;
-/**
- * @summary Get Datasets that are available to you
- */
-declare const useGetDatasetsSuspense: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
-    query?: Partial<UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
+declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params: undefined | GetDatasetsParams, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryResult<TData, TError> & {
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
@@ -129,37 +146,55 @@ You will not see Datasets while their upload is still in progress.
 declare const getVersions: (datasetId: string, params?: GetVersionsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDetail>;
 declare const getGetVersionsQueryKey: (datasetId: string, params?: GetVersionsParams) => readonly ["data-manager-api", `/dataset/${string}/versions`, ...GetVersionsParams[]];
 declare const getGetVersionsQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
-    query?: Partial<UseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryOptions<DatasetDetail, TError, TData, QueryKey> & {
+}) => UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetVersionsQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
 type GetVersionsQueryError = ErrorType<void | DmError>;
-/**
- * @summary Gets all the Versions of a specific Dataset
- */
-declare const useGetVersions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
-    query?: Partial<UseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
+declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params: undefined | GetVersionsParams, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryResult<TData, TError> & {
+}): UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 declare const getGetVersionsSuspenseQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
-    query?: Partial<UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey> & {
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetVersionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
 type GetVersionsSuspenseQueryError = ErrorType<void | DmError>;
-/**
- * @summary Gets all the Versions of a specific Dataset
- */
-declare const useGetVersionsSuspense: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
-    query?: Partial<UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
+declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params: undefined | GetVersionsParams, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryResult<TData, TError> & {
+}): UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
@@ -173,16 +208,16 @@ You cannot delete a Dataset until its upload is complete.
  */
 declare const deleteDataset: (datasetId: string, datasetVersion: number, params?: DeleteDatasetParams, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
 declare const getDeleteDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TaskIdentity, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
         datasetId: string;
         datasetVersion: number;
-        params?: DeleteDatasetParams | undefined;
-    }, TContext> | undefined;
+        params?: DeleteDatasetParams;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<TaskIdentity, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
     datasetId: string;
     datasetVersion: number;
-    params?: DeleteDatasetParams | undefined;
+    params?: DeleteDatasetParams;
 }, TContext>;
 type DeleteDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDataset>>>;
 type DeleteDatasetMutationError = ErrorType<void | DmError>;
@@ -190,16 +225,16 @@ type DeleteDatasetMutationError = ErrorType<void | DmError>;
 * @summary Delete a Dataset
 */
 declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TaskIdentity, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
         datasetId: string;
         datasetVersion: number;
-        params?: DeleteDatasetParams | undefined;
-    }, TContext> | undefined;
+        params?: DeleteDatasetParams;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<TaskIdentity, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof deleteDataset>>, TError, {
     datasetId: string;
     datasetVersion: number;
-    params?: DeleteDatasetParams | undefined;
+    params?: DeleteDatasetParams;
 }, TContext>;
 /**
 * Given a `dataset_id` the dataset will be returned if available.
@@ -210,38 +245,56 @@ You cannot get a Dataset until its upload is complete.
 */
 declare const downloadDataset: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
 declare const getDownloadDatasetQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/${number}`];
-declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
+}) => UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type DownloadDatasetQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
-type DownloadDatasetQueryError = ErrorType<DmError>;
-/**
- * @summary Download a Dataset
- */
-declare const useDownloadDataset: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+type DownloadDatasetQueryError = ErrorType<void | DmError>;
+declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryResult<TData, TError> & {
+}): UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
-declare const getDownloadDatasetSuspenseQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+declare const getDownloadDatasetSuspenseQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryOptions<void, TError, TData, QueryKey> & {
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type DownloadDatasetSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
-type DownloadDatasetSuspenseQueryError = ErrorType<DmError>;
-/**
- * @summary Download a Dataset
- */
-declare const useDownloadDatasetSuspense: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+type DownloadDatasetSuspenseQueryError = ErrorType<void | DmError>;
+declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryResult<TData, TError> & {
+}): UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
@@ -254,28 +307,28 @@ You cannot modify Dataset editors until its upload is complete.
  * @summary Remove a user's edit permission for a Dataset
  */
 declare const removeEditorFromDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getRemoveEditorFromDatasetMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getRemoveEditorFromDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
         datasetId: string;
         userId: string;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
     datasetId: string;
     userId: string;
 }, TContext>;
 type RemoveEditorFromDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromDataset>>>;
-type RemoveEditorFromDatasetMutationError = ErrorType<DmError>;
+type RemoveEditorFromDatasetMutationError = ErrorType<DmError | void>;
 /**
 * @summary Remove a user's edit permission for a Dataset
 */
-declare const useRemoveEditorFromDataset: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useRemoveEditorFromDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
         datasetId: string;
         userId: string;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
     datasetId: string;
     userId: string;
 }, TContext>;
@@ -289,28 +342,28 @@ You cannot modify Dataset editors until its upload is complete.
 * @summary Give a user edit permission for a Dataset
 */
 declare const addEditorToDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getAddEditorToDatasetMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getAddEditorToDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
         datasetId: string;
         userId: string;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
     datasetId: string;
     userId: string;
 }, TContext>;
 type AddEditorToDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToDataset>>>;
-type AddEditorToDatasetMutationError = ErrorType<DmError>;
+type AddEditorToDatasetMutationError = ErrorType<void | DmError>;
 /**
 * @summary Give a user edit permission for a Dataset
 */
-declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useAddEditorToDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
         datasetId: string;
         userId: string;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
     datasetId: string;
     userId: string;
 }, TContext>;
@@ -322,37 +375,55 @@ declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = un
 declare const getSchema: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetSchemaGetResponse>;
 declare const getGetSchemaQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/schema/${number}`];
 declare const getGetSchemaQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> & {
+}) => UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetSchemaQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
 type GetSchemaQueryError = ErrorType<void | DmError>;
-/**
- * @summary Gets the property schema for a specific Dataset
- */
-declare const useGetSchema: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
+declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryResult<TData, TError> & {
+}): UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 declare const getGetSchemaSuspenseQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> & {
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetSchemaSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
 type GetSchemaSuspenseQueryError = ErrorType<void | DmError>;
-/**
- * @summary Gets the property schema for a specific Dataset
- */
-declare const useGetSchemaSuspense: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
-    query?: Partial<UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
+declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryResult<TData, TError> & {
+}): UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 

package/dataset/dataset.js

@@ -107,24 +107,24 @@ var getGetDatasetsQueryOptions = (params, options) => {
   const queryFn = ({ signal }) => getDatasets(params, requestOptions, signal);
   return { queryKey, queryFn, ...queryOptions };
 };
-var useGetDatasets = (params, options) => {
+function useGetDatasets(params, options) {
   const queryOptions = getGetDatasetsQueryOptions(params, options);
   const query = useQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 var getGetDatasetsSuspenseQueryOptions = (params, options) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
   const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetDatasetsQueryKey(params);
   const queryFn = ({ signal }) => getDatasets(params, requestOptions, signal);
   return { queryKey, queryFn, ...queryOptions };
 };
-var useGetDatasetsSuspense = (params, options) => {
+function useGetDatasetsSuspense(params, options) {
   const queryOptions = getGetDatasetsSuspenseQueryOptions(params, options);
   const query = useSuspenseQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 var getVersions = (datasetId, params, options, signal) => {
   return customInstance(
     {
@@ -145,24 +145,24 @@ var getGetVersionsQueryOptions = (datasetId, params, options) => {
   const queryFn = ({ signal }) => getVersions(datasetId, params, requestOptions, signal);
   return { queryKey, queryFn, enabled: !!datasetId, ...queryOptions };
 };
-var useGetVersions = (datasetId, params, options) => {
+function useGetVersions(datasetId, params, options) {
   const queryOptions = getGetVersionsQueryOptions(datasetId, params, options);
   const query = useQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 var getGetVersionsSuspenseQueryOptions = (datasetId, params, options) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
   const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetVersionsQueryKey(datasetId, params);
   const queryFn = ({ signal }) => getVersions(datasetId, params, requestOptions, signal);
   return { queryKey, queryFn, enabled: !!datasetId, ...queryOptions };
 };
-var useGetVersionsSuspense = (datasetId, params, options) => {
+function useGetVersionsSuspense(datasetId, params, options) {
   const queryOptions = getGetVersionsSuspenseQueryOptions(datasetId, params, options);
   const query = useSuspenseQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 var deleteDataset = (datasetId, datasetVersion, params, options) => {
   return customInstance(
     {
@@ -204,24 +204,24 @@ var getDownloadDatasetQueryOptions = (datasetId, datasetVersion, options) => {
   const queryFn = ({ signal }) => downloadDataset(datasetId, datasetVersion, requestOptions, signal);
   return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions };
 };
-var useDownloadDataset = (datasetId, datasetVersion, options) => {
+function useDownloadDataset(datasetId, datasetVersion, options) {
   const queryOptions = getDownloadDatasetQueryOptions(datasetId, datasetVersion, options);
   const query = useQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 var getDownloadDatasetSuspenseQueryOptions = (datasetId, datasetVersion, options) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
   const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getDownloadDatasetQueryKey(datasetId, datasetVersion);
   const queryFn = ({ signal }) => downloadDataset(datasetId, datasetVersion, requestOptions, signal);
   return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions };
 };
-var useDownloadDatasetSuspense = (datasetId, datasetVersion, options) => {
+function useDownloadDatasetSuspense(datasetId, datasetVersion, options) {
   const queryOptions = getDownloadDatasetSuspenseQueryOptions(datasetId, datasetVersion, options);
   const query = useSuspenseQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 var removeEditorFromDataset = (datasetId, userId, options) => {
   return customInstance(
     {
@@ -283,24 +283,24 @@ var getGetSchemaQueryOptions = (datasetId, datasetVersion, options) => {
   const queryFn = ({ signal }) => getSchema(datasetId, datasetVersion, requestOptions, signal);
   return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions };
 };
-var useGetSchema = (datasetId, datasetVersion, options) => {
+function useGetSchema(datasetId, datasetVersion, options) {
   const queryOptions = getGetSchemaQueryOptions(datasetId, datasetVersion, options);
   const query = useQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 var getGetSchemaSuspenseQueryOptions = (datasetId, datasetVersion, options) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
   const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetSchemaQueryKey(datasetId, datasetVersion);
   const queryFn = ({ signal }) => getSchema(datasetId, datasetVersion, requestOptions, signal);
   return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions };
 };
-var useGetSchemaSuspense = (datasetId, datasetVersion, options) => {
+function useGetSchemaSuspense(datasetId, datasetVersion, options) {
   const queryOptions = getGetSchemaSuspenseQueryOptions(datasetId, datasetVersion, options);
   const query = useSuspenseQuery(queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
-};
+}
 export {
   addEditorToDataset,
   createDatasetFromFile,