@squonk/data-manager-client 0.7.0-alpha.5 → 0.7.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/annotation/annotation.ts"],"names":[],"mappings":";;;;;;AAUA;AAAA;AAAA;AAAA;AAuCO,IAAM,iBAAiB,CAC5B,WACA,gBACA,gCACA,YACG;AACH,QAAM,WAAW,IAAI;AACrB,WAAS,OAAO,eAAe,+BAA+B;AAE9D,SAAO,eACL;AAAA,IACE,KAAK,YAAY,yBAAyB;AAAA,IAC1C,QAAQ;AAAA,IACR,MAAM;AAAA,KAER;AAAA;AAIG,IAAM,oBAAoB,CAG/B,YAYI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAOF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,gBAAgB,SAAS,SAAS;AAErD,WAAO,eAAe,WAAW,gBAAgB,MAAM;AAAA;AAGzD,SAAO,YASL,YAAY;AAAA;AAOT,IAAM,cAAc,CACzB,WACA,gBACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,kBAAkB,QAAQ,SAC/D;AAAA;AAIG,IAAM,yBAAyB,CACpC,WACA,mBACG,CAAC,YAAY,kBAAkB;AAE7B,IAAM,iBAAiB,CAI5B,WACA,gBACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WACJ,8CAAc,aAAY,uBAAuB,WAAW;AAE9D,QAAM,UAA8D,MAClE,YAAY,WAAW,gBAAgB;AAEzC,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAE,cAAa,mBAAoB;AAGjD,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AASA,IAAM,iBAAiB,CAC5B,WACA,gBACA,gBACA,YACG;AACH,SAAO,eACL;AAAA,IACE,KAAK,YAAY,kBAAkB,kBAAkB;AAAA,IACrD,QAAQ;AAAA,KAEV;AAAA;AAIG,IAAM,oBAAoB,CAG/B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,gBAAgB,mBAAmB,SAAS;AAE/D,WAAO,eACL,WACA,gBACA,gBACA;AAAA;AAIJ,SAAO,YAKL,YAAY;AAAA","sourcesContent":["/**\n * Generated by orval v6.6.0 🍺\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: 0.7\n */\nimport {\n useQuery,\n useMutation,\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n DatasetAnnotationsPostResponse,\n DmError,\n DatasetAnnotationsPostBodyBody,\n DatasetMetaGetResponse,\n} from \"../data-manager-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (\n ...args: any\n) => Promise<infer R>\n ? R\n : any;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\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 * Creates new annotations of the specified type(s) and add to the metadata for the dataset.\nThe annotations are provided in a list in JSON format. For details of the annotations that can be created, see the data-manager-metadata library,\n\n * @summary Add new annotations to the Metadata for the Dataset\n */\nexport const addAnnotations = (\n datasetid: string,\n datasetversion: number,\n datasetAnnotationsPostBodyBody: DatasetAnnotationsPostBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"annotations\", datasetAnnotationsPostBodyBody.annotations);\n\n return customInstance<DatasetAnnotationsPostResponse>(\n {\n url: `/dataset/${datasetid}/annotations/${datasetversion}`,\n method: \"post\",\n data: formData,\n },\n options\n );\n};\n\nexport const useAddAnnotations = <\n TError = ErrorType<DmError | void>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof addAnnotations>,\n TError,\n {\n datasetid: string;\n datasetversion: number;\n data: DatasetAnnotationsPostBodyBody;\n },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof addAnnotations>,\n {\n datasetid: string;\n datasetversion: number;\n data: DatasetAnnotationsPostBodyBody;\n }\n > = (props) => {\n const { datasetid, datasetversion, data } = props || {};\n\n return addAnnotations(datasetid, datasetversion, data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof addAnnotations>,\n TError,\n {\n datasetid: string;\n datasetversion: number;\n data: DatasetAnnotationsPostBodyBody;\n },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Returns the metadata for a Dataset versions in JSON format.\n\n * @summary Gets the metadata for a specific Dataset\n */\nexport const getMetadata = (\n datasetid: string,\n datasetversion: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<DatasetMetaGetResponse>(\n { url: `/dataset/${datasetid}/meta/${datasetversion}`, method: \"get\" },\n options\n );\n};\n\nexport const getGetMetadataQueryKey = (\n datasetid: string,\n datasetversion: number\n) => [`/dataset/${datasetid}/meta/${datasetversion}`];\n\nexport const useGetMetadata = <\n TData = AsyncReturnType<typeof getMetadata>,\n TError = ErrorType<void | DmError>\n>(\n datasetid: string,\n datasetversion: number,\n options?: {\n query?: UseQueryOptions<AsyncReturnType<typeof getMetadata>, 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 =\n queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetid, datasetversion);\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getMetadata>> = () =>\n getMetadata(datasetid, datasetversion, requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getMetadata>, TError, TData>(\n queryKey,\n queryFn,\n { enabled: !!(datasetid && datasetversion), ...queryOptions }\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * Updates the metadata for a Dataset based on the given parameter array.\n\n * @summary Update the metadata for a specific Dataset\n */\nexport const updateMetadata = (\n datasetid: string,\n datasetversion: number,\n metaparameters: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n {\n url: `/dataset/${datasetid}/meta/${datasetversion}/${metaparameters}`,\n method: \"patch\",\n },\n options\n );\n};\n\nexport const useUpdateMetadata = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof updateMetadata>,\n TError,\n { datasetid: string; datasetversion: number; metaparameters: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof updateMetadata>,\n { datasetid: string; datasetversion: number; metaparameters: string }\n > = (props) => {\n const { datasetid, datasetversion, metaparameters } = props || {};\n\n return updateMetadata(\n datasetid,\n datasetversion,\n metaparameters,\n requestOptions\n );\n };\n\n return useMutation<\n AsyncReturnType<typeof updateMetadata>,\n TError,\n { datasetid: string; datasetversion: number; metaparameters: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n"]}
@@ -1,58 +0,0 @@
1
- import * as react_query from 'react-query';
2
- import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
3
- import { O as DatasetAnnotationsPostBodyBody, b8 as customInstance, a_ as DatasetAnnotationsPostResponse, b9 as ErrorType, b4 as DmError, aX as DatasetMetaGetResponse } from '../custom-instance-fcf163c4';
4
- import 'axios';
5
-
6
- declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
7
- /**
8
- * Creates new annotations of the specified type(s) and add to the metadata for the dataset.
9
- The annotations are provided in a list in JSON format. For details of the annotations that can be created, see the data-manager-metadata library,
10
-
11
- * @summary Add new annotations to the Metadata for the Dataset
12
- */
13
- declare const addAnnotations: (datasetid: string, datasetversion: number, datasetAnnotationsPostBodyBody: DatasetAnnotationsPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetAnnotationsPostResponse>;
14
- declare const useAddAnnotations: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
15
- mutation?: UseMutationOptions<DatasetAnnotationsPostResponse, TError, {
16
- datasetid: string;
17
- datasetversion: number;
18
- data: DatasetAnnotationsPostBodyBody;
19
- }, TContext> | undefined;
20
- request?: SecondParameter<typeof customInstance>;
21
- } | undefined) => react_query.UseMutationResult<DatasetAnnotationsPostResponse, TError, {
22
- datasetid: string;
23
- datasetversion: number;
24
- data: DatasetAnnotationsPostBodyBody;
25
- }, TContext>;
26
- /**
27
- * Returns the metadata for a Dataset versions in JSON format.
28
-
29
- * @summary Gets the metadata for a specific Dataset
30
- */
31
- declare const getMetadata: (datasetid: string, datasetversion: number, options?: SecondParameter<typeof customInstance>) => Promise<DatasetMetaGetResponse>;
32
- declare const getGetMetadataQueryKey: (datasetid: string, datasetversion: number) => string[];
33
- declare const useGetMetadata: <TData = DatasetMetaGetResponse, TError = ErrorType<void | DmError>>(datasetid: string, datasetversion: number, options?: {
34
- query?: UseQueryOptions<DatasetMetaGetResponse, TError, TData, QueryKey> | undefined;
35
- request?: SecondParameter<typeof customInstance>;
36
- } | undefined) => UseQueryResult<TData, TError> & {
37
- queryKey: QueryKey;
38
- };
39
- /**
40
- * Updates the metadata for a Dataset based on the given parameter array.
41
-
42
- * @summary Update the metadata for a specific Dataset
43
- */
44
- declare const updateMetadata: (datasetid: string, datasetversion: number, metaparameters: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
45
- declare const useUpdateMetadata: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
46
- mutation?: UseMutationOptions<void, TError, {
47
- datasetid: string;
48
- datasetversion: number;
49
- metaparameters: string;
50
- }, TContext> | undefined;
51
- request?: SecondParameter<typeof customInstance>;
52
- } | undefined) => react_query.UseMutationResult<void, TError, {
53
- datasetid: string;
54
- datasetversion: number;
55
- metaparameters: string;
56
- }, TContext>;
57
-
58
- export { addAnnotations, getGetMetadataQueryKey, getMetadata, updateMetadata, useAddAnnotations, useGetMetadata, useUpdateMetadata };
@@ -1,64 +0,0 @@
1
- import {
2
- __spreadValues,
3
- customInstance
4
- } from "../chunk-JR7F532L.js";
5
-
6
- // src/annotation/annotation.ts
7
- import {
8
- useQuery,
9
- useMutation
10
- } from "react-query";
11
- var addAnnotations = (datasetid, datasetversion, datasetAnnotationsPostBodyBody, options) => {
12
- const formData = new FormData();
13
- formData.append("annotations", datasetAnnotationsPostBodyBody.annotations);
14
- return customInstance({
15
- url: `/dataset/${datasetid}/annotations/${datasetversion}`,
16
- method: "post",
17
- data: formData
18
- }, options);
19
- };
20
- var useAddAnnotations = (options) => {
21
- const { mutation: mutationOptions, request: requestOptions } = options || {};
22
- const mutationFn = (props) => {
23
- const { datasetid, datasetversion, data } = props || {};
24
- return addAnnotations(datasetid, datasetversion, data, requestOptions);
25
- };
26
- return useMutation(mutationFn, mutationOptions);
27
- };
28
- var getMetadata = (datasetid, datasetversion, options) => {
29
- return customInstance({ url: `/dataset/${datasetid}/meta/${datasetversion}`, method: "get" }, options);
30
- };
31
- var getGetMetadataQueryKey = (datasetid, datasetversion) => [`/dataset/${datasetid}/meta/${datasetversion}`];
32
- var useGetMetadata = (datasetid, datasetversion, options) => {
33
- const { query: queryOptions, request: requestOptions } = options || {};
34
- const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetMetadataQueryKey(datasetid, datasetversion);
35
- const queryFn = () => getMetadata(datasetid, datasetversion, requestOptions);
36
- const query = useQuery(queryKey, queryFn, __spreadValues({ enabled: !!(datasetid && datasetversion) }, queryOptions));
37
- return __spreadValues({
38
- queryKey
39
- }, query);
40
- };
41
- var updateMetadata = (datasetid, datasetversion, metaparameters, options) => {
42
- return customInstance({
43
- url: `/dataset/${datasetid}/meta/${datasetversion}/${metaparameters}`,
44
- method: "patch"
45
- }, options);
46
- };
47
- var useUpdateMetadata = (options) => {
48
- const { mutation: mutationOptions, request: requestOptions } = options || {};
49
- const mutationFn = (props) => {
50
- const { datasetid, datasetversion, metaparameters } = props || {};
51
- return updateMetadata(datasetid, datasetversion, metaparameters, requestOptions);
52
- };
53
- return useMutation(mutationFn, mutationOptions);
54
- };
55
- export {
56
- addAnnotations,
57
- getGetMetadataQueryKey,
58
- getMetadata,
59
- updateMetadata,
60
- useAddAnnotations,
61
- useGetMetadata,
62
- useUpdateMetadata
63
- };
64
- //# sourceMappingURL=annotation.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/annotation/annotation.ts"],"sourcesContent":["/**\n * Generated by orval v6.6.0 🍺\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: 0.7\n */\nimport {\n useQuery,\n useMutation,\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n DatasetAnnotationsPostResponse,\n DmError,\n DatasetAnnotationsPostBodyBody,\n DatasetMetaGetResponse,\n} from \"../data-manager-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (\n ...args: any\n) => Promise<infer R>\n ? R\n : any;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\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 * Creates new annotations of the specified type(s) and add to the metadata for the dataset.\nThe annotations are provided in a list in JSON format. For details of the annotations that can be created, see the data-manager-metadata library,\n\n * @summary Add new annotations to the Metadata for the Dataset\n */\nexport const addAnnotations = (\n datasetid: string,\n datasetversion: number,\n datasetAnnotationsPostBodyBody: DatasetAnnotationsPostBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"annotations\", datasetAnnotationsPostBodyBody.annotations);\n\n return customInstance<DatasetAnnotationsPostResponse>(\n {\n url: `/dataset/${datasetid}/annotations/${datasetversion}`,\n method: \"post\",\n data: formData,\n },\n options\n );\n};\n\nexport const useAddAnnotations = <\n TError = ErrorType<DmError | void>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof addAnnotations>,\n TError,\n {\n datasetid: string;\n datasetversion: number;\n data: DatasetAnnotationsPostBodyBody;\n },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof addAnnotations>,\n {\n datasetid: string;\n datasetversion: number;\n data: DatasetAnnotationsPostBodyBody;\n }\n > = (props) => {\n const { datasetid, datasetversion, data } = props || {};\n\n return addAnnotations(datasetid, datasetversion, data, requestOptions);\n };\n\n return useMutation<\n AsyncReturnType<typeof addAnnotations>,\n TError,\n {\n datasetid: string;\n datasetversion: number;\n data: DatasetAnnotationsPostBodyBody;\n },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Returns the metadata for a Dataset versions in JSON format.\n\n * @summary Gets the metadata for a specific Dataset\n */\nexport const getMetadata = (\n datasetid: string,\n datasetversion: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<DatasetMetaGetResponse>(\n { url: `/dataset/${datasetid}/meta/${datasetversion}`, method: \"get\" },\n options\n );\n};\n\nexport const getGetMetadataQueryKey = (\n datasetid: string,\n datasetversion: number\n) => [`/dataset/${datasetid}/meta/${datasetversion}`];\n\nexport const useGetMetadata = <\n TData = AsyncReturnType<typeof getMetadata>,\n TError = ErrorType<void | DmError>\n>(\n datasetid: string,\n datasetversion: number,\n options?: {\n query?: UseQueryOptions<AsyncReturnType<typeof getMetadata>, 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 =\n queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetid, datasetversion);\n\n const queryFn: QueryFunction<AsyncReturnType<typeof getMetadata>> = () =>\n getMetadata(datasetid, datasetversion, requestOptions);\n\n const query = useQuery<AsyncReturnType<typeof getMetadata>, TError, TData>(\n queryKey,\n queryFn,\n { enabled: !!(datasetid && datasetversion), ...queryOptions }\n );\n\n return {\n queryKey,\n ...query,\n };\n};\n\n/**\n * Updates the metadata for a Dataset based on the given parameter array.\n\n * @summary Update the metadata for a specific Dataset\n */\nexport const updateMetadata = (\n datasetid: string,\n datasetversion: number,\n metaparameters: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n {\n url: `/dataset/${datasetid}/meta/${datasetversion}/${metaparameters}`,\n method: \"patch\",\n },\n options\n );\n};\n\nexport const useUpdateMetadata = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n AsyncReturnType<typeof updateMetadata>,\n TError,\n { datasetid: string; datasetversion: number; metaparameters: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n const mutationFn: MutationFunction<\n AsyncReturnType<typeof updateMetadata>,\n { datasetid: string; datasetversion: number; metaparameters: string }\n > = (props) => {\n const { datasetid, datasetversion, metaparameters } = props || {};\n\n return updateMetadata(\n datasetid,\n datasetversion,\n metaparameters,\n requestOptions\n );\n };\n\n return useMutation<\n AsyncReturnType<typeof updateMetadata>,\n TError,\n { datasetid: string; datasetversion: number; metaparameters: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n"],"mappings":";;;;;;AAUA;AAAA;AAAA;AAAA;AAuCO,IAAM,iBAAiB,CAC5B,WACA,gBACA,gCACA,YACG;AACH,QAAM,WAAW,IAAI;AACrB,WAAS,OAAO,eAAe,+BAA+B;AAE9D,SAAO,eACL;AAAA,IACE,KAAK,YAAY,yBAAyB;AAAA,IAC1C,QAAQ;AAAA,IACR,MAAM;AAAA,KAER;AAAA;AAIG,IAAM,oBAAoB,CAG/B,YAYI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAOF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,gBAAgB,SAAS,SAAS;AAErD,WAAO,eAAe,WAAW,gBAAgB,MAAM;AAAA;AAGzD,SAAO,YASL,YAAY;AAAA;AAOT,IAAM,cAAc,CACzB,WACA,gBACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,kBAAkB,QAAQ,SAC/D;AAAA;AAIG,IAAM,yBAAyB,CACpC,WACA,mBACG,CAAC,YAAY,kBAAkB;AAE7B,IAAM,iBAAiB,CAI5B,WACA,gBACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WACJ,8CAAc,aAAY,uBAAuB,WAAW;AAE9D,QAAM,UAA8D,MAClE,YAAY,WAAW,gBAAgB;AAEzC,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAE,cAAa,mBAAoB;AAGjD,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AASA,IAAM,iBAAiB,CAC5B,WACA,gBACA,gBACA,YACG;AACH,SAAO,eACL;AAAA,IACE,KAAK,YAAY,kBAAkB,kBAAkB;AAAA,IACrD,QAAQ;AAAA,KAEV;AAAA;AAIG,IAAM,oBAAoB,CAG/B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,gBAAgB,mBAAmB,SAAS;AAE/D,WAAO,eACL,WACA,gBACA,gBACA;AAAA;AAIJ,SAAO,YAKL,YAAY;AAAA;","names":[]}
@@ -1,7 +0,0 @@
1
- {
2
- "module": "./annotation.js",
3
- "main": "./annotation.cjs",
4
- "types": "./annotation.d.ts",
5
- "sideEffects": false,
6
- "type": "module"
7
- }
@@ -1,217 +0,0 @@
1
- /**
2
- * Generated by orval v6.6.0 🍺
3
- * Do not edit manually.
4
- * Dataset Manager API
5
- * The Dataset Manager API service.
6
-
7
- A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
8
-
9
- * OpenAPI spec version: 0.7
10
- */
11
- import {
12
- useQuery,
13
- useMutation,
14
- UseQueryOptions,
15
- UseMutationOptions,
16
- QueryFunction,
17
- MutationFunction,
18
- UseQueryResult,
19
- QueryKey,
20
- } from "react-query";
21
- import type {
22
- DatasetAnnotationsPostResponse,
23
- DmError,
24
- DatasetAnnotationsPostBodyBody,
25
- DatasetMetaGetResponse,
26
- } from "../data-manager-api.schemas";
27
- import { customInstance, ErrorType } from ".././custom-instance";
28
-
29
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
30
- type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
31
- ...args: any
32
- ) => Promise<infer R>
33
- ? R
34
- : any;
35
-
36
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
37
- type SecondParameter<T extends (...args: any) => any> = T extends (
38
- config: any,
39
- args: infer P
40
- ) => any
41
- ? P
42
- : never;
43
-
44
- /**
45
- * Creates new annotations of the specified type(s) and add to the metadata for the dataset.
46
- The annotations are provided in a list in JSON format. For details of the annotations that can be created, see the data-manager-metadata library,
47
-
48
- * @summary Add new annotations to the Metadata for the Dataset
49
- */
50
- export const addAnnotations = (
51
- datasetid: string,
52
- datasetversion: number,
53
- datasetAnnotationsPostBodyBody: DatasetAnnotationsPostBodyBody,
54
- options?: SecondParameter<typeof customInstance>
55
- ) => {
56
- const formData = new FormData();
57
- formData.append("annotations", datasetAnnotationsPostBodyBody.annotations);
58
-
59
- return customInstance<DatasetAnnotationsPostResponse>(
60
- {
61
- url: `/dataset/${datasetid}/annotations/${datasetversion}`,
62
- method: "post",
63
- data: formData,
64
- },
65
- options
66
- );
67
- };
68
-
69
- export const useAddAnnotations = <
70
- TError = ErrorType<DmError | void>,
71
- TContext = unknown
72
- >(options?: {
73
- mutation?: UseMutationOptions<
74
- AsyncReturnType<typeof addAnnotations>,
75
- TError,
76
- {
77
- datasetid: string;
78
- datasetversion: number;
79
- data: DatasetAnnotationsPostBodyBody;
80
- },
81
- TContext
82
- >;
83
- request?: SecondParameter<typeof customInstance>;
84
- }) => {
85
- const { mutation: mutationOptions, request: requestOptions } = options || {};
86
-
87
- const mutationFn: MutationFunction<
88
- AsyncReturnType<typeof addAnnotations>,
89
- {
90
- datasetid: string;
91
- datasetversion: number;
92
- data: DatasetAnnotationsPostBodyBody;
93
- }
94
- > = (props) => {
95
- const { datasetid, datasetversion, data } = props || {};
96
-
97
- return addAnnotations(datasetid, datasetversion, data, requestOptions);
98
- };
99
-
100
- return useMutation<
101
- AsyncReturnType<typeof addAnnotations>,
102
- TError,
103
- {
104
- datasetid: string;
105
- datasetversion: number;
106
- data: DatasetAnnotationsPostBodyBody;
107
- },
108
- TContext
109
- >(mutationFn, mutationOptions);
110
- };
111
- /**
112
- * Returns the metadata for a Dataset versions in JSON format.
113
-
114
- * @summary Gets the metadata for a specific Dataset
115
- */
116
- export const getMetadata = (
117
- datasetid: string,
118
- datasetversion: number,
119
- options?: SecondParameter<typeof customInstance>
120
- ) => {
121
- return customInstance<DatasetMetaGetResponse>(
122
- { url: `/dataset/${datasetid}/meta/${datasetversion}`, method: "get" },
123
- options
124
- );
125
- };
126
-
127
- export const getGetMetadataQueryKey = (
128
- datasetid: string,
129
- datasetversion: number
130
- ) => [`/dataset/${datasetid}/meta/${datasetversion}`];
131
-
132
- export const useGetMetadata = <
133
- TData = AsyncReturnType<typeof getMetadata>,
134
- TError = ErrorType<void | DmError>
135
- >(
136
- datasetid: string,
137
- datasetversion: number,
138
- options?: {
139
- query?: UseQueryOptions<AsyncReturnType<typeof getMetadata>, TError, TData>;
140
- request?: SecondParameter<typeof customInstance>;
141
- }
142
- ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
143
- const { query: queryOptions, request: requestOptions } = options || {};
144
-
145
- const queryKey =
146
- queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetid, datasetversion);
147
-
148
- const queryFn: QueryFunction<AsyncReturnType<typeof getMetadata>> = () =>
149
- getMetadata(datasetid, datasetversion, requestOptions);
150
-
151
- const query = useQuery<AsyncReturnType<typeof getMetadata>, TError, TData>(
152
- queryKey,
153
- queryFn,
154
- { enabled: !!(datasetid && datasetversion), ...queryOptions }
155
- );
156
-
157
- return {
158
- queryKey,
159
- ...query,
160
- };
161
- };
162
-
163
- /**
164
- * Updates the metadata for a Dataset based on the given parameter array.
165
-
166
- * @summary Update the metadata for a specific Dataset
167
- */
168
- export const updateMetadata = (
169
- datasetid: string,
170
- datasetversion: number,
171
- metaparameters: string,
172
- options?: SecondParameter<typeof customInstance>
173
- ) => {
174
- return customInstance<void>(
175
- {
176
- url: `/dataset/${datasetid}/meta/${datasetversion}/${metaparameters}`,
177
- method: "patch",
178
- },
179
- options
180
- );
181
- };
182
-
183
- export const useUpdateMetadata = <
184
- TError = ErrorType<DmError>,
185
- TContext = unknown
186
- >(options?: {
187
- mutation?: UseMutationOptions<
188
- AsyncReturnType<typeof updateMetadata>,
189
- TError,
190
- { datasetid: string; datasetversion: number; metaparameters: string },
191
- TContext
192
- >;
193
- request?: SecondParameter<typeof customInstance>;
194
- }) => {
195
- const { mutation: mutationOptions, request: requestOptions } = options || {};
196
-
197
- const mutationFn: MutationFunction<
198
- AsyncReturnType<typeof updateMetadata>,
199
- { datasetid: string; datasetversion: number; metaparameters: string }
200
- > = (props) => {
201
- const { datasetid, datasetversion, metaparameters } = props || {};
202
-
203
- return updateMetadata(
204
- datasetid,
205
- datasetversion,
206
- metaparameters,
207
- requestOptions
208
- );
209
- };
210
-
211
- return useMutation<
212
- AsyncReturnType<typeof updateMetadata>,
213
- TError,
214
- { datasetid: string; datasetversion: number; metaparameters: string },
215
- TContext
216
- >(mutationFn, mutationOptions);
217
- };