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

package/src/file-and-path/file-and-path.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 {
   CreatePathParams,
@@ -34,19 +37,13 @@ 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];
 
 
 /**
  * Creates a new Path within a Project. Every directory in the Path will be created. The path will belong to the User and Project.
 
-Only Project owners or editors can create Paths.
+Only Project editors can create Paths.
 
  * @summary Create a new Project Path
  */
@@ -56,7 +53,7 @@ export const createPath = (
       
       
       return customInstance<void>(
-      {url: `/path`, method: 'put',
+      {url: `/path`, method: 'PUT',
         params
     },
       options);
@@ -65,7 +62,6 @@ export const createPath = (
 
 
 export const getCreatePathMutationOptions = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError,{params: CreatePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError,{params: CreatePathParams}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -92,7 +88,6 @@ export const getCreatePathMutationOptions = <TError = ErrorType<DmError>,
  * @summary Create a new Project Path
  */
 export const useCreatePath = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError,{params: CreatePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -103,7 +98,7 @@ export const useCreatePath = <TError = ErrorType<DmError>,
     /**
  * Deletes a Path within the Project. Be aware that the deletion of a Path will result in te contents of the Path also being deleted. If There are files in Path or sub-directories, they will all be deleted.
 
-Only Project owners or editors can delete Paths.
+Only Project editors can delete Paths.
 
  * @summary Delete a Project Path
  */
@@ -113,7 +108,7 @@ export const deletePath = (
       
       
       return customInstance<void>(
-      {url: `/path`, method: 'delete',
+      {url: `/path`, method: 'DELETE',
         params
     },
       options);
@@ -122,7 +117,6 @@ export const deletePath = (
 
 
 export const getDeletePathMutationOptions = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError,{params: DeletePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError,{params: DeletePathParams}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -149,7 +143,6 @@ export const getDeletePathMutationOptions = <TError = ErrorType<DmError>,
  * @summary Delete a Project Path
  */
 export const useDeletePath = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError,{params: DeletePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -169,7 +162,7 @@ export const getFiles = (
       
       
       return customInstance<FilesGetResponse>(
-      {url: `/file`, method: 'get',
+      {url: `/file`, method: 'GET',
         params, signal
     },
       options);
@@ -177,12 +170,11 @@ export const getFiles = (
   
 
 export const getGetFilesQueryKey = (params: GetFilesParams,) => {
-    
     return ["data-manager-api", `/file`, ...(params ? [params]: [])] as const;
     }
 
     
-export const getGetFilesQueryOptions = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetFilesQueryOptions = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -207,7 +199,7 @@ export type GetFilesQueryError = ErrorType<void | DmError>
  * @summary Gets the Files on a Project Path
  */
 export const useGetFiles = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(
- params: GetFilesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+ params: GetFilesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -222,6 +214,46 @@ export const useGetFiles = <TData = Awaited<ReturnType<typeof getFiles>>, TError
 
 
 
+export const getGetFilesSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetFilesQueryKey(params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getFiles>>> = ({ signal }) => getFiles(params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetFilesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getFiles>>>
+export type GetFilesSuspenseQueryError = ErrorType<void | DmError>
+
+/**
+ * @summary Gets the Files on a Project Path
+ */
+export const useGetFilesSuspense = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(
+ params: GetFilesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetFilesSuspenseQueryOptions(params,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * Given a Project and a Dataset the Dataset will be attached (added) to the project as a File using the format provided. When attached the Dataset is referred to as a Project **File**. As format conversion may take some time the file may not be immediately available. You should use the `task_id` you're presented with on the `/task` endpoint to determine when the file is available to the project.
 
@@ -229,7 +261,7 @@ Only Datasets attached to projects are available through the Project API. A Data
 
 An `editor` of a **dataset** is not automatically and `editor` of the **project** it's attached to.
 
-You must be an `editor` or the `owner` of the project to attach a Dataset to a project. Being an `editor` of the Dataset you are attaching does not give you the ability to detach it from the Project.
+You must be an `editor` of the Project to attach a Dataset to a project. Being an `editor` of the Dataset you are attaching does not give you the ability to detach it from the Project.
 
 You cannot add a Dataset to a Project until its upload is complete.
 
@@ -255,7 +287,7 @@ if(filePostBodyBody.immutable !== undefined) {
  }
 
       return customInstance<FilePostResponse>(
-      {url: `/file`, method: 'post',
+      {url: `/file`, method: 'POST',
       headers: {'Content-Type': 'multipart/form-data', },
        data: formData
     },
@@ -265,7 +297,6 @@ if(filePostBodyBody.immutable !== undefined) {
 
 
 export const getAttachFileMutationOptions = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError,{data: FilePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError,{data: FilePostBodyBody}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -292,7 +323,6 @@ export const getAttachFileMutationOptions = <TError = ErrorType<void | DmError>,
  * @summary Attach a Dataset, as a File, to a Project
  */
 export const useAttachFile = <TError = ErrorType<void | DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError,{data: FilePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -303,7 +333,7 @@ export const useAttachFile = <TError = ErrorType<void | DmError>,
     /**
  * Removes an unmanaged file from a Project. You cannot use this endpoint to delete managed project files.
 
-You must be an `editor` or the `owner` of the project to delete a file from a project.
+You must be an `editor` of the Project to delete a file from a Project.
 
  * @summary Delete an unmanaged Project File
  */
@@ -313,7 +343,7 @@ export const deleteUnmanagedFile = (
       
       
       return customInstance<void>(
-      {url: `/file`, method: 'delete',
+      {url: `/file`, method: 'DELETE',
         params
     },
       options);
@@ -322,7 +352,6 @@ export const deleteUnmanagedFile = (
 
 
 export const getDeleteUnmanagedFileMutationOptions = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError,{params: DeleteUnmanagedFileParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError,{params: DeleteUnmanagedFileParams}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -349,7 +378,6 @@ export const getDeleteUnmanagedFileMutationOptions = <TError = ErrorType<DmError
  * @summary Delete an unmanaged Project File
  */
 export const useDeleteUnmanagedFile = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError,{params: DeleteUnmanagedFileParams}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -360,7 +388,7 @@ export const useDeleteUnmanagedFile = <TError = ErrorType<DmError>,
     /**
  * Given a `file_id` the file will be removed from the Project it's attached to.
 
-You must be an `editor` or the `owner` of the project to delete a file from a Project. Being an `editor` of the original Dataset does not give you the ability to detach it from the Project.
+You must be an `editor` of the project to delete a file from a Project. Being an `editor` of the original Dataset does not give you the ability to detach it from the Project.
 
 You cannot delete a Project File until the attach is complete.
 
@@ -372,7 +400,7 @@ export const deleteFile = (
       
       
       return customInstance<void>(
-      {url: `/file/${fileId}`, method: 'delete'
+      {url: `/file/${fileId}`, method: 'DELETE'
     },
       options);
     }
@@ -380,7 +408,6 @@ export const deleteFile = (
 
 
 export const getDeleteFileMutationOptions = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError,{fileId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError,{fileId: string}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -407,7 +434,6 @@ export const getDeleteFileMutationOptions = <TError = ErrorType<DmError>,
  * @summary Delete/detach a File (from a Project)
  */
 export const useDeleteFile = <TError = ErrorType<DmError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError,{fileId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -429,19 +455,18 @@ export const downloadFile = (
       
       
       return customInstance<void>(
-      {url: `/file/${fileId}`, method: 'get', signal
+      {url: `/file/${fileId}`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getDownloadFileQueryKey = (fileId: string,) => {
-    
     return ["data-manager-api", `/file/${fileId}`] as const;
     }
 
     
-export const getDownloadFileQueryOptions = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(fileId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getDownloadFileQueryOptions = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(fileId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -466,7 +491,7 @@ export type DownloadFileQueryError = ErrorType<DmError>
  * @summary Download a File (from a project)
  */
 export const useDownloadFile = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(
- fileId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+ fileId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -481,3 +506,43 @@ export const useDownloadFile = <TData = Awaited<ReturnType<typeof downloadFile>>
 
 
 
+export const getDownloadFileSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(fileId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getDownloadFileQueryKey(fileId);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof downloadFile>>> = ({ signal }) => downloadFile(fileId, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(fileId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type DownloadFileSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadFile>>>
+export type DownloadFileSuspenseQueryError = ErrorType<DmError>
+
+/**
+ * @summary Download a File (from a project)
+ */
+export const useDownloadFileSuspense = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(
+ fileId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getDownloadFileSuspenseQueryOptions(fileId,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+