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

package/src/application/application.ts

@@ -1,21 +1,24 @@
 /**
- * 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 {
-  useQuery
+  useQuery,
+  useSuspenseQuery
 } from '@tanstack/react-query'
 import type {
   QueryFunction,
   QueryKey,
   UseQueryOptions,
-  UseQueryResult
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
 } from '@tanstack/react-query'
 import type {
   ApplicationGetResponse,
@@ -26,13 +29,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];
 
 
 /**
@@ -49,19 +46,18 @@ export const getApplications = (
       
       
       return customInstance<ApplicationsGetResponse>(
-      {url: `/application`, method: 'get', signal
+      {url: `/application`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetApplicationsQueryKey = () => {
-    
     return ["data-manager-api", `/application`] as const;
     }
 
     
-export const getGetApplicationsQueryOptions = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetApplicationsQueryOptions = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -86,7 +82,7 @@ export type GetApplicationsQueryError = ErrorType<DmError>
  * @summary Get all Applications available to you
  */
 export const useGetApplications = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
-  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -101,6 +97,46 @@ export const useGetApplications = <TData = Awaited<ReturnType<typeof getApplicat
 
 
 
+export const getGetApplicationsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetApplicationsQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({ signal }) => getApplications(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetApplicationsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getApplications>>>
+export type GetApplicationsSuspenseQueryError = ErrorType<DmError>
+
+/**
+ * @summary Get all Applications available to you
+ */
+export const useGetApplicationsSuspense = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetApplicationsSuspenseQueryOptions(options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * Get details of a specific Application available to you that can be instantiated.
 
@@ -113,19 +149,18 @@ export const getApplication = (
       
       
       return customInstance<ApplicationGetResponse>(
-      {url: `/application/${applicationId}`, method: 'get', signal
+      {url: `/application/${applicationId}`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetApplicationQueryKey = (applicationId: string,) => {
-    
     return ["data-manager-api", `/application/${applicationId}`] as const;
     }
 
     
-export const getGetApplicationQueryOptions = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(applicationId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetApplicationQueryOptions = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(applicationId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -150,7 +185,7 @@ export type GetApplicationQueryError = ErrorType<void | DmError>
  * @summary Get details of a specific Application
  */
 export const useGetApplication = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
- applicationId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+ applicationId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -165,3 +200,43 @@ export const useGetApplication = <TData = Awaited<ReturnType<typeof getApplicati
 
 
 
+export const getGetApplicationSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(applicationId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetApplicationQueryKey(applicationId);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({ signal }) => getApplication(applicationId, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(applicationId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetApplicationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getApplication>>>
+export type GetApplicationSuspenseQueryError = ErrorType<void | DmError>
+
+/**
+ * @summary Get details of a specific Application
+ */
+export const useGetApplicationSuspense = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
+ applicationId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetApplicationSuspenseQueryOptions(applicationId,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+

package/src/configuration/configuration.ts

@@ -1,21 +1,24 @@
 /**
- * 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 {
-  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,13 +1,29 @@
 /**
- * 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
  */
+export type GetUserInventoryParams = {
+/**
+ * An Organisation identity
+ */
+org_id?: QOrgIdParameter;
+/**
+ * A Unit identity
+ */
+unit_id?: QUnitIdParameter;
+/**
+ * A comma-separated list of usernames
+
+ */
+usernames?: QUsernamesParameter;
+};
+
 export type AdminDeleteJobManifestParams = {
 /**
  * Purge unreferenced Jobs
@@ -242,12 +258,12 @@ username?: QUsernameParameter;
  */
 dataset_mime_type?: QDatasetMimeTypeParameter;
 /**
- * Filter the datasets by a comma separated list of owners
+ * A comma-separated list of owners
 
  */
 owners?: QOwnersParameter;
 /**
- * Filter the datasets by a comma separated list of editors
+ * A comma-separated list of editors
 
  */
 editors?: QEditorsParameter;
@@ -320,7 +336,7 @@ path?: QFilePathParameter;
 };
 
 /**
- * Filter the datasets by a comma separated list of editors
+ * A comma-separated list of editors
 
  */
 export type QEditorsParameter = string;
@@ -331,11 +347,17 @@ export type QEditorsParameter = string;
 export type QPurgeParameter = boolean;
 
 /**
- * Filter the datasets by a comma separated list of owners
+ * A comma-separated list of owners
 
  */
 export type QOwnersParameter = string;
 
+/**
+ * A comma-separated list of usernames
+
+ */
+export type QUsernamesParameter = string;
+
 /**
  * Filter the datasets by username
 
@@ -348,6 +370,11 @@ export type QUsernameParameter = string;
  */
 export type QUntilParameter = string;
 
+/**
+ * A Unit identity
+ */
+export type QUnitIdParameter = string;
+
 /**
  * A token
  */
@@ -368,6 +395,11 @@ export type QProjectNameParameter = string;
  */
 export type QProjectIdParameter = string;
 
+/**
+ * An Organisation identity
+ */
+export type QOrgIdParameter = string;
+
 /**
  * JSON string containing a list of label/value pairs for the datasets to be filtered by. If the value is set to null, then only the label is matched. If both the label and value are set, then both are matched. e.g. '{"label1": null, "label2": "value2"}'
 
@@ -1010,7 +1042,12 @@ export interface ProjectFileDetail {
 }
 
 export interface ProjectDetail {
+  /** An administrator (user_id) of the project */
+  administrators: string[];
   created: string;
+  /** The user who created the project
+ */
+  creator: string;
   /** An editor (user_id) of the project */
   editors: string[];
   /** A list of managed files in the Project
@@ -1024,10 +1061,7 @@ export interface ProjectDetail {
   /** The Account Server Organisation the Project Product Unit belongs to
  */
   organisation_id?: string;
-  /** The project (owner) creator
- */
-  owner: string;
-  /** True if the project is private. Private projects are only visible to the owner and its editors.
+  /** True if the project is private. Private projects are only visible to editors.
  */
   private: boolean;
   /** The Account Server Product the Project belongs to
@@ -1643,6 +1677,24 @@ export interface UserApiLogGetResponse {
   api_log: ApiLogDetail[];
 }
 
+export interface UserActivityDetail {
+  /** A list of dates where the API has been used during the monitoring period. Dates are returned if when the activity is not 100% and active dates are present. Dates are listed in reverse chronological order (i.e. the most recent first)
+ */
+  active_dates?: string[];
+  /** The number of days the API has been used
+ */
+  active_days: number;
+  /** Active days, as a percentage, over the monitoring period.
+ */
+  activity: string;
+  /** The number of days the API has not been used
+ */
+  inactive_days: number;
+  /** The period over which the activity is monitored
+ */
+  monitoring_period: string;
+}
+
 export type UserAccountGetResponse = UserAccountDetail;
 
 export interface TypesGetResponse {
@@ -1732,6 +1784,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 +1852,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;
@@ -1818,6 +1876,40 @@ Where there is no remedy for a given reason the remedy will be "There is no reme
   version: string;
 }
 
+export interface InventoryProjectDetail {
+  id: string;
+  name: string;
+  unit_id: string;
+}
+
+export interface InventoryDatasetDetail {
+  filename: string;
+  id: string;
+  unit_id: string;
+  version: number;
+}
+
+export type InventoryUserDetailProjects = {
+  administrator: InventoryProjectDetail[];
+  editor: InventoryProjectDetail[];
+  observer: InventoryProjectDetail[];
+};
+
+export type InventoryUserDetailDatasets = {
+  editor?: InventoryDatasetDetail[];
+  owner?: InventoryDatasetDetail[];
+};
+
+export interface InventoryUserDetail {
+  activity: UserActivityDetail;
+  datasets: InventoryUserDetailDatasets;
+  f_uid: number;
+  first_seen: string;
+  last_seen_date: string;
+  projects: InventoryUserDetailProjects;
+  username: string;
+}
+
 export type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
 
 
@@ -2085,10 +2177,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 +2202,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;
@@ -2191,6 +2287,12 @@ export interface AdminJobManifestLoadPutResponse {
   status: boolean;
 }
 
+export interface InventoryUserGetResponse {
+  /** The list of known Users
+ */
+  users: InventoryUserDetail[];
+}
+
 export interface AdminJobManifestGetResponse {
   /** The list of known Job manifests
  */