@squonk/data-manager-client 4.3.0 → 5.0.0-5-0.2173777171

package/src/accounting/accounting.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
 
- * OpenAPI spec version: 4.1
+ * OpenAPI spec version: 5.0
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -28,7 +28,7 @@ import type {
   AccountServerGetRegistrationResponse,
   DmError,
   VersionGetResponse,
-} from "../data-manager-api.schemas";
+} from "../API_TARGET_NAME.schemas";
 
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";
@@ -912,3 +912,245 @@ export function useGetWorkflowEngineVersionSuspense<
 
   return query;
 }
+
+/**
+ * @summary Gets the Data Manager Job Definition Schema version that's running behind the API
+ */
+export const getJobDefinitionSchemaVersion = (
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal,
+) => {
+  return customInstance<VersionGetResponse>(
+    { url: `/job-definition-schema/version`, method: "GET", signal },
+    options,
+  );
+};
+
+export const getGetJobDefinitionSchemaVersionQueryKey = () => {
+  return [`/job-definition-schema/version`] as const;
+};
+
+export const useGetJobDefinitionSchemaVersionQueryOptions = <
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(options?: {
+  query?: Partial<
+    UseQueryOptions<Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>, TError, TData>
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetJobDefinitionSchemaVersionQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>> = ({
+    signal,
+  }) => getJobDefinitionSchemaVersion(requestOptions, signal);
+
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
+  return customOptions as UseQueryOptions<
+    Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetJobDefinitionSchemaVersionQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>
+>;
+export type GetJobDefinitionSchemaVersionQueryError = ErrorType<void | DmError>;
+
+export function useGetJobDefinitionSchemaVersion<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options: {
+    query: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>, TError, TData>
+    > &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+          TError,
+          Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetJobDefinitionSchemaVersion<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>, TError, TData>
+    > &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+          TError,
+          Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetJobDefinitionSchemaVersion<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets the Data Manager Job Definition Schema version that's running behind the API
+ */
+
+export function useGetJobDefinitionSchemaVersion<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = useGetJobDefinitionSchemaVersionQueryOptions(options);
+
+  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+  };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}
+
+export const useGetJobDefinitionSchemaVersionSuspenseQueryOptions = <
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(options?: {
+  query?: Partial<
+    UseSuspenseQueryOptions<
+      Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+      TError,
+      TData
+    >
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetJobDefinitionSchemaVersionQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>> = ({
+    signal,
+  }) => getJobDefinitionSchemaVersion(requestOptions, signal);
+
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
+  return customOptions as UseSuspenseQueryOptions<
+    Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetJobDefinitionSchemaVersionSuspenseQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>
+>;
+export type GetJobDefinitionSchemaVersionSuspenseQueryError = ErrorType<void | DmError>;
+
+export function useGetJobDefinitionSchemaVersionSuspense<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options: {
+    query: Partial<
+      UseSuspenseQueryOptions<
+        Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+        TError,
+        TData
+      >
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetJobDefinitionSchemaVersionSuspense<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<
+        Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+        TError,
+        TData
+      >
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetJobDefinitionSchemaVersionSuspense<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<
+        Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+        TError,
+        TData
+      >
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets the Data Manager Job Definition Schema version that's running behind the API
+ */
+
+export function useGetJobDefinitionSchemaVersionSuspense<
+  TData = Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+  TError = ErrorType<void | DmError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<
+        Awaited<ReturnType<typeof getJobDefinitionSchemaVersion>>,
+        TError,
+        TData
+      >
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = useGetJobDefinitionSchemaVersionSuspenseQueryOptions(options);
+
+  const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
+    TData,
+    TError
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}

package/src/admin/admin.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
 
- * OpenAPI spec version: 4.1
+ * OpenAPI spec version: 5.0
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -38,7 +38,7 @@ import type {
   ServiceErrorsGetResponse,
   UserAccountDetail,
   UserPatchBodyBody,
-} from "../data-manager-api.schemas";
+} from "../API_TARGET_NAME.schemas";
 
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";
@@ -1159,6 +1159,8 @@ export function useAdminGetJobManifestsSuspense<
 /**
  * This endpoint is used to add (or update an existing **Job Manifest**). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.
 
+A URL to a manifest is typically its RAW location, something that (for GitHub) begins with `https://raw.githubusercontent.com/` followed by your repository (`InformaticsMatters/virtual-screening`) and then the reference to a **Manifest** file, like `/main/data-manager/manifest-im-virtual-screening.yaml`. For public GitHub repositories you are unlikely to need to provide a `header` or `params`.
+
 A limited number of manifest origins (URLs) are supported. At the moment we support basic GitHib and GitLab URLs, i.e. those that begin `https://raw.githubusercontent.com/` and `https://gitlab.com/api/v4/projects/`.
 
 You will need `admin` rights to use this endpoint

package/src/application/application.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
 
- * OpenAPI spec version: 4.1
+ * OpenAPI spec version: 5.0
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -27,7 +27,7 @@ import type {
   ApplicationGetResponse,
   ApplicationsGetResponse,
   DmError,
-} from "../data-manager-api.schemas";
+} from "../API_TARGET_NAME.schemas";
 
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";

package/src/configuration/configuration.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
 
- * OpenAPI spec version: 4.1
+ * OpenAPI spec version: 5.0
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -23,11 +23,7 @@ import type {
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
 
-import type {
-  DmError,
-  InputHandlerGetResponse,
-  ModeGetResponse,
-} from "../data-manager-api.schemas";
+import type { DmError, InputHandlerGetResponse, ModeGetResponse } from "../API_TARGET_NAME.schemas";
 
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";
@@ -36,7 +32,7 @@ import { queryMutator } from ".././options-mutator";
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 /**
- * @summary Gets the Data Manager mode that's running behind the API
+ * @summary Gets the Data Manager API mode
  */
 export const getMode = (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => {
   return customInstance<ModeGetResponse>({ url: `/mode`, method: "GET", signal }, options);
@@ -117,7 +113,7 @@ export function useGetMode<
   queryClient?: QueryClient,
 ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
- * @summary Gets the Data Manager mode that's running behind the API
+ * @summary Gets the Data Manager API mode
  */
 
 export function useGetMode<
@@ -198,7 +194,7 @@ export function useGetModeSuspense<
   queryClient?: QueryClient,
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
- * @summary Gets the Data Manager mode that's running behind the API
+ * @summary Gets the Data Manager API mode
  */
 
 export function useGetModeSuspense<

package/src/dataset/dataset.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
 
- * OpenAPI spec version: 4.1
+ * OpenAPI spec version: 5.0
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -38,7 +38,7 @@ import type {
   GetDatasetsParams,
   GetVersionsParams,
   TaskIdentity,
-} from "../data-manager-api.schemas";
+} from "../API_TARGET_NAME.schemas";
 
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";

package/src/digest/digest.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
 
- * OpenAPI spec version: 4.1
+ * OpenAPI spec version: 5.0
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -23,7 +23,7 @@ import type {
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
 
-import type { DatasetDigestGetResponse, DmError } from "../data-manager-api.schemas";
+import type { DatasetDigestGetResponse, DmError } from "../API_TARGET_NAME.schemas";
 
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";