@squonk/data-manager-client 1.2.8 → 1.2.9

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 (114) hide show
  1. package/README.md +1 -1
  2. package/accounting/accounting.cjs +51 -8
  3. package/accounting/accounting.cjs.map +1 -1
  4. package/accounting/accounting.d.cts +61 -10
  5. package/accounting/accounting.d.ts +61 -10
  6. package/accounting/accounting.js +49 -6
  7. package/accounting/accounting.js.map +1 -1
  8. package/admin/admin.cjs +67 -24
  9. package/admin/admin.cjs.map +1 -1
  10. package/admin/admin.d.cts +75 -24
  11. package/admin/admin.d.ts +75 -24
  12. package/admin/admin.js +56 -13
  13. package/admin/admin.js.map +1 -1
  14. package/application/application.cjs +35 -6
  15. package/application/application.cjs.map +1 -1
  16. package/application/application.d.cts +42 -8
  17. package/application/application.d.ts +42 -8
  18. package/application/application.js +34 -5
  19. package/application/application.js.map +1 -1
  20. package/{chunk-UKA7G3OB.js → chunk-EBOQPVLG.js} +2 -2
  21. package/{chunk-UKA7G3OB.js.map → chunk-EBOQPVLG.js.map} +1 -1
  22. package/{chunk-J22A7LHX.cjs → chunk-TKLTUR4R.cjs} +2 -2
  23. package/chunk-TKLTUR4R.cjs.map +1 -0
  24. package/configuration/configuration.cjs +19 -4
  25. package/configuration/configuration.cjs.map +1 -1
  26. package/configuration/configuration.d.cts +23 -6
  27. package/configuration/configuration.d.ts +23 -6
  28. package/configuration/configuration.js +19 -4
  29. package/configuration/configuration.js.map +1 -1
  30. package/dataset/dataset.cjs +93 -22
  31. package/dataset/dataset.cjs.map +1 -1
  32. package/dataset/dataset.d.cts +105 -20
  33. package/dataset/dataset.d.ts +105 -20
  34. package/dataset/dataset.js +83 -12
  35. package/dataset/dataset.js.map +1 -1
  36. package/exchange-rate/exchange-rate.cjs +71 -14
  37. package/exchange-rate/exchange-rate.cjs.map +1 -1
  38. package/exchange-rate/exchange-rate.d.cts +83 -15
  39. package/exchange-rate/exchange-rate.d.ts +83 -15
  40. package/exchange-rate/exchange-rate.js +65 -8
  41. package/exchange-rate/exchange-rate.js.map +1 -1
  42. package/file-and-path/file-and-path.cjs +45 -16
  43. package/file-and-path/file-and-path.cjs.map +1 -1
  44. package/file-and-path/file-and-path.d.cts +48 -14
  45. package/file-and-path/file-and-path.d.ts +48 -14
  46. package/file-and-path/file-and-path.js +39 -10
  47. package/file-and-path/file-and-path.js.map +1 -1
  48. package/index.cjs +9 -2
  49. package/index.cjs.map +1 -1
  50. package/index.d.cts +2033 -2
  51. package/index.d.ts +2033 -2
  52. package/index.js +8 -1
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +45 -16
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +48 -14
  57. package/instance/instance.d.ts +48 -14
  58. package/instance/instance.js +38 -9
  59. package/instance/instance.js.map +1 -1
  60. package/job/job.cjs +51 -8
  61. package/job/job.cjs.map +1 -1
  62. package/job/job.d.cts +61 -10
  63. package/job/job.d.ts +61 -10
  64. package/job/job.js +49 -6
  65. package/job/job.js.map +1 -1
  66. package/metadata/metadata.cjs +39 -10
  67. package/metadata/metadata.cjs.map +1 -1
  68. package/metadata/metadata.d.cts +45 -11
  69. package/metadata/metadata.d.ts +45 -11
  70. package/metadata/metadata.js +36 -7
  71. package/metadata/metadata.js.map +1 -1
  72. package/package.json +11 -11
  73. package/project/project.cjs +83 -26
  74. package/project/project.cjs.map +1 -1
  75. package/project/project.d.cts +89 -21
  76. package/project/project.d.ts +89 -21
  77. package/project/project.js +71 -14
  78. package/project/project.js.map +1 -1
  79. package/src/accounting/accounting.ts +136 -22
  80. package/src/admin/admin.ts +148 -50
  81. package/src/application/application.ts +93 -18
  82. package/src/configuration/configuration.ts +50 -14
  83. package/src/custom-instance.ts +3 -4
  84. package/src/data-manager-api.schemas.ts +59 -33
  85. package/src/dataset/dataset.ts +233 -45
  86. package/src/exchange-rate/exchange-rate.ts +185 -32
  87. package/src/file-and-path/file-and-path.ts +98 -33
  88. package/src/instance/instance.ts +98 -33
  89. package/src/job/job.ts +138 -22
  90. package/src/metadata/metadata.ts +97 -24
  91. package/src/project/project.ts +191 -50
  92. package/src/task/task.ts +96 -21
  93. package/src/type/type.ts +50 -14
  94. package/src/user/user.ts +137 -25
  95. package/task/task.cjs +37 -8
  96. package/task/task.cjs.map +1 -1
  97. package/task/task.d.cts +44 -10
  98. package/task/task.d.ts +44 -10
  99. package/task/task.js +35 -6
  100. package/task/task.js.map +1 -1
  101. package/type/type.cjs +19 -4
  102. package/type/type.cjs.map +1 -1
  103. package/type/type.d.cts +23 -6
  104. package/type/type.d.ts +23 -6
  105. package/type/type.js +19 -4
  106. package/type/type.js.map +1 -1
  107. package/user/user.cjs +53 -10
  108. package/user/user.cjs.map +1 -1
  109. package/user/user.d.cts +63 -12
  110. package/user/user.d.ts +63 -12
  111. package/user/user.js +49 -6
  112. package/user/user.js.map +1 -1
  113. package/chunk-J22A7LHX.cjs.map +0 -1
  114. package/custom-instance-37ed2460.d.ts +0 -2014
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v6.20.0 🍺
2
+ * Generated by orval v6.25.0 🍺
3
3
  * Do not edit manually.
4
4
  * Dataset Manager API
5
5
  * The Dataset Manager API service.
@@ -10,7 +10,8 @@ A service that allows *registered* users to make **Datasets** and associated **M
10
10
  */
11
11
  import {
12
12
  useMutation,
13
- useQuery
13
+ useQuery,
14
+ useSuspenseQuery
14
15
  } from '@tanstack/react-query'
15
16
  import type {
16
17
  MutationFunction,
@@ -18,7 +19,9 @@ import type {
18
19
  QueryKey,
19
20
  UseMutationOptions,
20
21
  UseQueryOptions,
21
- UseQueryResult
22
+ UseQueryResult,
23
+ UseSuspenseQueryOptions,
24
+ UseSuspenseQueryResult
22
25
  } from '@tanstack/react-query'
23
26
  import type {
24
27
  CreatePathParams,
@@ -34,13 +37,7 @@ import { customInstance } from '.././custom-instance';
34
37
  import type { ErrorType } from '.././custom-instance';
35
38
 
36
39
 
37
- // eslint-disable-next-line
38
- type SecondParameter<T extends (...args: any) => any> = T extends (
39
- config: any,
40
- args: infer P,
41
- ) => any
42
- ? P
43
- : never;
40
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
44
41
 
45
42
 
46
43
  /**
@@ -56,7 +53,7 @@ export const createPath = (
56
53
 
57
54
 
58
55
  return customInstance<void>(
59
- {url: `/path`, method: 'put',
56
+ {url: `/path`, method: 'PUT',
60
57
  params
61
58
  },
62
59
  options);
@@ -65,7 +62,6 @@ export const createPath = (
65
62
 
66
63
 
67
64
  export const getCreatePathMutationOptions = <TError = ErrorType<DmError>,
68
-
69
65
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError,{params: CreatePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
70
66
  ): UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError,{params: CreatePathParams}, TContext> => {
71
67
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -92,7 +88,6 @@ export const getCreatePathMutationOptions = <TError = ErrorType<DmError>,
92
88
  * @summary Create a new Project Path
93
89
  */
94
90
  export const useCreatePath = <TError = ErrorType<DmError>,
95
-
96
91
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError,{params: CreatePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
97
92
  ) => {
98
93
 
@@ -113,7 +108,7 @@ export const deletePath = (
113
108
 
114
109
 
115
110
  return customInstance<void>(
116
- {url: `/path`, method: 'delete',
111
+ {url: `/path`, method: 'DELETE',
117
112
  params
118
113
  },
119
114
  options);
@@ -122,7 +117,6 @@ export const deletePath = (
122
117
 
123
118
 
124
119
  export const getDeletePathMutationOptions = <TError = ErrorType<DmError>,
125
-
126
120
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError,{params: DeletePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
127
121
  ): UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError,{params: DeletePathParams}, TContext> => {
128
122
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -149,7 +143,6 @@ export const getDeletePathMutationOptions = <TError = ErrorType<DmError>,
149
143
  * @summary Delete a Project Path
150
144
  */
151
145
  export const useDeletePath = <TError = ErrorType<DmError>,
152
-
153
146
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError,{params: DeletePathParams}, TContext>, request?: SecondParameter<typeof customInstance>}
154
147
  ) => {
155
148
 
@@ -169,7 +162,7 @@ export const getFiles = (
169
162
 
170
163
 
171
164
  return customInstance<FilesGetResponse>(
172
- {url: `/file`, method: 'get',
165
+ {url: `/file`, method: 'GET',
173
166
  params, signal
174
167
  },
175
168
  options);
@@ -177,12 +170,11 @@ export const getFiles = (
177
170
 
178
171
 
179
172
  export const getGetFilesQueryKey = (params: GetFilesParams,) => {
180
-
181
173
  return ["data-manager-api", `/file`, ...(params ? [params]: [])] as const;
182
174
  }
183
175
 
184
176
 
185
- export const getGetFilesQueryOptions = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
177
+ export const getGetFilesQueryOptions = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
186
178
  ) => {
187
179
 
188
180
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -207,7 +199,7 @@ export type GetFilesQueryError = ErrorType<void | DmError>
207
199
  * @summary Gets the Files on a Project Path
208
200
  */
209
201
  export const useGetFiles = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(
210
- params: GetFilesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
202
+ params: GetFilesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
211
203
 
212
204
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
213
205
 
@@ -222,6 +214,46 @@ export const useGetFiles = <TData = Awaited<ReturnType<typeof getFiles>>, TError
222
214
 
223
215
 
224
216
 
217
+ export const getGetFilesSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
218
+ ) => {
219
+
220
+ const {query: queryOptions, request: requestOptions} = options ?? {};
221
+
222
+ const queryKey = queryOptions?.queryKey ?? getGetFilesQueryKey(params);
223
+
224
+
225
+
226
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getFiles>>> = ({ signal }) => getFiles(params, requestOptions, signal);
227
+
228
+
229
+
230
+
231
+
232
+ return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & { queryKey: QueryKey }
233
+ }
234
+
235
+ export type GetFilesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getFiles>>>
236
+ export type GetFilesSuspenseQueryError = ErrorType<void | DmError>
237
+
238
+ /**
239
+ * @summary Gets the Files on a Project Path
240
+ */
241
+ export const useGetFilesSuspense = <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(
242
+ params: GetFilesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
243
+
244
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
245
+
246
+ const queryOptions = getGetFilesSuspenseQueryOptions(params,options)
247
+
248
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
249
+
250
+ query.queryKey = queryOptions.queryKey ;
251
+
252
+ return query;
253
+ }
254
+
255
+
256
+
225
257
  /**
226
258
  * Given a Project and a Dataset the Dataset will be attached (added) to the project as a File using the format provided. When attached the Dataset is referred to as a Project **File**. As format conversion may take some time the file may not be immediately available. You should use the `task_id` you're presented with on the `/task` endpoint to determine when the file is available to the project.
227
259
 
@@ -255,7 +287,7 @@ if(filePostBodyBody.immutable !== undefined) {
255
287
  }
256
288
 
257
289
  return customInstance<FilePostResponse>(
258
- {url: `/file`, method: 'post',
290
+ {url: `/file`, method: 'POST',
259
291
  headers: {'Content-Type': 'multipart/form-data', },
260
292
  data: formData
261
293
  },
@@ -265,7 +297,6 @@ if(filePostBodyBody.immutable !== undefined) {
265
297
 
266
298
 
267
299
  export const getAttachFileMutationOptions = <TError = ErrorType<void | DmError>,
268
-
269
300
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError,{data: FilePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
270
301
  ): UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError,{data: FilePostBodyBody}, TContext> => {
271
302
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -292,7 +323,6 @@ export const getAttachFileMutationOptions = <TError = ErrorType<void | DmError>,
292
323
  * @summary Attach a Dataset, as a File, to a Project
293
324
  */
294
325
  export const useAttachFile = <TError = ErrorType<void | DmError>,
295
-
296
326
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError,{data: FilePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
297
327
  ) => {
298
328
 
@@ -313,7 +343,7 @@ export const deleteUnmanagedFile = (
313
343
 
314
344
 
315
345
  return customInstance<void>(
316
- {url: `/file`, method: 'delete',
346
+ {url: `/file`, method: 'DELETE',
317
347
  params
318
348
  },
319
349
  options);
@@ -322,7 +352,6 @@ export const deleteUnmanagedFile = (
322
352
 
323
353
 
324
354
  export const getDeleteUnmanagedFileMutationOptions = <TError = ErrorType<DmError>,
325
-
326
355
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError,{params: DeleteUnmanagedFileParams}, TContext>, request?: SecondParameter<typeof customInstance>}
327
356
  ): UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError,{params: DeleteUnmanagedFileParams}, TContext> => {
328
357
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -349,7 +378,6 @@ export const getDeleteUnmanagedFileMutationOptions = <TError = ErrorType<DmError
349
378
  * @summary Delete an unmanaged Project File
350
379
  */
351
380
  export const useDeleteUnmanagedFile = <TError = ErrorType<DmError>,
352
-
353
381
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError,{params: DeleteUnmanagedFileParams}, TContext>, request?: SecondParameter<typeof customInstance>}
354
382
  ) => {
355
383
 
@@ -372,7 +400,7 @@ export const deleteFile = (
372
400
 
373
401
 
374
402
  return customInstance<void>(
375
- {url: `/file/${fileId}`, method: 'delete'
403
+ {url: `/file/${fileId}`, method: 'DELETE'
376
404
  },
377
405
  options);
378
406
  }
@@ -380,7 +408,6 @@ export const deleteFile = (
380
408
 
381
409
 
382
410
  export const getDeleteFileMutationOptions = <TError = ErrorType<DmError>,
383
-
384
411
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError,{fileId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
385
412
  ): UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError,{fileId: string}, TContext> => {
386
413
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -407,7 +434,6 @@ export const getDeleteFileMutationOptions = <TError = ErrorType<DmError>,
407
434
  * @summary Delete/detach a File (from a Project)
408
435
  */
409
436
  export const useDeleteFile = <TError = ErrorType<DmError>,
410
-
411
437
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError,{fileId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
412
438
  ) => {
413
439
 
@@ -429,19 +455,18 @@ export const downloadFile = (
429
455
 
430
456
 
431
457
  return customInstance<void>(
432
- {url: `/file/${fileId}`, method: 'get', signal
458
+ {url: `/file/${fileId}`, method: 'GET', signal
433
459
  },
434
460
  options);
435
461
  }
436
462
 
437
463
 
438
464
  export const getDownloadFileQueryKey = (fileId: string,) => {
439
-
440
465
  return ["data-manager-api", `/file/${fileId}`] as const;
441
466
  }
442
467
 
443
468
 
444
- export const getDownloadFileQueryOptions = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(fileId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
469
+ export const getDownloadFileQueryOptions = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(fileId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
445
470
  ) => {
446
471
 
447
472
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -466,7 +491,7 @@ export type DownloadFileQueryError = ErrorType<DmError>
466
491
  * @summary Download a File (from a project)
467
492
  */
468
493
  export const useDownloadFile = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(
469
- fileId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
494
+ fileId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
470
495
 
471
496
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
472
497
 
@@ -481,3 +506,43 @@ export const useDownloadFile = <TData = Awaited<ReturnType<typeof downloadFile>>
481
506
 
482
507
 
483
508
 
509
+ export const getDownloadFileSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(fileId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
510
+ ) => {
511
+
512
+ const {query: queryOptions, request: requestOptions} = options ?? {};
513
+
514
+ const queryKey = queryOptions?.queryKey ?? getDownloadFileQueryKey(fileId);
515
+
516
+
517
+
518
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof downloadFile>>> = ({ signal }) => downloadFile(fileId, requestOptions, signal);
519
+
520
+
521
+
522
+
523
+
524
+ return { queryKey, queryFn, enabled: !!(fileId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & { queryKey: QueryKey }
525
+ }
526
+
527
+ export type DownloadFileSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadFile>>>
528
+ export type DownloadFileSuspenseQueryError = ErrorType<DmError>
529
+
530
+ /**
531
+ * @summary Download a File (from a project)
532
+ */
533
+ export const useDownloadFileSuspense = <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<DmError>>(
534
+ fileId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
535
+
536
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
537
+
538
+ const queryOptions = getDownloadFileSuspenseQueryOptions(fileId,options)
539
+
540
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
541
+
542
+ query.queryKey = queryOptions.queryKey ;
543
+
544
+ return query;
545
+ }
546
+
547
+
548
+
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v6.20.0 🍺
2
+ * Generated by orval v6.25.0 🍺
3
3
  * Do not edit manually.
4
4
  * Dataset Manager API
5
5
  * The Dataset Manager API service.
@@ -10,7 +10,8 @@ A service that allows *registered* users to make **Datasets** and associated **M
10
10
  */
11
11
  import {
12
12
  useMutation,
13
- useQuery
13
+ useQuery,
14
+ useSuspenseQuery
14
15
  } from '@tanstack/react-query'
15
16
  import type {
16
17
  MutationFunction,
@@ -18,7 +19,9 @@ import type {
18
19
  QueryKey,
19
20
  UseMutationOptions,
20
21
  UseQueryOptions,
21
- UseQueryResult
22
+ UseQueryResult,
23
+ UseSuspenseQueryOptions,
24
+ UseSuspenseQueryResult
22
25
  } from '@tanstack/react-query'
23
26
  import type {
24
27
  DmError,
@@ -35,13 +38,7 @@ import { customInstance } from '.././custom-instance';
35
38
  import type { ErrorType } from '.././custom-instance';
36
39
 
37
40
 
38
- // eslint-disable-next-line
39
- type SecondParameter<T extends (...args: any) => any> = T extends (
40
- config: any,
41
- args: infer P,
42
- ) => any
43
- ? P
44
- : never;
41
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
45
42
 
46
43
 
47
44
  /**
@@ -86,7 +83,7 @@ if(instancePostBodyBody.specification !== undefined) {
86
83
  }
87
84
 
88
85
  return customInstance<InstancePostResponse>(
89
- {url: `/instance`, method: 'post',
86
+ {url: `/instance`, method: 'POST',
90
87
  headers: {'Content-Type': 'multipart/form-data', },
91
88
  data: formData
92
89
  },
@@ -96,7 +93,6 @@ if(instancePostBodyBody.specification !== undefined) {
96
93
 
97
94
 
98
95
  export const getCreateInstanceMutationOptions = <TError = ErrorType<void | DmError>,
99
-
100
96
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
101
97
  ): UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError,{data: InstancePostBodyBody}, TContext> => {
102
98
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -123,7 +119,6 @@ export const getCreateInstanceMutationOptions = <TError = ErrorType<void | DmErr
123
119
  * @summary Creates a new Job or Application instance
124
120
  */
125
121
  export const useCreateInstance = <TError = ErrorType<void | DmError>,
126
-
127
122
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
128
123
  ) => {
129
124
 
@@ -143,7 +138,7 @@ export const getInstances = (
143
138
 
144
139
 
145
140
  return customInstance<InstancesGetResponse>(
146
- {url: `/instance`, method: 'get',
141
+ {url: `/instance`, method: 'GET',
147
142
  params, signal
148
143
  },
149
144
  options);
@@ -151,12 +146,11 @@ export const getInstances = (
151
146
 
152
147
 
153
148
  export const getGetInstancesQueryKey = (params?: GetInstancesParams,) => {
154
-
155
149
  return ["data-manager-api", `/instance`, ...(params ? [params]: [])] as const;
156
150
  }
157
151
 
158
152
 
159
- export const getGetInstancesQueryOptions = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
153
+ export const getGetInstancesQueryOptions = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
160
154
  ) => {
161
155
 
162
156
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -181,7 +175,7 @@ export type GetInstancesQueryError = ErrorType<void | DmError>
181
175
  * @summary Get summary information about all Job and Application instances
182
176
  */
183
177
  export const useGetInstances = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(
184
- params?: GetInstancesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
178
+ params?: GetInstancesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
185
179
 
186
180
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
187
181
 
@@ -196,6 +190,46 @@ export const useGetInstances = <TData = Awaited<ReturnType<typeof getInstances>>
196
190
 
197
191
 
198
192
 
193
+ export const getGetInstancesSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(params?: GetInstancesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
194
+ ) => {
195
+
196
+ const {query: queryOptions, request: requestOptions} = options ?? {};
197
+
198
+ const queryKey = queryOptions?.queryKey ?? getGetInstancesQueryKey(params);
199
+
200
+
201
+
202
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstances>>> = ({ signal }) => getInstances(params, requestOptions, signal);
203
+
204
+
205
+
206
+
207
+
208
+ return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData> & { queryKey: QueryKey }
209
+ }
210
+
211
+ export type GetInstancesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstances>>>
212
+ export type GetInstancesSuspenseQueryError = ErrorType<void | DmError>
213
+
214
+ /**
215
+ * @summary Get summary information about all Job and Application instances
216
+ */
217
+ export const useGetInstancesSuspense = <TData = Awaited<ReturnType<typeof getInstances>>, TError = ErrorType<void | DmError>>(
218
+ params?: GetInstancesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
219
+
220
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
221
+
222
+ const queryOptions = getGetInstancesSuspenseQueryOptions(params,options)
223
+
224
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
225
+
226
+ query.queryKey = queryOptions.queryKey ;
227
+
228
+ return query;
229
+ }
230
+
231
+
232
+
199
233
  /**
200
234
  * Similar to the `/instance [POST]` endpoint this one is used to check whether a new **Application** or **Job** instance can be launched. Rather than returning an **Instance** (or **Task**) ID this endpoint is simply used to ensure that the Job/Application is runnable while also returning the compiled `command` (if the Instance is a Job).
201
235
 
@@ -234,7 +268,7 @@ if(instancePostBodyBody.specification !== undefined) {
234
268
  }
235
269
 
236
270
  return customInstance<InstanceDryRunPostResponse>(
237
- {url: `/instance/dry-run`, method: 'post',
271
+ {url: `/instance/dry-run`, method: 'POST',
238
272
  headers: {'Content-Type': 'multipart/form-data', },
239
273
  data: formData
240
274
  },
@@ -244,7 +278,6 @@ if(instancePostBodyBody.specification !== undefined) {
244
278
 
245
279
 
246
280
  export const getDryRunInstanceMutationOptions = <TError = ErrorType<void | DmError>,
247
-
248
281
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
249
282
  ): UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError,{data: InstancePostBodyBody}, TContext> => {
250
283
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -271,7 +304,6 @@ export const getDryRunInstanceMutationOptions = <TError = ErrorType<void | DmErr
271
304
  * @summary Used to check the execution of new Job or Application instance
272
305
  */
273
306
  export const useDryRunInstance = <TError = ErrorType<void | DmError>,
274
-
275
307
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof dryRunInstance>>, TError,{data: InstancePostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
276
308
  ) => {
277
309
 
@@ -289,19 +321,18 @@ export const getInstance = (
289
321
 
290
322
 
291
323
  return customInstance<InstanceGetResponse>(
292
- {url: `/instance/${instanceId}`, method: 'get', signal
324
+ {url: `/instance/${instanceId}`, method: 'GET', signal
293
325
  },
294
326
  options);
295
327
  }
296
328
 
297
329
 
298
330
  export const getGetInstanceQueryKey = (instanceId: string,) => {
299
-
300
331
  return ["data-manager-api", `/instance/${instanceId}`] as const;
301
332
  }
302
333
 
303
334
 
304
- export const getGetInstanceQueryOptions = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
335
+ export const getGetInstanceQueryOptions = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
305
336
  ) => {
306
337
 
307
338
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -326,7 +357,7 @@ export type GetInstanceQueryError = ErrorType<void | DmError>
326
357
  * @summary Get detailed information about an Instance
327
358
  */
328
359
  export const useGetInstance = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(
329
- instanceId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
360
+ instanceId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
330
361
 
331
362
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
332
363
 
@@ -341,6 +372,46 @@ export const useGetInstance = <TData = Awaited<ReturnType<typeof getInstance>>,
341
372
 
342
373
 
343
374
 
375
+ export const getGetInstanceSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(instanceId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
376
+ ) => {
377
+
378
+ const {query: queryOptions, request: requestOptions} = options ?? {};
379
+
380
+ const queryKey = queryOptions?.queryKey ?? getGetInstanceQueryKey(instanceId);
381
+
382
+
383
+
384
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstance>>> = ({ signal }) => getInstance(instanceId, requestOptions, signal);
385
+
386
+
387
+
388
+
389
+
390
+ return { queryKey, queryFn, enabled: !!(instanceId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData> & { queryKey: QueryKey }
391
+ }
392
+
393
+ export type GetInstanceSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstance>>>
394
+ export type GetInstanceSuspenseQueryError = ErrorType<void | DmError>
395
+
396
+ /**
397
+ * @summary Get detailed information about an Instance
398
+ */
399
+ export const useGetInstanceSuspense = <TData = Awaited<ReturnType<typeof getInstance>>, TError = ErrorType<void | DmError>>(
400
+ instanceId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
401
+
402
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
403
+
404
+ const queryOptions = getGetInstanceSuspenseQueryOptions(instanceId,options)
405
+
406
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
407
+
408
+ query.queryKey = queryOptions.queryKey ;
409
+
410
+ return query;
411
+ }
412
+
413
+
414
+
344
415
  /**
345
416
  * The Application or Job Instance is terminated.
346
417
 
@@ -354,7 +425,7 @@ export const terminateInstance = (
354
425
 
355
426
 
356
427
  return customInstance<TaskIdentity>(
357
- {url: `/instance/${instanceId}`, method: 'delete'
428
+ {url: `/instance/${instanceId}`, method: 'DELETE'
358
429
  },
359
430
  options);
360
431
  }
@@ -362,7 +433,6 @@ export const terminateInstance = (
362
433
 
363
434
 
364
435
  export const getTerminateInstanceMutationOptions = <TError = ErrorType<void | DmError>,
365
-
366
436
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError,{instanceId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
367
437
  ): UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError,{instanceId: string}, TContext> => {
368
438
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -389,7 +459,6 @@ export const getTerminateInstanceMutationOptions = <TError = ErrorType<void | Dm
389
459
  * @summary Delete a Job or Application Instance
390
460
  */
391
461
  export const useTerminateInstance = <TError = ErrorType<void | DmError>,
392
-
393
462
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof terminateInstance>>, TError,{instanceId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
394
463
  ) => {
395
464
 
@@ -411,7 +480,7 @@ export const patchInstance = (
411
480
 
412
481
 
413
482
  return customInstance<void>(
414
- {url: `/instance/${instanceId}`, method: 'patch',
483
+ {url: `/instance/${instanceId}`, method: 'PATCH',
415
484
  params
416
485
  },
417
486
  options);
@@ -420,7 +489,6 @@ export const patchInstance = (
420
489
 
421
490
 
422
491
  export const getPatchInstanceMutationOptions = <TError = ErrorType<DmError>,
423
-
424
492
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError,{instanceId: string;params?: PatchInstanceParams}, TContext>, request?: SecondParameter<typeof customInstance>}
425
493
  ): UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError,{instanceId: string;params?: PatchInstanceParams}, TContext> => {
426
494
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -447,7 +515,6 @@ export const getPatchInstanceMutationOptions = <TError = ErrorType<DmError>,
447
515
  * @summary Update a Job or Application Instance
448
516
  */
449
517
  export const usePatchInstance = <TError = ErrorType<DmError>,
450
-
451
518
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof patchInstance>>, TError,{instanceId: string;params?: PatchInstanceParams}, TContext>, request?: SecondParameter<typeof customInstance>}
452
519
  ) => {
453
520
 
@@ -471,7 +538,7 @@ export const deleteInstanceToken = (
471
538
 
472
539
 
473
540
  return customInstance<void>(
474
- {url: `/instance/${instanceId}/token/${token}`, method: 'delete'
541
+ {url: `/instance/${instanceId}/token/${token}`, method: 'DELETE'
475
542
  },
476
543
  options);
477
544
  }
@@ -479,7 +546,6 @@ export const deleteInstanceToken = (
479
546
 
480
547
 
481
548
  export const getDeleteInstanceTokenMutationOptions = <TError = ErrorType<DmError>,
482
-
483
549
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError,{instanceId: string;token: string}, TContext>, request?: SecondParameter<typeof customInstance>}
484
550
  ): UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError,{instanceId: string;token: string}, TContext> => {
485
551
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -506,7 +572,6 @@ export const getDeleteInstanceTokenMutationOptions = <TError = ErrorType<DmError
506
572
  * @summary Delete (revoke) the Instance Token
507
573
  */
508
574
  export const useDeleteInstanceToken = <TError = ErrorType<DmError>,
509
-
510
575
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteInstanceToken>>, TError,{instanceId: string;token: string}, TContext>, request?: SecondParameter<typeof customInstance>}
511
576
  ) => {
512
577