@squonk/data-manager-client 0.7.0 → 0.7.1

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.
Files changed (48) hide show
  1. package/accounting/accounting.cjs +24 -8
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.ts +19 -8
  4. package/accounting/accounting.js +26 -10
  5. package/accounting/accounting.js.map +1 -1
  6. package/admin/admin.cjs +22 -1
  7. package/admin/admin.cjs.map +1 -1
  8. package/admin/admin.d.ts +20 -2
  9. package/admin/admin.js +21 -0
  10. package/admin/admin.js.map +1 -1
  11. package/application/application.d.ts +1 -1
  12. package/{custom-instance-9873bed3.d.ts → custom-instance-eb1ebf45.d.ts} +83 -19
  13. package/dataset/dataset.d.ts +1 -1
  14. package/file/file.d.ts +1 -1
  15. package/index.cjs +23 -1
  16. package/index.cjs.map +1 -1
  17. package/index.d.ts +1 -1
  18. package/index.js +22 -0
  19. package/index.js.map +1 -1
  20. package/instance/instance.cjs +6 -0
  21. package/instance/instance.cjs.map +1 -1
  22. package/instance/instance.d.ts +1 -1
  23. package/instance/instance.js +6 -0
  24. package/instance/instance.js.map +1 -1
  25. package/job/job.d.ts +1 -1
  26. package/metadata/metadata.cjs +93 -0
  27. package/metadata/metadata.cjs.map +1 -0
  28. package/metadata/metadata.d.ts +72 -0
  29. package/metadata/metadata.js +93 -0
  30. package/metadata/metadata.js.map +1 -0
  31. package/metadata/package.json +7 -0
  32. package/package.json +1 -1
  33. package/project/project.d.ts +1 -1
  34. package/src/accounting/accounting.ts +56 -15
  35. package/src/admin/admin.ts +59 -0
  36. package/src/data-manager-api.schemas.ts +108 -20
  37. package/src/instance/instance.ts +6 -0
  38. package/src/metadata/metadata.ts +283 -0
  39. package/task/task.d.ts +1 -1
  40. package/type/type.d.ts +1 -1
  41. package/user/user.d.ts +1 -1
  42. package/annotation/annotation.cjs +0 -64
  43. package/annotation/annotation.cjs.map +0 -1
  44. package/annotation/annotation.d.ts +0 -58
  45. package/annotation/annotation.js +0 -64
  46. package/annotation/annotation.js.map +0 -1
  47. package/annotation/package.json +0 -7
  48. package/src/annotation/annotation.ts +0 -217
@@ -0,0 +1,283 @@
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
+ DatasetMetaGetResponse,
23
+ DmError,
24
+ DatasetVersionMetaPostBodyBody,
25
+ DatasetMetaPostBodyBody,
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
+ * Update parameters or add new annotations of the specified type(s) and to the metadata for the version of the dataset.
46
+ The parameters are provided in a list in keyword/arguments
47
+ 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,
48
+
49
+ * @summary Update Metadata for the Dataset version
50
+ */
51
+ export const addMetadataVersion = (
52
+ datasetid: string,
53
+ datasetversion: number,
54
+ datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
55
+ options?: SecondParameter<typeof customInstance>
56
+ ) => {
57
+ const formData = new FormData();
58
+ if (datasetVersionMetaPostBodyBody.meta_properties !== undefined) {
59
+ formData.append(
60
+ "meta_properties",
61
+ datasetVersionMetaPostBodyBody.meta_properties
62
+ );
63
+ }
64
+ if (datasetVersionMetaPostBodyBody.annotations !== undefined) {
65
+ formData.append("annotations", datasetVersionMetaPostBodyBody.annotations);
66
+ }
67
+
68
+ return customInstance<DatasetMetaGetResponse>(
69
+ {
70
+ url: `/dataset/${datasetid}/meta/${datasetversion}`,
71
+ method: "post",
72
+ data: formData,
73
+ },
74
+ options
75
+ );
76
+ };
77
+
78
+ export const useAddMetadataVersion = <
79
+ TError = ErrorType<DmError | void>,
80
+ TContext = unknown
81
+ >(options?: {
82
+ mutation?: UseMutationOptions<
83
+ AsyncReturnType<typeof addMetadataVersion>,
84
+ TError,
85
+ {
86
+ datasetid: string;
87
+ datasetversion: number;
88
+ data: DatasetVersionMetaPostBodyBody;
89
+ },
90
+ TContext
91
+ >;
92
+ request?: SecondParameter<typeof customInstance>;
93
+ }) => {
94
+ const { mutation: mutationOptions, request: requestOptions } = options || {};
95
+
96
+ const mutationFn: MutationFunction<
97
+ AsyncReturnType<typeof addMetadataVersion>,
98
+ {
99
+ datasetid: string;
100
+ datasetversion: number;
101
+ data: DatasetVersionMetaPostBodyBody;
102
+ }
103
+ > = (props) => {
104
+ const { datasetid, datasetversion, data } = props || {};
105
+
106
+ return addMetadataVersion(datasetid, datasetversion, data, requestOptions);
107
+ };
108
+
109
+ return useMutation<
110
+ AsyncReturnType<typeof addMetadataVersion>,
111
+ TError,
112
+ {
113
+ datasetid: string;
114
+ datasetversion: number;
115
+ data: DatasetVersionMetaPostBodyBody;
116
+ },
117
+ TContext
118
+ >(mutationFn, mutationOptions);
119
+ };
120
+ /**
121
+ * Returns the metadata for a Dataset version in JSON format.
122
+
123
+ * @summary Gets the metadata for a specific Dataset version
124
+ */
125
+ export const getMetadataVersion = (
126
+ datasetid: string,
127
+ datasetversion: number,
128
+ options?: SecondParameter<typeof customInstance>
129
+ ) => {
130
+ return customInstance<DatasetMetaGetResponse>(
131
+ { url: `/dataset/${datasetid}/meta/${datasetversion}`, method: "get" },
132
+ options
133
+ );
134
+ };
135
+
136
+ export const getGetMetadataVersionQueryKey = (
137
+ datasetid: string,
138
+ datasetversion: number
139
+ ) => [`/dataset/${datasetid}/meta/${datasetversion}`];
140
+
141
+ export const useGetMetadataVersion = <
142
+ TData = AsyncReturnType<typeof getMetadataVersion>,
143
+ TError = ErrorType<void | DmError>
144
+ >(
145
+ datasetid: string,
146
+ datasetversion: number,
147
+ options?: {
148
+ query?: UseQueryOptions<
149
+ AsyncReturnType<typeof getMetadataVersion>,
150
+ TError,
151
+ TData
152
+ >;
153
+ request?: SecondParameter<typeof customInstance>;
154
+ }
155
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
156
+ const { query: queryOptions, request: requestOptions } = options || {};
157
+
158
+ const queryKey =
159
+ queryOptions?.queryKey ??
160
+ getGetMetadataVersionQueryKey(datasetid, datasetversion);
161
+
162
+ const queryFn: QueryFunction<
163
+ AsyncReturnType<typeof getMetadataVersion>
164
+ > = () => getMetadataVersion(datasetid, datasetversion, requestOptions);
165
+
166
+ const query = useQuery<
167
+ AsyncReturnType<typeof getMetadataVersion>,
168
+ TError,
169
+ TData
170
+ >(queryKey, queryFn, {
171
+ enabled: !!(datasetid && datasetversion),
172
+ ...queryOptions,
173
+ });
174
+
175
+ return {
176
+ queryKey,
177
+ ...query,
178
+ };
179
+ };
180
+
181
+ /**
182
+ * Update default parameters or add new labels to the metadata for the dataset.
183
+ The parameters are provided in a list in keyword/arguments
184
+ The labels are provided in a list in JSON format. For details of the label format, see the data-manager-metadata library,
185
+
186
+ * @summary Update Metadata for the Dataset
187
+ */
188
+ export const addMetadata = (
189
+ datasetid: string,
190
+ datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
191
+ options?: SecondParameter<typeof customInstance>
192
+ ) => {
193
+ const formData = new FormData();
194
+ if (datasetMetaPostBodyBody.meta_properties !== undefined) {
195
+ formData.append("meta_properties", datasetMetaPostBodyBody.meta_properties);
196
+ }
197
+ if (datasetMetaPostBodyBody.labels !== undefined) {
198
+ formData.append("labels", datasetMetaPostBodyBody.labels);
199
+ }
200
+
201
+ return customInstance<DatasetMetaGetResponse>(
202
+ { url: `/dataset/${datasetid}/meta`, method: "post", data: formData },
203
+ options
204
+ );
205
+ };
206
+
207
+ export const useAddMetadata = <
208
+ TError = ErrorType<DmError | void>,
209
+ TContext = unknown
210
+ >(options?: {
211
+ mutation?: UseMutationOptions<
212
+ AsyncReturnType<typeof addMetadata>,
213
+ TError,
214
+ { datasetid: string; data: DatasetMetaPostBodyBody },
215
+ TContext
216
+ >;
217
+ request?: SecondParameter<typeof customInstance>;
218
+ }) => {
219
+ const { mutation: mutationOptions, request: requestOptions } = options || {};
220
+
221
+ const mutationFn: MutationFunction<
222
+ AsyncReturnType<typeof addMetadata>,
223
+ { datasetid: string; data: DatasetMetaPostBodyBody }
224
+ > = (props) => {
225
+ const { datasetid, data } = props || {};
226
+
227
+ return addMetadata(datasetid, data, requestOptions);
228
+ };
229
+
230
+ return useMutation<
231
+ AsyncReturnType<typeof addMetadata>,
232
+ TError,
233
+ { datasetid: string; data: DatasetMetaPostBodyBody },
234
+ TContext
235
+ >(mutationFn, mutationOptions);
236
+ };
237
+ /**
238
+ * Returns the metadata for a Dataset in JSON format.
239
+
240
+ * @summary Gets the metadata for a specific Dataset
241
+ */
242
+ export const getMetadata = (
243
+ datasetid: string,
244
+ options?: SecondParameter<typeof customInstance>
245
+ ) => {
246
+ return customInstance<DatasetMetaGetResponse>(
247
+ { url: `/dataset/${datasetid}/meta`, method: "get" },
248
+ options
249
+ );
250
+ };
251
+
252
+ export const getGetMetadataQueryKey = (datasetid: string) => [
253
+ `/dataset/${datasetid}/meta`,
254
+ ];
255
+
256
+ export const useGetMetadata = <
257
+ TData = AsyncReturnType<typeof getMetadata>,
258
+ TError = ErrorType<void | DmError>
259
+ >(
260
+ datasetid: string,
261
+ options?: {
262
+ query?: UseQueryOptions<AsyncReturnType<typeof getMetadata>, TError, TData>;
263
+ request?: SecondParameter<typeof customInstance>;
264
+ }
265
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
266
+ const { query: queryOptions, request: requestOptions } = options || {};
267
+
268
+ const queryKey = queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetid);
269
+
270
+ const queryFn: QueryFunction<AsyncReturnType<typeof getMetadata>> = () =>
271
+ getMetadata(datasetid, requestOptions);
272
+
273
+ const query = useQuery<AsyncReturnType<typeof getMetadata>, TError, TData>(
274
+ queryKey,
275
+ queryFn,
276
+ { enabled: !!datasetid, ...queryOptions }
277
+ );
278
+
279
+ return {
280
+ queryKey,
281
+ ...query,
282
+ };
283
+ };
package/task/task.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as react_query from 'react-query';
2
2
  import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
3
- import { d as GetTasksParams, b7 as customInstance, ax as TasksGetResponse, b8 as ErrorType, b3 as DmError, c as GetTaskParams, az as TaskGetResponse } from '../custom-instance-9873bed3';
3
+ import { c as GetTasksParams, bb as customInstance, aB as TasksGetResponse, bc as ErrorType, b7 as DmError, b as GetTaskParams, aD as TaskGetResponse } from '../custom-instance-eb1ebf45';
4
4
  import 'axios';
5
5
 
6
6
  declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
package/type/type.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
2
- import { b7 as customInstance, aw as TypesGetResponse, b8 as ErrorType, b3 as DmError } from '../custom-instance-9873bed3';
2
+ import { bb as customInstance, aA as TypesGetResponse, bc as ErrorType, b7 as DmError } from '../custom-instance-eb1ebf45';
3
3
  import 'axios';
4
4
 
5
5
  /**
package/user/user.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as react_query from 'react-query';
2
2
  import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
3
- import { b7 as customInstance, at as UsersGetResponse, b8 as ErrorType, b3 as DmError, a as GetUserAccountParams, T as UserAccountDetail, F as UserAccountPatchBodyBody, G as GetUserApiLogParams, au as UserApiLogGetResponse } from '../custom-instance-9873bed3';
3
+ import { bb as customInstance, ax as UsersGetResponse, bc as ErrorType, b7 as DmError, E as GetUserAccountParams, W as UserAccountDetail, F as UserAccountPatchBodyBody, G as GetUserApiLogParams, ay as UserApiLogGetResponse } from '../custom-instance-eb1ebf45';
4
4
  import 'axios';
5
5
 
6
6
  declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
@@ -1,64 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
2
-
3
-
4
- var _chunk3DXYUDZHcjs = require('../chunk-3DXYUDZH.cjs');
5
-
6
- // src/annotation/annotation.ts
7
-
8
-
9
-
10
- var _reactquery = require('react-query');
11
- var addAnnotations = (datasetid, datasetversion, datasetAnnotationsPostBodyBody, options) => {
12
- const formData = new FormData();
13
- formData.append("annotations", datasetAnnotationsPostBodyBody.annotations);
14
- return _chunk3DXYUDZHcjs.customInstance.call(void 0, {
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 _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
27
- };
28
- var getMetadata = (datasetid, datasetversion, options) => {
29
- return _chunk3DXYUDZHcjs.customInstance.call(void 0, { 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 = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetMetadataQueryKey(datasetid, datasetversion)));
35
- const queryFn = () => getMetadata(datasetid, datasetversion, requestOptions);
36
- const query = _reactquery.useQuery.call(void 0, queryKey, queryFn, _chunk3DXYUDZHcjs.__spreadValues.call(void 0, { enabled: !!(datasetid && datasetversion) }, queryOptions));
37
- return _chunk3DXYUDZHcjs.__spreadValues.call(void 0, {
38
- queryKey
39
- }, query);
40
- };
41
- var updateMetadata = (datasetid, datasetversion, metaparameters, options) => {
42
- return _chunk3DXYUDZHcjs.customInstance.call(void 0, {
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 _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
54
- };
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
- exports.addAnnotations = addAnnotations; exports.getGetMetadataQueryKey = getGetMetadataQueryKey; exports.getMetadata = getMetadata; exports.updateMetadata = updateMetadata; exports.useAddAnnotations = useAddAnnotations; exports.useGetMetadata = useGetMetadata; exports.useUpdateMetadata = useUpdateMetadata;
64
- //# sourceMappingURL=annotation.cjs.map
@@ -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 { N as DatasetAnnotationsPostBodyBody, b7 as customInstance, aZ as DatasetAnnotationsPostResponse, b8 as ErrorType, b3 as DmError, aW as DatasetMetaGetResponse } from '../custom-instance-9873bed3';
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
- }