@squonk/data-manager-client 0.7.12-rc.1 → 0.7.13

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

@@ -25,17 +25,11 @@ export type PatchInstanceParams = { archive?: QInstanceArchiveParameter };
 
 export type GetInstancesParams = { project_id?: QProjectIdParameter };
 
-/**
- * The ordinal of a previously received event. If set, only events subsequent to the ordinal provided will be returned. Providing a value of 0 will result in retrieving the first and subsequent events.
-
- */
-export type QEventPriorOrdinalParameter = number;
-
-/**
- * Maximum number of events to return. If provided, can be 1 or more.
-
- */
-export type QEventLimitParameter = number;
+export type GetJobByNameParams = {
+  collection: QJobCollectionParameter;
+  name: QJobNameParameter;
+  version: QJobVersionParameter;
+};
 
 export type GetTaskParams = {
   event_limit?: QEventLimitParameter;
@@ -48,6 +42,12 @@ export type GetTasksParams = {
   project_id?: QProjectIdParameter;
 };
 
+/**
+ * A project file.
+
+ */
+export type QFileParameter = string;
+
 export type DeleteUnmanagedFileParams = {
   file: QFileParameter;
   path?: QFilePathParameter;
@@ -66,12 +66,6 @@ export type DeleteDatasetParams = {
 
 export type GetVersionsParams = { include_deleted?: QIncludeDeletedParameter };
 
-/**
- * Filter the datasets by the supplied mime_type.
-
- */
-export type QDatasetMimeTypeParameter = string;
-
 export type GetDatasetsParams = {
   include_deleted?: QIncludeDeletedParameter;
   username?: QUsernameParameter;
@@ -132,6 +126,24 @@ export type QProjectIdParameter = string;
  */
 export type QLabelsParameter = string;
 
+/**
+ * The version of a Job, i.e. "1.0.0"
+
+ */
+export type QJobVersionParameter = string;
+
+/**
+ * The name of a Job, i.e. "nop"
+
+ */
+export type QJobNameParameter = string;
+
+/**
+ * The Collection for a Job, i.e. "im-test"
+
+ */
+export type QJobCollectionParameter = string;
+
 /**
  * Whether to convert Project managed file instances to unmanged files
 
@@ -176,12 +188,6 @@ export type QFileProjectIdParameter = string;
  */
 export type QFilePathParameter = string;
 
-/**
- * A project file.
-
- */
-export type QFileParameter = string;
-
 /**
  * Set to a dot-separated string of purpose enumerations, i.e. `INSTANCE`, `FILE` or `DATASET`. To exclude file and dataset tasks set to `FILE.DATASET`
 
@@ -194,6 +200,24 @@ export type QExcludePurposeParameter = string;
  */
 export type QExcludeDoneParameter = boolean;
 
+/**
+ * The ordinal of a previously received event. If set, only events subsequent to the ordinal provided will be returned. Providing a value of 0 will result in retrieving the first and subsequent events.
+
+ */
+export type QEventPriorOrdinalParameter = number;
+
+/**
+ * Maximum number of events to return. If provided, can be 1 or more.
+
+ */
+export type QEventLimitParameter = number;
+
+/**
+ * Filter the datasets by the supplied mime_type.
+
+ */
+export type QDatasetMimeTypeParameter = string;
+
 /**
  * Set, if you're an admin, to call the endpoint without impersonation
 
@@ -952,6 +976,9 @@ export interface DatasetVersionSummary {
   /** The version of the dataset
    */
   version: number;
+  /** The name of the Pod handling the creation of the Dataset
+   */
+  creator_pod_name?: string;
   /** The processign stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
    */
   processing_stage: DatasetVersionSummaryProcessingStage;
@@ -1029,6 +1056,9 @@ export interface DatasetVersionDetail {
   /** The version of the dataset
    */
   version: number;
+  /** The name of the Pod handling the creation of the Dataset
+   */
+  creator_pod_name?: string;
   /** The processign stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
    */
   processing_stage: DatasetVersionDetailProcessingStage;

package/src/job/job.ts

@@ -19,6 +19,7 @@ import type {
   JobsGetResponse,
   DmError,
   JobGetResponse,
+  GetJobByNameParams,
 } from "../data-manager-api.schemas";
 import { customInstance, ErrorType } from ".././custom-instance";
 
@@ -85,6 +86,68 @@ export const useGetJobs = <
   };
 };
 
+/**
+ * Gets a Job based on the **name**, its **collection** and **version**.
+
+Job availability will vary as Jobs are added to the cluster.
+
+ * @summary Get a Job by name (collection and version)
+ */
+export const getJobByName = (
+  params?: GetJobByNameParams,
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal
+) => {
+  return customInstance<JobGetResponse>(
+    { url: `/job/get-by-name`, method: "get", signal, params },
+    options
+  );
+};
+
+export const getGetJobByNameQueryKey = (params?: GetJobByNameParams) => [
+  `/job/get-by-name`,
+  ...(params ? [params] : []),
+];
+
+export type GetJobByNameQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getJobByName>>
+>;
+export type GetJobByNameQueryError = ErrorType<DmError>;
+
+export const useGetJobByName = <
+  TData = Awaited<ReturnType<typeof getJobByName>>,
+  TError = ErrorType<DmError>
+>(
+  params?: GetJobByNameParams,
+  options?: {
+    query?: UseQueryOptions<
+      Awaited<ReturnType<typeof getJobByName>>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetJobByNameQueryKey(params);
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getJobByName>>> = ({
+    signal,
+  }) => getJobByName(params, requestOptions, signal);
+
+  const query = useQuery<
+    Awaited<ReturnType<typeof getJobByName>>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
 /**
  * Get details of a specific job available to you that can be instantiated.
 

package/task/task.d.ts

@@ -1,6 +1,6 @@
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
-import { e as GetTasksParams, bd as customInstance, aD as TasksGetResponse, be as ErrorType, b9 as DmError, d as GetTaskParams, aF as TaskGetResponse } from '../custom-instance-da4fff1f.js';
+import { e as GetTasksParams, bh as customInstance, aH as TasksGetResponse, bi as ErrorType, bd as DmError, d as GetTaskParams, aJ as TaskGetResponse } from '../custom-instance-da28e834.js';
 import 'axios';
 
 declare type AwaitedInput<T> = PromiseLike<T> | T;

package/type/type.d.ts

@@ -1,5 +1,5 @@
 import { UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
-import { bd as customInstance, aC as TypesGetResponse, be as ErrorType, b9 as DmError } from '../custom-instance-da4fff1f.js';
+import { bh as customInstance, aG as TypesGetResponse, bi as ErrorType, bd as DmError } from '../custom-instance-da28e834.js';
 import 'axios';
 
 /**

package/user/user.d.ts

@@ -1,6 +1,6 @@
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
-import { bd as customInstance, az as UsersGetResponse, be as ErrorType, b9 as DmError, a as GetUserAccountParams, Y as UserAccountDetail, I as UserAccountPatchBodyBody, G as GetUserApiLogParams, aA as UserApiLogGetResponse } from '../custom-instance-da4fff1f.js';
+import { bh as customInstance, aD as UsersGetResponse, bi as ErrorType, bd as DmError, a as GetUserAccountParams, a0 as UserAccountDetail, M as UserAccountPatchBodyBody, G as GetUserApiLogParams, aE as UserApiLogGetResponse } from '../custom-instance-da28e834.js';
 import 'axios';
 
 declare type AwaitedInput<T> = PromiseLike<T> | T;