@squonk/data-manager-client 6.7.1 → 6.7.2

package/dist/api/dataset/dataset.js

@@ -1,8 +1,8 @@
 import { customInstance } from "../../custom-axios.js";
-import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
+import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 //#region src/api/dataset/dataset.ts
 /**
-* Generated by orval v8.16.0 🍺
+* Generated by orval v8.22.0 🍺
 * Do not edit manually.
 * Dataset Manager API
 * The Dataset Manager API service.
@@ -11,6 +11,18 @@ import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 *
 * OpenAPI spec version: 6.7
 */
+const withQueryKey = (query, queryKey) => {
+	const result = { queryKey };
+	for (const key of Object.keys(query)) {
+		if (key === "queryKey") continue;
+		Object.defineProperty(result, key, {
+			enumerable: true,
+			configurable: true,
+			get: () => query[key]
+		});
+	}
+	return result;
+};
 /**
 * Using an unmanaged file in a Project as a source a Dataset (or new Dataset Version) is created.
 *
@@ -37,40 +49,32 @@ const createDatasetFromFile = (datasetPutBodyBody, options, signal) => {
 		signal
 	}, options);
 };
-const getCreateDatasetFromFileQueryKey = (datasetPutBodyBody) => {
-	return [
-		"data-manager",
-		"PUT",
-		"dataset",
-		datasetPutBodyBody
-	];
-};
-const getCreateDatasetFromFileQueryOptions = (datasetPutBodyBody, options) => {
-	const { query: queryOptions, request: requestOptions } = options ?? {};
-	const queryKey = queryOptions?.queryKey ?? getCreateDatasetFromFileQueryKey(datasetPutBodyBody);
-	const queryFn = ({ signal }) => createDatasetFromFile(datasetPutBodyBody, requestOptions, signal);
-	return {
-		queryKey,
-		queryFn,
-		...queryOptions
+const getCreateDatasetFromFileMutationOptions = (options) => {
+	const mutationKey = ["createDatasetFromFile"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { data } = props ?? {};
+		return createDatasetFromFile(data, requestOptions);
 	};
-};
-/**
-* @summary Create a Dataset from a file in a Project
-*/
-function useCreateDatasetFromFile(datasetPutBodyBody, options, queryClient) {
-	const queryOptions = getCreateDatasetFromFileQueryOptions(datasetPutBodyBody, options);
 	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
+		mutationFn,
+		...mutationOptions
 	};
-}
+};
 /**
 * @summary Create a Dataset from a file in a Project
 */
-const invalidateCreateDatasetFromFile = async (queryClient, datasetPutBodyBody, options) => {
-	await queryClient.invalidateQueries({ queryKey: getCreateDatasetFromFileQueryKey(datasetPutBodyBody) }, options);
-	return queryClient;
+const useCreateDatasetFromFile = (options, queryClient) => {
+	return useMutation(getCreateDatasetFromFileMutationOptions(options), queryClient);
 };
 /**
 * Uploads a dataset.
@@ -101,40 +105,32 @@ const uploadDataset = (datasetPostBodyBody, options, signal) => {
 		signal
 	}, options);
 };
-const getUploadDatasetQueryKey = (datasetPostBodyBody) => {
-	return [
-		"data-manager",
-		"POST",
-		"dataset",
-		datasetPostBodyBody
-	];
-};
-const getUploadDatasetQueryOptions = (datasetPostBodyBody, options) => {
-	const { query: queryOptions, request: requestOptions } = options ?? {};
-	const queryKey = queryOptions?.queryKey ?? getUploadDatasetQueryKey(datasetPostBodyBody);
-	const queryFn = ({ signal }) => uploadDataset(datasetPostBodyBody, requestOptions, signal);
-	return {
-		queryKey,
-		queryFn,
-		...queryOptions
+const getUploadDatasetMutationOptions = (options) => {
+	const mutationKey = ["uploadDataset"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { data } = props ?? {};
+		return uploadDataset(data, requestOptions);
 	};
-};
-/**
-* @summary Upload an external file as a Dataset
-*/
-function useUploadDataset(datasetPostBodyBody, options, queryClient) {
-	const queryOptions = getUploadDatasetQueryOptions(datasetPostBodyBody, options);
 	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
+		mutationFn,
+		...mutationOptions
 	};
-}
+};
 /**
 * @summary Upload an external file as a Dataset
 */
-const invalidateUploadDataset = async (queryClient, datasetPostBodyBody, options) => {
-	await queryClient.invalidateQueries({ queryKey: getUploadDatasetQueryKey(datasetPostBodyBody) }, options);
-	return queryClient;
+const useUploadDataset = (options, queryClient) => {
+	return useMutation(getUploadDatasetMutationOptions(options), queryClient);
 };
 /**
 * Returns datasets that you have access to, whether attached to a project or not.
@@ -176,10 +172,7 @@ const getGetDatasetsQueryOptions = (params, options) => {
 */
 function useGetDatasets(params, options, queryClient) {
 	const queryOptions = getGetDatasetsQueryOptions(params, options);
-	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Get Datasets that are available to you
@@ -203,10 +196,7 @@ const getGetDatasetsSuspenseQueryOptions = (params, options) => {
 */
 function useGetDatasetsSuspense(params, options, queryClient) {
 	const queryOptions = getGetDatasetsSuspenseQueryOptions(params, options);
-	return {
-		...useSuspenseQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useSuspenseQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * Returns a list of Dataset Versions.
@@ -247,10 +237,7 @@ const getGetVersionsQueryOptions = (datasetId, params, options) => {
 */
 function useGetVersions(datasetId, params, options, queryClient) {
 	const queryOptions = getGetVersionsQueryOptions(datasetId, params, options);
-	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Gets all the Versions of a specific Dataset
@@ -274,10 +261,7 @@ const getGetVersionsSuspenseQueryOptions = (datasetId, params, options) => {
 */
 function useGetVersionsSuspense(datasetId, params, options, queryClient) {
 	const queryOptions = getGetVersionsSuspenseQueryOptions(datasetId, params, options);
-	return {
-		...useSuspenseQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useSuspenseQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * Given the Dataset `id` and `version` the Dataset will be removed. The API does not prevent you removing a Dataset that's been used in a **Project**. When removed using this endpoint the Dataset is automatically detached from any and all Projects that it was attached to and any corresponding Project Files relating to the Dataset are also removed.
@@ -295,43 +279,32 @@ const deleteDataset = (datasetId, datasetVersion, params, options, signal) => {
 		signal
 	}, options);
 };
-const getDeleteDatasetQueryKey = (datasetId, datasetVersion, params) => {
-	return [
-		"data-manager",
-		"DELETE",
-		"dataset",
-		datasetId,
-		datasetVersion,
-		...params ? [params] : []
-	];
-};
-const getDeleteDatasetQueryOptions = (datasetId, datasetVersion, params, options) => {
-	const { query: queryOptions, request: requestOptions } = options ?? {};
-	const queryKey = queryOptions?.queryKey ?? getDeleteDatasetQueryKey(datasetId, datasetVersion, params);
-	const queryFn = ({ signal }) => deleteDataset(datasetId, datasetVersion, params, requestOptions, signal);
-	return {
-		queryKey,
-		queryFn,
-		enabled: datasetId !== null && datasetId !== void 0 && datasetVersion !== null && datasetVersion !== void 0,
-		...queryOptions
+const getDeleteDatasetMutationOptions = (options) => {
+	const mutationKey = ["deleteDataset"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { datasetId, datasetVersion, params } = props ?? {};
+		return deleteDataset(datasetId, datasetVersion, params, requestOptions);
 	};
-};
-/**
-* @summary Delete a Dataset
-*/
-function useDeleteDataset(datasetId, datasetVersion, params, options, queryClient) {
-	const queryOptions = getDeleteDatasetQueryOptions(datasetId, datasetVersion, params, options);
 	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
+		mutationFn,
+		...mutationOptions
 	};
-}
+};
 /**
 * @summary Delete a Dataset
 */
-const invalidateDeleteDataset = async (queryClient, datasetId, datasetVersion, params, options) => {
-	await queryClient.invalidateQueries({ queryKey: getDeleteDatasetQueryKey(datasetId, datasetVersion, params) }, options);
-	return queryClient;
+const useDeleteDataset = (options, queryClient) => {
+	return useMutation(getDeleteDatasetMutationOptions(options), queryClient);
 };
 /**
 * Given a `dataset_id` the dataset will be returned if available.
@@ -370,10 +343,7 @@ const getDownloadDatasetQueryOptions = (datasetId, datasetVersion, options) => {
 */
 function useDownloadDataset(datasetId, datasetVersion, options, queryClient) {
 	const queryOptions = getDownloadDatasetQueryOptions(datasetId, datasetVersion, options);
-	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Download a Dataset
@@ -397,10 +367,7 @@ const getDownloadDatasetSuspenseQueryOptions = (datasetId, datasetVersion, optio
 */
 function useDownloadDatasetSuspense(datasetId, datasetVersion, options, queryClient) {
 	const queryOptions = getDownloadDatasetSuspenseQueryOptions(datasetId, datasetVersion, options);
-	return {
-		...useSuspenseQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useSuspenseQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * The user is removed from the Dataset's `editor` list. The user is removed from all versions of a dataset. You can remove yourself but an `owner` (creator) will always have access to the dataset.
@@ -417,43 +384,32 @@ const removeEditorFromDataset = (datasetId, userId, options, signal) => {
 		signal
 	}, options);
 };
-const getRemoveEditorFromDatasetQueryKey = (datasetId, userId) => {
-	return [
-		"data-manager",
-		"DELETE",
-		"dataset",
-		datasetId,
-		"editor",
-		userId
-	];
-};
-const getRemoveEditorFromDatasetQueryOptions = (datasetId, userId, options) => {
-	const { query: queryOptions, request: requestOptions } = options ?? {};
-	const queryKey = queryOptions?.queryKey ?? getRemoveEditorFromDatasetQueryKey(datasetId, userId);
-	const queryFn = ({ signal }) => removeEditorFromDataset(datasetId, userId, requestOptions, signal);
-	return {
-		queryKey,
-		queryFn,
-		enabled: datasetId !== null && datasetId !== void 0 && userId !== null && userId !== void 0,
-		...queryOptions
+const getRemoveEditorFromDatasetMutationOptions = (options) => {
+	const mutationKey = ["removeEditorFromDataset"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { datasetId, userId } = props ?? {};
+		return removeEditorFromDataset(datasetId, userId, requestOptions);
 	};
-};
-/**
-* @summary Remove a user's edit permission for a Dataset
-*/
-function useRemoveEditorFromDataset(datasetId, userId, options, queryClient) {
-	const queryOptions = getRemoveEditorFromDatasetQueryOptions(datasetId, userId, options);
 	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
+		mutationFn,
+		...mutationOptions
 	};
-}
+};
 /**
 * @summary Remove a user's edit permission for a Dataset
 */
-const invalidateRemoveEditorFromDataset = async (queryClient, datasetId, userId, options) => {
-	await queryClient.invalidateQueries({ queryKey: getRemoveEditorFromDatasetQueryKey(datasetId, userId) }, options);
-	return queryClient;
+const useRemoveEditorFromDataset = (options, queryClient) => {
+	return useMutation(getRemoveEditorFromDatasetMutationOptions(options), queryClient);
 };
 /**
 * The user is added to the dataset's `editor`` list. The dataset `owner` is automatically an editor and so does not need to be added as an `editor`.
@@ -470,43 +426,32 @@ const addEditorToDataset = (datasetId, userId, options, signal) => {
 		signal
 	}, options);
 };
-const getAddEditorToDatasetQueryKey = (datasetId, userId) => {
-	return [
-		"data-manager",
-		"PUT",
-		"dataset",
-		datasetId,
-		"editor",
-		userId
-	];
-};
-const getAddEditorToDatasetQueryOptions = (datasetId, userId, options) => {
-	const { query: queryOptions, request: requestOptions } = options ?? {};
-	const queryKey = queryOptions?.queryKey ?? getAddEditorToDatasetQueryKey(datasetId, userId);
-	const queryFn = ({ signal }) => addEditorToDataset(datasetId, userId, requestOptions, signal);
-	return {
-		queryKey,
-		queryFn,
-		enabled: datasetId !== null && datasetId !== void 0 && userId !== null && userId !== void 0,
-		...queryOptions
+const getAddEditorToDatasetMutationOptions = (options) => {
+	const mutationKey = ["addEditorToDataset"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { datasetId, userId } = props ?? {};
+		return addEditorToDataset(datasetId, userId, requestOptions);
 	};
-};
-/**
-* @summary Give a user edit permission for a Dataset
-*/
-function useAddEditorToDataset(datasetId, userId, options, queryClient) {
-	const queryOptions = getAddEditorToDatasetQueryOptions(datasetId, userId, options);
 	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
+		mutationFn,
+		...mutationOptions
 	};
-}
+};
 /**
 * @summary Give a user edit permission for a Dataset
 */
-const invalidateAddEditorToDataset = async (queryClient, datasetId, userId, options) => {
-	await queryClient.invalidateQueries({ queryKey: getAddEditorToDatasetQueryKey(datasetId, userId) }, options);
-	return queryClient;
+const useAddEditorToDataset = (options, queryClient) => {
+	return useMutation(getAddEditorToDatasetMutationOptions(options), queryClient);
 };
 /**
 * Returns the property schema for a Dataset versions in JSON format (if available).
@@ -544,10 +489,7 @@ const getGetSchemaQueryOptions = (datasetId, datasetVersion, options) => {
 */
 function useGetSchema(datasetId, datasetVersion, options, queryClient) {
 	const queryOptions = getGetSchemaQueryOptions(datasetId, datasetVersion, options);
-	return {
-		...useQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Gets the property schema for a specific Dataset
@@ -571,12 +513,9 @@ const getGetSchemaSuspenseQueryOptions = (datasetId, datasetVersion, options) =>
 */
 function useGetSchemaSuspense(datasetId, datasetVersion, options, queryClient) {
 	const queryOptions = getGetSchemaSuspenseQueryOptions(datasetId, datasetVersion, options);
-	return {
-		...useSuspenseQuery(queryOptions, queryClient),
-		queryKey: queryOptions.queryKey
-	};
+	return withQueryKey(useSuspenseQuery(queryOptions, queryClient), queryOptions.queryKey);
 }
 //#endregion
-export { addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetQueryKey, getAddEditorToDatasetQueryOptions, getCreateDatasetFromFileQueryKey, getCreateDatasetFromFileQueryOptions, getDatasets, getDeleteDatasetQueryKey, getDeleteDatasetQueryOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getDownloadDatasetSuspenseQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetDatasetsSuspenseQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetSchemaSuspenseQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getGetVersionsSuspenseQueryOptions, getRemoveEditorFromDatasetQueryKey, getRemoveEditorFromDatasetQueryOptions, getSchema, getUploadDatasetQueryKey, getUploadDatasetQueryOptions, getVersions, invalidateAddEditorToDataset, invalidateCreateDatasetFromFile, invalidateDeleteDataset, invalidateDownloadDataset, invalidateGetDatasets, invalidateGetSchema, invalidateGetVersions, invalidateRemoveEditorFromDataset, invalidateUploadDataset, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useDownloadDatasetSuspense, useGetDatasets, useGetDatasetsSuspense, useGetSchema, useGetSchemaSuspense, useGetVersions, useGetVersionsSuspense, useRemoveEditorFromDataset, useUploadDataset };
+export { addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetMutationOptions, getCreateDatasetFromFileMutationOptions, getDatasets, getDeleteDatasetMutationOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getDownloadDatasetSuspenseQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetDatasetsSuspenseQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetSchemaSuspenseQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getGetVersionsSuspenseQueryOptions, getRemoveEditorFromDatasetMutationOptions, getSchema, getUploadDatasetMutationOptions, getVersions, invalidateDownloadDataset, invalidateGetDatasets, invalidateGetSchema, invalidateGetVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useDownloadDatasetSuspense, useGetDatasets, useGetDatasetsSuspense, useGetSchema, useGetSchemaSuspense, useGetVersions, useGetVersionsSuspense, useRemoveEditorFromDataset, useUploadDataset };
 
 //# sourceMappingURL=dataset.js.map