@squonk/data-manager-client 4.1.0 → 4.2.0

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

@@ -53,6 +53,14 @@ export type AdminGetServiceErrorsParams = {
 include_acknowledged?: QIncludeAcknowledgedParameter;
 };
 
+export type GetRunningWorkflowsParams = {
+/**
+ * A workflow ID
+
+ */
+workflow_id?: QWorkflowIdParameter;
+};
+
 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
@@ -82,10 +90,18 @@ archive?: QInstanceArchiveParameter;
 };
 
 export type GetInstancesParams = {
+/**
+ * An Organisation identity
+ */
+org_id?: QOrgIdParameter;
 /**
  * A Project identity
  */
 project_id?: QProjectIdParameter;
+/**
+ * A Unit identity
+ */
+unit_id?: QUnitIdParameter;
 };
 
 export type GetJobExchangeRatesParams = {
@@ -190,10 +206,18 @@ exclude_removal?: QExcludeRemovalParameter;
 
  */
 exclude_purpose?: QExcludePurposeParameter;
+/**
+ * An Organisation identity
+ */
+org_id?: QOrgIdParameter;
 /**
  * A Project identity
  */
 project_id?: QProjectIdParameter;
+/**
+ * A Unit identity
+ */
+unit_id?: QUnitIdParameter;
 /**
  * An instance callback context string
  */
@@ -385,6 +409,12 @@ project_id: QFileProjectIdParameter;
 path?: QFilePathParameter;
 };
 
+/**
+ * A workflow ID
+
+ */
+export type QWorkflowIdParameter = string;
+
 /**
  * A comma-separated list of editors
 
@@ -1278,6 +1308,23 @@ export interface RunningWorkflowWorkflow {
   name?: string;
 }
 
+/**
+ * The processing stage.
+
+ */
+export type ProjectFileDetailProcessingStage = typeof ProjectFileDetailProcessingStage[keyof typeof ProjectFileDetailProcessingStage];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ProjectFileDetailProcessingStage = {
+  COPYING: 'COPYING',
+  FAILED: 'FAILED',
+  FORMATTING: 'FORMATTING',
+  LOADING: 'LOADING',
+  DELETING: 'DELETING',
+  DONE: 'DONE',
+} as const;
+
 export interface ProjectFileDetail {
   /** The code obtained from the Account Server
  */
@@ -1297,6 +1344,9 @@ export interface ProjectFileDetail {
   /** The ProjectFile's path within the Project volume
  */
   file_path: string;
+  /** The processing stage.
+ */
+  processing_stage?: ProjectFileDetailProcessingStage;
   /** True if the ProjectFile cannot be modified while in the Project
  */
   immutable: boolean;
@@ -2043,9 +2093,17 @@ export interface RunningWorkflowSummary {
   /** The name attached to this running workflow
  */
   name: string;
+  error_num?: number;
+  error_msg?: string;
   /** The status of the running workflow */
-  status?: RunningWorkflowSummaryStatus;
-  workflow?: RunningWorkflowWorkflow;
+  status: RunningWorkflowSummaryStatus;
+  /** The date and time the running workflow was started */
+  started?: string;
+  /** The date and time the running workflow was stopped
+ */
+  stopped?: string;
+  workflow: RunningWorkflowWorkflow;
+  project: RunningWorkflowProject;
 }
 
 export interface PriorRunningWorkflowStep {
@@ -2066,13 +2124,19 @@ export interface WorkflowVersionPutResponse {
   id: string;
 }
 
+/**
+ * The step specification
+
+ */
+export type WorkflowStepSummarySpecification = { [key: string]: unknown };
+
 export interface WorkflowStepSummary {
   /** The name of the step
  */
   name: string;
-  /** The JSON string representation of the step specification
+  /** The step specification
  */
-  specification: string;
+  specification: WorkflowStepSummarySpecification;
 }
 
 export interface WorkflowRunPostResponse {
@@ -2085,6 +2149,11 @@ export interface WorkflowDefinitionGetResponse {
   definition: string;
 }
 
+/**
+ * The workflow control variables
+ */
+export type WorkflowGetResponseVariables = { [key: string]: unknown };
+
 /**
  * The scope of the workflow.
  */
@@ -2131,6 +2200,8 @@ export interface WorkflowGetResponse {
   /** A list of validation errors. Only present if the workflow has been validated and errors were found.
  */
   validation_error_msg?: string[];
+  /** The workflow control variables */
+  variables?: WorkflowGetResponseVariables;
   /** The steps, if the Workflow has been validated and has no errors.
  */
   steps?: WorkflowStepSummary[];
@@ -2196,7 +2267,7 @@ export interface WorkflowGetAllResponse {
 }
 
 export interface VersionGetResponse {
-  /** The Data Manager version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined
+  /** A Data Manager version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined
  */
   version: string;
 }

package/src/instance/instance.ts

@@ -143,6 +143,8 @@ export const useCreateInstance = <TData = Awaited<ReturnType<typeof createInstan
     /**
  * Returns a summary of all running instances. Instances can be running as an Application or as a Job. The response will contain an `application_type` field that is either `job` or `application`
 
+Results can be filtered by **Project**, **Unit** or **Organisation**.
+
  * @summary Get summary information about all Job and Application instances
  */
 export const getInstances = (

package/src/workflow/workflow.ts

@@ -31,6 +31,7 @@ import type {
 } from '@tanstack/react-query'
 import type {
   DmError,
+  GetRunningWorkflowsParams,
   RunningWorkflowGetAllResponse,
   RunningWorkflowGetResponse,
   RunningWorkflowStepsGetResponse,
@@ -847,36 +848,39 @@ export const useVersionWorkflow = <TData = Awaited<ReturnType<typeof versionWork
     /**
  * Get a list of all Running Workflows available to you. The Running Workflows are listed in chronological order of the start time, where the first that was executed is the first in the list.
 
+By providing a workflow ID you will only see Running Workflows for that Workflow.
+
  * @summary Get all Running Workflows available to you
  */
 export const getRunningWorkflows = (
-    
+    params?: GetRunningWorkflowsParams,
  options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
 ) => {
       
       
       return customInstance<RunningWorkflowGetAllResponse>(
-      {url: `/running-workflow`, method: 'GET', signal
+      {url: `/running-workflow`, method: 'GET',
+        params, signal
     },
       options);
     }
   
 
-export const getGetRunningWorkflowsQueryKey = () => {
-    return ["data-manager-api", `/running-workflow`] as const;
+export const getGetRunningWorkflowsQueryKey = (params?: GetRunningWorkflowsParams,) => {
+    return ["data-manager-api", `/running-workflow`, ...(params ? [params]: [])] as const;
     }
 
     
-export const getGetRunningWorkflowsQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export const getGetRunningWorkflowsQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
 
-  const queryKey =  queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey();
+  const queryKey =  queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey(params);
 
   
 
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) => getRunningWorkflows(requestOptions, signal);
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) => getRunningWorkflows(params, requestOptions, signal);
 
       
 
@@ -890,7 +894,7 @@ export type GetRunningWorkflowsQueryError = ErrorType<void>
 
 
 export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<
+ params: undefined |  GetRunningWorkflowsParams, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<
         DefinedInitialDataOptions<
           Awaited<ReturnType<typeof getRunningWorkflows>>,
           TError,
@@ -900,7 +904,7 @@ export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunn
 
   ):  DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<
+ params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<
         UndefinedInitialDataOptions<
           Awaited<ReturnType<typeof getRunningWorkflows>>,
           TError,
@@ -910,7 +914,7 @@ export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunn
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+ params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 /**
@@ -918,11 +922,11 @@ export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunn
  */
 
 export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+ params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
 
-  const queryOptions = getGetRunningWorkflowsQueryOptions(options)
+  const queryOptions = getGetRunningWorkflowsQueryOptions(params,options)
 
   const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 
@@ -933,16 +937,16 @@ export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunn
 
 
 
-export const getGetRunningWorkflowsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export const getGetRunningWorkflowsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
 
-  const queryKey =  queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey();
+  const queryKey =  queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey(params);
 
   
 
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) => getRunningWorkflows(requestOptions, signal);
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) => getRunningWorkflows(params, requestOptions, signal);
 
       
 
@@ -956,15 +960,15 @@ export type GetRunningWorkflowsSuspenseQueryError = ErrorType<void>
 
 
 export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+ params: undefined |  GetRunningWorkflowsParams, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+ params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+ params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 /**
@@ -972,11 +976,11 @@ export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof
  */
 
 export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
-  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+ params?: GetRunningWorkflowsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
 
-  const queryOptions = getGetRunningWorkflowsSuspenseQueryOptions(options)
+  const queryOptions = getGetRunningWorkflowsSuspenseQueryOptions(params,options)
 
   const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 

package/workflow/workflow.cjs

@@ -272,39 +272,40 @@ var useVersionWorkflow = (options) => {
   const mutationOptions = getVersionWorkflowMutationOptions(options);
   return _reactquery.useMutation.call(void 0, mutationOptions);
 };
-var getRunningWorkflows = (options, signal) => {
+var getRunningWorkflows = (params, options, signal) => {
   return _chunkTKLTUR4Rcjs.customInstance.call(void 0, 
     {
       url: `/running-workflow`,
       method: "GET",
+      params,
       signal
     },
     options
   );
 };
-var getGetRunningWorkflowsQueryKey = () => {
-  return ["data-manager-api", `/running-workflow`];
+var getGetRunningWorkflowsQueryKey = (params) => {
+  return ["data-manager-api", `/running-workflow`, ...params ? [params] : []];
 };
-var getGetRunningWorkflowsQueryOptions = (options) => {
+var getGetRunningWorkflowsQueryOptions = (params, options) => {
   const { query: queryOptions, request: requestOptions } = _nullishCoalesce(options, () => ( {}));
-  const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetRunningWorkflowsQueryKey()));
-  const queryFn = ({ signal }) => getRunningWorkflows(requestOptions, signal);
+  const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetRunningWorkflowsQueryKey(params)));
+  const queryFn = ({ signal }) => getRunningWorkflows(params, requestOptions, signal);
   return { queryKey, queryFn, ...queryOptions };
 };
-function useGetRunningWorkflows(options) {
-  const queryOptions = getGetRunningWorkflowsQueryOptions(options);
+function useGetRunningWorkflows(params, options) {
+  const queryOptions = getGetRunningWorkflowsQueryOptions(params, options);
   const query = _reactquery.useQuery.call(void 0, queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;
 }
-var getGetRunningWorkflowsSuspenseQueryOptions = (options) => {
+var getGetRunningWorkflowsSuspenseQueryOptions = (params, options) => {
   const { query: queryOptions, request: requestOptions } = _nullishCoalesce(options, () => ( {}));
-  const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetRunningWorkflowsQueryKey()));
-  const queryFn = ({ signal }) => getRunningWorkflows(requestOptions, signal);
+  const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetRunningWorkflowsQueryKey(params)));
+  const queryFn = ({ signal }) => getRunningWorkflows(params, requestOptions, signal);
   return { queryKey, queryFn, ...queryOptions };
 };
-function useGetRunningWorkflowsSuspense(options) {
-  const queryOptions = getGetRunningWorkflowsSuspenseQueryOptions(options);
+function useGetRunningWorkflowsSuspense(params, options) {
+  const queryOptions = getGetRunningWorkflowsSuspenseQueryOptions(params, options);
   const query = _reactquery.useSuspenseQuery.call(void 0, queryOptions);
   query.queryKey = queryOptions.queryKey;
   return query;