@squonk/data-manager-client 5.4.0 → 6.2.0

package/dist/api/instance/instance.js

@@ -1,26 +1,24 @@
 import { customInstance } from "../../custom-axios.js";
-import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
-
+import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 //#region src/api/instance/instance.ts
 /**
-* Generated by orval v7.21.0 🍺
+* Generated by orval v8.16.0 🍺
 * Do not edit manually.
 * Dataset Manager API
 * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
-
-* OpenAPI spec version: 5.4
+*
+* A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
+*
+* OpenAPI spec version: 6.2
 */
 /**
 * Launches a new Application or Job instance, returning an Instance and Task ID. The Task ID should be used against the `/task` endpoint to determine the availability of the the running instance.
-
-Instance behaviour is controlled using the `specification`. You will need to consult individual applications to determine what can be placed in the specification. Applications typically provide a `template` describing its **options**.
-
-An Application instance is not Ready for use until the corresponding **TaskState** is _STARTED_.
-
-A Job instance typically runs to completion, reaching the **TaskState** _SUCCESS_ when successful and _FAILURE_ is unsuccessful.
-
+*
+* Instance behaviour is controlled using the `specification`. You will need to consult individual applications to determine what can be placed in the specification. Applications typically provide a `template` describing its **options**.
+*
+* An Application instance is not Ready for use until the corresponding **TaskState** is _STARTED_.
+*
+* A Job instance typically runs to completion, reaching the **TaskState** _SUCCESS_ when successful and _FAILURE_ is unsuccessful.
 * @summary Creates a new Job or Application instance
 */
 const createInstance = (instancePostBodyBody, options, signal) => {
@@ -42,38 +40,45 @@ const createInstance = (instancePostBodyBody, options, signal) => {
 		signal
 	}, options);
 };
-const getCreateInstanceMutationOptions = (options) => {
-	const mutationKey = ["createInstance"];
-	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 createInstance(data, requestOptions);
-	};
+const getCreateInstanceQueryKey = (instancePostBodyBody) => {
+	return [
+		"data-manager",
+		"POST",
+		"instance",
+		instancePostBodyBody
+	];
+};
+const getCreateInstanceQueryOptions = (instancePostBodyBody, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getCreateInstanceQueryKey(instancePostBodyBody);
+	const queryFn = ({ signal }) => createInstance(instancePostBodyBody, requestOptions, signal);
 	return {
-		mutationFn,
-		...mutationOptions
+		queryKey,
+		queryFn,
+		...queryOptions
 	};
 };
 /**
 * @summary Creates a new Job or Application instance
 */
-const useCreateInstance = (options, queryClient) => {
-	return useMutation(getCreateInstanceMutationOptions(options), queryClient);
+function useCreateInstance(instancePostBodyBody, options, queryClient) {
+	const queryOptions = getCreateInstanceQueryOptions(instancePostBodyBody, options);
+	return {
+		...useQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
+}
+/**
+* @summary Creates a new Job or Application instance
+*/
+const invalidateCreateInstance = async (queryClient, instancePostBodyBody, options) => {
+	await queryClient.invalidateQueries({ queryKey: getCreateInstanceQueryKey(instancePostBodyBody) }, options);
+	return queryClient;
 };
 /**
 * Returns a summary of all running instances. Instances can be running as an Application or as a Job. The response will contain an `application_type` field that is either `job` or `application`
-
-Results can be filtered by **Project**, **Unit** or **Organisation**.
-
+*
+* Results can be filtered by **Project**, **Unit** or **Organisation**.
 * @summary Get summary information about all Job and Application instances
 */
 const getInstances = (params, options, signal) => {
@@ -106,9 +111,10 @@ const getGetInstancesQueryOptions = (params, options) => {
 */
 function useGetInstances(params, options, queryClient) {
 	const queryOptions = getGetInstancesQueryOptions(params, options);
-	const query = useQuery(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return {
+		...useQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
 }
 /**
 * @summary Get summary information about all Job and Application instances
@@ -132,15 +138,15 @@ const getGetInstancesSuspenseQueryOptions = (params, options) => {
 */
 function useGetInstancesSuspense(params, options, queryClient) {
 	const queryOptions = getGetInstancesSuspenseQueryOptions(params, options);
-	const query = useSuspenseQuery(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return {
+		...useSuspenseQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
 }
 /**
 * Similar to the `/instance [POST]` endpoint this one is used to check whether a new **Application** or **Job** instance can be launched. Rather than returning an **Instance** (or **Task**) ID this endpoint is simply used to ensure that the Job/Application is runnable while also returning the compiled `command` (if the Instance is a Job).
-
-The test result is only valid at the time of the call, whether an actual instance would start or not will require an identical call to `/instance POST`.
-
+*
+* The test result is only valid at the time of the call, whether an actual instance would start or not will require an identical call to `/instance POST`.
 * @summary Used to check the execution of new Job or Application instance
 */
 const dryRunInstance = (instancePostBodyBody, options, signal) => {
@@ -162,32 +168,41 @@ const dryRunInstance = (instancePostBodyBody, options, signal) => {
 		signal
 	}, options);
 };
-const getDryRunInstanceMutationOptions = (options) => {
-	const mutationKey = ["dryRunInstance"];
-	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 dryRunInstance(data, requestOptions);
-	};
+const getDryRunInstanceQueryKey = (instancePostBodyBody) => {
+	return [
+		"data-manager",
+		"POST",
+		"instance",
+		"dry-run",
+		instancePostBodyBody
+	];
+};
+const getDryRunInstanceQueryOptions = (instancePostBodyBody, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getDryRunInstanceQueryKey(instancePostBodyBody);
+	const queryFn = ({ signal }) => dryRunInstance(instancePostBodyBody, requestOptions, signal);
 	return {
-		mutationFn,
-		...mutationOptions
+		queryKey,
+		queryFn,
+		...queryOptions
 	};
 };
 /**
 * @summary Used to check the execution of new Job or Application instance
 */
-const useDryRunInstance = (options, queryClient) => {
-	return useMutation(getDryRunInstanceMutationOptions(options), queryClient);
+function useDryRunInstance(instancePostBodyBody, options, queryClient) {
+	const queryOptions = getDryRunInstanceQueryOptions(instancePostBodyBody, options);
+	return {
+		...useQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
+}
+/**
+* @summary Used to check the execution of new Job or Application instance
+*/
+const invalidateDryRunInstance = async (queryClient, instancePostBodyBody, options) => {
+	await queryClient.invalidateQueries({ queryKey: getDryRunInstanceQueryKey(instancePostBodyBody) }, options);
+	return queryClient;
 };
 /**
 * @summary Get detailed information about an Instance
@@ -213,7 +228,7 @@ const getGetInstanceQueryOptions = (instanceId, options) => {
 	return {
 		queryKey,
 		queryFn,
-		enabled: !!instanceId,
+		enabled: instanceId !== null && instanceId !== void 0,
 		...queryOptions
 	};
 };
@@ -222,9 +237,10 @@ const getGetInstanceQueryOptions = (instanceId, options) => {
 */
 function useGetInstance(instanceId, options, queryClient) {
 	const queryOptions = getGetInstanceQueryOptions(instanceId, options);
-	const query = useQuery(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return {
+		...useQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
 }
 /**
 * @summary Get detailed information about an Instance
@@ -248,134 +264,165 @@ const getGetInstanceSuspenseQueryOptions = (instanceId, options) => {
 */
 function useGetInstanceSuspense(instanceId, options, queryClient) {
 	const queryOptions = getGetInstanceSuspenseQueryOptions(instanceId, options);
-	const query = useSuspenseQuery(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return {
+		...useSuspenseQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
 }
 /**
 * The Application or Job Instance is terminated.
-
-You must be the `owner` or an `editor` of the Instance to delete it
-
+*
+* You must be the `owner` or an `editor` of the Instance to delete it
 * @summary Delete a Job or Application Instance
 */
-const terminateInstance = (instanceId, options) => {
+const terminateInstance = (instanceId, options, signal) => {
 	return customInstance({
 		url: `/instance/${instanceId}`,
-		method: "DELETE"
+		method: "DELETE",
+		signal
 	}, options);
 };
-const getTerminateInstanceMutationOptions = (options) => {
-	const mutationKey = ["terminateInstance"];
-	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 { instanceId } = props ?? {};
-		return terminateInstance(instanceId, requestOptions);
-	};
+const getTerminateInstanceQueryKey = (instanceId) => {
+	return [
+		"data-manager",
+		"DELETE",
+		"instance",
+		instanceId
+	];
+};
+const getTerminateInstanceQueryOptions = (instanceId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getTerminateInstanceQueryKey(instanceId);
+	const queryFn = ({ signal }) => terminateInstance(instanceId, requestOptions, signal);
 	return {
-		mutationFn,
-		...mutationOptions
+		queryKey,
+		queryFn,
+		enabled: instanceId !== null && instanceId !== void 0,
+		...queryOptions
 	};
 };
 /**
 * @summary Delete a Job or Application Instance
 */
-const useTerminateInstance = (options, queryClient) => {
-	return useMutation(getTerminateInstanceMutationOptions(options), queryClient);
+function useTerminateInstance(instanceId, options, queryClient) {
+	const queryOptions = getTerminateInstanceQueryOptions(instanceId, options);
+	return {
+		...useQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
+}
+/**
+* @summary Delete a Job or Application Instance
+*/
+const invalidateTerminateInstance = async (queryClient, instanceId, options) => {
+	await queryClient.invalidateQueries({ queryKey: getTerminateInstanceQueryKey(instanceId) }, options);
+	return queryClient;
 };
 /**
 * The Application or Job Instance is updated according to the patch parameters.
-
-You must be the `owner` or an `editor` of the Instance to patch it
-
+*
+* You must be the `owner` or an `editor` of the Instance to patch it
 * @summary Update a Job or Application Instance
 */
-const patchInstance = (instanceId, params, options) => {
+const patchInstance = (instanceId, params, options, signal) => {
 	return customInstance({
 		url: `/instance/${instanceId}`,
 		method: "PATCH",
-		params
+		params,
+		signal
 	}, options);
 };
-const getPatchInstanceMutationOptions = (options) => {
-	const mutationKey = ["patchInstance"];
-	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 { instanceId, params } = props ?? {};
-		return patchInstance(instanceId, params, requestOptions);
-	};
+const getPatchInstanceQueryKey = (instanceId, params) => {
+	return [
+		"data-manager",
+		"PATCH",
+		"instance",
+		instanceId,
+		...params ? [params] : []
+	];
+};
+const getPatchInstanceQueryOptions = (instanceId, params, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getPatchInstanceQueryKey(instanceId, params);
+	const queryFn = ({ signal }) => patchInstance(instanceId, params, requestOptions, signal);
 	return {
-		mutationFn,
-		...mutationOptions
+		queryKey,
+		queryFn,
+		enabled: instanceId !== null && instanceId !== void 0,
+		...queryOptions
 	};
 };
 /**
 * @summary Update a Job or Application Instance
 */
-const usePatchInstance = (options, queryClient) => {
-	return useMutation(getPatchInstanceMutationOptions(options), queryClient);
+function usePatchInstance(instanceId, params, options, queryClient) {
+	const queryOptions = getPatchInstanceQueryOptions(instanceId, params, options);
+	return {
+		...useQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
+}
+/**
+* @summary Update a Job or Application Instance
+*/
+const invalidatePatchInstance = async (queryClient, instanceId, params, options) => {
+	await queryClient.invalidateQueries({ queryKey: getPatchInstanceQueryKey(instanceId, params) }, options);
+	return queryClient;
 };
 /**
 * This revokes the instance **Token**, which was optionally generated when the instance was launched. No authentication is required to use this endpoint, which is typically used by a remote system driven by instance callbacks.
-
-Tokens automatically expire after a period of time but can be revoked instantly with this endpoint.
-
-The remote system will revoke the token when it's finished with it
-
+*
+* Tokens automatically expire after a period of time but can be revoked instantly with this endpoint.
+*
+* The remote system will revoke the token when it's finished with it
 * @summary Delete (revoke) the Instance Token
 */
-const deleteInstanceToken = (instanceId, token, options) => {
+const deleteInstanceToken = (instanceId, token, options, signal) => {
 	return customInstance({
 		url: `/instance/${instanceId}/token/${token}`,
-		method: "DELETE"
+		method: "DELETE",
+		signal
 	}, options);
 };
-const getDeleteInstanceTokenMutationOptions = (options) => {
-	const mutationKey = ["deleteInstanceToken"];
-	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 { instanceId, token } = props ?? {};
-		return deleteInstanceToken(instanceId, token, requestOptions);
-	};
+const getDeleteInstanceTokenQueryKey = (instanceId, token) => {
+	return [
+		"data-manager",
+		"DELETE",
+		"instance",
+		instanceId,
+		"token",
+		token
+	];
+};
+const getDeleteInstanceTokenQueryOptions = (instanceId, token, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getDeleteInstanceTokenQueryKey(instanceId, token);
+	const queryFn = ({ signal }) => deleteInstanceToken(instanceId, token, requestOptions, signal);
 	return {
-		mutationFn,
-		...mutationOptions
+		queryKey,
+		queryFn,
+		enabled: instanceId !== null && instanceId !== void 0 && token !== null && token !== void 0,
+		...queryOptions
 	};
 };
 /**
 * @summary Delete (revoke) the Instance Token
 */
-const useDeleteInstanceToken = (options, queryClient) => {
-	return useMutation(getDeleteInstanceTokenMutationOptions(options), queryClient);
+function useDeleteInstanceToken(instanceId, token, options, queryClient) {
+	const queryOptions = getDeleteInstanceTokenQueryOptions(instanceId, token, options);
+	return {
+		...useQuery(queryOptions, queryClient),
+		queryKey: queryOptions.queryKey
+	};
+}
+/**
+* @summary Delete (revoke) the Instance Token
+*/
+const invalidateDeleteInstanceToken = async (queryClient, instanceId, token, options) => {
+	await queryClient.invalidateQueries({ queryKey: getDeleteInstanceTokenQueryKey(instanceId, token) }, options);
+	return queryClient;
 };
-
 //#endregion
-export { createInstance, deleteInstanceToken, dryRunInstance, getCreateInstanceMutationOptions, getDeleteInstanceTokenMutationOptions, getDryRunInstanceMutationOptions, getGetInstanceQueryKey, getGetInstanceQueryOptions, getGetInstanceSuspenseQueryOptions, getGetInstancesQueryKey, getGetInstancesQueryOptions, getGetInstancesSuspenseQueryOptions, getInstance, getInstances, getPatchInstanceMutationOptions, getTerminateInstanceMutationOptions, invalidateGetInstance, invalidateGetInstances, patchInstance, terminateInstance, useCreateInstance, useDeleteInstanceToken, useDryRunInstance, useGetInstance, useGetInstanceSuspense, useGetInstances, useGetInstancesSuspense, usePatchInstance, useTerminateInstance };
+export { createInstance, deleteInstanceToken, dryRunInstance, getCreateInstanceQueryKey, getCreateInstanceQueryOptions, getDeleteInstanceTokenQueryKey, getDeleteInstanceTokenQueryOptions, getDryRunInstanceQueryKey, getDryRunInstanceQueryOptions, getGetInstanceQueryKey, getGetInstanceQueryOptions, getGetInstanceSuspenseQueryOptions, getGetInstancesQueryKey, getGetInstancesQueryOptions, getGetInstancesSuspenseQueryOptions, getInstance, getInstances, getPatchInstanceQueryKey, getPatchInstanceQueryOptions, getTerminateInstanceQueryKey, getTerminateInstanceQueryOptions, invalidateCreateInstance, invalidateDeleteInstanceToken, invalidateDryRunInstance, invalidateGetInstance, invalidateGetInstances, invalidatePatchInstance, invalidateTerminateInstance, patchInstance, terminateInstance, useCreateInstance, useDeleteInstanceToken, useDryRunInstance, useGetInstance, useGetInstanceSuspense, useGetInstances, useGetInstancesSuspense, usePatchInstance, useTerminateInstance };
+
 //# sourceMappingURL=instance.js.map