@squonk/data-manager-client 1.2.8 → 1.2.9

package/src/configuration/configuration.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v6.25.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -9,13 +9,16 @@ A service that allows *registered* users to make **Datasets** and associated **M
  * OpenAPI spec version: 1.2
  */
 import {
-  useQuery
+  useQuery,
+  useSuspenseQuery
 } from '@tanstack/react-query'
 import type {
   QueryFunction,
   QueryKey,
   UseQueryOptions,
-  UseQueryResult
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
 } from '@tanstack/react-query'
 import type {
   DmError,
@@ -25,13 +28,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];
 
 
 /**
@@ -44,19 +41,18 @@ export const getMode = (
       
       
       return customInstance<ModeGetResponse>(
-      {url: `/mode`, method: 'get', signal
+      {url: `/mode`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetModeQueryKey = () => {
-    
     return ["data-manager-api", `/mode`] as const;
     }
 
     
-export const getGetModeQueryOptions = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetModeQueryOptions = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -81,7 +77,7 @@ export type GetModeQueryError = ErrorType<void | DmError>
  * @summary Gets the Data Manager mode that's running behind the API
  */
 export const useGetMode = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
-  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -96,3 +92,43 @@ export const useGetMode = <TData = Awaited<ReturnType<typeof getMode>>, TError =
 
 
 
+export const getGetModeSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetModeQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getMode>>> = ({ signal }) => getMode(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetModeSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getMode>>>
+export type GetModeSuspenseQueryError = ErrorType<void | DmError>
+
+/**
+ * @summary Gets the Data Manager mode that's running behind the API
+ */
+export const useGetModeSuspense = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetModeSuspenseQueryOptions(options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+

package/src/custom-instance.ts

@@ -39,10 +39,9 @@ export const customInstance = <TReturn>(
     ({ data }) => data,
   );
 
-  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.
-  // This can either be a any assertion or a @ts-ignore comment.
-  (promise as any).cancel = () => {
-    source.cancel('Query was cancelled by React Query');
+  // @ts-expect-error need to add a cancel method to the promise
+  promise.cancel = () => {
+    source.cancel('Query was cancelled');
   };
 
   return promise;

package/src/data-manager-api.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v6.25.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -28,6 +28,12 @@ idle_days?: QIdleDaysParameter;
 active_days?: QActiveDaysParameter;
 };
 
+/**
+ * Set to include acknowledged items
+
+ */
+export type QIncludeAcknowlegedParameter = boolean;
+
 export type AdminGetServiceErrorsParams = {
 /**
  * Set to include acknowledged items
@@ -36,6 +42,12 @@ export type AdminGetServiceErrorsParams = {
 include_acknowleged?: QIncludeAcknowlegedParameter;
 };
 
+/**
+ * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
+
+ */
+export type QFromParameter = string;
+
 export type GetUserApiLogParams = {
 /**
  * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
@@ -153,6 +165,11 @@ event_prior_ordinal?: QEventPriorOrdinalParameter;
 };
 
 export type GetTasksParams = {
+/**
+ * Set to limit the response to objects relating to the named purpose.
+
+ */
+purpose?: QPurposeParameter;
 /**
  * Set true if you want to exclude 'done' tasks, i.e. just see those that are still running.
 
@@ -178,6 +195,23 @@ project_id?: QProjectIdParameter;
 instance_callback_context?: QInstanceCallbackContextParameter;
 };
 
+/**
+ * The Project identity
+ */
+export type QFileProjectIdParameter = string;
+
+/**
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+
+ */
+export type QFilePathParameter = string;
+
+/**
+ * A project file.
+
+ */
+export type QFileParameter = string;
+
 export type DeleteUnmanagedFileParams = {
 /**
  * A project file.
@@ -425,35 +459,6 @@ export type QIncludeHiddenParameter = boolean;
  */
 export type QIncludeDeletedParameter = boolean;
 
-/**
- * Set to include acknowledged items
-
- */
-export type QIncludeAcknowlegedParameter = boolean;
-
-/**
- * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
-
- */
-export type QFromParameter = string;
-
-/**
- * The Project identity
- */
-export type QFileProjectIdParameter = string;
-
-/**
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
-
- */
-export type QFilePathParameter = string;
-
-/**
- * A project file.
-
- */
-export type QFileParameter = string;
-
 /**
  * Minimum days a user has been active (has used the API). If you specify `2` and it's Monday then users who have used the API on Saturday or later will be returned.
 
@@ -466,6 +471,17 @@ export type QActiveDaysParameter = number;
  */
 export type QIdleDaysParameter = number;
 
+export type QPurposeParameter = typeof QPurposeParameter[keyof typeof QPurposeParameter];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const QPurposeParameter = {
+  DATASET: 'DATASET',
+  FILE: 'FILE',
+  INSTANCE: 'INSTANCE',
+  PROJECT: 'PROJECT',
+} as const;
+
 /**
  * Set to a dot-separated string of purpose enumerations, i.e. `DATASET`, `FILE`, `INSTANCE`, or `PROJECT`. To exclude file and dataset tasks set this field to `FILE.DATASET`
 
@@ -1732,6 +1748,12 @@ export interface JobsGetResponse {
   jobs: JobSummary[];
 }
 
+/**
+ * The directory used as the container image working directory (if defined)
+
+ */
+export type JobGetResponseImageWorkingDirectory = {};
+
 /**
  * The optional container image type. Typically a single-container `SIMPLE` (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
 
@@ -1794,7 +1816,7 @@ Where there is no remedy for a given reason the remedy will be "There is no reme
   image_type?: JobGetResponseImageType;
   /** The directory used as the container image working directory (if defined)
  */
-  image_working_directory?: unknown;
+  image_working_directory?: JobGetResponseImageWorkingDirectory;
   /** The Job name, unique within a given collection
  */
   job: string;
@@ -2085,10 +2107,14 @@ export interface DatasetSchemaGetResponse {
   [key: string]: any;
  }
 
+export type DatasetMetaGetResponseLabelsItem = {};
+
+export type DatasetMetaGetResponseAnnotationsItem = {};
+
 export interface DatasetMetaGetResponse {
   /** The Metadata's annotations
  */
-  annotations: unknown[];
+  annotations: DatasetMetaGetResponseAnnotationsItem[];
   /** The date and time of creation
  */
   created: string;
@@ -2106,7 +2132,7 @@ export interface DatasetMetaGetResponse {
   description: string;
   /** The Metadata's labels
  */
-  labels: unknown[];
+  labels: DatasetMetaGetResponseLabelsItem[];
   /** The date and time it was last updated
  */
   last_updated: string;