@squonk/data-manager-client 3.3.0 → 3.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/accounting/accounting.cjs.map +1 -1
  2. package/accounting/accounting.d.cts +25 -25
  3. package/accounting/accounting.d.ts +25 -25
  4. package/accounting/accounting.js.map +1 -1
  5. package/admin/admin.cjs +16 -8
  6. package/admin/admin.cjs.map +1 -1
  7. package/admin/admin.d.cts +73 -73
  8. package/admin/admin.d.ts +73 -73
  9. package/admin/admin.js +16 -8
  10. package/admin/admin.js.map +1 -1
  11. package/application/application.cjs +1 -1
  12. package/application/application.cjs.map +1 -1
  13. package/application/application.d.cts +17 -17
  14. package/application/application.d.ts +17 -17
  15. package/application/application.js +1 -1
  16. package/application/application.js.map +1 -1
  17. package/configuration/configuration.cjs.map +1 -1
  18. package/configuration/configuration.d.cts +9 -9
  19. package/configuration/configuration.d.ts +9 -9
  20. package/configuration/configuration.js.map +1 -1
  21. package/dataset/dataset.cjs +16 -10
  22. package/dataset/dataset.cjs.map +1 -1
  23. package/dataset/dataset.d.cts +64 -64
  24. package/dataset/dataset.d.ts +64 -64
  25. package/dataset/dataset.js +16 -10
  26. package/dataset/dataset.js.map +1 -1
  27. package/digest/digest.cjs +1 -1
  28. package/digest/digest.cjs.map +1 -1
  29. package/digest/digest.d.cts +9 -9
  30. package/digest/digest.d.ts +9 -9
  31. package/digest/digest.js +1 -1
  32. package/digest/digest.js.map +1 -1
  33. package/exchange-rate/exchange-rate.cjs +6 -4
  34. package/exchange-rate/exchange-rate.cjs.map +1 -1
  35. package/exchange-rate/exchange-rate.d.cts +45 -45
  36. package/exchange-rate/exchange-rate.d.ts +45 -45
  37. package/exchange-rate/exchange-rate.js +6 -4
  38. package/exchange-rate/exchange-rate.js.map +1 -1
  39. package/file-and-path/file-and-path.cjs +18 -10
  40. package/file-and-path/file-and-path.cjs.map +1 -1
  41. package/file-and-path/file-and-path.d.cts +60 -60
  42. package/file-and-path/file-and-path.d.ts +60 -60
  43. package/file-and-path/file-and-path.js +18 -10
  44. package/file-and-path/file-and-path.js.map +1 -1
  45. package/index.cjs +8 -8
  46. package/index.cjs.map +1 -1
  47. package/index.d.cts +537 -537
  48. package/index.d.ts +537 -537
  49. package/index.js +8 -8
  50. package/index.js.map +1 -1
  51. package/instance/instance.cjs +17 -10
  52. package/instance/instance.cjs.map +1 -1
  53. package/instance/instance.d.cts +49 -49
  54. package/instance/instance.d.ts +49 -49
  55. package/instance/instance.js +17 -10
  56. package/instance/instance.js.map +1 -1
  57. package/inventory/inventory.cjs.map +1 -1
  58. package/inventory/inventory.d.cts +9 -9
  59. package/inventory/inventory.d.ts +9 -9
  60. package/inventory/inventory.js.map +1 -1
  61. package/job/job.cjs +1 -1
  62. package/job/job.cjs.map +1 -1
  63. package/job/job.d.cts +25 -25
  64. package/job/job.d.ts +25 -25
  65. package/job/job.js +1 -1
  66. package/job/job.js.map +1 -1
  67. package/metadata/metadata.cjs +12 -8
  68. package/metadata/metadata.cjs.map +1 -1
  69. package/metadata/metadata.d.cts +31 -31
  70. package/metadata/metadata.d.ts +31 -31
  71. package/metadata/metadata.js +12 -8
  72. package/metadata/metadata.js.map +1 -1
  73. package/package.json +11 -11
  74. package/project/project.cjs +26 -15
  75. package/project/project.cjs.map +1 -1
  76. package/project/project.d.cts +94 -94
  77. package/project/project.d.ts +94 -94
  78. package/project/project.js +26 -15
  79. package/project/project.js.map +1 -1
  80. package/src/accounting/accounting.ts +38 -37
  81. package/src/admin/admin.ts +142 -101
  82. package/src/application/application.ts +26 -25
  83. package/src/configuration/configuration.ts +14 -13
  84. package/src/data-manager-api.schemas.ts +545 -545
  85. package/src/dataset/dataset.ts +118 -91
  86. package/src/digest/digest.ts +14 -13
  87. package/src/exchange-rate/exchange-rate.ts +76 -65
  88. package/src/file-and-path/file-and-path.ts +120 -83
  89. package/src/instance/instance.ts +97 -69
  90. package/src/inventory/inventory.ts +14 -13
  91. package/src/job/job.ts +38 -37
  92. package/src/metadata/metadata.ts +58 -45
  93. package/src/project/project.ts +183 -131
  94. package/src/task/task.ts +39 -33
  95. package/src/type/type.ts +14 -13
  96. package/src/user/user.ts +51 -45
  97. package/task/task.cjs +3 -2
  98. package/task/task.cjs.map +1 -1
  99. package/task/task.d.cts +23 -23
  100. package/task/task.d.ts +23 -23
  101. package/task/task.js +3 -2
  102. package/task/task.js.map +1 -1
  103. package/type/type.cjs.map +1 -1
  104. package/type/type.d.cts +9 -9
  105. package/type/type.d.ts +9 -9
  106. package/type/type.js.map +1 -1
  107. package/user/user.cjs +2 -1
  108. package/user/user.cjs.map +1 -1
  109. package/user/user.d.cts +31 -31
  110. package/user/user.d.ts +31 -31
  111. package/user/user.js +2 -1
  112. package/user/user.js.map +1 -1
@@ -1,4 +1,4 @@
1
- import { UseMutationOptions, UseMutationResult, UseQueryOptions, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
1
+ import { UseMutationOptions, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
2
2
  import { DatasetPutBodyBody, customInstance, DatasetPutPostResponse, ErrorType, DmError, DatasetPostBodyBody, GetDatasetsParams, DatasetsGetResponse, GetVersionsParams, DatasetDetail, DeleteDatasetParams, TaskIdentity, DatasetSchemaGetResponse } from '../index.js';
3
3
  import 'axios';
4
4
 
@@ -13,12 +13,12 @@ Behaves like the corresponding **POST** method except the file is expected to ex
13
13
  * @summary Create a Dataset from a file in a Project
14
14
  */
15
15
  declare const createDatasetFromFile: (datasetPutBodyBody: DatasetPutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
16
- declare const getCreateDatasetFromFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
17
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
16
+ declare const getCreateDatasetFromFileMutationOptions: <TData = DatasetPutPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
17
+ mutation?: UseMutationOptions<TData, TError, {
18
18
  data: DatasetPutBodyBody;
19
19
  }, TContext>;
20
20
  request?: SecondParameter<typeof customInstance>;
21
- }) => UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
21
+ }) => UseMutationOptions<TData, TError, {
22
22
  data: DatasetPutBodyBody;
23
23
  }, TContext>;
24
24
  type CreateDatasetFromFileMutationResult = NonNullable<Awaited<ReturnType<typeof createDatasetFromFile>>>;
@@ -27,12 +27,12 @@ type CreateDatasetFromFileMutationError = ErrorType<void | DmError>;
27
27
  /**
28
28
  * @summary Create a Dataset from a file in a Project
29
29
  */
30
- declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
31
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
30
+ declare const useCreateDatasetFromFile: <TData = DatasetPutPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
31
+ mutation?: UseMutationOptions<TData, TError, {
32
32
  data: DatasetPutBodyBody;
33
33
  }, TContext>;
34
34
  request?: SecondParameter<typeof customInstance>;
35
- }) => UseMutationResult<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
35
+ }) => UseMutationResult<TData, TError, {
36
36
  data: DatasetPutBodyBody;
37
37
  }, TContext>;
38
38
  /**
@@ -48,13 +48,13 @@ Datasets undergo some processing in an asynchronous **Task** after control retur
48
48
 
49
49
  * @summary Upload an external file as a Dataset
50
50
  */
51
- declare const uploadDataset: (datasetPostBodyBody: DatasetPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
52
- declare const getUploadDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
53
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
51
+ declare const uploadDataset: (datasetPostBodyBody: DatasetPostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetPutPostResponse>;
52
+ declare const getUploadDatasetMutationOptions: <TData = DatasetPutPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
53
+ mutation?: UseMutationOptions<TData, TError, {
54
54
  data: DatasetPostBodyBody;
55
55
  }, TContext>;
56
56
  request?: SecondParameter<typeof customInstance>;
57
- }) => UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
57
+ }) => UseMutationOptions<TData, TError, {
58
58
  data: DatasetPostBodyBody;
59
59
  }, TContext>;
60
60
  type UploadDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof uploadDataset>>>;
@@ -63,12 +63,12 @@ type UploadDatasetMutationError = ErrorType<void | DmError>;
63
63
  /**
64
64
  * @summary Upload an external file as a Dataset
65
65
  */
66
- declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
67
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
66
+ declare const useUploadDataset: <TData = DatasetPutPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
67
+ mutation?: UseMutationOptions<TData, TError, {
68
68
  data: DatasetPostBodyBody;
69
69
  }, TContext>;
70
70
  request?: SecondParameter<typeof customInstance>;
71
- }) => UseMutationResult<Awaited<ReturnType<typeof uploadDataset>>, TError, {
71
+ }) => UseMutationResult<TData, TError, {
72
72
  data: DatasetPostBodyBody;
73
73
  }, TContext>;
74
74
  /**
@@ -88,7 +88,7 @@ declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError =
88
88
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
89
89
  request?: SecondParameter<typeof customInstance>;
90
90
  }) => UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & {
91
- queryKey: QueryKey;
91
+ queryKey: DataTag<QueryKey, TData, TError>;
92
92
  };
93
93
  type GetDatasetsQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
94
94
  type GetDatasetsQueryError = ErrorType<void | DmError>;
@@ -96,25 +96,25 @@ declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>,
96
96
  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>, 'initialData'>;
97
97
  request?: SecondParameter<typeof customInstance>;
98
98
  }): DefinedUseQueryResult<TData, TError> & {
99
- queryKey: QueryKey;
99
+ queryKey: DataTag<QueryKey, TData, TError>;
100
100
  };
101
101
  declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
102
102
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>, 'initialData'>;
103
103
  request?: SecondParameter<typeof customInstance>;
104
104
  }): UseQueryResult<TData, TError> & {
105
- queryKey: QueryKey;
105
+ queryKey: DataTag<QueryKey, TData, TError>;
106
106
  };
107
107
  declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
108
108
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
109
109
  request?: SecondParameter<typeof customInstance>;
110
110
  }): UseQueryResult<TData, TError> & {
111
- queryKey: QueryKey;
111
+ queryKey: DataTag<QueryKey, TData, TError>;
112
112
  };
113
113
  declare const getGetDatasetsSuspenseQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
114
114
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
115
115
  request?: SecondParameter<typeof customInstance>;
116
116
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & {
117
- queryKey: QueryKey;
117
+ queryKey: DataTag<QueryKey, TData, TError>;
118
118
  };
119
119
  type GetDatasetsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
120
120
  type GetDatasetsSuspenseQueryError = ErrorType<void | DmError>;
@@ -122,19 +122,19 @@ declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDat
122
122
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
123
123
  request?: SecondParameter<typeof customInstance>;
124
124
  }): UseSuspenseQueryResult<TData, TError> & {
125
- queryKey: QueryKey;
125
+ queryKey: DataTag<QueryKey, TData, TError>;
126
126
  };
127
127
  declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
128
128
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
129
129
  request?: SecondParameter<typeof customInstance>;
130
130
  }): UseSuspenseQueryResult<TData, TError> & {
131
- queryKey: QueryKey;
131
+ queryKey: DataTag<QueryKey, TData, TError>;
132
132
  };
133
133
  declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
134
134
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
135
135
  request?: SecondParameter<typeof customInstance>;
136
136
  }): UseSuspenseQueryResult<TData, TError> & {
137
- queryKey: QueryKey;
137
+ queryKey: DataTag<QueryKey, TData, TError>;
138
138
  };
139
139
  /**
140
140
  * Returns a list of Dataset Versions.
@@ -149,7 +149,7 @@ declare const getGetVersionsQueryOptions: <TData = DatasetDetail, TError = Error
149
149
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
150
150
  request?: SecondParameter<typeof customInstance>;
151
151
  }) => UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & {
152
- queryKey: QueryKey;
152
+ queryKey: DataTag<QueryKey, TData, TError>;
153
153
  };
154
154
  type GetVersionsQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
155
155
  type GetVersionsQueryError = ErrorType<void | DmError>;
@@ -157,25 +157,25 @@ declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>,
157
157
  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>, 'initialData'>;
158
158
  request?: SecondParameter<typeof customInstance>;
159
159
  }): DefinedUseQueryResult<TData, TError> & {
160
- queryKey: QueryKey;
160
+ queryKey: DataTag<QueryKey, TData, TError>;
161
161
  };
162
162
  declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
163
163
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>, 'initialData'>;
164
164
  request?: SecondParameter<typeof customInstance>;
165
165
  }): UseQueryResult<TData, TError> & {
166
- queryKey: QueryKey;
166
+ queryKey: DataTag<QueryKey, TData, TError>;
167
167
  };
168
168
  declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
169
169
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
170
170
  request?: SecondParameter<typeof customInstance>;
171
171
  }): UseQueryResult<TData, TError> & {
172
- queryKey: QueryKey;
172
+ queryKey: DataTag<QueryKey, TData, TError>;
173
173
  };
174
174
  declare const getGetVersionsSuspenseQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
175
175
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
176
176
  request?: SecondParameter<typeof customInstance>;
177
177
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & {
178
- queryKey: QueryKey;
178
+ queryKey: DataTag<QueryKey, TData, TError>;
179
179
  };
180
180
  type GetVersionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
181
181
  type GetVersionsSuspenseQueryError = ErrorType<void | DmError>;
@@ -183,19 +183,19 @@ declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVer
183
183
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
184
184
  request?: SecondParameter<typeof customInstance>;
185
185
  }): UseSuspenseQueryResult<TData, TError> & {
186
- queryKey: QueryKey;
186
+ queryKey: DataTag<QueryKey, TData, TError>;
187
187
  };
188
188
  declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
189
189
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
190
190
  request?: SecondParameter<typeof customInstance>;
191
191
  }): UseSuspenseQueryResult<TData, TError> & {
192
- queryKey: QueryKey;
192
+ queryKey: DataTag<QueryKey, TData, TError>;
193
193
  };
194
194
  declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
195
195
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
196
196
  request?: SecondParameter<typeof customInstance>;
197
197
  }): UseSuspenseQueryResult<TData, TError> & {
198
- queryKey: QueryKey;
198
+ queryKey: DataTag<QueryKey, TData, TError>;
199
199
  };
200
200
  /**
201
201
  * 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.
@@ -207,14 +207,14 @@ You cannot delete a Dataset until its upload is complete.
207
207
  * @summary Delete a Dataset
208
208
  */
209
209
  declare const deleteDataset: (datasetId: string, datasetVersion: number, params?: DeleteDatasetParams, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
210
- declare const getDeleteDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
211
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
210
+ declare const getDeleteDatasetMutationOptions: <TData = TaskIdentity, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
211
+ mutation?: UseMutationOptions<TData, TError, {
212
212
  datasetId: string;
213
213
  datasetVersion: number;
214
214
  params?: DeleteDatasetParams;
215
215
  }, TContext>;
216
216
  request?: SecondParameter<typeof customInstance>;
217
- }) => UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
217
+ }) => UseMutationOptions<TData, TError, {
218
218
  datasetId: string;
219
219
  datasetVersion: number;
220
220
  params?: DeleteDatasetParams;
@@ -224,14 +224,14 @@ type DeleteDatasetMutationError = ErrorType<void | DmError>;
224
224
  /**
225
225
  * @summary Delete a Dataset
226
226
  */
227
- declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
228
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
227
+ declare const useDeleteDataset: <TData = TaskIdentity, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
228
+ mutation?: UseMutationOptions<TData, TError, {
229
229
  datasetId: string;
230
230
  datasetVersion: number;
231
231
  params?: DeleteDatasetParams;
232
232
  }, TContext>;
233
233
  request?: SecondParameter<typeof customInstance>;
234
- }) => UseMutationResult<Awaited<ReturnType<typeof deleteDataset>>, TError, {
234
+ }) => UseMutationResult<TData, TError, {
235
235
  datasetId: string;
236
236
  datasetVersion: number;
237
237
  params?: DeleteDatasetParams;
@@ -249,7 +249,7 @@ declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<
249
249
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
250
250
  request?: SecondParameter<typeof customInstance>;
251
251
  }) => UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & {
252
- queryKey: QueryKey;
252
+ queryKey: DataTag<QueryKey, TData, TError>;
253
253
  };
254
254
  type DownloadDatasetQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
255
255
  type DownloadDatasetQueryError = ErrorType<void | DmError>;
@@ -257,25 +257,25 @@ declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDa
257
257
  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>, 'initialData'>;
258
258
  request?: SecondParameter<typeof customInstance>;
259
259
  }): DefinedUseQueryResult<TData, TError> & {
260
- queryKey: QueryKey;
260
+ queryKey: DataTag<QueryKey, TData, TError>;
261
261
  };
262
262
  declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
263
263
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>, 'initialData'>;
264
264
  request?: SecondParameter<typeof customInstance>;
265
265
  }): UseQueryResult<TData, TError> & {
266
- queryKey: QueryKey;
266
+ queryKey: DataTag<QueryKey, TData, TError>;
267
267
  };
268
268
  declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
269
269
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
270
270
  request?: SecondParameter<typeof customInstance>;
271
271
  }): UseQueryResult<TData, TError> & {
272
- queryKey: QueryKey;
272
+ queryKey: DataTag<QueryKey, TData, TError>;
273
273
  };
274
274
  declare const getDownloadDatasetSuspenseQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
275
275
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
276
276
  request?: SecondParameter<typeof customInstance>;
277
277
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & {
278
- queryKey: QueryKey;
278
+ queryKey: DataTag<QueryKey, TData, TError>;
279
279
  };
280
280
  type DownloadDatasetSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
281
281
  type DownloadDatasetSuspenseQueryError = ErrorType<void | DmError>;
@@ -283,19 +283,19 @@ declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof do
283
283
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
284
284
  request?: SecondParameter<typeof customInstance>;
285
285
  }): UseSuspenseQueryResult<TData, TError> & {
286
- queryKey: QueryKey;
286
+ queryKey: DataTag<QueryKey, TData, TError>;
287
287
  };
288
288
  declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
289
289
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
290
290
  request?: SecondParameter<typeof customInstance>;
291
291
  }): UseSuspenseQueryResult<TData, TError> & {
292
- queryKey: QueryKey;
292
+ queryKey: DataTag<QueryKey, TData, TError>;
293
293
  };
294
294
  declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
295
295
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
296
296
  request?: SecondParameter<typeof customInstance>;
297
297
  }): UseSuspenseQueryResult<TData, TError> & {
298
- queryKey: QueryKey;
298
+ queryKey: DataTag<QueryKey, TData, TError>;
299
299
  };
300
300
  /**
301
301
  * 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.
@@ -307,13 +307,13 @@ You cannot modify Dataset editors until its upload is complete.
307
307
  * @summary Remove a user's edit permission for a Dataset
308
308
  */
309
309
  declare const removeEditorFromDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
310
- declare const getRemoveEditorFromDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
311
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
310
+ declare const getRemoveEditorFromDatasetMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
311
+ mutation?: UseMutationOptions<TData, TError, {
312
312
  datasetId: string;
313
313
  userId: string;
314
314
  }, TContext>;
315
315
  request?: SecondParameter<typeof customInstance>;
316
- }) => UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
316
+ }) => UseMutationOptions<TData, TError, {
317
317
  datasetId: string;
318
318
  userId: string;
319
319
  }, TContext>;
@@ -322,13 +322,13 @@ type RemoveEditorFromDatasetMutationError = ErrorType<DmError | void>;
322
322
  /**
323
323
  * @summary Remove a user's edit permission for a Dataset
324
324
  */
325
- declare const useRemoveEditorFromDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
326
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
325
+ declare const useRemoveEditorFromDataset: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
326
+ mutation?: UseMutationOptions<TData, TError, {
327
327
  datasetId: string;
328
328
  userId: string;
329
329
  }, TContext>;
330
330
  request?: SecondParameter<typeof customInstance>;
331
- }) => UseMutationResult<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
331
+ }) => UseMutationResult<TData, TError, {
332
332
  datasetId: string;
333
333
  userId: string;
334
334
  }, TContext>;
@@ -342,13 +342,13 @@ You cannot modify Dataset editors until its upload is complete.
342
342
  * @summary Give a user edit permission for a Dataset
343
343
  */
344
344
  declare const addEditorToDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
345
- declare const getAddEditorToDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
346
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
345
+ declare const getAddEditorToDatasetMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
346
+ mutation?: UseMutationOptions<TData, TError, {
347
347
  datasetId: string;
348
348
  userId: string;
349
349
  }, TContext>;
350
350
  request?: SecondParameter<typeof customInstance>;
351
- }) => UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
351
+ }) => UseMutationOptions<TData, TError, {
352
352
  datasetId: string;
353
353
  userId: string;
354
354
  }, TContext>;
@@ -357,13 +357,13 @@ type AddEditorToDatasetMutationError = ErrorType<void | DmError>;
357
357
  /**
358
358
  * @summary Give a user edit permission for a Dataset
359
359
  */
360
- declare const useAddEditorToDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
361
- mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
360
+ declare const useAddEditorToDataset: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
361
+ mutation?: UseMutationOptions<TData, TError, {
362
362
  datasetId: string;
363
363
  userId: string;
364
364
  }, TContext>;
365
365
  request?: SecondParameter<typeof customInstance>;
366
- }) => UseMutationResult<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
366
+ }) => UseMutationResult<TData, TError, {
367
367
  datasetId: string;
368
368
  userId: string;
369
369
  }, TContext>;
@@ -378,7 +378,7 @@ declare const getGetSchemaQueryOptions: <TData = DatasetSchemaGetResponse, TErro
378
378
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
379
379
  request?: SecondParameter<typeof customInstance>;
380
380
  }) => UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & {
381
- queryKey: QueryKey;
381
+ queryKey: DataTag<QueryKey, TData, TError>;
382
382
  };
383
383
  type GetSchemaQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
384
384
  type GetSchemaQueryError = ErrorType<void | DmError>;
@@ -386,25 +386,25 @@ declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TEr
386
386
  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>, 'initialData'>;
387
387
  request?: SecondParameter<typeof customInstance>;
388
388
  }): DefinedUseQueryResult<TData, TError> & {
389
- queryKey: QueryKey;
389
+ queryKey: DataTag<QueryKey, TData, TError>;
390
390
  };
391
391
  declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
392
392
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>, 'initialData'>;
393
393
  request?: SecondParameter<typeof customInstance>;
394
394
  }): UseQueryResult<TData, TError> & {
395
- queryKey: QueryKey;
395
+ queryKey: DataTag<QueryKey, TData, TError>;
396
396
  };
397
397
  declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
398
398
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
399
399
  request?: SecondParameter<typeof customInstance>;
400
400
  }): UseQueryResult<TData, TError> & {
401
- queryKey: QueryKey;
401
+ queryKey: DataTag<QueryKey, TData, TError>;
402
402
  };
403
403
  declare const getGetSchemaSuspenseQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
404
404
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
405
405
  request?: SecondParameter<typeof customInstance>;
406
406
  }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & {
407
- queryKey: QueryKey;
407
+ queryKey: DataTag<QueryKey, TData, TError>;
408
408
  };
409
409
  type GetSchemaSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
410
410
  type GetSchemaSuspenseQueryError = ErrorType<void | DmError>;
@@ -412,19 +412,19 @@ declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchem
412
412
  query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
413
413
  request?: SecondParameter<typeof customInstance>;
414
414
  }): UseSuspenseQueryResult<TData, TError> & {
415
- queryKey: QueryKey;
415
+ queryKey: DataTag<QueryKey, TData, TError>;
416
416
  };
417
417
  declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
418
418
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
419
419
  request?: SecondParameter<typeof customInstance>;
420
420
  }): UseSuspenseQueryResult<TData, TError> & {
421
- queryKey: QueryKey;
421
+ queryKey: DataTag<QueryKey, TData, TError>;
422
422
  };
423
423
  declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
424
424
  query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
425
425
  request?: SecondParameter<typeof customInstance>;
426
426
  }): UseSuspenseQueryResult<TData, TError> & {
427
- queryKey: QueryKey;
427
+ queryKey: DataTag<QueryKey, TData, TError>;
428
428
  };
429
429
 
430
430
  export { type AddEditorToDatasetMutationError, type AddEditorToDatasetMutationResult, type CreateDatasetFromFileMutationBody, type CreateDatasetFromFileMutationError, type CreateDatasetFromFileMutationResult, type DeleteDatasetMutationError, type DeleteDatasetMutationResult, type DownloadDatasetQueryError, type DownloadDatasetQueryResult, type DownloadDatasetSuspenseQueryError, type DownloadDatasetSuspenseQueryResult, type GetDatasetsQueryError, type GetDatasetsQueryResult, type GetDatasetsSuspenseQueryError, type GetDatasetsSuspenseQueryResult, type GetSchemaQueryError, type GetSchemaQueryResult, type GetSchemaSuspenseQueryError, type GetSchemaSuspenseQueryResult, type GetVersionsQueryError, type GetVersionsQueryResult, type GetVersionsSuspenseQueryError, type GetVersionsSuspenseQueryResult, type RemoveEditorFromDatasetMutationError, type RemoveEditorFromDatasetMutationResult, type UploadDatasetMutationBody, type UploadDatasetMutationError, type UploadDatasetMutationResult, addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetMutationOptions, getCreateDatasetFromFileMutationOptions, getDatasets, getDeleteDatasetMutationOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getDownloadDatasetSuspenseQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetDatasetsSuspenseQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetSchemaSuspenseQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getGetVersionsSuspenseQueryOptions, getRemoveEditorFromDatasetMutationOptions, getSchema, getUploadDatasetMutationOptions, getVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useDownloadDatasetSuspense, useGetDatasets, useGetDatasetsSuspense, useGetSchema, useGetSchemaSuspense, useGetVersions, useGetVersionsSuspense, useRemoveEditorFromDataset, useUploadDataset };
@@ -37,7 +37,8 @@ var createDatasetFromFile = (datasetPutBodyBody, options) => {
37
37
  );
38
38
  };
39
39
  var getCreateDatasetFromFileMutationOptions = (options) => {
40
- const { mutation: mutationOptions, request: requestOptions } = options ?? {};
40
+ const mutationKey = ["createDatasetFromFile"];
41
+ const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: void 0 };
41
42
  const mutationFn = (props) => {
42
43
  const { data } = props ?? {};
43
44
  return createDatasetFromFile(data, requestOptions);
@@ -48,7 +49,7 @@ var useCreateDatasetFromFile = (options) => {
48
49
  const mutationOptions = getCreateDatasetFromFileMutationOptions(options);
49
50
  return useMutation(mutationOptions);
50
51
  };
51
- var uploadDataset = (datasetPostBodyBody, options) => {
52
+ var uploadDataset = (datasetPostBodyBody, options, signal) => {
52
53
  const formData = new FormData();
53
54
  formData.append("dataset_file", datasetPostBodyBody.dataset_file);
54
55
  formData.append("dataset_type", datasetPostBodyBody.dataset_type);
@@ -70,13 +71,15 @@ var uploadDataset = (datasetPostBodyBody, options) => {
70
71
  url: `/dataset`,
71
72
  method: "POST",
72
73
  headers: { "Content-Type": "multipart/form-data" },
73
- data: formData
74
+ data: formData,
75
+ signal
74
76
  },
75
77
  options
76
78
  );
77
79
  };
78
80
  var getUploadDatasetMutationOptions = (options) => {
79
- const { mutation: mutationOptions, request: requestOptions } = options ?? {};
81
+ const mutationKey = ["uploadDataset"];
82
+ const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: void 0 };
80
83
  const mutationFn = (props) => {
81
84
  const { data } = props ?? {};
82
85
  return uploadDataset(data, requestOptions);
@@ -155,7 +158,7 @@ var getGetVersionsSuspenseQueryOptions = (datasetId, params, options) => {
155
158
  const { query: queryOptions, request: requestOptions } = options ?? {};
156
159
  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetVersionsQueryKey(datasetId, params);
157
160
  const queryFn = ({ signal }) => getVersions(datasetId, params, requestOptions, signal);
158
- return { queryKey, queryFn, enabled: !!datasetId, ...queryOptions };
161
+ return { queryKey, queryFn, ...queryOptions };
159
162
  };
160
163
  function useGetVersionsSuspense(datasetId, params, options) {
161
164
  const queryOptions = getGetVersionsSuspenseQueryOptions(datasetId, params, options);
@@ -174,7 +177,8 @@ var deleteDataset = (datasetId, datasetVersion, params, options) => {
174
177
  );
175
178
  };
176
179
  var getDeleteDatasetMutationOptions = (options) => {
177
- const { mutation: mutationOptions, request: requestOptions } = options ?? {};
180
+ const mutationKey = ["deleteDataset"];
181
+ const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: void 0 };
178
182
  const mutationFn = (props) => {
179
183
  const { datasetId, datasetVersion, params } = props ?? {};
180
184
  return deleteDataset(datasetId, datasetVersion, params, requestOptions);
@@ -214,7 +218,7 @@ var getDownloadDatasetSuspenseQueryOptions = (datasetId, datasetVersion, options
214
218
  const { query: queryOptions, request: requestOptions } = options ?? {};
215
219
  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getDownloadDatasetQueryKey(datasetId, datasetVersion);
216
220
  const queryFn = ({ signal }) => downloadDataset(datasetId, datasetVersion, requestOptions, signal);
217
- return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions };
221
+ return { queryKey, queryFn, ...queryOptions };
218
222
  };
219
223
  function useDownloadDatasetSuspense(datasetId, datasetVersion, options) {
220
224
  const queryOptions = getDownloadDatasetSuspenseQueryOptions(datasetId, datasetVersion, options);
@@ -232,7 +236,8 @@ var removeEditorFromDataset = (datasetId, userId, options) => {
232
236
  );
233
237
  };
234
238
  var getRemoveEditorFromDatasetMutationOptions = (options) => {
235
- const { mutation: mutationOptions, request: requestOptions } = options ?? {};
239
+ const mutationKey = ["removeEditorFromDataset"];
240
+ const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: void 0 };
236
241
  const mutationFn = (props) => {
237
242
  const { datasetId, userId } = props ?? {};
238
243
  return removeEditorFromDataset(datasetId, userId, requestOptions);
@@ -253,7 +258,8 @@ var addEditorToDataset = (datasetId, userId, options) => {
253
258
  );
254
259
  };
255
260
  var getAddEditorToDatasetMutationOptions = (options) => {
256
- const { mutation: mutationOptions, request: requestOptions } = options ?? {};
261
+ const mutationKey = ["addEditorToDataset"];
262
+ const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: void 0 };
257
263
  const mutationFn = (props) => {
258
264
  const { datasetId, userId } = props ?? {};
259
265
  return addEditorToDataset(datasetId, userId, requestOptions);
@@ -293,7 +299,7 @@ var getGetSchemaSuspenseQueryOptions = (datasetId, datasetVersion, options) => {
293
299
  const { query: queryOptions, request: requestOptions } = options ?? {};
294
300
  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetSchemaQueryKey(datasetId, datasetVersion);
295
301
  const queryFn = ({ signal }) => getSchema(datasetId, datasetVersion, requestOptions, signal);
296
- return { queryKey, queryFn, enabled: !!(datasetId && datasetVersion), ...queryOptions };
302
+ return { queryKey, queryFn, ...queryOptions };
297
303
  };
298
304
  function useGetSchemaSuspense(datasetId, datasetVersion, options) {
299
305
  const queryOptions = getGetSchemaSuspenseQueryOptions(datasetId, datasetVersion, options);