@squonk/data-manager-client 1.2.8 → 2.0.0-alpha.1

package/src/instance/instance.ts

@@ -1,16 +1,17 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v6.25.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** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.2
+ * OpenAPI spec version: 2.0
  */
 import {
   useMutation,
-  useQuery
+  useQuery,
+  useSuspenseQuery
 } from '@tanstack/react-query'
 import type {
   MutationFunction,
@@ -18,7 +19,9 @@ import type {
   QueryKey,
   UseMutationOptions,
   UseQueryOptions,
-  UseQueryResult
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
 } from '@tanstack/react-query'
 import type {
   DmError,
@@ -35,13 +38,7 @@ import { customInstance } from '.././custom-instance';
 import type { ErrorType } from '.././custom-instance';
 
 
-// eslint-disable-next-line
-  type SecondParameter<T extends (...args: any) => any> = T extends (
-  config: any,
-  args: infer P,
-) => any
-  ? P
-  : never;
+type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
 
 
 /**
@@ -86,7 +83,7 @@ if(instancePostBodyBody.specification !== undefined) {
  }
 
       return customInstance<InstancePostResponse>(
-      {url: `/instance`, method: 'post',
+      {url: `/instance`, method: 'POST',
       headers: {'Content-Type': 'multipart/form-data', },
        data: formData
     },
@@ -96,7 +93,6 @@ if(instancePostBodyBody.specification !== undefined) {
 
 
 export const getCreateInstanceMutationOptions = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError,{data: InstancePostBodyBody}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -123,7 +119,6 @@ export const getCreateInstanceMutationOptions = <TError = ErrorType<void | DmErr
  * @summary Creates a new Job or Application instance
  */
 export const useCreateInstance = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -143,7 +138,7 @@ export const getInstances = (
       
       
       return customInstance<InstancesGetResponse>(
-      {url: `/instance`, method: 'get',
+      {url: `/instance`, method: 'GET',
         params, signal
     },
       options);
@@ -151,12 +146,11 @@ export const getInstances = (
   
 
 export const getGetInstancesQueryKey = (params?: GetInstancesParams,) => {
-    
     return ["data-manager-api", `/instance`, ...(params ? [params]: [])] as const;
     }
 
     
-export const getGetInstancesQueryOptions = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetInstancesQueryOptions = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -181,7 +175,7 @@ export type GetInstancesQueryError = ErrorType<void | DmError>
  * @summary Get summary information about all Job and Application instances
  */
 export const useGetInstances = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(
- params?: GetInstancesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+ params?: GetInstancesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -196,6 +190,46 @@ export const useGetInstances = <TData = Awaited<ReturnType<typeof getInstances>>
 
 
 
+export const getGetInstancesSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetInstancesQueryKey(params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstances>>> = ({ signal }) => getInstances(params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetInstancesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstances>>>
+export type GetInstancesSuspenseQueryError = ErrorType<void | DmError>
+
+/**
+ * @summary Get summary information about all Job and Application instances
+ */
+export const useGetInstancesSuspense = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(
+ params?: GetInstancesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetInstancesSuspenseQueryOptions(params,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * 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).
 
@@ -234,7 +268,7 @@ if(instancePostBodyBody.specification !== undefined) {
  }
 
       return customInstance<InstanceDryRunPostResponse>(
-      {url: `/instance/dry-run`, method: 'post',
+      {url: `/instance/dry-run`, method: 'POST',
       headers: {'Content-Type': 'multipart/form-data', },
        data: formData
     },
@@ -244,7 +278,6 @@ if(instancePostBodyBody.specification !== undefined) {
 
 
 export const getDryRunInstanceMutationOptions = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError,{data: InstancePostBodyBody}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -271,7 +304,6 @@ export const getDryRunInstanceMutationOptions = <TError = ErrorType<void | DmErr
  * @summary Used to check the execution of new Job or Application instance
  */
 export const useDryRunInstance = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -289,19 +321,18 @@ export const getInstance = (
       
       
       return customInstance<InstanceGetResponse>(
-      {url: `/instance/${instanceId}`, method: 'get', signal
+      {url: `/instance/${instanceId}`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetInstanceQueryKey = (instanceId: string,) => {
-    
     return ["data-manager-api", `/instance/${instanceId}`] as const;
     }
 
     
-export const getGetInstanceQueryOptions = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetInstanceQueryOptions = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -326,7 +357,7 @@ export type GetInstanceQueryError = ErrorType<void | DmError>
  * @summary Get detailed information about an Instance
  */
 export const useGetInstance = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(
- instanceId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+ instanceId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -341,6 +372,46 @@ export const useGetInstance = <TData = Awaited<ReturnType<typeof getInstance>>,
 
 
 
+export const getGetInstanceSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetInstanceQueryKey(instanceId);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstance>>> = ({ signal }) => getInstance(instanceId, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(instanceId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetInstanceSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstance>>>
+export type GetInstanceSuspenseQueryError = ErrorType<void | DmError>
+
+/**
+ * @summary Get detailed information about an Instance
+ */
+export const useGetInstanceSuspense = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(
+ instanceId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetInstanceSuspenseQueryOptions(instanceId,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * The Application or Job Instance is terminated.
 
@@ -354,7 +425,7 @@ export const terminateInstance = (
       
       
       return customInstance<TaskIdentity>(
-      {url: `/instance/${instanceId}`, method: 'delete'
+      {url: `/instance/${instanceId}`, method: 'DELETE'
     },
       options);
     }
@@ -362,7 +433,6 @@ export const terminateInstance = (
 
 
 export const getTerminateInstanceMutationOptions = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError,{instanceId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError,{instanceId: string}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -389,7 +459,6 @@ export const getTerminateInstanceMutationOptions = <TError = ErrorType<void | Dm
  * @summary Delete a Job or Application Instance
  */
 export const useTerminateInstance = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError,{instanceId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -411,7 +480,7 @@ export const patchInstance = (
       
       
       return customInstance<void>(
-      {url: `/instance/${instanceId}`, method: 'patch',
+      {url: `/instance/${instanceId}`, method: 'PATCH',
         params
     },
       options);
@@ -420,7 +489,6 @@ export const patchInstance = (
 
 
 export const getPatchInstanceMutationOptions = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError,{instanceId: string;params?: PatchInstanceParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError,{instanceId: string;params?: PatchInstanceParams}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -447,7 +515,6 @@ export const getPatchInstanceMutationOptions = <TError = ErrorType<DmError>,
  * @summary Update a Job or Application Instance
  */
 export const usePatchInstance = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError,{instanceId: string;params?: PatchInstanceParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -471,7 +538,7 @@ export const deleteInstanceToken = (
       
       
       return customInstance<void>(
-      {url: `/instance/${instanceId}/token/${token}`, method: 'delete'
+      {url: `/instance/${instanceId}/token/${token}`, method: 'DELETE'
     },
       options);
     }
@@ -479,7 +546,6 @@ export const deleteInstanceToken = (
 
 
 export const getDeleteInstanceTokenMutationOptions = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError,{instanceId: string;token: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError,{instanceId: string;token: string}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -506,7 +572,6 @@ export const getDeleteInstanceTokenMutationOptions = <TError = ErrorType<DmError
  * @summary Delete (revoke) the Instance Token
  */
 export const useDeleteInstanceToken = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError,{instanceId: string;token: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 

package/src/inventory/inventory.ts

@@ -0,0 +1,140 @@
+/**
+ * Generated by orval v6.25.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** and **Jobs** using **Projects** and **Files**.
+
+ * OpenAPI spec version: 2.0
+ */
+import {
+  useQuery,
+  useSuspenseQuery
+} from '@tanstack/react-query'
+import type {
+  QueryFunction,
+  QueryKey,
+  UseQueryOptions,
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
+} from '@tanstack/react-query'
+import type {
+  DmError,
+  GetUserInventoryParams,
+  InventoryUserGetResponse
+} from '../data-manager-api.schemas'
+import { customInstance } from '.././custom-instance';
+import type { ErrorType } from '.././custom-instance';
+
+
+type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+
+
+/**
+ * Returns an inventory of users, which includes Projects membership and Datasets they own. An Account Server **Unit** or **Organisation** must be provided (but not both).
+
+The caller must also be a member of the provided Unit or Organisation, i.e. you can only query User inventory if you are a member of the corresponding Account Server Unit or Organisation.
+
+ * @summary Get User Inventory
+ */
+export const getUserInventory = (
+    params?: GetUserInventoryParams,
+ options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
+) => {
+      
+      
+      return customInstance<InventoryUserGetResponse>(
+      {url: `/inventory/user`, method: 'GET',
+        params, signal
+    },
+      options);
+    }
+  
+
+export const getGetUserInventoryQueryKey = (params?: GetUserInventoryParams,) => {
+    return ["data-manager-api", `/inventory/user`, ...(params ? [params]: [])] as const;
+    }
+
+    
+export const getGetUserInventoryQueryOptions = <TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(params?: GetUserInventoryParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetUserInventoryQueryKey(params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getUserInventory>>> = ({ signal }) => getUserInventory(params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetUserInventoryQueryResult = NonNullable<Awaited<ReturnType<typeof getUserInventory>>>
+export type GetUserInventoryQueryError = ErrorType<void | DmError>
+
+/**
+ * @summary Get User Inventory
+ */
+export const useGetUserInventory = <TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
+ params?: GetUserInventoryParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetUserInventoryQueryOptions(params,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+export const getGetUserInventorySuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(params?: GetUserInventoryParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetUserInventoryQueryKey(params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getUserInventory>>> = ({ signal }) => getUserInventory(params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetUserInventorySuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getUserInventory>>>
+export type GetUserInventorySuspenseQueryError = ErrorType<void | DmError>
+
+/**
+ * @summary Get User Inventory
+ */
+export const useGetUserInventorySuspense = <TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
+ params?: GetUserInventoryParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetUserInventorySuspenseQueryOptions(params,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+