@squonk/data-manager-client 0.7.10 → 0.7.11-rc.3

package/src/project/project.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.7.1 🍺
+ * Generated by orval v6.8.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -28,15 +28,13 @@ import type {
   ProjectDeleteResponse,
   GetProjectFileParams,
   ProjectFilePutBodyBody,
+  GetProjectFileWithTokenParams,
 } from "../data-manager-api.schemas";
 import { customInstance, ErrorType } from ".././custom-instance";
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
-  ...args: any
-) => Promise<infer R>
-  ? R
-  : any;
+export type AwaitedInput<T> = PromiseLike<T> | T;
+
+export type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type SecondParameter<T extends (...args: any) => any> = T extends (
@@ -52,10 +50,11 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
  * @summary Get all projects available to you
  */
 export const getProjects = (
-  options?: SecondParameter<typeof customInstance>
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal
 ) => {
   return customInstance<ProjectsGetResponse>(
-    { url: `/project`, method: "get" },
+    { url: `/project`, method: "get", signal },
     options
   );
 };
@@ -63,29 +62,34 @@ export const getProjects = (
 export const getGetProjectsQueryKey = () => [`/project`];
 
 export type GetProjectsQueryResult = NonNullable<
-  AsyncReturnType<typeof getProjects>
+  Awaited<ReturnType<typeof getProjects>>
 >;
 export type GetProjectsQueryError = ErrorType<void | DmError>;
 
 export const useGetProjects = <
-  TData = AsyncReturnType<typeof getProjects>,
+  TData = Awaited<ReturnType<typeof getProjects>>,
   TError = ErrorType<void | DmError>
 >(options?: {
-  query?: UseQueryOptions<AsyncReturnType<typeof getProjects>, TError, TData>;
+  query?: UseQueryOptions<
+    Awaited<ReturnType<typeof getProjects>>,
+    TError,
+    TData
+  >;
   request?: SecondParameter<typeof customInstance>;
 }): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-  const { query: queryOptions, request: requestOptions } = options || {};
+  const { query: queryOptions, request: requestOptions } = options ?? {};
 
   const queryKey = queryOptions?.queryKey ?? getGetProjectsQueryKey();
 
-  const queryFn: QueryFunction<AsyncReturnType<typeof getProjects>> = () =>
-    getProjects(requestOptions);
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getProjects>>> = ({
+    signal,
+  }) => getProjects(requestOptions, signal);
 
-  const query = useQuery<AsyncReturnType<typeof getProjects>, TError, TData>(
-    queryKey,
-    queryFn,
-    queryOptions
-  );
+  const query = useQuery<
+    Awaited<ReturnType<typeof getProjects>>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
 
   return {
     queryKey,
@@ -129,7 +133,7 @@ export const createProject = (
 };
 
 export type CreateProjectMutationResult = NonNullable<
-  AsyncReturnType<typeof createProject>
+  Awaited<ReturnType<typeof createProject>>
 >;
 export type CreateProjectMutationBody = ProjectPostBodyBody;
 export type CreateProjectMutationError = ErrorType<DmError | void>;
@@ -139,26 +143,26 @@ export const useCreateProject = <
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<
-    AsyncReturnType<typeof createProject>,
+    Awaited<ReturnType<typeof createProject>>,
     TError,
     { data: ProjectPostBodyBody },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
 
   const mutationFn: MutationFunction<
-    AsyncReturnType<typeof createProject>,
+    Awaited<ReturnType<typeof createProject>>,
     { data: ProjectPostBodyBody }
   > = (props) => {
-    const { data } = props || {};
+    const { data } = props ?? {};
 
     return createProject(data, requestOptions);
   };
 
   return useMutation<
-    AsyncReturnType<typeof createProject>,
+    Awaited<ReturnType<typeof createProject>>,
     TError,
     { data: ProjectPostBodyBody },
     TContext
@@ -171,10 +175,11 @@ export const useCreateProject = <
  */
 export const getProject = (
   projectId: string,
-  options?: SecondParameter<typeof customInstance>
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal
 ) => {
   return customInstance<ProjectGetResponse>(
-    { url: `/project/${projectId}`, method: "get" },
+    { url: `/project/${projectId}`, method: "get", signal },
     options
   );
 };
@@ -184,28 +189,33 @@ export const getGetProjectQueryKey = (projectId: string) => [
 ];
 
 export type GetProjectQueryResult = NonNullable<
-  AsyncReturnType<typeof getProject>
+  Awaited<ReturnType<typeof getProject>>
 >;
 export type GetProjectQueryError = ErrorType<void | DmError>;
 
 export const useGetProject = <
-  TData = AsyncReturnType<typeof getProject>,
+  TData = Awaited<ReturnType<typeof getProject>>,
   TError = ErrorType<void | DmError>
 >(
   projectId: string,
   options?: {
-    query?: UseQueryOptions<AsyncReturnType<typeof getProject>, TError, TData>;
+    query?: UseQueryOptions<
+      Awaited<ReturnType<typeof getProject>>,
+      TError,
+      TData
+    >;
     request?: SecondParameter<typeof customInstance>;
   }
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-  const { query: queryOptions, request: requestOptions } = options || {};
+  const { query: queryOptions, request: requestOptions } = options ?? {};
 
   const queryKey = queryOptions?.queryKey ?? getGetProjectQueryKey(projectId);
 
-  const queryFn: QueryFunction<AsyncReturnType<typeof getProject>> = () =>
-    getProject(projectId, requestOptions);
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getProject>>> = ({
+    signal,
+  }) => getProject(projectId, requestOptions, signal);
 
-  const query = useQuery<AsyncReturnType<typeof getProject>, TError, TData>(
+  const query = useQuery<Awaited<ReturnType<typeof getProject>>, TError, TData>(
     queryKey,
     queryFn,
     { enabled: !!projectId, ...queryOptions }
@@ -247,7 +257,7 @@ export const patchProject = (
 };
 
 export type PatchProjectMutationResult = NonNullable<
-  AsyncReturnType<typeof patchProject>
+  Awaited<ReturnType<typeof patchProject>>
 >;
 export type PatchProjectMutationBody = ProjectPatchBodyBody;
 export type PatchProjectMutationError = ErrorType<DmError>;
@@ -257,26 +267,26 @@ export const usePatchProject = <
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<
-    AsyncReturnType<typeof patchProject>,
+    Awaited<ReturnType<typeof patchProject>>,
     TError,
     { projectId: string; data: ProjectPatchBodyBody },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
 
   const mutationFn: MutationFunction<
-    AsyncReturnType<typeof patchProject>,
+    Awaited<ReturnType<typeof patchProject>>,
     { projectId: string; data: ProjectPatchBodyBody }
   > = (props) => {
-    const { projectId, data } = props || {};
+    const { projectId, data } = props ?? {};
 
     return patchProject(projectId, data, requestOptions);
   };
 
   return useMutation<
-    AsyncReturnType<typeof patchProject>,
+    Awaited<ReturnType<typeof patchProject>>,
     TError,
     { projectId: string; data: ProjectPatchBodyBody },
     TContext
@@ -302,7 +312,7 @@ export const deleteProject = (
 };
 
 export type DeleteProjectMutationResult = NonNullable<
-  AsyncReturnType<typeof deleteProject>
+  Awaited<ReturnType<typeof deleteProject>>
 >;
 
 export type DeleteProjectMutationError = ErrorType<void | DmError>;
@@ -312,26 +322,26 @@ export const useDeleteProject = <
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<
-    AsyncReturnType<typeof deleteProject>,
+    Awaited<ReturnType<typeof deleteProject>>,
     TError,
     { projectId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
 
   const mutationFn: MutationFunction<
-    AsyncReturnType<typeof deleteProject>,
+    Awaited<ReturnType<typeof deleteProject>>,
     { projectId: string }
   > = (props) => {
-    const { projectId } = props || {};
+    const { projectId } = props ?? {};
 
     return deleteProject(projectId, requestOptions);
   };
 
   return useMutation<
-    AsyncReturnType<typeof deleteProject>,
+    Awaited<ReturnType<typeof deleteProject>>,
     TError,
     { projectId: string },
     TContext
@@ -358,7 +368,7 @@ export const addEditorToProject = (
 };
 
 export type AddEditorToProjectMutationResult = NonNullable<
-  AsyncReturnType<typeof addEditorToProject>
+  Awaited<ReturnType<typeof addEditorToProject>>
 >;
 
 export type AddEditorToProjectMutationError = ErrorType<DmError>;
@@ -368,26 +378,26 @@ export const useAddEditorToProject = <
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<
-    AsyncReturnType<typeof addEditorToProject>,
+    Awaited<ReturnType<typeof addEditorToProject>>,
     TError,
     { projectId: string; userId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
 
   const mutationFn: MutationFunction<
-    AsyncReturnType<typeof addEditorToProject>,
+    Awaited<ReturnType<typeof addEditorToProject>>,
     { projectId: string; userId: string }
   > = (props) => {
-    const { projectId, userId } = props || {};
+    const { projectId, userId } = props ?? {};
 
     return addEditorToProject(projectId, userId, requestOptions);
   };
 
   return useMutation<
-    AsyncReturnType<typeof addEditorToProject>,
+    Awaited<ReturnType<typeof addEditorToProject>>,
     TError,
     { projectId: string; userId: string },
     TContext
@@ -414,7 +424,7 @@ export const removeEditorFromProject = (
 };
 
 export type RemoveEditorFromProjectMutationResult = NonNullable<
-  AsyncReturnType<typeof removeEditorFromProject>
+  Awaited<ReturnType<typeof removeEditorFromProject>>
 >;
 
 export type RemoveEditorFromProjectMutationError = ErrorType<DmError>;
@@ -424,26 +434,26 @@ export const useRemoveEditorFromProject = <
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<
-    AsyncReturnType<typeof removeEditorFromProject>,
+    Awaited<ReturnType<typeof removeEditorFromProject>>,
     TError,
     { projectId: string; userId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
 
   const mutationFn: MutationFunction<
-    AsyncReturnType<typeof removeEditorFromProject>,
+    Awaited<ReturnType<typeof removeEditorFromProject>>,
     { projectId: string; userId: string }
   > = (props) => {
-    const { projectId, userId } = props || {};
+    const { projectId, userId } = props ?? {};
 
     return removeEditorFromProject(projectId, userId, requestOptions);
   };
 
   return useMutation<
-    AsyncReturnType<typeof removeEditorFromProject>,
+    Awaited<ReturnType<typeof removeEditorFromProject>>,
     TError,
     { projectId: string; userId: string },
     TContext
@@ -461,10 +471,11 @@ You must be an `editor` or the `owner` of the project if the project is private
 export const getProjectFile = (
   projectId: string,
   params?: GetProjectFileParams,
-  options?: SecondParameter<typeof customInstance>
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal
 ) => {
   return customInstance<void>(
-    { url: `/project/${projectId}/file`, method: "get", params },
+    { url: `/project/${projectId}/file`, method: "get", signal, params },
     options
   );
 };
@@ -475,38 +486,39 @@ export const getGetProjectFileQueryKey = (
 ) => [`/project/${projectId}/file`, ...(params ? [params] : [])];
 
 export type GetProjectFileQueryResult = NonNullable<
-  AsyncReturnType<typeof getProjectFile>
+  Awaited<ReturnType<typeof getProjectFile>>
 >;
 export type GetProjectFileQueryError = ErrorType<DmError>;
 
 export const useGetProjectFile = <
-  TData = AsyncReturnType<typeof getProjectFile>,
+  TData = Awaited<ReturnType<typeof getProjectFile>>,
   TError = ErrorType<DmError>
 >(
   projectId: string,
   params?: GetProjectFileParams,
   options?: {
     query?: UseQueryOptions<
-      AsyncReturnType<typeof getProjectFile>,
+      Awaited<ReturnType<typeof getProjectFile>>,
       TError,
       TData
     >;
     request?: SecondParameter<typeof customInstance>;
   }
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-  const { query: queryOptions, request: requestOptions } = options || {};
+  const { query: queryOptions, request: requestOptions } = options ?? {};
 
   const queryKey =
     queryOptions?.queryKey ?? getGetProjectFileQueryKey(projectId, params);
 
-  const queryFn: QueryFunction<AsyncReturnType<typeof getProjectFile>> = () =>
-    getProjectFile(projectId, params, requestOptions);
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getProjectFile>>> = ({
+    signal,
+  }) => getProjectFile(projectId, params, requestOptions, signal);
 
-  const query = useQuery<AsyncReturnType<typeof getProjectFile>, TError, TData>(
-    queryKey,
-    queryFn,
-    { enabled: !!projectId, ...queryOptions }
-  );
+  const query = useQuery<
+    Awaited<ReturnType<typeof getProjectFile>>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!projectId, ...queryOptions });
 
   return {
     queryKey,
@@ -547,7 +559,7 @@ export const addFileToProject = (
 };
 
 export type AddFileToProjectMutationResult = NonNullable<
-  AsyncReturnType<typeof addFileToProject>
+  Awaited<ReturnType<typeof addFileToProject>>
 >;
 export type AddFileToProjectMutationBody = ProjectFilePutBodyBody;
 export type AddFileToProjectMutationError = ErrorType<DmError>;
@@ -557,28 +569,101 @@ export const useAddFileToProject = <
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<
-    AsyncReturnType<typeof addFileToProject>,
+    Awaited<ReturnType<typeof addFileToProject>>,
     TError,
     { projectId: string; data: ProjectFilePutBodyBody },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
 
   const mutationFn: MutationFunction<
-    AsyncReturnType<typeof addFileToProject>,
+    Awaited<ReturnType<typeof addFileToProject>>,
     { projectId: string; data: ProjectFilePutBodyBody }
   > = (props) => {
-    const { projectId, data } = props || {};
+    const { projectId, data } = props ?? {};
 
     return addFileToProject(projectId, data, requestOptions);
   };
 
   return useMutation<
-    AsyncReturnType<typeof addFileToProject>,
+    Awaited<ReturnType<typeof addFileToProject>>,
     TError,
     { projectId: string; data: ProjectFilePutBodyBody },
     TContext
   >(mutationFn, mutationOptions);
 };
+/**
+ * Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).
+
+For **managed** files you should consider using the `/file/{file_id}` endpoint.
+
+As there is no security You must provide a valid token. The token must be a token valid for the project, usually generted when an Instance has been launched in the Project. If the token is not valid ou will receive a `403` error
+
+ * @summary Download a project file using a token
+ */
+export const getProjectFileWithToken = (
+  projectId: string,
+  params?: GetProjectFileWithTokenParams,
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal
+) => {
+  return customInstance<void>(
+    {
+      url: `/project/${projectId}/file-with-token`,
+      method: "get",
+      signal,
+      params,
+    },
+    options
+  );
+};
+
+export const getGetProjectFileWithTokenQueryKey = (
+  projectId: string,
+  params?: GetProjectFileWithTokenParams
+) => [`/project/${projectId}/file-with-token`, ...(params ? [params] : [])];
+
+export type GetProjectFileWithTokenQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getProjectFileWithToken>>
+>;
+export type GetProjectFileWithTokenQueryError = ErrorType<DmError>;
+
+export const useGetProjectFileWithToken = <
+  TData = Awaited<ReturnType<typeof getProjectFileWithToken>>,
+  TError = ErrorType<DmError>
+>(
+  projectId: string,
+  params?: GetProjectFileWithTokenParams,
+  options?: {
+    query?: UseQueryOptions<
+      Awaited<ReturnType<typeof getProjectFileWithToken>>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey =
+    queryOptions?.queryKey ??
+    getGetProjectFileWithTokenQueryKey(projectId, params);
+
+  const queryFn: QueryFunction<
+    Awaited<ReturnType<typeof getProjectFileWithToken>>
+  > = ({ signal }) =>
+    getProjectFileWithToken(projectId, params, requestOptions, signal);
+
+  const query = useQuery<
+    Awaited<ReturnType<typeof getProjectFileWithToken>>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!projectId, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
+  };
+};