@squonk/data-manager-client 4.2.0 → 4.3.0

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 (140) hide show
  1. package/accounting/accounting.cjs +96 -95
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +47 -47
  4. package/accounting/accounting.d.ts +47 -47
  5. package/accounting/accounting.js +102 -101
  6. package/accounting/accounting.js.map +1 -1
  7. package/admin/admin.cjs +120 -145
  8. package/admin/admin.cjs.map +1 -1
  9. package/admin/admin.d.cts +121 -121
  10. package/admin/admin.d.ts +121 -121
  11. package/admin/admin.js +127 -152
  12. package/admin/admin.js.map +1 -1
  13. package/application/application.cjs +39 -43
  14. package/application/application.cjs.map +1 -1
  15. package/application/application.d.cts +25 -25
  16. package/application/application.d.ts +25 -25
  17. package/application/application.js +42 -46
  18. package/application/application.js.map +1 -1
  19. package/chunk-OYRETEBZ.js +25 -0
  20. package/chunk-OYRETEBZ.js.map +1 -0
  21. package/{chunk-TKLTUR4R.cjs → chunk-RB2KVIEK.cjs} +1 -1
  22. package/chunk-RB2KVIEK.cjs.map +1 -0
  23. package/{chunk-EBOQPVLG.js → chunk-XYDLYMQ2.js} +1 -1
  24. package/chunk-XYDLYMQ2.js.map +1 -0
  25. package/chunk-ZLY5XEOQ.cjs +25 -0
  26. package/chunk-ZLY5XEOQ.cjs.map +1 -0
  27. package/configuration/configuration.cjs +38 -45
  28. package/configuration/configuration.cjs.map +1 -1
  29. package/configuration/configuration.d.cts +25 -25
  30. package/configuration/configuration.d.ts +25 -25
  31. package/configuration/configuration.js +42 -49
  32. package/configuration/configuration.js.map +1 -1
  33. package/dataset/dataset.cjs +126 -141
  34. package/dataset/dataset.cjs.map +1 -1
  35. package/dataset/dataset.d.cts +102 -102
  36. package/dataset/dataset.d.ts +102 -102
  37. package/dataset/dataset.js +132 -147
  38. package/dataset/dataset.js.map +1 -1
  39. package/digest/digest.cjs +22 -24
  40. package/digest/digest.cjs.map +1 -1
  41. package/digest/digest.d.cts +14 -14
  42. package/digest/digest.d.ts +14 -14
  43. package/digest/digest.js +24 -26
  44. package/digest/digest.js.map +1 -1
  45. package/exchange-rate/exchange-rate.cjs +111 -109
  46. package/exchange-rate/exchange-rate.cjs.map +1 -1
  47. package/exchange-rate/exchange-rate.d.cts +69 -69
  48. package/exchange-rate/exchange-rate.d.ts +69 -69
  49. package/exchange-rate/exchange-rate.js +117 -115
  50. package/exchange-rate/exchange-rate.js.map +1 -1
  51. package/file-and-path/file-and-path.cjs +93 -138
  52. package/file-and-path/file-and-path.cjs.map +1 -1
  53. package/file-and-path/file-and-path.d.cts +102 -102
  54. package/file-and-path/file-and-path.d.ts +102 -102
  55. package/file-and-path/file-and-path.js +105 -150
  56. package/file-and-path/file-and-path.js.map +1 -1
  57. package/index.cjs +80 -102
  58. package/index.cjs.map +1 -1
  59. package/index.d.cts +2401 -2326
  60. package/index.d.ts +2401 -2326
  61. package/index.js +79 -101
  62. package/index.js.map +1 -1
  63. package/instance/instance.cjs +100 -107
  64. package/instance/instance.cjs.map +1 -1
  65. package/instance/instance.d.cts +76 -76
  66. package/instance/instance.d.ts +76 -76
  67. package/instance/instance.js +105 -112
  68. package/instance/instance.js.map +1 -1
  69. package/inventory/inventory.cjs +22 -25
  70. package/inventory/inventory.cjs.map +1 -1
  71. package/inventory/inventory.d.cts +14 -14
  72. package/inventory/inventory.d.ts +14 -14
  73. package/inventory/inventory.js +24 -27
  74. package/inventory/inventory.js.map +1 -1
  75. package/job/job.cjs +55 -67
  76. package/job/job.cjs.map +1 -1
  77. package/job/job.d.cts +36 -36
  78. package/job/job.d.ts +36 -36
  79. package/job/job.js +60 -72
  80. package/job/job.js.map +1 -1
  81. package/metadata/metadata.cjs +61 -59
  82. package/metadata/metadata.cjs.map +1 -1
  83. package/metadata/metadata.d.cts +47 -47
  84. package/metadata/metadata.d.ts +47 -47
  85. package/metadata/metadata.js +65 -63
  86. package/metadata/metadata.js.map +1 -1
  87. package/package.json +13 -16
  88. package/project/project.cjs +165 -186
  89. package/project/project.cjs.map +1 -1
  90. package/project/project.d.cts +157 -157
  91. package/project/project.d.ts +157 -157
  92. package/project/project.js +172 -193
  93. package/project/project.js.map +1 -1
  94. package/src/accounting/accounting.ts +767 -461
  95. package/src/admin/admin.ts +1187 -787
  96. package/src/application/application.ts +377 -231
  97. package/src/configuration/configuration.ts +348 -237
  98. package/src/custom-instance.ts +3 -3
  99. package/src/data-manager-api.schemas.ts +2538 -2492
  100. package/src/dataset/dataset.ts +1199 -792
  101. package/src/digest/digest.ts +198 -122
  102. package/src/exchange-rate/exchange-rate.ts +1088 -612
  103. package/src/file-and-path/file-and-path.ts +869 -616
  104. package/src/index.ts +2 -2
  105. package/src/instance/instance.ts +804 -539
  106. package/src/inventory/inventory.ts +200 -122
  107. package/src/job/job.ts +556 -348
  108. package/src/metadata/metadata.ts +587 -371
  109. package/src/options-mutator.ts +27 -0
  110. package/src/project/project.ts +1576 -1034
  111. package/src/task/task.ts +434 -295
  112. package/src/type/type.ts +180 -126
  113. package/src/user/user.ts +846 -398
  114. package/src/workflow/workflow.ts +1750 -1089
  115. package/task/task.cjs +45 -59
  116. package/task/task.cjs.map +1 -1
  117. package/task/task.d.cts +33 -33
  118. package/task/task.d.ts +33 -33
  119. package/task/task.js +51 -65
  120. package/task/task.js.map +1 -1
  121. package/type/type.cjs +21 -26
  122. package/type/type.cjs.map +1 -1
  123. package/type/type.d.cts +14 -14
  124. package/type/type.d.ts +14 -14
  125. package/type/type.js +24 -29
  126. package/type/type.js.map +1 -1
  127. package/user/user.cjs +114 -80
  128. package/user/user.cjs.map +1 -1
  129. package/user/user.d.cts +107 -48
  130. package/user/user.d.ts +107 -48
  131. package/user/user.js +120 -86
  132. package/user/user.js.map +1 -1
  133. package/workflow/workflow.cjs +179 -193
  134. package/workflow/workflow.cjs.map +1 -1
  135. package/workflow/workflow.d.cts +146 -146
  136. package/workflow/workflow.d.ts +146 -146
  137. package/workflow/workflow.js +187 -201
  138. package/workflow/workflow.js.map +1 -1
  139. package/chunk-EBOQPVLG.js.map +0 -1
  140. package/chunk-TKLTUR4R.cjs.map +0 -1
@@ -1,6 +1,5 @@
1
- // @ts-nocheck
2
1
  /**
3
- * Generated by orval v7.4.1 🍺
2
+ * Generated by orval v7.10.0 🍺
4
3
  * Do not edit manually.
5
4
  * Dataset Manager API
6
5
  * The Dataset Manager API service.
@@ -9,16 +8,13 @@ A service that allows *registered* users to make **Datasets** and associated **M
9
8
 
10
9
  * OpenAPI spec version: 4.1
11
10
  */
12
- import {
13
- useMutation,
14
- useQuery,
15
- useSuspenseQuery
16
- } from '@tanstack/react-query'
11
+ import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
17
12
  import type {
18
13
  DataTag,
19
14
  DefinedInitialDataOptions,
20
15
  DefinedUseQueryResult,
21
16
  MutationFunction,
17
+ QueryClient,
22
18
  QueryFunction,
23
19
  QueryKey,
24
20
  UndefinedInitialDataOptions,
@@ -27,8 +23,9 @@ import type {
27
23
  UseQueryOptions,
28
24
  UseQueryResult,
29
25
  UseSuspenseQueryOptions,
30
- UseSuspenseQueryResult
31
- } from '@tanstack/react-query'
26
+ UseSuspenseQueryResult,
27
+ } from "@tanstack/react-query";
28
+
32
29
  import type {
33
30
  DatasetDetail,
34
31
  DatasetPostBodyBody,
@@ -40,14 +37,15 @@ import type {
40
37
  DmError,
41
38
  GetDatasetsParams,
42
39
  GetVersionsParams,
43
- TaskIdentity
44
- } from '../data-manager-api.schemas'
45
- import { customInstance } from '.././custom-instance';
46
- import type { ErrorType } from '.././custom-instance';
47
-
40
+ TaskIdentity,
41
+ } from "../data-manager-api.schemas";
48
42
 
49
- type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
43
+ import { customInstance } from ".././custom-instance";
44
+ import type { ErrorType } from ".././custom-instance";
45
+ import { mutationMutator } from ".././options-mutator";
46
+ import { queryMutator } from ".././options-mutator";
50
47
 
48
+ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
51
49
 
52
50
  /**
53
51
  * Using an unmanaged file in a Project as a source a Dataset (or new Dataset Version) is created.
@@ -59,82 +57,107 @@ Behaves like the corresponding **POST** method except the file is expected to ex
59
57
  * @summary Create a Dataset from a file in a Project
60
58
  */
61
59
  export const createDatasetFromFile = (
62
- datasetPutBodyBody: DatasetPutBodyBody,
63
- options?: SecondParameter<typeof customInstance>,) => {
64
-
65
- const formUrlEncoded = new URLSearchParams();
66
- formUrlEncoded.append('dataset_type', datasetPutBodyBody.dataset_type)
67
- if(datasetPutBodyBody.format_extra_variables !== undefined) {
68
- formUrlEncoded.append('format_extra_variables', datasetPutBodyBody.format_extra_variables)
69
- }
70
- if(datasetPutBodyBody.skip_molecule_load !== undefined) {
71
- formUrlEncoded.append('skip_molecule_load', datasetPutBodyBody.skip_molecule_load.toString())
72
- }
73
- formUrlEncoded.append('project_id', datasetPutBodyBody.project_id)
74
- formUrlEncoded.append('path', datasetPutBodyBody.path)
75
- formUrlEncoded.append('file_name', datasetPutBodyBody.file_name)
76
- if(datasetPutBodyBody.dataset_id !== undefined) {
77
- formUrlEncoded.append('dataset_id', datasetPutBodyBody.dataset_id)
78
- }
79
- if(datasetPutBodyBody.unit_id !== undefined) {
80
- formUrlEncoded.append('unit_id', datasetPutBodyBody.unit_id)
81
- }
82
-
83
- return customInstance<DatasetPutPostResponse>(
84
- {url: `/dataset`, method: 'PUT',
85
- headers: {'Content-Type': 'application/x-www-form-urlencoded', },
86
- data: formUrlEncoded
87
- },
88
- options);
89
- }
90
-
91
-
92
-
93
- export const getCreateDatasetFromFileMutationOptions = <TData = Awaited<ReturnType<typeof createDatasetFromFile>>, TError = ErrorType<void | DmError>,
94
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: DatasetPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
60
+ datasetPutBodyBody: DatasetPutBodyBody,
61
+ options?: SecondParameter<typeof customInstance>,
95
62
  ) => {
96
- const mutationKey = ['createDatasetFromFile'];
97
- const {mutation: mutationOptions, request: requestOptions} = options ?
98
- options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
99
- options
100
- : {...options, mutation: {...options.mutation, mutationKey}}
101
- : {mutation: { mutationKey, }, request: undefined};
102
-
103
-
104
-
105
-
106
- const mutationFn: MutationFunction<Awaited<ReturnType<typeof createDatasetFromFile>>, {data: DatasetPutBodyBody}> = (props) => {
107
- const {data} = props ?? {};
108
-
109
- return createDatasetFromFile(data,requestOptions)
110
- }
111
-
112
-
113
-
114
-
115
- return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{data: DatasetPutBodyBody}, TContext>}
116
-
117
- export type CreateDatasetFromFileMutationResult = NonNullable<Awaited<ReturnType<typeof createDatasetFromFile>>>
118
- export type CreateDatasetFromFileMutationBody = DatasetPutBodyBody
119
- export type CreateDatasetFromFileMutationError = ErrorType<void | DmError>
63
+ const formUrlEncoded = new URLSearchParams();
64
+ formUrlEncoded.append(`dataset_type`, datasetPutBodyBody.dataset_type);
65
+ if (datasetPutBodyBody.format_extra_variables !== undefined) {
66
+ formUrlEncoded.append(`format_extra_variables`, datasetPutBodyBody.format_extra_variables);
67
+ }
68
+ if (datasetPutBodyBody.skip_molecule_load !== undefined) {
69
+ formUrlEncoded.append(`skip_molecule_load`, datasetPutBodyBody.skip_molecule_load.toString());
70
+ }
71
+ formUrlEncoded.append(`project_id`, datasetPutBodyBody.project_id);
72
+ formUrlEncoded.append(`path`, datasetPutBodyBody.path);
73
+ formUrlEncoded.append(`file_name`, datasetPutBodyBody.file_name);
74
+ if (datasetPutBodyBody.dataset_id !== undefined) {
75
+ formUrlEncoded.append(`dataset_id`, datasetPutBodyBody.dataset_id);
76
+ }
77
+ if (datasetPutBodyBody.unit_id !== undefined) {
78
+ formUrlEncoded.append(`unit_id`, datasetPutBodyBody.unit_id);
79
+ }
80
+
81
+ return customInstance<DatasetPutPostResponse>(
82
+ {
83
+ url: `/dataset`,
84
+ method: "PUT",
85
+ headers: { "Content-Type": "application/x-www-form-urlencoded" },
86
+ data: formUrlEncoded,
87
+ },
88
+ options,
89
+ );
90
+ };
91
+
92
+ export const useCreateDatasetFromFileMutationOptions = <
93
+ TError = ErrorType<void | DmError>,
94
+ TContext = unknown,
95
+ >(options?: {
96
+ mutation?: UseMutationOptions<
97
+ Awaited<ReturnType<typeof createDatasetFromFile>>,
98
+ TError,
99
+ { data: DatasetPutBodyBody },
100
+ TContext
101
+ >;
102
+ request?: SecondParameter<typeof customInstance>;
103
+ }): UseMutationOptions<
104
+ Awaited<ReturnType<typeof createDatasetFromFile>>,
105
+ TError,
106
+ { data: DatasetPutBodyBody },
107
+ TContext
108
+ > => {
109
+ const mutationKey = ["createDatasetFromFile"];
110
+ const { mutation: mutationOptions, request: requestOptions } = options
111
+ ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
112
+ ? options
113
+ : { ...options, mutation: { ...options.mutation, mutationKey } }
114
+ : { mutation: { mutationKey }, request: undefined };
115
+
116
+ const mutationFn: MutationFunction<
117
+ Awaited<ReturnType<typeof createDatasetFromFile>>,
118
+ { data: DatasetPutBodyBody }
119
+ > = (props) => {
120
+ const { data } = props ?? {};
121
+
122
+ return createDatasetFromFile(data, requestOptions);
123
+ };
124
+
125
+ const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
126
+
127
+ return customOptions;
128
+ };
129
+
130
+ export type CreateDatasetFromFileMutationResult = NonNullable<
131
+ Awaited<ReturnType<typeof createDatasetFromFile>>
132
+ >;
133
+ export type CreateDatasetFromFileMutationBody = DatasetPutBodyBody;
134
+ export type CreateDatasetFromFileMutationError = ErrorType<void | DmError>;
120
135
 
121
- /**
136
+ /**
122
137
  * @summary Create a Dataset from a file in a Project
123
138
  */
124
- export const useCreateDatasetFromFile = <TData = Awaited<ReturnType<typeof createDatasetFromFile>>, TError = ErrorType<void | DmError>,
125
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: DatasetPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
139
+ export const useCreateDatasetFromFile = <TError = ErrorType<void | DmError>, TContext = unknown>(
140
+ options?: {
141
+ mutation?: UseMutationOptions<
142
+ Awaited<ReturnType<typeof createDatasetFromFile>>,
143
+ TError,
144
+ { data: DatasetPutBodyBody },
145
+ TContext
146
+ >;
147
+ request?: SecondParameter<typeof customInstance>;
148
+ },
149
+ queryClient?: QueryClient,
126
150
  ): UseMutationResult<
127
- TData,
128
- TError,
129
- {data: DatasetPutBodyBody},
130
- TContext
131
- > => {
132
-
133
- const mutationOptions = getCreateDatasetFromFileMutationOptions(options);
134
-
135
- return useMutation(mutationOptions);
136
- }
137
- /**
151
+ Awaited<ReturnType<typeof createDatasetFromFile>>,
152
+ TError,
153
+ { data: DatasetPutBodyBody },
154
+ TContext
155
+ > => {
156
+ const mutationOptions = useCreateDatasetFromFileMutationOptions(options);
157
+
158
+ return useMutation(mutationOptions, queryClient);
159
+ };
160
+ /**
138
161
  * Uploads a dataset.
139
162
 
140
163
  Dataset file-naming is strictly limited to a fixed set of extensions based on the Dataset **Type**. You can obtain the supported types (and their extensions) via the `/type` endpoint. Filenames that do not comply with the supported filename extensions will be rejected.
@@ -148,82 +171,106 @@ Datasets undergo some processing in an asynchronous **Task** after control retur
148
171
  * @summary Upload an external file as a Dataset
149
172
  */
150
173
  export const uploadDataset = (
151
- datasetPostBodyBody: DatasetPostBodyBody,
152
- options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
174
+ datasetPostBodyBody: DatasetPostBodyBody,
175
+ options?: SecondParameter<typeof customInstance>,
176
+ signal?: AbortSignal,
153
177
  ) => {
154
-
155
- const formData = new FormData();
156
- formData.append('dataset_file', datasetPostBodyBody.dataset_file)
157
- formData.append('dataset_type', datasetPostBodyBody.dataset_type)
158
- if(datasetPostBodyBody.format_extra_variables !== undefined) {
159
- formData.append('format_extra_variables', datasetPostBodyBody.format_extra_variables)
160
- }
161
- if(datasetPostBodyBody.skip_molecule_load !== undefined) {
162
- formData.append('skip_molecule_load', datasetPostBodyBody.skip_molecule_load.toString())
163
- }
164
- if(datasetPostBodyBody.as_filename !== undefined) {
165
- formData.append('as_filename', datasetPostBodyBody.as_filename)
166
- }
167
- if(datasetPostBodyBody.dataset_id !== undefined) {
168
- formData.append('dataset_id', datasetPostBodyBody.dataset_id)
169
- }
170
- formData.append('unit_id', datasetPostBodyBody.unit_id)
171
-
172
- return customInstance<DatasetPutPostResponse>(
173
- {url: `/dataset`, method: 'POST',
174
- headers: {'Content-Type': 'multipart/form-data', },
175
- data: formData, signal
178
+ const formData = new FormData();
179
+ formData.append(`dataset_file`, datasetPostBodyBody.dataset_file);
180
+ formData.append(`dataset_type`, datasetPostBodyBody.dataset_type);
181
+ if (datasetPostBodyBody.format_extra_variables !== undefined) {
182
+ formData.append(`format_extra_variables`, datasetPostBodyBody.format_extra_variables);
183
+ }
184
+ if (datasetPostBodyBody.skip_molecule_load !== undefined) {
185
+ formData.append(`skip_molecule_load`, datasetPostBodyBody.skip_molecule_load.toString());
186
+ }
187
+ if (datasetPostBodyBody.as_filename !== undefined) {
188
+ formData.append(`as_filename`, datasetPostBodyBody.as_filename);
189
+ }
190
+ if (datasetPostBodyBody.dataset_id !== undefined) {
191
+ formData.append(`dataset_id`, datasetPostBodyBody.dataset_id);
192
+ }
193
+ formData.append(`unit_id`, datasetPostBodyBody.unit_id);
194
+
195
+ return customInstance<DatasetPutPostResponse>(
196
+ {
197
+ url: `/dataset`,
198
+ method: "POST",
199
+ headers: { "Content-Type": "multipart/form-data" },
200
+ data: formData,
201
+ signal,
176
202
  },
177
- options);
178
- }
179
-
180
-
181
-
182
- export const getUploadDatasetMutationOptions = <TData = Awaited<ReturnType<typeof uploadDataset>>, TError = ErrorType<void | DmError>,
183
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: DatasetPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
184
- ) => {
185
- const mutationKey = ['uploadDataset'];
186
- const {mutation: mutationOptions, request: requestOptions} = options ?
187
- options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
188
- options
189
- : {...options, mutation: {...options.mutation, mutationKey}}
190
- : {mutation: { mutationKey, }, request: undefined};
191
-
192
-
193
-
194
-
195
- const mutationFn: MutationFunction<Awaited<ReturnType<typeof uploadDataset>>, {data: DatasetPostBodyBody}> = (props) => {
196
- const {data} = props ?? {};
197
-
198
- return uploadDataset(data,requestOptions)
199
- }
200
-
201
-
202
-
203
-
204
- return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{data: DatasetPostBodyBody}, TContext>}
205
-
206
- export type UploadDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof uploadDataset>>>
207
- export type UploadDatasetMutationBody = DatasetPostBodyBody
208
- export type UploadDatasetMutationError = ErrorType<void | DmError>
203
+ options,
204
+ );
205
+ };
206
+
207
+ export const useUploadDatasetMutationOptions = <
208
+ TError = ErrorType<void | DmError>,
209
+ TContext = unknown,
210
+ >(options?: {
211
+ mutation?: UseMutationOptions<
212
+ Awaited<ReturnType<typeof uploadDataset>>,
213
+ TError,
214
+ { data: DatasetPostBodyBody },
215
+ TContext
216
+ >;
217
+ request?: SecondParameter<typeof customInstance>;
218
+ }): UseMutationOptions<
219
+ Awaited<ReturnType<typeof uploadDataset>>,
220
+ TError,
221
+ { data: DatasetPostBodyBody },
222
+ TContext
223
+ > => {
224
+ const mutationKey = ["uploadDataset"];
225
+ const { mutation: mutationOptions, request: requestOptions } = options
226
+ ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
227
+ ? options
228
+ : { ...options, mutation: { ...options.mutation, mutationKey } }
229
+ : { mutation: { mutationKey }, request: undefined };
230
+
231
+ const mutationFn: MutationFunction<
232
+ Awaited<ReturnType<typeof uploadDataset>>,
233
+ { data: DatasetPostBodyBody }
234
+ > = (props) => {
235
+ const { data } = props ?? {};
236
+
237
+ return uploadDataset(data, requestOptions);
238
+ };
239
+
240
+ const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
241
+
242
+ return customOptions;
243
+ };
244
+
245
+ export type UploadDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof uploadDataset>>>;
246
+ export type UploadDatasetMutationBody = DatasetPostBodyBody;
247
+ export type UploadDatasetMutationError = ErrorType<void | DmError>;
209
248
 
210
- /**
249
+ /**
211
250
  * @summary Upload an external file as a Dataset
212
251
  */
213
- export const useUploadDataset = <TData = Awaited<ReturnType<typeof uploadDataset>>, TError = ErrorType<void | DmError>,
214
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: DatasetPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
252
+ export const useUploadDataset = <TError = ErrorType<void | DmError>, TContext = unknown>(
253
+ options?: {
254
+ mutation?: UseMutationOptions<
255
+ Awaited<ReturnType<typeof uploadDataset>>,
256
+ TError,
257
+ { data: DatasetPostBodyBody },
258
+ TContext
259
+ >;
260
+ request?: SecondParameter<typeof customInstance>;
261
+ },
262
+ queryClient?: QueryClient,
215
263
  ): UseMutationResult<
216
- TData,
217
- TError,
218
- {data: DatasetPostBodyBody},
219
- TContext
220
- > => {
221
-
222
- const mutationOptions = getUploadDatasetMutationOptions(options);
223
-
224
- return useMutation(mutationOptions);
225
- }
226
- /**
264
+ Awaited<ReturnType<typeof uploadDataset>>,
265
+ TError,
266
+ { data: DatasetPostBodyBody },
267
+ TContext
268
+ > => {
269
+ const mutationOptions = useUploadDatasetMutationOptions(options);
270
+
271
+ return useMutation(mutationOptions, queryClient);
272
+ };
273
+ /**
227
274
  * Returns datasets that you have access to, whether attached to a project or not.
228
275
 
229
276
  You will not see Datasets while their upload is still in progress.
@@ -235,144 +282,221 @@ Note that if `editors` are combined with `owner username`, then the datasets wil
235
282
  * @summary Get Datasets that are available to you
236
283
  */
237
284
  export const getDatasets = (
238
- params?: GetDatasetsParams,
239
- options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
285
+ params?: GetDatasetsParams,
286
+ options?: SecondParameter<typeof customInstance>,
287
+ signal?: AbortSignal,
240
288
  ) => {
241
-
242
-
243
- return customInstance<DatasetsGetResponse>(
244
- {url: `/dataset`, method: 'GET',
245
- params, signal
246
- },
247
- options);
248
- }
249
-
250
-
251
- export const getGetDatasetsQueryKey = (params?: GetDatasetsParams,) => {
252
- return ["data-manager-api", `/dataset`, ...(params ? [params]: [])] as const;
253
- }
254
-
255
-
256
- export const getGetDatasetsQueryOptions = <TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
289
+ return customInstance<DatasetsGetResponse>(
290
+ { url: `/dataset`, method: "GET", params, signal },
291
+ options,
292
+ );
293
+ };
294
+
295
+ export const getGetDatasetsQueryKey = (params?: GetDatasetsParams) => {
296
+ return [`/dataset`, ...(params ? [params] : [])] as const;
297
+ };
298
+
299
+ export const useGetDatasetsQueryOptions = <
300
+ TData = Awaited<ReturnType<typeof getDatasets>>,
301
+ TError = ErrorType<void | DmError>,
302
+ >(
303
+ params?: GetDatasetsParams,
304
+ options?: {
305
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
306
+ request?: SecondParameter<typeof customInstance>;
307
+ },
257
308
  ) => {
309
+ const { query: queryOptions, request: requestOptions } = options ?? {};
258
310
 
259
- const {query: queryOptions, request: requestOptions} = options ?? {};
260
-
261
- const queryKey = queryOptions?.queryKey ?? getGetDatasetsQueryKey(params);
311
+ const queryKey = queryOptions?.queryKey ?? getGetDatasetsQueryKey(params);
262
312
 
263
-
313
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getDatasets>>> = ({ signal }) =>
314
+ getDatasets(params, requestOptions, signal);
264
315
 
265
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getDatasets>>> = ({ signal }) => getDatasets(params, requestOptions, signal);
316
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
266
317
 
267
-
318
+ return customOptions as UseQueryOptions<
319
+ Awaited<ReturnType<typeof getDatasets>>,
320
+ TError,
321
+ TData
322
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
323
+ };
268
324
 
269
-
325
+ export type GetDatasetsQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
326
+ export type GetDatasetsQueryError = ErrorType<void | DmError>;
270
327
 
271
- return { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
272
- }
273
-
274
- export type GetDatasetsQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>
275
- export type GetDatasetsQueryError = ErrorType<void | DmError>
276
-
277
-
278
- export function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
279
- params: undefined | GetDatasetsParams, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<
328
+ export function useGetDatasets<
329
+ TData = Awaited<ReturnType<typeof getDatasets>>,
330
+ TError = ErrorType<void | DmError>,
331
+ >(
332
+ params: undefined | GetDatasetsParams,
333
+ options: {
334
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> &
335
+ Pick<
280
336
  DefinedInitialDataOptions<
281
337
  Awaited<ReturnType<typeof getDatasets>>,
282
338
  TError,
283
- TData
284
- > , 'initialData'
285
- >, request?: SecondParameter<typeof customInstance>}
286
-
287
- ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
288
- export function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
289
- params?: GetDatasetsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<
339
+ Awaited<ReturnType<typeof getDatasets>>
340
+ >,
341
+ "initialData"
342
+ >;
343
+ request?: SecondParameter<typeof customInstance>;
344
+ },
345
+ queryClient?: QueryClient,
346
+ ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
347
+ export function useGetDatasets<
348
+ TData = Awaited<ReturnType<typeof getDatasets>>,
349
+ TError = ErrorType<void | DmError>,
350
+ >(
351
+ params?: GetDatasetsParams,
352
+ options?: {
353
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> &
354
+ Pick<
290
355
  UndefinedInitialDataOptions<
291
356
  Awaited<ReturnType<typeof getDatasets>>,
292
357
  TError,
293
- TData
294
- > , 'initialData'
295
- >, request?: SecondParameter<typeof customInstance>}
296
-
297
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
298
- export function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
299
- params?: GetDatasetsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
300
-
301
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
358
+ Awaited<ReturnType<typeof getDatasets>>
359
+ >,
360
+ "initialData"
361
+ >;
362
+ request?: SecondParameter<typeof customInstance>;
363
+ },
364
+ queryClient?: QueryClient,
365
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
366
+ export function useGetDatasets<
367
+ TData = Awaited<ReturnType<typeof getDatasets>>,
368
+ TError = ErrorType<void | DmError>,
369
+ >(
370
+ params?: GetDatasetsParams,
371
+ options?: {
372
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
373
+ request?: SecondParameter<typeof customInstance>;
374
+ },
375
+ queryClient?: QueryClient,
376
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
302
377
  /**
303
378
  * @summary Get Datasets that are available to you
304
379
  */
305
380
 
306
- export function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
307
- params?: GetDatasetsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
308
-
309
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
310
-
311
- const queryOptions = getGetDatasetsQueryOptions(params,options)
312
-
313
- const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
314
-
315
- query.queryKey = queryOptions.queryKey ;
381
+ export function useGetDatasets<
382
+ TData = Awaited<ReturnType<typeof getDatasets>>,
383
+ TError = ErrorType<void | DmError>,
384
+ >(
385
+ params?: GetDatasetsParams,
386
+ options?: {
387
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
388
+ request?: SecondParameter<typeof customInstance>;
389
+ },
390
+ queryClient?: QueryClient,
391
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
392
+ const queryOptions = useGetDatasetsQueryOptions(params, options);
393
+
394
+ const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
395
+ queryKey: DataTag<QueryKey, TData, TError>;
396
+ };
397
+
398
+ query.queryKey = queryOptions.queryKey;
316
399
 
317
400
  return query;
318
401
  }
319
402
 
320
-
321
-
322
- export const getGetDatasetsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
403
+ export const useGetDatasetsSuspenseQueryOptions = <
404
+ TData = Awaited<ReturnType<typeof getDatasets>>,
405
+ TError = ErrorType<void | DmError>,
406
+ >(
407
+ params?: GetDatasetsParams,
408
+ options?: {
409
+ query?: Partial<
410
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>
411
+ >;
412
+ request?: SecondParameter<typeof customInstance>;
413
+ },
323
414
  ) => {
324
-
325
- const {query: queryOptions, request: requestOptions} = options ?? {};
326
-
327
- const queryKey = queryOptions?.queryKey ?? getGetDatasetsQueryKey(params);
328
-
329
-
330
-
331
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getDatasets>>> = ({ signal }) => getDatasets(params, requestOptions, signal);
332
-
333
-
334
-
335
-
336
-
337
- return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
338
- }
339
-
340
- export type GetDatasetsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>
341
- export type GetDatasetsSuspenseQueryError = ErrorType<void | DmError>
342
-
343
-
344
- export function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
345
- params: undefined | GetDatasetsParams, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
346
-
347
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
348
- export function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
349
- params?: GetDatasetsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
350
-
351
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
352
- export function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
353
- params?: GetDatasetsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
354
-
355
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
415
+ const { query: queryOptions, request: requestOptions } = options ?? {};
416
+
417
+ const queryKey = queryOptions?.queryKey ?? getGetDatasetsQueryKey(params);
418
+
419
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getDatasets>>> = ({ signal }) =>
420
+ getDatasets(params, requestOptions, signal);
421
+
422
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
423
+
424
+ return customOptions as UseSuspenseQueryOptions<
425
+ Awaited<ReturnType<typeof getDatasets>>,
426
+ TError,
427
+ TData
428
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
429
+ };
430
+
431
+ export type GetDatasetsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
432
+ export type GetDatasetsSuspenseQueryError = ErrorType<void | DmError>;
433
+
434
+ export function useGetDatasetsSuspense<
435
+ TData = Awaited<ReturnType<typeof getDatasets>>,
436
+ TError = ErrorType<void | DmError>,
437
+ >(
438
+ params: undefined | GetDatasetsParams,
439
+ options: {
440
+ query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
441
+ request?: SecondParameter<typeof customInstance>;
442
+ },
443
+ queryClient?: QueryClient,
444
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
445
+ export function useGetDatasetsSuspense<
446
+ TData = Awaited<ReturnType<typeof getDatasets>>,
447
+ TError = ErrorType<void | DmError>,
448
+ >(
449
+ params?: GetDatasetsParams,
450
+ options?: {
451
+ query?: Partial<
452
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>
453
+ >;
454
+ request?: SecondParameter<typeof customInstance>;
455
+ },
456
+ queryClient?: QueryClient,
457
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
458
+ export function useGetDatasetsSuspense<
459
+ TData = Awaited<ReturnType<typeof getDatasets>>,
460
+ TError = ErrorType<void | DmError>,
461
+ >(
462
+ params?: GetDatasetsParams,
463
+ options?: {
464
+ query?: Partial<
465
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>
466
+ >;
467
+ request?: SecondParameter<typeof customInstance>;
468
+ },
469
+ queryClient?: QueryClient,
470
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
356
471
  /**
357
472
  * @summary Get Datasets that are available to you
358
473
  */
359
474
 
360
- export function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(
361
- params?: GetDatasetsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
362
-
363
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
364
-
365
- const queryOptions = getGetDatasetsSuspenseQueryOptions(params,options)
366
-
367
- const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
368
-
369
- query.queryKey = queryOptions.queryKey ;
475
+ export function useGetDatasetsSuspense<
476
+ TData = Awaited<ReturnType<typeof getDatasets>>,
477
+ TError = ErrorType<void | DmError>,
478
+ >(
479
+ params?: GetDatasetsParams,
480
+ options?: {
481
+ query?: Partial<
482
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>
483
+ >;
484
+ request?: SecondParameter<typeof customInstance>;
485
+ },
486
+ queryClient?: QueryClient,
487
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
488
+ const queryOptions = useGetDatasetsSuspenseQueryOptions(params, options);
489
+
490
+ const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
491
+ TData,
492
+ TError
493
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
494
+
495
+ query.queryKey = queryOptions.queryKey;
370
496
 
371
497
  return query;
372
498
  }
373
499
 
374
-
375
-
376
500
  /**
377
501
  * Returns a list of Dataset Versions.
378
502
 
@@ -381,156 +505,232 @@ You will not see Datasets while their upload is still in progress.
381
505
  * @summary Gets all the Versions of a specific Dataset
382
506
  */
383
507
  export const getVersions = (
384
- datasetId: string,
385
- params?: GetVersionsParams,
386
- options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
508
+ datasetId: string,
509
+ params?: GetVersionsParams,
510
+ options?: SecondParameter<typeof customInstance>,
511
+ signal?: AbortSignal,
387
512
  ) => {
388
-
389
-
390
- return customInstance<DatasetDetail>(
391
- {url: `/dataset/${datasetId}/versions`, method: 'GET',
392
- params, signal
393
- },
394
- options);
395
- }
396
-
397
-
398
- export const getGetVersionsQueryKey = (datasetId: string,
399
- params?: GetVersionsParams,) => {
400
- return ["data-manager-api", `/dataset/${datasetId}/versions`, ...(params ? [params]: [])] as const;
401
- }
402
-
403
-
404
- export const getGetVersionsQueryOptions = <TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string,
405
- params?: GetVersionsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
513
+ return customInstance<DatasetDetail>(
514
+ { url: `/dataset/${datasetId}/versions`, method: "GET", params, signal },
515
+ options,
516
+ );
517
+ };
518
+
519
+ export const getGetVersionsQueryKey = (datasetId: string, params?: GetVersionsParams) => {
520
+ return [`/dataset/${datasetId}/versions`, ...(params ? [params] : [])] as const;
521
+ };
522
+
523
+ export const useGetVersionsQueryOptions = <
524
+ TData = Awaited<ReturnType<typeof getVersions>>,
525
+ TError = ErrorType<void | DmError>,
526
+ >(
527
+ datasetId: string,
528
+ params?: GetVersionsParams,
529
+ options?: {
530
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
531
+ request?: SecondParameter<typeof customInstance>;
532
+ },
406
533
  ) => {
407
-
408
- const {query: queryOptions, request: requestOptions} = options ?? {};
409
-
410
- const queryKey = queryOptions?.queryKey ?? getGetVersionsQueryKey(datasetId,params);
411
-
412
-
413
-
414
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getVersions>>> = ({ signal }) => getVersions(datasetId,params, requestOptions, signal);
415
-
416
-
417
-
418
-
419
-
420
- return { queryKey, queryFn, enabled: !!(datasetId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
421
- }
422
-
423
- export type GetVersionsQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>
424
- export type GetVersionsQueryError = ErrorType<void | DmError>
425
-
426
-
427
- export function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
428
- datasetId: string,
429
- params: undefined | GetVersionsParams, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<
534
+ const { query: queryOptions, request: requestOptions } = options ?? {};
535
+
536
+ const queryKey = queryOptions?.queryKey ?? getGetVersionsQueryKey(datasetId, params);
537
+
538
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getVersions>>> = ({ signal }) =>
539
+ getVersions(datasetId, params, requestOptions, signal);
540
+
541
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
542
+
543
+ return customOptions as UseQueryOptions<
544
+ Awaited<ReturnType<typeof getVersions>>,
545
+ TError,
546
+ TData
547
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
548
+ };
549
+
550
+ export type GetVersionsQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
551
+ export type GetVersionsQueryError = ErrorType<void | DmError>;
552
+
553
+ export function useGetVersions<
554
+ TData = Awaited<ReturnType<typeof getVersions>>,
555
+ TError = ErrorType<void | DmError>,
556
+ >(
557
+ datasetId: string,
558
+ params: undefined | GetVersionsParams,
559
+ options: {
560
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> &
561
+ Pick<
430
562
  DefinedInitialDataOptions<
431
563
  Awaited<ReturnType<typeof getVersions>>,
432
564
  TError,
433
- TData
434
- > , 'initialData'
435
- >, request?: SecondParameter<typeof customInstance>}
436
-
437
- ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
438
- export function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
439
- datasetId: string,
440
- params?: GetVersionsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<
565
+ Awaited<ReturnType<typeof getVersions>>
566
+ >,
567
+ "initialData"
568
+ >;
569
+ request?: SecondParameter<typeof customInstance>;
570
+ },
571
+ queryClient?: QueryClient,
572
+ ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
573
+ export function useGetVersions<
574
+ TData = Awaited<ReturnType<typeof getVersions>>,
575
+ TError = ErrorType<void | DmError>,
576
+ >(
577
+ datasetId: string,
578
+ params?: GetVersionsParams,
579
+ options?: {
580
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> &
581
+ Pick<
441
582
  UndefinedInitialDataOptions<
442
583
  Awaited<ReturnType<typeof getVersions>>,
443
584
  TError,
444
- TData
445
- > , 'initialData'
446
- >, request?: SecondParameter<typeof customInstance>}
447
-
448
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
449
- export function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
450
- datasetId: string,
451
- params?: GetVersionsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
452
-
453
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
585
+ Awaited<ReturnType<typeof getVersions>>
586
+ >,
587
+ "initialData"
588
+ >;
589
+ request?: SecondParameter<typeof customInstance>;
590
+ },
591
+ queryClient?: QueryClient,
592
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
593
+ export function useGetVersions<
594
+ TData = Awaited<ReturnType<typeof getVersions>>,
595
+ TError = ErrorType<void | DmError>,
596
+ >(
597
+ datasetId: string,
598
+ params?: GetVersionsParams,
599
+ options?: {
600
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
601
+ request?: SecondParameter<typeof customInstance>;
602
+ },
603
+ queryClient?: QueryClient,
604
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
454
605
  /**
455
606
  * @summary Gets all the Versions of a specific Dataset
456
607
  */
457
608
 
458
- export function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
459
- datasetId: string,
460
- params?: GetVersionsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
461
-
462
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
463
-
464
- const queryOptions = getGetVersionsQueryOptions(datasetId,params,options)
465
-
466
- const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
467
-
468
- query.queryKey = queryOptions.queryKey ;
609
+ export function useGetVersions<
610
+ TData = Awaited<ReturnType<typeof getVersions>>,
611
+ TError = ErrorType<void | DmError>,
612
+ >(
613
+ datasetId: string,
614
+ params?: GetVersionsParams,
615
+ options?: {
616
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
617
+ request?: SecondParameter<typeof customInstance>;
618
+ },
619
+ queryClient?: QueryClient,
620
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
621
+ const queryOptions = useGetVersionsQueryOptions(datasetId, params, options);
622
+
623
+ const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
624
+ queryKey: DataTag<QueryKey, TData, TError>;
625
+ };
626
+
627
+ query.queryKey = queryOptions.queryKey;
469
628
 
470
629
  return query;
471
630
  }
472
631
 
473
-
474
-
475
- export const getGetVersionsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string,
476
- params?: GetVersionsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
632
+ export const useGetVersionsSuspenseQueryOptions = <
633
+ TData = Awaited<ReturnType<typeof getVersions>>,
634
+ TError = ErrorType<void | DmError>,
635
+ >(
636
+ datasetId: string,
637
+ params?: GetVersionsParams,
638
+ options?: {
639
+ query?: Partial<
640
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>
641
+ >;
642
+ request?: SecondParameter<typeof customInstance>;
643
+ },
477
644
  ) => {
478
-
479
- const {query: queryOptions, request: requestOptions} = options ?? {};
480
-
481
- const queryKey = queryOptions?.queryKey ?? getGetVersionsQueryKey(datasetId,params);
482
-
483
-
484
-
485
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getVersions>>> = ({ signal }) => getVersions(datasetId,params, requestOptions, signal);
486
-
487
-
488
-
489
-
490
-
491
- return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
492
- }
493
-
494
- export type GetVersionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>
495
- export type GetVersionsSuspenseQueryError = ErrorType<void | DmError>
496
-
497
-
498
- export function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
499
- datasetId: string,
500
- params: undefined | GetVersionsParams, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
501
-
502
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
503
- export function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
504
- datasetId: string,
505
- params?: GetVersionsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
506
-
507
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
508
- export function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
509
- datasetId: string,
510
- params?: GetVersionsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
511
-
512
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
645
+ const { query: queryOptions, request: requestOptions } = options ?? {};
646
+
647
+ const queryKey = queryOptions?.queryKey ?? getGetVersionsQueryKey(datasetId, params);
648
+
649
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getVersions>>> = ({ signal }) =>
650
+ getVersions(datasetId, params, requestOptions, signal);
651
+
652
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
653
+
654
+ return customOptions as UseSuspenseQueryOptions<
655
+ Awaited<ReturnType<typeof getVersions>>,
656
+ TError,
657
+ TData
658
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
659
+ };
660
+
661
+ export type GetVersionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
662
+ export type GetVersionsSuspenseQueryError = ErrorType<void | DmError>;
663
+
664
+ export function useGetVersionsSuspense<
665
+ TData = Awaited<ReturnType<typeof getVersions>>,
666
+ TError = ErrorType<void | DmError>,
667
+ >(
668
+ datasetId: string,
669
+ params: undefined | GetVersionsParams,
670
+ options: {
671
+ query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
672
+ request?: SecondParameter<typeof customInstance>;
673
+ },
674
+ queryClient?: QueryClient,
675
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
676
+ export function useGetVersionsSuspense<
677
+ TData = Awaited<ReturnType<typeof getVersions>>,
678
+ TError = ErrorType<void | DmError>,
679
+ >(
680
+ datasetId: string,
681
+ params?: GetVersionsParams,
682
+ options?: {
683
+ query?: Partial<
684
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>
685
+ >;
686
+ request?: SecondParameter<typeof customInstance>;
687
+ },
688
+ queryClient?: QueryClient,
689
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
690
+ export function useGetVersionsSuspense<
691
+ TData = Awaited<ReturnType<typeof getVersions>>,
692
+ TError = ErrorType<void | DmError>,
693
+ >(
694
+ datasetId: string,
695
+ params?: GetVersionsParams,
696
+ options?: {
697
+ query?: Partial<
698
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>
699
+ >;
700
+ request?: SecondParameter<typeof customInstance>;
701
+ },
702
+ queryClient?: QueryClient,
703
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
513
704
  /**
514
705
  * @summary Gets all the Versions of a specific Dataset
515
706
  */
516
707
 
517
- export function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(
518
- datasetId: string,
519
- params?: GetVersionsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
520
-
521
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
522
-
523
- const queryOptions = getGetVersionsSuspenseQueryOptions(datasetId,params,options)
524
-
525
- const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
526
-
527
- query.queryKey = queryOptions.queryKey ;
708
+ export function useGetVersionsSuspense<
709
+ TData = Awaited<ReturnType<typeof getVersions>>,
710
+ TError = ErrorType<void | DmError>,
711
+ >(
712
+ datasetId: string,
713
+ params?: GetVersionsParams,
714
+ options?: {
715
+ query?: Partial<
716
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>
717
+ >;
718
+ request?: SecondParameter<typeof customInstance>;
719
+ },
720
+ queryClient?: QueryClient,
721
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
722
+ const queryOptions = useGetVersionsSuspenseQueryOptions(datasetId, params, options);
723
+
724
+ const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
725
+ TData,
726
+ TError
727
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
728
+
729
+ query.queryKey = queryOptions.queryKey;
528
730
 
529
731
  return query;
530
732
  }
531
733
 
532
-
533
-
534
734
  /**
535
735
  * Given the Dataset `id` and `version` the Dataset will be removed. The API does not prevent you removing a Dataset that's been used in a **Project**. When removed using this endpoint the Dataset is automatically detached from any and all Projects that it was attached to and any corresponding Project Files relating to the Dataset are also removed.
536
736
 
@@ -541,66 +741,84 @@ You cannot delete a Dataset until its upload is complete.
541
741
  * @summary Delete a Dataset
542
742
  */
543
743
  export const deleteDataset = (
544
- datasetId: string,
545
- datasetVersion: number,
546
- params?: DeleteDatasetParams,
547
- options?: SecondParameter<typeof customInstance>,) => {
548
-
549
-
550
- return customInstance<TaskIdentity>(
551
- {url: `/dataset/${datasetId}/${datasetVersion}`, method: 'DELETE',
552
- params
553
- },
554
- options);
555
- }
556
-
557
-
558
-
559
- export const getDeleteDatasetMutationOptions = <TData = Awaited<ReturnType<typeof deleteDataset>>, TError = ErrorType<void | DmError>,
560
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{datasetId: string;datasetVersion: number;params?: DeleteDatasetParams}, TContext>, request?: SecondParameter<typeof customInstance>}
744
+ datasetId: string,
745
+ datasetVersion: number,
746
+ params?: DeleteDatasetParams,
747
+ options?: SecondParameter<typeof customInstance>,
561
748
  ) => {
562
- const mutationKey = ['deleteDataset'];
563
- const {mutation: mutationOptions, request: requestOptions} = options ?
564
- options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
565
- options
566
- : {...options, mutation: {...options.mutation, mutationKey}}
567
- : {mutation: { mutationKey, }, request: undefined};
568
-
569
-
570
-
749
+ return customInstance<TaskIdentity>(
750
+ { url: `/dataset/${datasetId}/${datasetVersion}`, method: "DELETE", params },
751
+ options,
752
+ );
753
+ };
754
+
755
+ export const useDeleteDatasetMutationOptions = <
756
+ TError = ErrorType<void | DmError>,
757
+ TContext = unknown,
758
+ >(options?: {
759
+ mutation?: UseMutationOptions<
760
+ Awaited<ReturnType<typeof deleteDataset>>,
761
+ TError,
762
+ { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams },
763
+ TContext
764
+ >;
765
+ request?: SecondParameter<typeof customInstance>;
766
+ }): UseMutationOptions<
767
+ Awaited<ReturnType<typeof deleteDataset>>,
768
+ TError,
769
+ { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams },
770
+ TContext
771
+ > => {
772
+ const mutationKey = ["deleteDataset"];
773
+ const { mutation: mutationOptions, request: requestOptions } = options
774
+ ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
775
+ ? options
776
+ : { ...options, mutation: { ...options.mutation, mutationKey } }
777
+ : { mutation: { mutationKey }, request: undefined };
778
+
779
+ const mutationFn: MutationFunction<
780
+ Awaited<ReturnType<typeof deleteDataset>>,
781
+ { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams }
782
+ > = (props) => {
783
+ const { datasetId, datasetVersion, params } = props ?? {};
784
+
785
+ return deleteDataset(datasetId, datasetVersion, params, requestOptions);
786
+ };
787
+
788
+ const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
789
+
790
+ return customOptions;
791
+ };
792
+
793
+ export type DeleteDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDataset>>>;
794
+
795
+ export type DeleteDatasetMutationError = ErrorType<void | DmError>;
571
796
 
572
- const mutationFn: MutationFunction<Awaited<ReturnType<typeof deleteDataset>>, {datasetId: string;datasetVersion: number;params?: DeleteDatasetParams}> = (props) => {
573
- const {datasetId,datasetVersion,params} = props ?? {};
574
-
575
- return deleteDataset(datasetId,datasetVersion,params,requestOptions)
576
- }
577
-
578
-
579
-
580
-
581
- return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{datasetId: string;datasetVersion: number;params?: DeleteDatasetParams}, TContext>}
582
-
583
- export type DeleteDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDataset>>>
584
-
585
- export type DeleteDatasetMutationError = ErrorType<void | DmError>
586
-
587
- /**
797
+ /**
588
798
  * @summary Delete a Dataset
589
799
  */
590
- export const useDeleteDataset = <TData = Awaited<ReturnType<typeof deleteDataset>>, TError = ErrorType<void | DmError>,
591
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{datasetId: string;datasetVersion: number;params?: DeleteDatasetParams}, TContext>, request?: SecondParameter<typeof customInstance>}
800
+ export const useDeleteDataset = <TError = ErrorType<void | DmError>, TContext = unknown>(
801
+ options?: {
802
+ mutation?: UseMutationOptions<
803
+ Awaited<ReturnType<typeof deleteDataset>>,
804
+ TError,
805
+ { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams },
806
+ TContext
807
+ >;
808
+ request?: SecondParameter<typeof customInstance>;
809
+ },
810
+ queryClient?: QueryClient,
592
811
  ): UseMutationResult<
593
- TData,
594
- TError,
595
- {datasetId: string;datasetVersion: number;params?: DeleteDatasetParams},
596
- TContext
597
- > => {
598
-
599
- const mutationOptions = getDeleteDatasetMutationOptions(options);
600
-
601
- return useMutation(mutationOptions);
602
- }
603
- /**
812
+ Awaited<ReturnType<typeof deleteDataset>>,
813
+ TError,
814
+ { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams },
815
+ TContext
816
+ > => {
817
+ const mutationOptions = useDeleteDatasetMutationOptions(options);
818
+
819
+ return useMutation(mutationOptions, queryClient);
820
+ };
821
+ /**
604
822
  * Given a `dataset_id` the dataset will be returned if available.
605
823
 
606
824
  You cannot get a Dataset until its upload is complete.
@@ -608,155 +826,236 @@ You cannot get a Dataset until its upload is complete.
608
826
  * @summary Download a Dataset
609
827
  */
610
828
  export const downloadDataset = (
611
- datasetId: string,
612
- datasetVersion: number,
613
- options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
829
+ datasetId: string,
830
+ datasetVersion: number,
831
+ options?: SecondParameter<typeof customInstance>,
832
+ signal?: AbortSignal,
614
833
  ) => {
615
-
616
-
617
- return customInstance<void>(
618
- {url: `/dataset/${datasetId}/${datasetVersion}`, method: 'GET', signal
619
- },
620
- options);
621
- }
622
-
623
-
624
- export const getDownloadDatasetQueryKey = (datasetId: string,
625
- datasetVersion: number,) => {
626
- return ["data-manager-api", `/dataset/${datasetId}/${datasetVersion}`] as const;
627
- }
628
-
629
-
630
- export const getDownloadDatasetQueryOptions = <TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string,
631
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
834
+ return customInstance<void>(
835
+ { url: `/dataset/${datasetId}/${datasetVersion}`, method: "GET", signal },
836
+ options,
837
+ );
838
+ };
839
+
840
+ export const getDownloadDatasetQueryKey = (datasetId: string, datasetVersion: number) => {
841
+ return [`/dataset/${datasetId}/${datasetVersion}`] as const;
842
+ };
843
+
844
+ export const useDownloadDatasetQueryOptions = <
845
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
846
+ TError = ErrorType<void | DmError>,
847
+ >(
848
+ datasetId: string,
849
+ datasetVersion: number,
850
+ options?: {
851
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
852
+ request?: SecondParameter<typeof customInstance>;
853
+ },
632
854
  ) => {
633
-
634
- const {query: queryOptions, request: requestOptions} = options ?? {};
635
-
636
- const queryKey = queryOptions?.queryKey ?? getDownloadDatasetQueryKey(datasetId,datasetVersion);
637
-
638
-
639
-
640
- const queryFn: QueryFunction<Awaited<ReturnType<typeof downloadDataset>>> = ({ signal }) => downloadDataset(datasetId,datasetVersion, requestOptions, signal);
641
-
642
-
643
-
644
-
645
-
646
- return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
647
- }
648
-
649
- export type DownloadDatasetQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>
650
- export type DownloadDatasetQueryError = ErrorType<void | DmError>
651
-
652
-
653
- export function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
654
- datasetId: string,
655
- datasetVersion: number, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<
855
+ const { query: queryOptions, request: requestOptions } = options ?? {};
856
+
857
+ const queryKey = queryOptions?.queryKey ?? getDownloadDatasetQueryKey(datasetId, datasetVersion);
858
+
859
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof downloadDataset>>> = ({ signal }) =>
860
+ downloadDataset(datasetId, datasetVersion, requestOptions, signal);
861
+
862
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
863
+
864
+ return customOptions as UseQueryOptions<
865
+ Awaited<ReturnType<typeof downloadDataset>>,
866
+ TError,
867
+ TData
868
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
869
+ };
870
+
871
+ export type DownloadDatasetQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
872
+ export type DownloadDatasetQueryError = ErrorType<void | DmError>;
873
+
874
+ export function useDownloadDataset<
875
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
876
+ TError = ErrorType<void | DmError>,
877
+ >(
878
+ datasetId: string,
879
+ datasetVersion: number,
880
+ options: {
881
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> &
882
+ Pick<
656
883
  DefinedInitialDataOptions<
657
884
  Awaited<ReturnType<typeof downloadDataset>>,
658
885
  TError,
659
- TData
660
- > , 'initialData'
661
- >, request?: SecondParameter<typeof customInstance>}
662
-
663
- ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
664
- export function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
665
- datasetId: string,
666
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<
886
+ Awaited<ReturnType<typeof downloadDataset>>
887
+ >,
888
+ "initialData"
889
+ >;
890
+ request?: SecondParameter<typeof customInstance>;
891
+ },
892
+ queryClient?: QueryClient,
893
+ ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
894
+ export function useDownloadDataset<
895
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
896
+ TError = ErrorType<void | DmError>,
897
+ >(
898
+ datasetId: string,
899
+ datasetVersion: number,
900
+ options?: {
901
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> &
902
+ Pick<
667
903
  UndefinedInitialDataOptions<
668
904
  Awaited<ReturnType<typeof downloadDataset>>,
669
905
  TError,
670
- TData
671
- > , 'initialData'
672
- >, request?: SecondParameter<typeof customInstance>}
673
-
674
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
675
- export function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
676
- datasetId: string,
677
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
678
-
679
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
906
+ Awaited<ReturnType<typeof downloadDataset>>
907
+ >,
908
+ "initialData"
909
+ >;
910
+ request?: SecondParameter<typeof customInstance>;
911
+ },
912
+ queryClient?: QueryClient,
913
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
914
+ export function useDownloadDataset<
915
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
916
+ TError = ErrorType<void | DmError>,
917
+ >(
918
+ datasetId: string,
919
+ datasetVersion: number,
920
+ options?: {
921
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
922
+ request?: SecondParameter<typeof customInstance>;
923
+ },
924
+ queryClient?: QueryClient,
925
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
680
926
  /**
681
927
  * @summary Download a Dataset
682
928
  */
683
929
 
684
- export function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
685
- datasetId: string,
686
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
687
-
688
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
689
-
690
- const queryOptions = getDownloadDatasetQueryOptions(datasetId,datasetVersion,options)
691
-
692
- const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
693
-
694
- query.queryKey = queryOptions.queryKey ;
930
+ export function useDownloadDataset<
931
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
932
+ TError = ErrorType<void | DmError>,
933
+ >(
934
+ datasetId: string,
935
+ datasetVersion: number,
936
+ options?: {
937
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
938
+ request?: SecondParameter<typeof customInstance>;
939
+ },
940
+ queryClient?: QueryClient,
941
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
942
+ const queryOptions = useDownloadDatasetQueryOptions(datasetId, datasetVersion, options);
943
+
944
+ const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
945
+ queryKey: DataTag<QueryKey, TData, TError>;
946
+ };
947
+
948
+ query.queryKey = queryOptions.queryKey;
695
949
 
696
950
  return query;
697
951
  }
698
952
 
699
-
700
-
701
- export const getDownloadDatasetSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string,
702
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
953
+ export const useDownloadDatasetSuspenseQueryOptions = <
954
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
955
+ TError = ErrorType<void | DmError>,
956
+ >(
957
+ datasetId: string,
958
+ datasetVersion: number,
959
+ options?: {
960
+ query?: Partial<
961
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>
962
+ >;
963
+ request?: SecondParameter<typeof customInstance>;
964
+ },
703
965
  ) => {
704
-
705
- const {query: queryOptions, request: requestOptions} = options ?? {};
706
-
707
- const queryKey = queryOptions?.queryKey ?? getDownloadDatasetQueryKey(datasetId,datasetVersion);
708
-
709
-
710
-
711
- const queryFn: QueryFunction<Awaited<ReturnType<typeof downloadDataset>>> = ({ signal }) => downloadDataset(datasetId,datasetVersion, requestOptions, signal);
712
-
713
-
714
-
715
-
716
-
717
- return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
718
- }
719
-
720
- export type DownloadDatasetSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>
721
- export type DownloadDatasetSuspenseQueryError = ErrorType<void | DmError>
722
-
723
-
724
- export function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
725
- datasetId: string,
726
- datasetVersion: number, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
727
-
728
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
729
- export function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
730
- datasetId: string,
731
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
732
-
733
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
734
- export function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
735
- datasetId: string,
736
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
737
-
738
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
966
+ const { query: queryOptions, request: requestOptions } = options ?? {};
967
+
968
+ const queryKey = queryOptions?.queryKey ?? getDownloadDatasetQueryKey(datasetId, datasetVersion);
969
+
970
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof downloadDataset>>> = ({ signal }) =>
971
+ downloadDataset(datasetId, datasetVersion, requestOptions, signal);
972
+
973
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
974
+
975
+ return customOptions as UseSuspenseQueryOptions<
976
+ Awaited<ReturnType<typeof downloadDataset>>,
977
+ TError,
978
+ TData
979
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
980
+ };
981
+
982
+ export type DownloadDatasetSuspenseQueryResult = NonNullable<
983
+ Awaited<ReturnType<typeof downloadDataset>>
984
+ >;
985
+ export type DownloadDatasetSuspenseQueryError = ErrorType<void | DmError>;
986
+
987
+ export function useDownloadDatasetSuspense<
988
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
989
+ TError = ErrorType<void | DmError>,
990
+ >(
991
+ datasetId: string,
992
+ datasetVersion: number,
993
+ options: {
994
+ query: Partial<
995
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>
996
+ >;
997
+ request?: SecondParameter<typeof customInstance>;
998
+ },
999
+ queryClient?: QueryClient,
1000
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1001
+ export function useDownloadDatasetSuspense<
1002
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
1003
+ TError = ErrorType<void | DmError>,
1004
+ >(
1005
+ datasetId: string,
1006
+ datasetVersion: number,
1007
+ options?: {
1008
+ query?: Partial<
1009
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>
1010
+ >;
1011
+ request?: SecondParameter<typeof customInstance>;
1012
+ },
1013
+ queryClient?: QueryClient,
1014
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1015
+ export function useDownloadDatasetSuspense<
1016
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
1017
+ TError = ErrorType<void | DmError>,
1018
+ >(
1019
+ datasetId: string,
1020
+ datasetVersion: number,
1021
+ options?: {
1022
+ query?: Partial<
1023
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>
1024
+ >;
1025
+ request?: SecondParameter<typeof customInstance>;
1026
+ },
1027
+ queryClient?: QueryClient,
1028
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
739
1029
  /**
740
1030
  * @summary Download a Dataset
741
1031
  */
742
1032
 
743
- export function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(
744
- datasetId: string,
745
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
746
-
747
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
748
-
749
- const queryOptions = getDownloadDatasetSuspenseQueryOptions(datasetId,datasetVersion,options)
750
-
751
- const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
752
-
753
- query.queryKey = queryOptions.queryKey ;
1033
+ export function useDownloadDatasetSuspense<
1034
+ TData = Awaited<ReturnType<typeof downloadDataset>>,
1035
+ TError = ErrorType<void | DmError>,
1036
+ >(
1037
+ datasetId: string,
1038
+ datasetVersion: number,
1039
+ options?: {
1040
+ query?: Partial<
1041
+ UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>
1042
+ >;
1043
+ request?: SecondParameter<typeof customInstance>;
1044
+ },
1045
+ queryClient?: QueryClient,
1046
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
1047
+ const queryOptions = useDownloadDatasetSuspenseQueryOptions(datasetId, datasetVersion, options);
1048
+
1049
+ const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
1050
+ TData,
1051
+ TError
1052
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
1053
+
1054
+ query.queryKey = queryOptions.queryKey;
754
1055
 
755
1056
  return query;
756
1057
  }
757
1058
 
758
-
759
-
760
1059
  /**
761
1060
  * The user is removed from the Dataset's `editor` list. The user is removed from all versions of a dataset. You can remove yourself but an `owner` (creator) will always have access to the dataset.
762
1061
 
@@ -767,64 +1066,85 @@ You cannot modify Dataset editors until its upload is complete.
767
1066
  * @summary Remove a user's edit permission for a Dataset
768
1067
  */
769
1068
  export const removeEditorFromDataset = (
770
- datasetId: string,
771
- userId: string,
772
- options?: SecondParameter<typeof customInstance>,) => {
773
-
774
-
775
- return customInstance<void>(
776
- {url: `/dataset/${datasetId}/editor/${userId}`, method: 'DELETE'
777
- },
778
- options);
779
- }
780
-
781
-
782
-
783
- export const getRemoveEditorFromDatasetMutationOptions = <TData = Awaited<ReturnType<typeof removeEditorFromDataset>>, TError = ErrorType<DmError | void>,
784
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{datasetId: string;userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
1069
+ datasetId: string,
1070
+ userId: string,
1071
+ options?: SecondParameter<typeof customInstance>,
785
1072
  ) => {
786
- const mutationKey = ['removeEditorFromDataset'];
787
- const {mutation: mutationOptions, request: requestOptions} = options ?
788
- options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
789
- options
790
- : {...options, mutation: {...options.mutation, mutationKey}}
791
- : {mutation: { mutationKey, }, request: undefined};
792
-
793
-
794
-
795
-
796
- const mutationFn: MutationFunction<Awaited<ReturnType<typeof removeEditorFromDataset>>, {datasetId: string;userId: string}> = (props) => {
797
- const {datasetId,userId} = props ?? {};
798
-
799
- return removeEditorFromDataset(datasetId,userId,requestOptions)
800
- }
801
-
802
-
1073
+ return customInstance<void>(
1074
+ { url: `/dataset/${datasetId}/editor/${userId}`, method: "DELETE" },
1075
+ options,
1076
+ );
1077
+ };
1078
+
1079
+ export const useRemoveEditorFromDatasetMutationOptions = <
1080
+ TError = ErrorType<DmError | void>,
1081
+ TContext = unknown,
1082
+ >(options?: {
1083
+ mutation?: UseMutationOptions<
1084
+ Awaited<ReturnType<typeof removeEditorFromDataset>>,
1085
+ TError,
1086
+ { datasetId: string; userId: string },
1087
+ TContext
1088
+ >;
1089
+ request?: SecondParameter<typeof customInstance>;
1090
+ }): UseMutationOptions<
1091
+ Awaited<ReturnType<typeof removeEditorFromDataset>>,
1092
+ TError,
1093
+ { datasetId: string; userId: string },
1094
+ TContext
1095
+ > => {
1096
+ const mutationKey = ["removeEditorFromDataset"];
1097
+ const { mutation: mutationOptions, request: requestOptions } = options
1098
+ ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
1099
+ ? options
1100
+ : { ...options, mutation: { ...options.mutation, mutationKey } }
1101
+ : { mutation: { mutationKey }, request: undefined };
1102
+
1103
+ const mutationFn: MutationFunction<
1104
+ Awaited<ReturnType<typeof removeEditorFromDataset>>,
1105
+ { datasetId: string; userId: string }
1106
+ > = (props) => {
1107
+ const { datasetId, userId } = props ?? {};
1108
+
1109
+ return removeEditorFromDataset(datasetId, userId, requestOptions);
1110
+ };
1111
+
1112
+ const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
1113
+
1114
+ return customOptions;
1115
+ };
1116
+
1117
+ export type RemoveEditorFromDatasetMutationResult = NonNullable<
1118
+ Awaited<ReturnType<typeof removeEditorFromDataset>>
1119
+ >;
1120
+
1121
+ export type RemoveEditorFromDatasetMutationError = ErrorType<DmError | void>;
803
1122
 
804
-
805
- return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{datasetId: string;userId: string}, TContext>}
806
-
807
- export type RemoveEditorFromDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromDataset>>>
808
-
809
- export type RemoveEditorFromDatasetMutationError = ErrorType<DmError | void>
810
-
811
- /**
1123
+ /**
812
1124
  * @summary Remove a user's edit permission for a Dataset
813
1125
  */
814
- export const useRemoveEditorFromDataset = <TData = Awaited<ReturnType<typeof removeEditorFromDataset>>, TError = ErrorType<DmError | void>,
815
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{datasetId: string;userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
1126
+ export const useRemoveEditorFromDataset = <TError = ErrorType<DmError | void>, TContext = unknown>(
1127
+ options?: {
1128
+ mutation?: UseMutationOptions<
1129
+ Awaited<ReturnType<typeof removeEditorFromDataset>>,
1130
+ TError,
1131
+ { datasetId: string; userId: string },
1132
+ TContext
1133
+ >;
1134
+ request?: SecondParameter<typeof customInstance>;
1135
+ },
1136
+ queryClient?: QueryClient,
816
1137
  ): UseMutationResult<
817
- TData,
818
- TError,
819
- {datasetId: string;userId: string},
820
- TContext
821
- > => {
822
-
823
- const mutationOptions = getRemoveEditorFromDatasetMutationOptions(options);
824
-
825
- return useMutation(mutationOptions);
826
- }
827
- /**
1138
+ Awaited<ReturnType<typeof removeEditorFromDataset>>,
1139
+ TError,
1140
+ { datasetId: string; userId: string },
1141
+ TContext
1142
+ > => {
1143
+ const mutationOptions = useRemoveEditorFromDatasetMutationOptions(options);
1144
+
1145
+ return useMutation(mutationOptions, queryClient);
1146
+ };
1147
+ /**
828
1148
  * The user is added to the dataset's `editor`` list. The dataset `owner` is automatically an editor and so does not need to be added as an `editor`.
829
1149
 
830
1150
  You must be an `editor` or `owner` of the dataset.
@@ -834,215 +1154,302 @@ You cannot modify Dataset editors until its upload is complete.
834
1154
  * @summary Give a user edit permission for a Dataset
835
1155
  */
836
1156
  export const addEditorToDataset = (
837
- datasetId: string,
838
- userId: string,
839
- options?: SecondParameter<typeof customInstance>,) => {
840
-
841
-
842
- return customInstance<void>(
843
- {url: `/dataset/${datasetId}/editor/${userId}`, method: 'PUT'
844
- },
845
- options);
846
- }
847
-
848
-
849
-
850
- export const getAddEditorToDatasetMutationOptions = <TData = Awaited<ReturnType<typeof addEditorToDataset>>, TError = ErrorType<void | DmError>,
851
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{datasetId: string;userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
1157
+ datasetId: string,
1158
+ userId: string,
1159
+ options?: SecondParameter<typeof customInstance>,
852
1160
  ) => {
853
- const mutationKey = ['addEditorToDataset'];
854
- const {mutation: mutationOptions, request: requestOptions} = options ?
855
- options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
856
- options
857
- : {...options, mutation: {...options.mutation, mutationKey}}
858
- : {mutation: { mutationKey, }, request: undefined};
859
-
860
-
861
-
862
-
863
- const mutationFn: MutationFunction<Awaited<ReturnType<typeof addEditorToDataset>>, {datasetId: string;userId: string}> = (props) => {
864
- const {datasetId,userId} = props ?? {};
865
-
866
- return addEditorToDataset(datasetId,userId,requestOptions)
867
- }
868
-
869
-
1161
+ return customInstance<void>(
1162
+ { url: `/dataset/${datasetId}/editor/${userId}`, method: "PUT" },
1163
+ options,
1164
+ );
1165
+ };
1166
+
1167
+ export const useAddEditorToDatasetMutationOptions = <
1168
+ TError = ErrorType<void | DmError>,
1169
+ TContext = unknown,
1170
+ >(options?: {
1171
+ mutation?: UseMutationOptions<
1172
+ Awaited<ReturnType<typeof addEditorToDataset>>,
1173
+ TError,
1174
+ { datasetId: string; userId: string },
1175
+ TContext
1176
+ >;
1177
+ request?: SecondParameter<typeof customInstance>;
1178
+ }): UseMutationOptions<
1179
+ Awaited<ReturnType<typeof addEditorToDataset>>,
1180
+ TError,
1181
+ { datasetId: string; userId: string },
1182
+ TContext
1183
+ > => {
1184
+ const mutationKey = ["addEditorToDataset"];
1185
+ const { mutation: mutationOptions, request: requestOptions } = options
1186
+ ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
1187
+ ? options
1188
+ : { ...options, mutation: { ...options.mutation, mutationKey } }
1189
+ : { mutation: { mutationKey }, request: undefined };
1190
+
1191
+ const mutationFn: MutationFunction<
1192
+ Awaited<ReturnType<typeof addEditorToDataset>>,
1193
+ { datasetId: string; userId: string }
1194
+ > = (props) => {
1195
+ const { datasetId, userId } = props ?? {};
1196
+
1197
+ return addEditorToDataset(datasetId, userId, requestOptions);
1198
+ };
1199
+
1200
+ const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
1201
+
1202
+ return customOptions;
1203
+ };
1204
+
1205
+ export type AddEditorToDatasetMutationResult = NonNullable<
1206
+ Awaited<ReturnType<typeof addEditorToDataset>>
1207
+ >;
1208
+
1209
+ export type AddEditorToDatasetMutationError = ErrorType<void | DmError>;
870
1210
 
871
-
872
- return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{datasetId: string;userId: string}, TContext>}
873
-
874
- export type AddEditorToDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToDataset>>>
875
-
876
- export type AddEditorToDatasetMutationError = ErrorType<void | DmError>
877
-
878
- /**
1211
+ /**
879
1212
  * @summary Give a user edit permission for a Dataset
880
1213
  */
881
- export const useAddEditorToDataset = <TData = Awaited<ReturnType<typeof addEditorToDataset>>, TError = ErrorType<void | DmError>,
882
- TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{datasetId: string;userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
1214
+ export const useAddEditorToDataset = <TError = ErrorType<void | DmError>, TContext = unknown>(
1215
+ options?: {
1216
+ mutation?: UseMutationOptions<
1217
+ Awaited<ReturnType<typeof addEditorToDataset>>,
1218
+ TError,
1219
+ { datasetId: string; userId: string },
1220
+ TContext
1221
+ >;
1222
+ request?: SecondParameter<typeof customInstance>;
1223
+ },
1224
+ queryClient?: QueryClient,
883
1225
  ): UseMutationResult<
884
- TData,
885
- TError,
886
- {datasetId: string;userId: string},
887
- TContext
888
- > => {
889
-
890
- const mutationOptions = getAddEditorToDatasetMutationOptions(options);
891
-
892
- return useMutation(mutationOptions);
893
- }
894
- /**
1226
+ Awaited<ReturnType<typeof addEditorToDataset>>,
1227
+ TError,
1228
+ { datasetId: string; userId: string },
1229
+ TContext
1230
+ > => {
1231
+ const mutationOptions = useAddEditorToDatasetMutationOptions(options);
1232
+
1233
+ return useMutation(mutationOptions, queryClient);
1234
+ };
1235
+ /**
895
1236
  * Returns the property schema for a Dataset versions in JSON format (if available).
896
1237
 
897
1238
  * @summary Gets the property schema for a specific Dataset
898
1239
  */
899
1240
  export const getSchema = (
900
- datasetId: string,
901
- datasetVersion: number,
902
- options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
1241
+ datasetId: string,
1242
+ datasetVersion: number,
1243
+ options?: SecondParameter<typeof customInstance>,
1244
+ signal?: AbortSignal,
903
1245
  ) => {
904
-
905
-
906
- return customInstance<DatasetSchemaGetResponse>(
907
- {url: `/dataset/${datasetId}/schema/${datasetVersion}`, method: 'GET', signal
908
- },
909
- options);
910
- }
911
-
912
-
913
- export const getGetSchemaQueryKey = (datasetId: string,
914
- datasetVersion: number,) => {
915
- return ["data-manager-api", `/dataset/${datasetId}/schema/${datasetVersion}`] as const;
916
- }
917
-
918
-
919
- export const getGetSchemaQueryOptions = <TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string,
920
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
1246
+ return customInstance<DatasetSchemaGetResponse>(
1247
+ { url: `/dataset/${datasetId}/schema/${datasetVersion}`, method: "GET", signal },
1248
+ options,
1249
+ );
1250
+ };
1251
+
1252
+ export const getGetSchemaQueryKey = (datasetId: string, datasetVersion: number) => {
1253
+ return [`/dataset/${datasetId}/schema/${datasetVersion}`] as const;
1254
+ };
1255
+
1256
+ export const useGetSchemaQueryOptions = <
1257
+ TData = Awaited<ReturnType<typeof getSchema>>,
1258
+ TError = ErrorType<void | DmError>,
1259
+ >(
1260
+ datasetId: string,
1261
+ datasetVersion: number,
1262
+ options?: {
1263
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1264
+ request?: SecondParameter<typeof customInstance>;
1265
+ },
921
1266
  ) => {
1267
+ const { query: queryOptions, request: requestOptions } = options ?? {};
922
1268
 
923
- const {query: queryOptions, request: requestOptions} = options ?? {};
924
-
925
- const queryKey = queryOptions?.queryKey ?? getGetSchemaQueryKey(datasetId,datasetVersion);
1269
+ const queryKey = queryOptions?.queryKey ?? getGetSchemaQueryKey(datasetId, datasetVersion);
926
1270
 
927
-
1271
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getSchema>>> = ({ signal }) =>
1272
+ getSchema(datasetId, datasetVersion, requestOptions, signal);
928
1273
 
929
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getSchema>>> = ({ signal }) => getSchema(datasetId,datasetVersion, requestOptions, signal);
1274
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
930
1275
 
931
-
1276
+ return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & {
1277
+ queryKey: DataTag<QueryKey, TData, TError>;
1278
+ };
1279
+ };
932
1280
 
933
-
934
-
935
- return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
936
- }
1281
+ export type GetSchemaQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
1282
+ export type GetSchemaQueryError = ErrorType<void | DmError>;
937
1283
 
938
- export type GetSchemaQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>
939
- export type GetSchemaQueryError = ErrorType<void | DmError>
940
-
941
-
942
- export function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
943
- datasetId: string,
944
- datasetVersion: number, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<
1284
+ export function useGetSchema<
1285
+ TData = Awaited<ReturnType<typeof getSchema>>,
1286
+ TError = ErrorType<void | DmError>,
1287
+ >(
1288
+ datasetId: string,
1289
+ datasetVersion: number,
1290
+ options: {
1291
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> &
1292
+ Pick<
945
1293
  DefinedInitialDataOptions<
946
1294
  Awaited<ReturnType<typeof getSchema>>,
947
1295
  TError,
948
- TData
949
- > , 'initialData'
950
- >, request?: SecondParameter<typeof customInstance>}
951
-
952
- ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
953
- export function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
954
- datasetId: string,
955
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<
1296
+ Awaited<ReturnType<typeof getSchema>>
1297
+ >,
1298
+ "initialData"
1299
+ >;
1300
+ request?: SecondParameter<typeof customInstance>;
1301
+ },
1302
+ queryClient?: QueryClient,
1303
+ ): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1304
+ export function useGetSchema<
1305
+ TData = Awaited<ReturnType<typeof getSchema>>,
1306
+ TError = ErrorType<void | DmError>,
1307
+ >(
1308
+ datasetId: string,
1309
+ datasetVersion: number,
1310
+ options?: {
1311
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> &
1312
+ Pick<
956
1313
  UndefinedInitialDataOptions<
957
1314
  Awaited<ReturnType<typeof getSchema>>,
958
1315
  TError,
959
- TData
960
- > , 'initialData'
961
- >, request?: SecondParameter<typeof customInstance>}
962
-
963
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
964
- export function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
965
- datasetId: string,
966
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
967
-
968
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
1316
+ Awaited<ReturnType<typeof getSchema>>
1317
+ >,
1318
+ "initialData"
1319
+ >;
1320
+ request?: SecondParameter<typeof customInstance>;
1321
+ },
1322
+ queryClient?: QueryClient,
1323
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1324
+ export function useGetSchema<
1325
+ TData = Awaited<ReturnType<typeof getSchema>>,
1326
+ TError = ErrorType<void | DmError>,
1327
+ >(
1328
+ datasetId: string,
1329
+ datasetVersion: number,
1330
+ options?: {
1331
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1332
+ request?: SecondParameter<typeof customInstance>;
1333
+ },
1334
+ queryClient?: QueryClient,
1335
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
969
1336
  /**
970
1337
  * @summary Gets the property schema for a specific Dataset
971
1338
  */
972
1339
 
973
- export function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
974
- datasetId: string,
975
- datasetVersion: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
976
-
977
- ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
978
-
979
- const queryOptions = getGetSchemaQueryOptions(datasetId,datasetVersion,options)
980
-
981
- const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
982
-
983
- query.queryKey = queryOptions.queryKey ;
1340
+ export function useGetSchema<
1341
+ TData = Awaited<ReturnType<typeof getSchema>>,
1342
+ TError = ErrorType<void | DmError>,
1343
+ >(
1344
+ datasetId: string,
1345
+ datasetVersion: number,
1346
+ options?: {
1347
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1348
+ request?: SecondParameter<typeof customInstance>;
1349
+ },
1350
+ queryClient?: QueryClient,
1351
+ ): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
1352
+ const queryOptions = useGetSchemaQueryOptions(datasetId, datasetVersion, options);
1353
+
1354
+ const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
1355
+ queryKey: DataTag<QueryKey, TData, TError>;
1356
+ };
1357
+
1358
+ query.queryKey = queryOptions.queryKey;
984
1359
 
985
1360
  return query;
986
1361
  }
987
1362
 
988
-
989
-
990
- export const getGetSchemaSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string,
991
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
1363
+ export const useGetSchemaSuspenseQueryOptions = <
1364
+ TData = Awaited<ReturnType<typeof getSchema>>,
1365
+ TError = ErrorType<void | DmError>,
1366
+ >(
1367
+ datasetId: string,
1368
+ datasetVersion: number,
1369
+ options?: {
1370
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1371
+ request?: SecondParameter<typeof customInstance>;
1372
+ },
992
1373
  ) => {
993
-
994
- const {query: queryOptions, request: requestOptions} = options ?? {};
995
-
996
- const queryKey = queryOptions?.queryKey ?? getGetSchemaQueryKey(datasetId,datasetVersion);
997
-
998
-
999
-
1000
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getSchema>>> = ({ signal }) => getSchema(datasetId,datasetVersion, requestOptions, signal);
1001
-
1002
-
1003
-
1004
-
1005
-
1006
- return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
1007
- }
1008
-
1009
- export type GetSchemaSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>
1010
- export type GetSchemaSuspenseQueryError = ErrorType<void | DmError>
1011
-
1012
-
1013
- export function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
1014
- datasetId: string,
1015
- datasetVersion: number, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
1016
-
1017
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
1018
- export function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
1019
- datasetId: string,
1020
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
1021
-
1022
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
1023
- export function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
1024
- datasetId: string,
1025
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
1026
-
1027
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
1374
+ const { query: queryOptions, request: requestOptions } = options ?? {};
1375
+
1376
+ const queryKey = queryOptions?.queryKey ?? getGetSchemaQueryKey(datasetId, datasetVersion);
1377
+
1378
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getSchema>>> = ({ signal }) =>
1379
+ getSchema(datasetId, datasetVersion, requestOptions, signal);
1380
+
1381
+ const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
1382
+
1383
+ return customOptions as UseSuspenseQueryOptions<
1384
+ Awaited<ReturnType<typeof getSchema>>,
1385
+ TError,
1386
+ TData
1387
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
1388
+ };
1389
+
1390
+ export type GetSchemaSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
1391
+ export type GetSchemaSuspenseQueryError = ErrorType<void | DmError>;
1392
+
1393
+ export function useGetSchemaSuspense<
1394
+ TData = Awaited<ReturnType<typeof getSchema>>,
1395
+ TError = ErrorType<void | DmError>,
1396
+ >(
1397
+ datasetId: string,
1398
+ datasetVersion: number,
1399
+ options: {
1400
+ query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1401
+ request?: SecondParameter<typeof customInstance>;
1402
+ },
1403
+ queryClient?: QueryClient,
1404
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1405
+ export function useGetSchemaSuspense<
1406
+ TData = Awaited<ReturnType<typeof getSchema>>,
1407
+ TError = ErrorType<void | DmError>,
1408
+ >(
1409
+ datasetId: string,
1410
+ datasetVersion: number,
1411
+ options?: {
1412
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1413
+ request?: SecondParameter<typeof customInstance>;
1414
+ },
1415
+ queryClient?: QueryClient,
1416
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1417
+ export function useGetSchemaSuspense<
1418
+ TData = Awaited<ReturnType<typeof getSchema>>,
1419
+ TError = ErrorType<void | DmError>,
1420
+ >(
1421
+ datasetId: string,
1422
+ datasetVersion: number,
1423
+ options?: {
1424
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1425
+ request?: SecondParameter<typeof customInstance>;
1426
+ },
1427
+ queryClient?: QueryClient,
1428
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1028
1429
  /**
1029
1430
  * @summary Gets the property schema for a specific Dataset
1030
1431
  */
1031
1432
 
1032
- export function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(
1033
- datasetId: string,
1034
- datasetVersion: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
1035
-
1036
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
1037
-
1038
- const queryOptions = getGetSchemaSuspenseQueryOptions(datasetId,datasetVersion,options)
1039
-
1040
- const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
1041
-
1042
- query.queryKey = queryOptions.queryKey ;
1433
+ export function useGetSchemaSuspense<
1434
+ TData = Awaited<ReturnType<typeof getSchema>>,
1435
+ TError = ErrorType<void | DmError>,
1436
+ >(
1437
+ datasetId: string,
1438
+ datasetVersion: number,
1439
+ options?: {
1440
+ query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
1441
+ request?: SecondParameter<typeof customInstance>;
1442
+ },
1443
+ queryClient?: QueryClient,
1444
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
1445
+ const queryOptions = useGetSchemaSuspenseQueryOptions(datasetId, datasetVersion, options);
1446
+
1447
+ const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
1448
+ TData,
1449
+ TError
1450
+ > & { queryKey: DataTag<QueryKey, TData, TError> };
1451
+
1452
+ query.queryKey = queryOptions.queryKey;
1043
1453
 
1044
1454
  return query;
1045
1455
  }
1046
-
1047
-
1048
-