@squonk/data-manager-client 1.1.0 → 1.1.1

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

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.10.0 🍺
+ * Generated by orval v6.12.1 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -9,91 +9,253 @@ A service that allows *registered* users to make **Datasets** and associated **M
  * OpenAPI spec version: 1.0
  */
 export type AdminGetServiceErrorsParams = {
+  /**
+ * Set to include acknowledged items
+
+ */
   include_acknowleged?: QIncludeAcknowlegedParameter;
 };
 
 export type GetUserApiLogParams = {
+  /**
+ * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
+
+ */
   from?: QFromParameter;
+  /**
+ * An until (exclusive) date-time. If provided only API calls made before this will be returned. UTC is assumed if no timezone is provided
+
+ */
   until?: QUntilParameter;
 };
 
 export type GetUserAccountParams = {
+  /**
+ * Set, if you're an admin, to call the endpoint without impersonation
+
+ */
   do_not_impersonate?: QDoNotImpersonateParameter;
 };
 
-export type PatchInstanceParams = { archive?: QInstanceArchiveParameter };
+export type PatchInstanceParams = {
+  /**
+   * True to archive the instance
+   */
+  archive?: QInstanceArchiveParameter;
+};
 
-export type GetInstancesParams = { project_id?: QProjectIdParameter };
+export type GetInstancesParams = {
+  /**
+   * A Project identity
+   */
+  project_id?: QProjectIdParameter;
+};
 
-export type GetJobExchangeRatesParams = { current?: QCurrentParameter };
+export type GetJobExchangeRatesParams = {
+  /**
+ * Set to get current
+
+ */
+  current?: QCurrentParameter;
+};
 
 export type GetAllJobExchangeRatesParams = {
+  /**
+ * Only return records where the exchange rate is undefined
+
+ */
   only_undefined?: QOnlyUndefinedParameter;
 };
 
-export type GetJobParams = { project_id?: QProjectIdParameter };
+export type GetJobParams = {
+  /**
+   * A Project identity
+   */
+  project_id?: QProjectIdParameter;
+};
 
 export type GetJobByVersionParams = {
+  /**
+ * The Collection for a Job, i.e. "im-test"
+
+ */
   collection: QJobCollectionParameter;
+  /**
+ * The Job, i.e. "nop"
+
+ */
   job: QJobJobParameter;
+  /**
+ * The version of a Job, i.e. "1.0.0"
+
+ */
   version: QJobVersionParameter;
+  /**
+   * A Project identity
+   */
   project_id?: QProjectIdParameter;
 };
 
-export type GetJobsParams = { project_id?: QProjectIdParameter };
+export type GetJobsParams = {
+  /**
+   * A Project identity
+   */
+  project_id?: QProjectIdParameter;
+};
 
-export type GetApplicationExchangeRatesParams = { current?: QCurrentParameter };
+export type GetApplicationExchangeRatesParams = {
+  /**
+ * Set to get current
+
+ */
+  current?: QCurrentParameter;
+};
 
 export type GetAllApplicationExchangeRatesParams = {
+  /**
+ * Only return records where the exchange rate is undefined
+
+ */
   only_undefined?: QOnlyUndefinedParameter;
 };
 
 export type GetTaskParams = {
+  /**
+ * Maximum number of events to return. If provided, can be 1 or more.
+
+ */
   event_limit?: QEventLimitParameter;
+  /**
+ * 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.
+
+ */
   event_prior_ordinal?: QEventPriorOrdinalParameter;
 };
 
 export type GetTasksParams = {
+  /**
+ * Set true if you want to exclude 'done' tasks, i.e. just see those that are still running.
+
+ */
   exclude_done?: QExcludeDoneParameter;
+  /**
+ * 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`
+
+ */
   exclude_purpose?: QExcludePurposeParameter;
+  /**
+   * A Project identity
+   */
   project_id?: QProjectIdParameter;
 };
 
 export type DeleteUnmanagedFileParams = {
+  /**
+ * A project file.
+
+ */
   file: QFileParameter;
+  /**
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+
+ */
   path?: QFilePathParameter;
+  /**
+   * The Project identity
+   */
   project_id: QFileProjectIdParameter;
 };
 
 export type GetFilesParams = {
+  /**
+   * The Project identity
+   */
   project_id: QFileProjectIdParameter;
+  /**
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+
+ */
   path?: QFilePathParameter;
+  /**
+   * Whether to include hidden files and directories
+   */
   include_hidden?: QIncludeHiddenParameter;
 };
 
 export type DeleteDatasetParams = {
+  /**
+ * Whether to convert Project managed file instances to unmanaged files
+
+ */
   keep_project_files?: QKeepProjectFilesParameter;
 };
 
-export type GetVersionsParams = { include_deleted?: QIncludeDeletedParameter };
+export type GetVersionsParams = {
+  /**
+   * Whether to include records that are deleted
+   */
+  include_deleted?: QIncludeDeletedParameter;
+};
 
 export type GetDatasetsParams = {
+  /**
+   * Whether to include records that are deleted
+   */
   include_deleted?: QIncludeDeletedParameter;
+  /**
+ * Filter the datasets by username
+
+ */
   username?: QUsernameParameter;
+  /**
+ * Filter the datasets by the supplied mime_type.
+
+ */
   dataset_mime_type?: QDatasetMimeTypeParameter;
+  /**
+ * Filter the datasets by a comma separated list of owners
+
+ */
   owners?: QOwnersParameter;
+  /**
+ * Filter the datasets by a comma separated list of editors
+
+ */
   editors?: QEditorsParameter;
+  /**
+ * 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"}'
+
+ */
   labels?: QLabelsParameter;
 };
 
 export type GetProjectFileWithTokenParams = {
+  /**
+   * A token
+   */
   token?: QTokenParameter;
+  /**
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+
+ */
   path?: QFilePathParameter;
+  /**
+ * A project file.
+
+ */
   file: QFileParameter;
 };
 
 export type GetProjectFileParams = {
+  /**
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+
+ */
   path?: QFilePathParameter;
+  /**
+ * A project file.
+
+ */
   file: QFileParameter;
 };
 
@@ -542,7 +704,7 @@ export interface UserAccountDetail {
 
  */
 export type TypeSummaryFormatterOptionsType =
-  typeof TypeSummaryFormatterOptionsType[keyof typeof TypeSummaryFormatterOptionsType];
+  (typeof TypeSummaryFormatterOptionsType)[keyof typeof TypeSummaryFormatterOptionsType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const TypeSummaryFormatterOptionsType = {
@@ -589,7 +751,7 @@ export interface TypeSummary {
 
  */
 export type TaskSummaryProcessingStage =
-  typeof TaskSummaryProcessingStage[keyof typeof TaskSummaryProcessingStage];
+  (typeof TaskSummaryProcessingStage)[keyof typeof TaskSummaryProcessingStage];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const TaskSummaryProcessingStage = {
@@ -638,7 +800,8 @@ export interface TaskSummary {
  * The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
 
  */
-export type TaskStateState = typeof TaskStateState[keyof typeof TaskStateState];
+export type TaskStateState =
+  (typeof TaskStateState)[keyof typeof TaskStateState];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const TaskStateState = {
@@ -669,7 +832,8 @@ export interface TaskIdentity {
  * The level of the message, a typical logging framework value
 
  */
-export type TaskEventLevel = typeof TaskEventLevel[keyof typeof TaskEventLevel];
+export type TaskEventLevel =
+  (typeof TaskEventLevel)[keyof typeof TaskEventLevel];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const TaskEventLevel = {
@@ -696,7 +860,7 @@ export interface TaskEvent {
 }
 
 export type ServiceErrorSummarySeverity =
-  typeof ServiceErrorSummarySeverity[keyof typeof ServiceErrorSummarySeverity];
+  (typeof ServiceErrorSummarySeverity)[keyof typeof ServiceErrorSummarySeverity];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ServiceErrorSummarySeverity = {
@@ -782,6 +946,17 @@ export interface ProjectDetail {
   files?: ProjectFileDetail[];
 }
 
+export interface JobReplacement {
+  collection: string;
+  job: string;
+}
+
+/**
+ * A list of Jobs, collection and job that are either replacing or being replaced
+
+ */
+export type JobReplacements = JobReplacement[];
+
 export interface JobOrderDetail {
   options: string[];
 }
@@ -806,7 +981,7 @@ export interface JobVariables {
 
  */
 export type JobSummaryImageType =
-  typeof JobSummaryImageType[keyof typeof JobSummaryImageType];
+  (typeof JobSummaryImageType)[keyof typeof JobSummaryImageType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const JobSummaryImageType = {
@@ -862,6 +1037,8 @@ export interface JobSummary {
 Where there is no remedy for a given reason the remedy will be "There is no remedy".
  */
   disabled_remedy?: string;
+  replaces?: JobReplacements;
+  replaced_by?: JobReplacements;
 }
 
 export interface JobManifestDetail {
@@ -905,7 +1082,7 @@ export interface JobApplication {
 
  */
 export type InstanceSummaryJobImageType =
-  typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
+  (typeof InstanceSummaryJobImageType)[keyof typeof InstanceSummaryJobImageType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceSummaryJobImageType = {
@@ -919,7 +1096,7 @@ The initial phase, indicating that the Instance is preparing to run, is `PENDING
 
  */
 export type InstanceSummaryPhase =
-  typeof InstanceSummaryPhase[keyof typeof InstanceSummaryPhase];
+  (typeof InstanceSummaryPhase)[keyof typeof InstanceSummaryPhase];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceSummaryPhase = {
@@ -938,7 +1115,7 @@ export const InstanceSummaryPhase = {
 
  */
 export type InstanceSummaryApplicationType =
-  typeof InstanceSummaryApplicationType[keyof typeof InstanceSummaryApplicationType];
+  (typeof InstanceSummaryApplicationType)[keyof typeof InstanceSummaryApplicationType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceSummaryApplicationType = {
@@ -1094,7 +1271,7 @@ export type DatasetVersionSummaryLabels = { [key: string]: any };
 
  */
 export type DatasetVersionSummaryProcessingStage =
-  typeof DatasetVersionSummaryProcessingStage[keyof typeof DatasetVersionSummaryProcessingStage];
+  (typeof DatasetVersionSummaryProcessingStage)[keyof typeof DatasetVersionSummaryProcessingStage];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const DatasetVersionSummaryProcessingStage = {
@@ -1171,7 +1348,7 @@ export type DatasetVersionDetailLabels = { [key: string]: any };
 
  */
 export type DatasetVersionDetailProcessingStage =
-  typeof DatasetVersionDetailProcessingStage[keyof typeof DatasetVersionDetailProcessingStage];
+  (typeof DatasetVersionDetailProcessingStage)[keyof typeof DatasetVersionDetailProcessingStage];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const DatasetVersionDetailProcessingStage = {
@@ -1290,7 +1467,7 @@ export interface ApplicationImageVariants {
 
  */
 export type ApiLogDetailMethod =
-  typeof ApiLogDetailMethod[keyof typeof ApiLogDetailMethod];
+  (typeof ApiLogDetailMethod)[keyof typeof ApiLogDetailMethod];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ApiLogDetailMethod = {
@@ -1364,7 +1541,7 @@ export interface TasksGetResponse {
 
  */
 export type TaskGetResponsePurpose =
-  typeof TaskGetResponsePurpose[keyof typeof TaskGetResponsePurpose];
+  (typeof TaskGetResponsePurpose)[keyof typeof TaskGetResponsePurpose];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const TaskGetResponsePurpose = {
@@ -1439,7 +1616,7 @@ export interface JobsGetResponse {
 
  */
 export type JobGetResponseImageType =
-  typeof JobGetResponseImageType[keyof typeof JobGetResponseImageType];
+  (typeof JobGetResponseImageType)[keyof typeof JobGetResponseImageType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const JobGetResponseImageType = {
@@ -1516,10 +1693,12 @@ export interface JobGetResponse {
 Where there is no remedy for a given reason the remedy will be "There is no remedy".
  */
   disabled_remedy?: string;
+  replaces?: JobReplacements;
+  replaced_by?: JobReplacements;
 }
 
 export type InstanceTaskPurpose =
-  typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
+  (typeof InstanceTaskPurpose)[keyof typeof InstanceTaskPurpose];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceTaskPurpose = {
@@ -1541,7 +1720,7 @@ export interface InstancesGetResponse {
 
  */
 export type InstanceGetResponseJobImageType =
-  typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
+  (typeof InstanceGetResponseJobImageType)[keyof typeof InstanceGetResponseJobImageType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceGetResponseJobImageType = {
@@ -1555,7 +1734,7 @@ The initial phase, indicating that the Instance is preparing to run, is `PENDING
 
  */
 export type InstanceGetResponsePhase =
-  typeof InstanceGetResponsePhase[keyof typeof InstanceGetResponsePhase];
+  (typeof InstanceGetResponsePhase)[keyof typeof InstanceGetResponsePhase];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceGetResponsePhase = {
@@ -1574,7 +1753,7 @@ export const InstanceGetResponsePhase = {
 
  */
 export type InstanceGetResponseApplicationType =
-  typeof InstanceGetResponseApplicationType[keyof typeof InstanceGetResponseApplicationType];
+  (typeof InstanceGetResponseApplicationType)[keyof typeof InstanceGetResponseApplicationType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const InstanceGetResponseApplicationType = {
@@ -1764,7 +1943,7 @@ export type DatasetVersionDeleteResponse = TaskIdentity;
 
  */
 export type DatasetSchemaGetResponseType =
-  typeof DatasetSchemaGetResponseType[keyof typeof DatasetSchemaGetResponseType];
+  (typeof DatasetSchemaGetResponseType)[keyof typeof DatasetSchemaGetResponseType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const DatasetSchemaGetResponseType = {

package/src/dataset/dataset.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.10.0 🍺
+ * Generated by orval v6.12.1 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -33,6 +33,7 @@ import type {
 } from "../data-manager-api.schemas";
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";
+import { queryMutator } from ".././queryMutator";
 
 // eslint-disable-next-line
 type SecondParameter<T extends (...args: any) => any> = T extends (
@@ -267,15 +268,15 @@ export const useGetDatasets = <
     signal,
   }) => getDatasets(params, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof getDatasets>>,
     TError,
     TData
-  >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
-  };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };
@@ -333,16 +334,15 @@ export const useGetVersions = <
     signal,
   }) => getVersions(datasetId, params, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof getVersions>>,
     TError,
     TData
-  >(queryKey, queryFn, {
-    enabled: !!datasetId,
-    ...queryOptions,
-  }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };
@@ -462,16 +462,15 @@ export const useDownloadDataset = <
     signal,
   }) => downloadDataset(datasetId, datasetVersion, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof downloadDataset>>,
     TError,
     TData
-  >(queryKey, queryFn, {
-    enabled: !!(datasetId && datasetVersion),
-    ...queryOptions,
-  }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };
@@ -636,16 +635,15 @@ export const useGetDatasetDigest = <
     Awaited<ReturnType<typeof getDatasetDigest>>
   > = ({ signal }) => getDatasetDigest(datasetDigest, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof getDatasetDigest>>,
     TError,
     TData
-  >(queryKey, queryFn, {
-    enabled: !!datasetDigest,
-    ...queryOptions,
-  }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };
@@ -705,13 +703,13 @@ export const useGetSchema = <
     signal,
   }) => getSchema(datasetId, datasetVersion, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<Awaited<ReturnType<typeof getSchema>>, TError, TData>(
-    queryKey,
-    queryFn,
-    { enabled: !!(datasetId && datasetVersion), ...queryOptions }
+    customOptions
   ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };

package/src/exchange-rate/exchange-rate.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.10.0 🍺
+ * Generated by orval v6.12.1 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -29,6 +29,7 @@ import type {
 } from "../data-manager-api.schemas";
 import { customInstance } from ".././custom-instance";
 import type { ErrorType } from ".././custom-instance";
+import { queryMutator } from ".././queryMutator";
 
 // eslint-disable-next-line
 type SecondParameter<T extends (...args: any) => any> = T extends (
@@ -90,15 +91,15 @@ export const useGetAllApplicationExchangeRates = <
   > = ({ signal }) =>
     getAllApplicationExchangeRates(params, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof getAllApplicationExchangeRates>>,
     TError,
     TData
-  >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
-  };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };
@@ -231,16 +232,15 @@ export const useGetApplicationExchangeRates = <
   > = ({ signal }) =>
     getApplicationExchangeRates(applicationId, params, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof getApplicationExchangeRates>>,
     TError,
     TData
-  >(queryKey, queryFn, {
-    enabled: !!applicationId,
-    ...queryOptions,
-  }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };
@@ -293,15 +293,15 @@ export const useGetAllJobExchangeRates = <
     Awaited<ReturnType<typeof getAllJobExchangeRates>>
   > = ({ signal }) => getAllJobExchangeRates(params, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof getAllJobExchangeRates>>,
     TError,
     TData
-  >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
-  };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };
@@ -425,16 +425,15 @@ export const useGetJobExchangeRates = <
   > = ({ signal }) =>
     getJobExchangeRates(jobId, params, requestOptions, signal);
 
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
   const query = useQuery<
     Awaited<ReturnType<typeof getJobExchangeRates>>,
     TError,
     TData
-  >(queryKey, queryFn, { enabled: !!jobId, ...queryOptions }) as UseQueryResult<
-    TData,
-    TError
-  > & { queryKey: QueryKey };
+  >(customOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
-  query.queryKey = queryKey;
+  query.queryKey = customOptions.queryKey;
 
   return query;
 };