@squonk/data-manager-client 1.0.0-rc.4 → 1.0.2-rc.2

package/src/admin/admin.ts

@@ -23,6 +23,7 @@ import type {
   AdminGetServiceErrorsParams,
   AdminUserPutResponse,
   UserPatchBodyBody,
+  AdminJobManifestGetResponse,
   AdminJobManifestLoadPutResponse,
   JobManifestPutBodyBody,
   JobManifestLoadPutBodyBody,
@@ -378,13 +379,69 @@ export const useAdminPatchUser = <
   >(mutationFn, mutationOptions);
 };
 /**
- * This endpoint is used to add (or update an existing manifest). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.
+ * Returns the list of known **Job Manifests** including the time the manifest was last loaded and its load status, a message indicating success or failure.
+
+You will need **admin** rights to use this endpoint
+
+ * @summary Get Job Manifests
+ */
+export const adminGetJobManifests = (
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal
+) => {
+  return customInstance<AdminJobManifestGetResponse>(
+    { url: `/admin/job-manifest`, method: "get", signal },
+    options
+  );
+};
+
+export const getAdminGetJobManifestsQueryKey = () => [`/admin/job-manifest`];
+
+export type AdminGetJobManifestsQueryResult = NonNullable<
+  Awaited<ReturnType<typeof adminGetJobManifests>>
+>;
+export type AdminGetJobManifestsQueryError = ErrorType<void | DmError>;
+
+export const useAdminGetJobManifests = <
+  TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
+  TError = ErrorType<void | DmError>
+>(options?: {
+  query?: UseQueryOptions<
+    Awaited<ReturnType<typeof adminGetJobManifests>>,
+    TError,
+    TData
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getAdminGetJobManifestsQueryKey();
+
+  const queryFn: QueryFunction<
+    Awaited<ReturnType<typeof adminGetJobManifests>>
+  > = ({ signal }) => adminGetJobManifests(requestOptions, signal);
+
+  const query = useQuery<
+    Awaited<ReturnType<typeof adminGetJobManifests>>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+  };
+
+  query.queryKey = queryKey;
+
+  return query;
+};
+
+/**
+ * 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 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
 
- * @summary Adds a manifest and triggers the download of Job Definitions
+ * @summary Adds a Job Manifest and triggers the download of its Job Definitions
  */
 export const adminJobManifestPut = (
   jobManifestPutBodyBody: JobManifestPutBodyBody,
@@ -447,11 +504,11 @@ export const useAdminJobManifestPut = <
   >(mutationFn, mutationOptions);
 };
 /**
- * This endpoint is used to trigger the Data Manager to re-inspect the internal Job **Manifest** table and download the manifests and reprocess the related job definitions. This is normally done by an administrator when the Manifest table has been modified or if external job definitions are known to have changed in the referenced repositories.
+ * This endpoint is used to trigger the Data Manager to re-inspect the internal **Job Manifest** table and download the manifests and reprocess the related job definitions. This is normally done by an administrator when the Manifest table has been modified or if external job definitions are known to have changed in the referenced repositories.
 
 You will need **admin** rights to use this endpoint
 
- * @summary Trigger a download of known Job Definitions using the Manifest table
+ * @summary Trigger a download of Job Definitions using existing Job Manifests
  */
 export const adminJobManifestLoad = (
   jobManifestLoadPutBodyBody: JobManifestLoadPutBodyBody,

package/src/application/application.ts

@@ -88,9 +88,9 @@ export const useGetApplications = <
 };
 
 /**
- * Get details of a specific application available to you that can be instantiated.
+ * Get details of a specific Application available to you that can be instantiated.
 
- * @summary Get details of a specific application
+ * @summary Get details of a specific Application
  */
 export const getApplication = (
   applicationId: string,

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

@@ -54,6 +54,18 @@ export type GetTasksParams = {
   project_id?: QProjectIdParameter;
 };
 
+/**
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+
+ */
+export type QFilePathParameter = string;
+
+/**
+ * A project file.
+
+ */
+export type QFileParameter = string;
+
 export type DeleteUnmanagedFileParams = {
   file: QFileParameter;
   path?: QFilePathParameter;
@@ -200,18 +212,6 @@ export type QFromParameter = string;
  */
 export type QFileProjectIdParameter = string;
 
-/**
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
-
- */
-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`
 
@@ -335,7 +335,9 @@ Jobs in the collection `im-test` are not removed */
 
 export type InstancePostBodyBody = {
   /** A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
-   */
+
+Application IDs currently supported include ``datamanagerjobs.squonk.it`` and ``jupyternotebooks.squonk.it``
+ */
   application_id: string;
   /** A supported application version to launch.
 
@@ -375,6 +377,8 @@ When launching a Data Manager **Job** Application you must identify the Job usin
 Jobs that offer commands will often advertise a series of **inputs** and **options** where the values can be provided using a **variables** map in the specification. Something like `"variables":{"x":7}`.
 
 Jobs start in a Job-specific **working directory** but the starting directory for any Job can be adjusted by defining a `sub_path` to the root specification. For example, if you want the Job to start in the path `foo/bar` (inside the Job's built-in working directory) you can add `"sub_path":"foo/bar"` to the specification. You can only use a sub-path for a Job if the Job defines a working directory and `sub-path` cannot begin or end with a path separator (`/`).
+
+Applications also support `variables`. The Jupyter notebook application supports the definition of the notebook image (i.e. `"image:":"tensorflow"`), `"cpu"` and `"memory"`. A full Jupyter notebook specification might look like `{"variables":{"image":"tensorflow","cpu":2,"memory":"4Gi"}}`. `memory` is limited to `Gi` as a suffix.
  */
   specification?: string;
 };
@@ -814,6 +818,35 @@ export interface JobSummary {
   doc_url?: string;
 }
 
+export interface JobManifestDetail {
+  /** The Job Manifest record ID */
+  id: number;
+  url: string;
+  header?: string;
+  params?: string;
+  /** The Date (and time) the manifest was created
+   */
+  created: string;
+  /** The (admin) user who created the manifest
+   */
+  creator?: string;
+  /** The number of job definition files loaded during the most recent successful load
+   */
+  job_definition_files_loaded?: number;
+  /** The number of job definitions loaded during the most recent successful load
+   */
+  job_definitions_loaded?: number;
+  /** The Date (and time) the manifest was last loaded successfully
+   */
+  last_successful_load_time?: string;
+  /** The Date (and time) the manifest was last loaded, successfully or otherwise. If the manifest (or any of the Job definition files it refers to) fails to load the `load_status` should provide some diagnostic feedback
+   */
+  last_load_time?: string;
+  /** The status of the time the manifest was last loaded. If the load was successful this will be `SUCCESS` and `last_successful_load` will be the same as `last_load`
+   */
+  last_load_status: string;
+}
+
 export interface JobApplication {
   /** The Job's operator ID */
   id: string;
@@ -1717,6 +1750,12 @@ export interface AdminJobManifestLoadPutResponse {
   jobs_purged?: number;
 }
 
+export interface AdminJobManifestGetResponse {
+  /** The list of known Job manifests
+   */
+  job_manifests: JobManifestDetail[];
+}
+
 export interface AccountServerGetNamespaceResponse {
   /** The configured Account Server namespace, which will be an empty string if one is not configured. The AS API is expected as the service `as-api` in this namespace.
    */

package/src/dataset/dataset.ts

@@ -222,7 +222,7 @@ Datasets can be filtered by: 1. `owner username`, 2. `mime_type`, 3. a list of `
 
 Note that if `editors` are combined with `owner username`, then the datasets will be filtered by owner username first followed by editors (so it's an AND). If `editors` are combined with `owners`, then the result will be datasets filtered by a combination of owners OR editors.
 
- * @summary Get datasets that are available to you
+ * @summary Get Datasets that are available to you
  */
 export const getDatasets = (
   params?: GetDatasetsParams,
@@ -354,7 +354,7 @@ You must be an `editor` or `owner` of the Dataset.
 
 You cannot delete a Dataset until its upload is complete.
 
- * @summary Delete a dataset
+ * @summary Delete a Dataset
  */
 export const deleteDataset = (
   datasetId: string,
@@ -413,7 +413,7 @@ export const useDeleteDataset = <
 
 You cannot get a Dataset until its upload is complete.
 
- * @summary Download a dataset
+ * @summary Download a Dataset
  */
 export const downloadDataset = (
   datasetId: string,
@@ -539,7 +539,7 @@ You must be an `editor` or `owner` of the dataset.
 
 You cannot modify Dataset editors until its upload is complete.
 
- * @summary Give a user edit permission for a dataset
+ * @summary Give a user edit permission for a Dataset
  */
 export const addEditorToDataset = (
   datasetId: string,

package/src/instance/instance.ts

@@ -47,7 +47,7 @@ An Application instance is not Ready for use until the corresponding **TaskState
 
 A Job instance typically runs to completion, reaching the **TaskState** `SUCCESS` when successful and `FAILURE` is unsuccessful.
 
- * @summary Creates a new application instance
+ * @summary Creates a new Job or Application instance
  */
 export const createInstance = (
   instancePostBodyBody: InstancePostBodyBody,
@@ -132,7 +132,7 @@ export const useCreateInstance = <
 /**
  * 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`
 
- * @summary Get summary information about all application instances
+ * @summary Get summary information about all Job and Application instances
  */
 export const getInstances = (
   params?: GetInstancesParams,
@@ -256,7 +256,7 @@ export const useGetInstance = <
 
 You must be the `owner` or an `editor` of the instance to delete it
 
- * @summary Delete an application instance
+ * @summary Delete a Job or Application instance
  */
 export const terminateInstance = (
   instanceId: string,
@@ -309,7 +309,7 @@ export const useTerminateInstance = <
 
 You must be the `owner` or an `editor` of the instance to patch it
 
- * @summary Update an application instance
+ * @summary Update a Job or Application instance
  */
 export const patchInstance = (
   instanceId: string,

package/src/job/job.ts

@@ -83,9 +83,9 @@ export const useGetJobs = <
 };
 
 /**
- * Gets a Job based on the its **collection**, **job** and **version**.
+ * Gets a Job based on its **collection**, **job** and **version**.
 
-Job availability will vary as Jobs are added to the cluster.
+Job availability will vary as Jobs are added to the cluster. Jobs that have been added are unlikely to be removed.
 
  * @summary Get a Job by its version
  */

package/src/metadata/metadata.ts

@@ -122,7 +122,7 @@ export const useAddMetadataVersion = <
 /**
  * Returns the metadata for a Dataset version in JSON format.
 
- * @summary Gets the metadata for a specific Dataset version
+ * @summary Gets the Metadata for a specific Dataset version
  */
 export const getMetadataVersion = (
   datasetId: string,
@@ -260,7 +260,7 @@ export const useAddMetadata = <
 /**
  * Returns the metadata for a Dataset in JSON format.
 
- * @summary Gets the metadata for a specific Dataset
+ * @summary Gets the Metadata for a specific Dataset
  */
 export const getMetadata = (
   datasetId: string,

package/src/project/project.ts

@@ -41,9 +41,9 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * Get a list of all projects available to you.
+ * Get a list of all Projects available to you.
 
- * @summary Get all projects available to you
+ * @summary Get all Pojects available to you
  */
 export const getProjects = (
   options?: SecondParameter<typeof customInstance>,
@@ -95,7 +95,7 @@ export const useGetProjects = <
 };
 
 /**
- * Creates a new project, assigning and returning a unique **ID**. A persistent volume is created in the cluster and assigned to your Project. It's here you can add **Datasets** as **Files** and run **Applications** and **Jobs**.
+ * Creates a new Project, assigning and returning a unique **ID**. A persistent volume is created in the cluster and assigned to your Project. It's here you can add **Datasets** as **Files** and run **Applications** and **Jobs**.
 
 To create a Project you will need an uncommitted Project product.
 
@@ -103,7 +103,7 @@ As the project `owner` (creator) you are also automatically an `editor` of the p
 
 The name you give the project is free-form text (can contain spaces etc.). The name you use must be unique amongst all the projects you create.
 
- * @summary Create a new project
+ * @summary Create a new Project
  */
 export const createProject = (
   projectPostBodyBody: ProjectPostBodyBody,
@@ -166,7 +166,7 @@ export const useCreateProject = <
 /**
  * Gets the details of a project that is available to you.
 
- * @summary Get a project
+ * @summary Get a Project
  */
 export const getProject = (
   projectId: string,
@@ -222,9 +222,9 @@ export const useGetProject = <
 };
 
 /**
- * Used to update some adjustable parameters of a project, i.e. to make it Private or make it Public. What can be adjusted will depend on the purchased product
+ * Used to update some adjustable parameters of a Project, i.e. to make it Private or make it Public. What can be adjusted will depend on the purchased product
 
- * @summary Adjust an existing project
+ * @summary Adjust an existing Project
  */
 export const patchProject = (
   projectId: string,
@@ -293,7 +293,7 @@ You must be an `editor` or the `owner` of the project.
 
 Once deleted all **Files**, working directories and material in the project will also be removed
 
- * @summary Delete a project
+ * @summary Delete a Project
  */
 export const deleteProject = (
   projectId: string,
@@ -348,7 +348,7 @@ An `editor` of a project is not automatically an `editor` of any datasets the pr
 
 You must be an `editor` or the `owner` of the project
 
- * @summary Add a project editor
+ * @summary Add a Project Editor
  */
 export const addEditorToProject = (
   projectId: string,
@@ -404,7 +404,7 @@ A project must always have one `editor` so you will not be able to delete the la
 
 You must be an `editor` or the `owner` of the project
 
- * @summary Delete a project editor
+ * @summary Delete a Project Editor
  */
 export const removeEditorFromProject = (
   projectId: string,
@@ -460,7 +460,7 @@ For **managed** files you should consider using the `/file/{file_id}` endpoint.
 
 You must be an `editor` or the `owner` of the project if the project is private
 
- * @summary Download a project file
+ * @summary Download a Project file
  */
 export const getProjectFile = (
   projectId: string,
@@ -597,7 +597,7 @@ 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 generated 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
+ * @summary Download a Project file using a Token
  */
 export const getProjectFileWithToken = (
   projectId: string,

package/src/task/task.ts

@@ -38,7 +38,7 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
 /**
  * Returns a list of tasks that you have access to. These will be Tasks that you **own**. Being an editor of the related object does not allow you to see its task.
 
- * @summary Returns a list of tasks
+ * @summary Returns a list of Tasks
  */
 export const getTasks = (
   params?: GetTasksParams,
@@ -113,7 +113,7 @@ For **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait unti
 
 For Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.
 
- * @summary Returns task information
+ * @summary Returns Task information
  */
 export const getTask = (
   taskId: string,

package/task/task.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/task/task.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAgC/B,IAAM,WAAW,CACtB,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAC,WAA4B;AAAA,EAC9D;AAAA,EACA,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,cAAc,CAIzB,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,oBAAoB,MAAM;AAErE,QAAM,UAA+D,CAAC;AAAA,IACpE;AAAA,EACF,MAAM,SAAS,QAAQ,gBAAgB,MAAM;AAE7C,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAuBO,IAAM,UAAU,CACrB,QACA,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,OAAO,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AACF;AAEO,IAAM,qBAAqB,CAAC,QAAgB,WAA2B;AAAA,EAC5E,SAAS;AAAA,EACT,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,aAAa,CAIxB,QACA,QACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,mBAAmB,QAAQ,MAAM;AAE5E,QAAM,UAA8D,CAAC;AAAA,IACnE;AAAA,EACF,MAAM,QAAQ,QAAQ,QAAQ,gBAAgB,MAAM;AAEpD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA,EAAE,SAAS,CAAC,CAAC,QAAQ,GAAG,aAAa;AAAA,EACvC;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAWO,IAAM,aAAa,CACxB,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,SAAS;AAAA,IAC3C;AAAA,EACF;AACF;AAQO,IAAM,gBAAgB,CAG3B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,WAAW,QAAQ,cAAc;AAAA,EAC1C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B","sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n  UseQueryOptions,\n  UseMutationOptions,\n  QueryFunction,\n  MutationFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"react-query\";\nimport type {\n  TasksGetResponse,\n  DmError,\n  GetTasksParams,\n  TaskGetResponse,\n  GetTaskParams,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Returns a list of tasks that you have access to. These will be Tasks that you **own**. Being an editor of the related object does not allow you to see its task.\n\n * @summary Returns a list of tasks\n */\nexport const getTasks = (\n  params?: GetTasksParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TasksGetResponse>(\n    { url: `/task`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTasksQueryKey = (params?: GetTasksParams) => [\n  `/task`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTasksQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTasks>>\n>;\nexport type GetTasksQueryError = ErrorType<void | DmError>;\n\nexport const useGetTasks = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTasksQueryKey(params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTasks>>> = ({\n    signal,\n  }) => getTasks(params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTasks>>, TError, TData>(\n    queryKey,\n    queryFn,\n    queryOptions\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Returns Task information including its states and events.\n\nYou can only retrieve a Task if you are its **owner**. For example, you can get a Task relating to an Application **Instance** if you created the **Instance**.\n\nTasks are created in response to creating datasets and launching applications.\n\nTasks contain of a list of `states` and `events`. A task will always have states but may not have events.\n\nStates and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 100 events are returned.\n\nYou can control the number of events returned by using the `event_limit` query parameter. You can also retrieve the next set of events by combining it with the `event_prior_ordinal`, setting it to the ordinal of the oldest event you've already received.\n\n**Dataset** tasks must be allowed to complete successfully before you can expect a it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.\n\nFor **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The dataset is available when the task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the task is `done` but you have a non-zero `exit_code`, the dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.\n\nFor Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.\n\n * @summary Returns task information\n */\nexport const getTask = (\n  taskId: string,\n  params?: GetTaskParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TaskGetResponse>(\n    { url: `/task/${taskId}`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTaskQueryKey = (taskId: string, params?: GetTaskParams) => [\n  `/task/${taskId}`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTaskQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTask>>\n>;\nexport type GetTaskQueryError = ErrorType<void | DmError>;\n\nexport const useGetTask = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskId, params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTask>>> = ({\n    signal,\n  }) => getTask(taskId, params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTask>>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!taskId, ...queryOptions }\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Given a `task_id` the Task will be removed.\n\nYou cannot delete a Task until it is `done`.\n\nYou must be an **owner** of the Task action to delete it. For example you must be the owner of the Dataset to delete **DATASET** tasks and an owner of the ProjectFile to delete **FILE** tasks.\n\n * @summary Delete a Task entry\n */\nexport const deleteTask = (\n  taskId: string,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<void>(\n    { url: `/task/${taskId}`, method: \"delete\" },\n    options\n  );\n};\n\nexport type DeleteTaskMutationResult = NonNullable<\n  Awaited<ReturnType<typeof deleteTask>>\n>;\n\nexport type DeleteTaskMutationError = ErrorType<DmError>;\n\nexport const useDeleteTask = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n  const mutationFn: MutationFunction<\n    Awaited<ReturnType<typeof deleteTask>>,\n    { taskId: string }\n  > = (props) => {\n    const { taskId } = props ?? {};\n\n    return deleteTask(taskId, requestOptions);\n  };\n\n  return useMutation<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >(mutationFn, mutationOptions);\n};\n"]}
+{"version":3,"sources":["../../src/task/task.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAgC/B,IAAM,WAAW,CACtB,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAC,WAA4B;AAAA,EAC9D;AAAA,EACA,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,cAAc,CAIzB,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,oBAAoB,MAAM;AAErE,QAAM,UAA+D,CAAC;AAAA,IACpE;AAAA,EACF,MAAM,SAAS,QAAQ,gBAAgB,MAAM;AAE7C,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAuBO,IAAM,UAAU,CACrB,QACA,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,OAAO,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AACF;AAEO,IAAM,qBAAqB,CAAC,QAAgB,WAA2B;AAAA,EAC5E,SAAS;AAAA,EACT,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,aAAa,CAIxB,QACA,QACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,mBAAmB,QAAQ,MAAM;AAE5E,QAAM,UAA8D,CAAC;AAAA,IACnE;AAAA,EACF,MAAM,QAAQ,QAAQ,QAAQ,gBAAgB,MAAM;AAEpD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA,EAAE,SAAS,CAAC,CAAC,QAAQ,GAAG,aAAa;AAAA,EACvC;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAWO,IAAM,aAAa,CACxB,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,SAAS;AAAA,IAC3C;AAAA,EACF;AACF;AAQO,IAAM,gBAAgB,CAG3B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,WAAW,QAAQ,cAAc;AAAA,EAC1C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B","sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n  UseQueryOptions,\n  UseMutationOptions,\n  QueryFunction,\n  MutationFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"react-query\";\nimport type {\n  TasksGetResponse,\n  DmError,\n  GetTasksParams,\n  TaskGetResponse,\n  GetTaskParams,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Returns a list of tasks that you have access to. These will be Tasks that you **own**. Being an editor of the related object does not allow you to see its task.\n\n * @summary Returns a list of Tasks\n */\nexport const getTasks = (\n  params?: GetTasksParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TasksGetResponse>(\n    { url: `/task`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTasksQueryKey = (params?: GetTasksParams) => [\n  `/task`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTasksQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTasks>>\n>;\nexport type GetTasksQueryError = ErrorType<void | DmError>;\n\nexport const useGetTasks = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTasksQueryKey(params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTasks>>> = ({\n    signal,\n  }) => getTasks(params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTasks>>, TError, TData>(\n    queryKey,\n    queryFn,\n    queryOptions\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Returns Task information including its states and events.\n\nYou can only retrieve a Task if you are its **owner**. For example, you can get a Task relating to an Application **Instance** if you created the **Instance**.\n\nTasks are created in response to creating datasets and launching applications.\n\nTasks contain of a list of `states` and `events`. A task will always have states but may not have events.\n\nStates and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 100 events are returned.\n\nYou can control the number of events returned by using the `event_limit` query parameter. You can also retrieve the next set of events by combining it with the `event_prior_ordinal`, setting it to the ordinal of the oldest event you've already received.\n\n**Dataset** tasks must be allowed to complete successfully before you can expect a it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.\n\nFor **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The dataset is available when the task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the task is `done` but you have a non-zero `exit_code`, the dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.\n\nFor Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.\n\n * @summary Returns Task information\n */\nexport const getTask = (\n  taskId: string,\n  params?: GetTaskParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TaskGetResponse>(\n    { url: `/task/${taskId}`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTaskQueryKey = (taskId: string, params?: GetTaskParams) => [\n  `/task/${taskId}`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTaskQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTask>>\n>;\nexport type GetTaskQueryError = ErrorType<void | DmError>;\n\nexport const useGetTask = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskId, params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTask>>> = ({\n    signal,\n  }) => getTask(taskId, params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTask>>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!taskId, ...queryOptions }\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Given a `task_id` the Task will be removed.\n\nYou cannot delete a Task until it is `done`.\n\nYou must be an **owner** of the Task action to delete it. For example you must be the owner of the Dataset to delete **DATASET** tasks and an owner of the ProjectFile to delete **FILE** tasks.\n\n * @summary Delete a Task entry\n */\nexport const deleteTask = (\n  taskId: string,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<void>(\n    { url: `/task/${taskId}`, method: \"delete\" },\n    options\n  );\n};\n\nexport type DeleteTaskMutationResult = NonNullable<\n  Awaited<ReturnType<typeof deleteTask>>\n>;\n\nexport type DeleteTaskMutationError = ErrorType<DmError>;\n\nexport const useDeleteTask = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n  const mutationFn: MutationFunction<\n    Awaited<ReturnType<typeof deleteTask>>,\n    { taskId: string }\n  > = (props) => {\n    const { taskId } = props ?? {};\n\n    return deleteTask(taskId, requestOptions);\n  };\n\n  return useMutation<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >(mutationFn, mutationOptions);\n};\n"]}

package/task/task.d.ts

@@ -1,13 +1,13 @@
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
-import { i as GetTasksParams, bz as customInstance, aU as TasksGetResponse, bA as ErrorType, bv as DmError, h as GetTaskParams, aW as TaskGetResponse } from '../custom-instance-f73fb7dc.js';
+import { i as GetTasksParams, bB as customInstance, aV as TasksGetResponse, bC as ErrorType, bx as DmError, h as GetTaskParams, aX as TaskGetResponse } from '../custom-instance-3a73945d.js';
 import 'axios';
 
 declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
 /**
  * Returns a list of tasks that you have access to. These will be Tasks that you **own**. Being an editor of the related object does not allow you to see its task.
 
- * @summary Returns a list of tasks
+ * @summary Returns a list of Tasks
  */
 declare const getTasks: (params?: GetTasksParams | undefined, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal | undefined) => Promise<TasksGetResponse>;
 declare const getGetTasksQueryKey: (params?: GetTasksParams | undefined) => (string | GetTasksParams)[];
@@ -38,7 +38,7 @@ For **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait unti
 
 For Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.
 
- * @summary Returns task information
+ * @summary Returns Task information
  */
 declare const getTask: (taskId: string, params?: GetTaskParams | undefined, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal | undefined) => Promise<TaskGetResponse>;
 declare const getGetTaskQueryKey: (taskId: string, params?: GetTaskParams | undefined) => (string | GetTaskParams)[];

package/task/task.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/task/task.ts"],"sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n  UseQueryOptions,\n  UseMutationOptions,\n  QueryFunction,\n  MutationFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"react-query\";\nimport type {\n  TasksGetResponse,\n  DmError,\n  GetTasksParams,\n  TaskGetResponse,\n  GetTaskParams,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Returns a list of tasks that you have access to. These will be Tasks that you **own**. Being an editor of the related object does not allow you to see its task.\n\n * @summary Returns a list of tasks\n */\nexport const getTasks = (\n  params?: GetTasksParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TasksGetResponse>(\n    { url: `/task`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTasksQueryKey = (params?: GetTasksParams) => [\n  `/task`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTasksQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTasks>>\n>;\nexport type GetTasksQueryError = ErrorType<void | DmError>;\n\nexport const useGetTasks = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTasksQueryKey(params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTasks>>> = ({\n    signal,\n  }) => getTasks(params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTasks>>, TError, TData>(\n    queryKey,\n    queryFn,\n    queryOptions\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Returns Task information including its states and events.\n\nYou can only retrieve a Task if you are its **owner**. For example, you can get a Task relating to an Application **Instance** if you created the **Instance**.\n\nTasks are created in response to creating datasets and launching applications.\n\nTasks contain of a list of `states` and `events`. A task will always have states but may not have events.\n\nStates and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 100 events are returned.\n\nYou can control the number of events returned by using the `event_limit` query parameter. You can also retrieve the next set of events by combining it with the `event_prior_ordinal`, setting it to the ordinal of the oldest event you've already received.\n\n**Dataset** tasks must be allowed to complete successfully before you can expect a it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.\n\nFor **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The dataset is available when the task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the task is `done` but you have a non-zero `exit_code`, the dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.\n\nFor Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.\n\n * @summary Returns task information\n */\nexport const getTask = (\n  taskId: string,\n  params?: GetTaskParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TaskGetResponse>(\n    { url: `/task/${taskId}`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTaskQueryKey = (taskId: string, params?: GetTaskParams) => [\n  `/task/${taskId}`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTaskQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTask>>\n>;\nexport type GetTaskQueryError = ErrorType<void | DmError>;\n\nexport const useGetTask = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskId, params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTask>>> = ({\n    signal,\n  }) => getTask(taskId, params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTask>>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!taskId, ...queryOptions }\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Given a `task_id` the Task will be removed.\n\nYou cannot delete a Task until it is `done`.\n\nYou must be an **owner** of the Task action to delete it. For example you must be the owner of the Dataset to delete **DATASET** tasks and an owner of the ProjectFile to delete **FILE** tasks.\n\n * @summary Delete a Task entry\n */\nexport const deleteTask = (\n  taskId: string,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<void>(\n    { url: `/task/${taskId}`, method: \"delete\" },\n    options\n  );\n};\n\nexport type DeleteTaskMutationResult = NonNullable<\n  Awaited<ReturnType<typeof deleteTask>>\n>;\n\nexport type DeleteTaskMutationError = ErrorType<DmError>;\n\nexport const useDeleteTask = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n  const mutationFn: MutationFunction<\n    Awaited<ReturnType<typeof deleteTask>>,\n    { taskId: string }\n  > = (props) => {\n    const { taskId } = props ?? {};\n\n    return deleteTask(taskId, requestOptions);\n  };\n\n  return useMutation<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >(mutationFn, mutationOptions);\n};\n"],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAgC/B,IAAM,WAAW,CACtB,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAC,WAA4B;AAAA,EAC9D;AAAA,EACA,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,cAAc,CAIzB,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,oBAAoB,MAAM;AAErE,QAAM,UAA+D,CAAC;AAAA,IACpE;AAAA,EACF,MAAM,SAAS,QAAQ,gBAAgB,MAAM;AAE7C,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAuBO,IAAM,UAAU,CACrB,QACA,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,OAAO,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AACF;AAEO,IAAM,qBAAqB,CAAC,QAAgB,WAA2B;AAAA,EAC5E,SAAS;AAAA,EACT,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,aAAa,CAIxB,QACA,QACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,mBAAmB,QAAQ,MAAM;AAE5E,QAAM,UAA8D,CAAC;AAAA,IACnE;AAAA,EACF,MAAM,QAAQ,QAAQ,QAAQ,gBAAgB,MAAM;AAEpD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA,EAAE,SAAS,CAAC,CAAC,QAAQ,GAAG,aAAa;AAAA,EACvC;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAWO,IAAM,aAAa,CACxB,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,SAAS;AAAA,IAC3C;AAAA,EACF;AACF;AAQO,IAAM,gBAAgB,CAG3B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,WAAW,QAAQ,cAAc;AAAA,EAC1C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;","names":[]}
+{"version":3,"sources":["../../src/task/task.ts"],"sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n  UseQueryOptions,\n  UseMutationOptions,\n  QueryFunction,\n  MutationFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"react-query\";\nimport type {\n  TasksGetResponse,\n  DmError,\n  GetTasksParams,\n  TaskGetResponse,\n  GetTaskParams,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Returns a list of tasks that you have access to. These will be Tasks that you **own**. Being an editor of the related object does not allow you to see its task.\n\n * @summary Returns a list of Tasks\n */\nexport const getTasks = (\n  params?: GetTasksParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TasksGetResponse>(\n    { url: `/task`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTasksQueryKey = (params?: GetTasksParams) => [\n  `/task`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTasksQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTasks>>\n>;\nexport type GetTasksQueryError = ErrorType<void | DmError>;\n\nexport const useGetTasks = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTasksQueryKey(params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTasks>>> = ({\n    signal,\n  }) => getTasks(params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTasks>>, TError, TData>(\n    queryKey,\n    queryFn,\n    queryOptions\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Returns Task information including its states and events.\n\nYou can only retrieve a Task if you are its **owner**. For example, you can get a Task relating to an Application **Instance** if you created the **Instance**.\n\nTasks are created in response to creating datasets and launching applications.\n\nTasks contain of a list of `states` and `events`. A task will always have states but may not have events.\n\nStates and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 100 events are returned.\n\nYou can control the number of events returned by using the `event_limit` query parameter. You can also retrieve the next set of events by combining it with the `event_prior_ordinal`, setting it to the ordinal of the oldest event you've already received.\n\n**Dataset** tasks must be allowed to complete successfully before you can expect a it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.\n\nFor **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The dataset is available when the task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the task is `done` but you have a non-zero `exit_code`, the dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.\n\nFor Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.\n\n * @summary Returns Task information\n */\nexport const getTask = (\n  taskId: string,\n  params?: GetTaskParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TaskGetResponse>(\n    { url: `/task/${taskId}`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTaskQueryKey = (taskId: string, params?: GetTaskParams) => [\n  `/task/${taskId}`,\n  ...(params ? [params] : []),\n];\n\nexport type GetTaskQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTask>>\n>;\nexport type GetTaskQueryError = ErrorType<void | DmError>;\n\nexport const useGetTask = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskId, params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTask>>> = ({\n    signal,\n  }) => getTask(taskId, params, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getTask>>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!taskId, ...queryOptions }\n  ) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n  query.queryKey = queryKey;\n\n  return query;\n};\n\n/**\n * Given a `task_id` the Task will be removed.\n\nYou cannot delete a Task until it is `done`.\n\nYou must be an **owner** of the Task action to delete it. For example you must be the owner of the Dataset to delete **DATASET** tasks and an owner of the ProjectFile to delete **FILE** tasks.\n\n * @summary Delete a Task entry\n */\nexport const deleteTask = (\n  taskId: string,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<void>(\n    { url: `/task/${taskId}`, method: \"delete\" },\n    options\n  );\n};\n\nexport type DeleteTaskMutationResult = NonNullable<\n  Awaited<ReturnType<typeof deleteTask>>\n>;\n\nexport type DeleteTaskMutationError = ErrorType<DmError>;\n\nexport const useDeleteTask = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n  const mutationFn: MutationFunction<\n    Awaited<ReturnType<typeof deleteTask>>,\n    { taskId: string }\n  > = (props) => {\n    const { taskId } = props ?? {};\n\n    return deleteTask(taskId, requestOptions);\n  };\n\n  return useMutation<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >(mutationFn, mutationOptions);\n};\n"],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAgC/B,IAAM,WAAW,CACtB,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAC,WAA4B;AAAA,EAC9D;AAAA,EACA,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,cAAc,CAIzB,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,oBAAoB,MAAM;AAErE,QAAM,UAA+D,CAAC;AAAA,IACpE;AAAA,EACF,MAAM,SAAS,QAAQ,gBAAgB,MAAM;AAE7C,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAuBO,IAAM,UAAU,CACrB,QACA,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,OAAO,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AACF;AAEO,IAAM,qBAAqB,CAAC,QAAgB,WAA2B;AAAA,EAC5E,SAAS;AAAA,EACT,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC;AAC3B;AAOO,IAAM,aAAa,CAIxB,QACA,QACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,mBAAmB,QAAQ,MAAM;AAE5E,QAAM,UAA8D,CAAC;AAAA,IACnE;AAAA,EACF,MAAM,QAAQ,QAAQ,QAAQ,gBAAgB,MAAM;AAEpD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA,EAAE,SAAS,CAAC,CAAC,QAAQ,GAAG,aAAa;AAAA,EACvC;AAEA,QAAM,WAAW;AAEjB,SAAO;AACT;AAWO,IAAM,aAAa,CACxB,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,SAAS;AAAA,IAC3C;AAAA,EACF;AACF;AAQO,IAAM,gBAAgB,CAG3B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,WAAW,QAAQ,cAAc;AAAA,EAC1C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;","names":[]}

package/type/type.d.ts

@@ -1,5 +1,5 @@
 import { UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
-import { bz as customInstance, aT as TypesGetResponse, bA as ErrorType, bv as DmError } from '../custom-instance-f73fb7dc.js';
+import { bB as customInstance, aU as TypesGetResponse, bC as ErrorType, bx as DmError } from '../custom-instance-3a73945d.js';
 import 'axios';
 
 declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;

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 { bz as customInstance, aQ as UsersGetResponse, bA as ErrorType, bv as DmError, a as GetUserAccountParams, aa as UserAccountDetail, X as UserAccountPatchBodyBody, G as GetUserApiLogParams, aR as UserApiLogGetResponse } from '../custom-instance-f73fb7dc.js';
+import { bB as customInstance, aR as UsersGetResponse, bC as ErrorType, bx as DmError, a as GetUserAccountParams, aa as UserAccountDetail, X as UserAccountPatchBodyBody, G as GetUserApiLogParams, aS as UserApiLogGetResponse } from '../custom-instance-3a73945d.js';
 import 'axios';
 
 declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;