@squonk/data-manager-client 1.2.3 → 1.2.4-rc.2

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 +31 -13
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +77 -0
  4. package/accounting/accounting.d.ts +10 -1
  5. package/accounting/accounting.js +29 -11
  6. package/accounting/accounting.js.map +1 -1
  7. package/admin/admin.cjs +67 -27
  8. package/admin/admin.cjs.map +1 -1
  9. package/admin/admin.d.cts +324 -0
  10. package/admin/admin.d.ts +55 -22
  11. package/admin/admin.js +57 -17
  12. package/admin/admin.js.map +1 -1
  13. package/application/application.cjs +23 -13
  14. package/application/application.cjs.map +1 -1
  15. package/application/application.d.cts +57 -0
  16. package/application/application.d.ts +7 -1
  17. package/application/application.js +22 -12
  18. package/application/application.js.map +1 -1
  19. package/{chunk-UZTHSGDT.cjs → chunk-J22A7LHX.cjs} +1 -1
  20. package/chunk-J22A7LHX.cjs.map +1 -0
  21. package/{chunk-3RNIDX7T.js → chunk-UKA7G3OB.js} +1 -1
  22. package/{chunk-3RNIDX7T.js.map → chunk-UKA7G3OB.js.map} +1 -1
  23. package/configuration/configuration.cjs +13 -7
  24. package/configuration/configuration.cjs.map +1 -1
  25. package/configuration/configuration.d.cts +29 -0
  26. package/configuration/configuration.d.ts +4 -1
  27. package/configuration/configuration.js +13 -7
  28. package/configuration/configuration.js.map +1 -1
  29. package/{custom-instance-50c9dd5d.d.ts → custom-instance-3d66fe97.d.ts} +826 -826
  30. package/dataset/dataset.cjs +71 -72
  31. package/dataset/dataset.cjs.map +1 -1
  32. package/dataset/dataset.d.cts +315 -0
  33. package/dataset/dataset.d.ts +46 -16
  34. package/dataset/dataset.js +62 -63
  35. package/dataset/dataset.js.map +1 -1
  36. package/exchange-rate/exchange-rate.cjs +43 -32
  37. package/exchange-rate/exchange-rate.cjs.map +1 -1
  38. package/exchange-rate/exchange-rate.d.cts +180 -0
  39. package/exchange-rate/exchange-rate.d.ts +25 -7
  40. package/exchange-rate/exchange-rate.js +38 -27
  41. package/exchange-rate/exchange-rate.js.map +1 -1
  42. package/file/file.cjs +38 -22
  43. package/file/file.cjs.map +1 -1
  44. package/file/file.d.cts +154 -0
  45. package/file/file.d.ts +25 -10
  46. package/file/file.js +34 -18
  47. package/file/file.js.map +1 -1
  48. package/index.cjs +10 -10
  49. package/index.cjs.map +1 -1
  50. package/index.d.cts +2 -0
  51. package/index.d.ts +1 -1
  52. package/index.js +9 -9
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +47 -37
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +215 -0
  57. package/instance/instance.d.ts +33 -12
  58. package/instance/instance.js +41 -31
  59. package/instance/instance.js.map +1 -1
  60. package/job/job.cjs +36 -19
  61. package/job/job.cjs.map +1 -1
  62. package/job/job.d.cts +85 -0
  63. package/job/job.d.ts +10 -1
  64. package/job/job.js +34 -17
  65. package/job/job.js.map +1 -1
  66. package/metadata/metadata.cjs +23 -26
  67. package/metadata/metadata.cjs.map +1 -1
  68. package/metadata/metadata.d.cts +132 -0
  69. package/metadata/metadata.d.ts +19 -7
  70. package/metadata/metadata.js +20 -23
  71. package/metadata/metadata.js.map +1 -1
  72. package/package.json +12 -12
  73. package/project/project.cjs +70 -48
  74. package/project/project.cjs.map +1 -1
  75. package/project/project.d.cts +377 -0
  76. package/project/project.d.ts +61 -25
  77. package/project/project.js +59 -37
  78. package/project/project.js.map +1 -1
  79. package/src/accounting/accounting.ts +179 -194
  80. package/src/admin/admin.ts +590 -735
  81. package/src/application/application.ts +125 -141
  82. package/src/configuration/configuration.ts +72 -60
  83. package/src/data-manager-api.schemas.ts +941 -942
  84. package/src/dataset/dataset.ts +591 -770
  85. package/src/exchange-rate/exchange-rate.ts +362 -478
  86. package/src/file/file.ts +292 -357
  87. package/src/instance/instance.ts +427 -533
  88. package/src/job/job.ts +187 -198
  89. package/src/metadata/metadata.ts +247 -339
  90. package/src/project/project.ts +669 -860
  91. package/src/task/task.ts +181 -202
  92. package/src/type/type.ts +72 -68
  93. package/src/user/user.ts +248 -286
  94. package/task/task.cjs +31 -15
  95. package/task/task.cjs.map +1 -1
  96. package/task/task.d.cts +103 -0
  97. package/task/task.d.ts +10 -1
  98. package/task/task.js +29 -13
  99. package/task/task.js.map +1 -1
  100. package/type/type.cjs +13 -7
  101. package/type/type.cjs.map +1 -1
  102. package/type/type.d.cts +31 -0
  103. package/type/type.d.ts +4 -1
  104. package/type/type.js +13 -7
  105. package/type/type.js.map +1 -1
  106. package/user/user.cjs +39 -28
  107. package/user/user.cjs.map +1 -1
  108. package/user/user.d.cts +104 -0
  109. package/user/user.d.ts +16 -4
  110. package/user/user.js +36 -25
  111. package/user/user.js.map +1 -1
  112. package/chunk-UZTHSGDT.cjs.map +0 -1
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v6.15.0 🍺
2
+ * Generated by orval v6.20.0 🍺
3
3
  * Do not edit manually.
4
4
  * Dataset Manager API
5
5
  * The Dataset Manager API service.
@@ -8,29 +8,33 @@ A service that allows *registered* users to make **Datasets** and associated **M
8
8
 
9
9
  * OpenAPI spec version: 1.2
10
10
  */
11
- import { useQuery } from "@tanstack/react-query";
11
+ import {
12
+ useQuery
13
+ } from '@tanstack/react-query'
12
14
  import type {
13
- UseQueryOptions,
14
15
  QueryFunction,
15
- UseQueryResult,
16
16
  QueryKey,
17
- } from "@tanstack/react-query";
17
+ UseQueryOptions,
18
+ UseQueryResult
19
+ } from '@tanstack/react-query'
18
20
  import type {
19
- ApplicationsGetResponse,
20
- DmError,
21
21
  ApplicationGetResponse,
22
- } from "../data-manager-api.schemas";
23
- import { customInstance } from ".././custom-instance";
24
- import type { ErrorType } from ".././custom-instance";
22
+ ApplicationsGetResponse,
23
+ DmError
24
+ } from '../data-manager-api.schemas'
25
+ import { customInstance } from '.././custom-instance';
26
+ import type { ErrorType } from '.././custom-instance';
27
+
25
28
 
26
29
  // eslint-disable-next-line
27
- type SecondParameter<T extends (...args: any) => any> = T extends (
30
+ type SecondParameter<T extends (...args: any) => any> = T extends (
28
31
  config: any,
29
- args: infer P
32
+ args: infer P,
30
33
  ) => any
31
34
  ? P
32
35
  : never;
33
36
 
37
+
34
38
  /**
35
39
  * Get a list of all Applications available to you that can be instantiated via the `/instance` endpoint.
36
40
 
@@ -39,69 +43,63 @@ Application availability will vary as applications are added to the service.
39
43
  * @summary Get all Applications available to you
40
44
  */
41
45
  export const getApplications = (
42
- options?: SecondParameter<typeof customInstance>,
43
- signal?: AbortSignal
46
+
47
+ options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
44
48
  ) => {
45
- return customInstance<ApplicationsGetResponse>(
46
- { url: `/application`, method: "get", signal },
47
- options
48
- );
49
- };
50
-
51
- export const getGetApplicationsQueryKey = () => ["data-manager-api", `/application`] as const;
52
-
53
- export const getGetApplicationsQueryOptions = <
54
- TData = Awaited<ReturnType<typeof getApplications>>,
55
- TError = ErrorType<DmError>
56
- >(options?: {
57
- query?: UseQueryOptions<
58
- Awaited<ReturnType<typeof getApplications>>,
59
- TError,
60
- TData
61
- >;
62
- request?: SecondParameter<typeof customInstance>;
63
- }): UseQueryOptions<
64
- Awaited<ReturnType<typeof getApplications>>,
65
- TError,
66
- TData
67
- > & { queryKey: QueryKey } => {
68
- const { query: queryOptions, request: requestOptions } = options ?? {};
69
-
70
- const queryKey = queryOptions?.queryKey ?? getGetApplicationsQueryKey();
71
-
72
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({
73
- signal,
74
- }) => getApplications(requestOptions, signal);
75
-
76
- return { queryKey, queryFn, ...queryOptions };
77
- };
78
-
79
- export type GetApplicationsQueryResult = NonNullable<
80
- Awaited<ReturnType<typeof getApplications>>
81
- >;
82
- export type GetApplicationsQueryError = ErrorType<DmError>;
83
-
84
- export const useGetApplications = <
85
- TData = Awaited<ReturnType<typeof getApplications>>,
86
- TError = ErrorType<DmError>
87
- >(options?: {
88
- query?: UseQueryOptions<
89
- Awaited<ReturnType<typeof getApplications>>,
90
- TError,
91
- TData
92
- >;
93
- request?: SecondParameter<typeof customInstance>;
94
- }): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
95
- const queryOptions = getGetApplicationsQueryOptions(options);
96
-
97
- const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {
98
- queryKey: QueryKey;
99
- };
100
-
101
- query.queryKey = queryOptions.queryKey;
49
+
50
+
51
+ return customInstance<ApplicationsGetResponse>(
52
+ {url: `/application`, method: 'get', signal
53
+ },
54
+ options);
55
+ }
56
+
57
+
58
+ export const getGetApplicationsQueryKey = () => {
59
+
60
+ return ["data-manager-api", `/application`] as const;
61
+ }
62
+
63
+
64
+ export const getGetApplicationsQueryOptions = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
65
+ ) => {
66
+
67
+ const {query: queryOptions, request: requestOptions} = options ?? {};
68
+
69
+ const queryKey = queryOptions?.queryKey ?? getGetApplicationsQueryKey();
70
+
71
+
72
+
73
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({ signal }) => getApplications(requestOptions, signal);
74
+
75
+
76
+
77
+
78
+
79
+ return { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData> & { queryKey: QueryKey }
80
+ }
81
+
82
+ export type GetApplicationsQueryResult = NonNullable<Awaited<ReturnType<typeof getApplications>>>
83
+ export type GetApplicationsQueryError = ErrorType<DmError>
84
+
85
+ /**
86
+ * @summary Get all Applications available to you
87
+ */
88
+ export const useGetApplications = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
89
+ options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
90
+
91
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
92
+
93
+ const queryOptions = getGetApplicationsQueryOptions(options)
94
+
95
+ const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
96
+
97
+ query.queryKey = queryOptions.queryKey ;
102
98
 
103
99
  return query;
104
- };
100
+ }
101
+
102
+
105
103
 
106
104
  /**
107
105
  * Get details of a specific Application available to you that can be instantiated.
@@ -109,75 +107,61 @@ export const useGetApplications = <
109
107
  * @summary Get details of a specific Application
110
108
  */
111
109
  export const getApplication = (
112
- applicationId: string,
113
- options?: SecondParameter<typeof customInstance>,
114
- signal?: AbortSignal
110
+ applicationId: string,
111
+ options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
112
+ ) => {
113
+
114
+
115
+ return customInstance<ApplicationGetResponse>(
116
+ {url: `/application/${applicationId}`, method: 'get', signal
117
+ },
118
+ options);
119
+ }
120
+
121
+
122
+ export const getGetApplicationQueryKey = (applicationId: string,) => {
123
+
124
+ return ["data-manager-api", `/application/${applicationId}`] as const;
125
+ }
126
+
127
+
128
+ export const getGetApplicationQueryOptions = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(applicationId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
115
129
  ) => {
116
- return customInstance<ApplicationGetResponse>(
117
- { url: `/application/${applicationId}`, method: "get", signal },
118
- options
119
- );
120
- };
121
-
122
- export const getGetApplicationQueryKey = (applicationId: string) =>
123
- ["data-manager-api", `/application/${applicationId}`] as const;
124
-
125
- export const getGetApplicationQueryOptions = <
126
- TData = Awaited<ReturnType<typeof getApplication>>,
127
- TError = ErrorType<void | DmError>
128
- >(
129
- applicationId: string,
130
- options?: {
131
- query?: UseQueryOptions<
132
- Awaited<ReturnType<typeof getApplication>>,
133
- TError,
134
- TData
135
- >;
136
- request?: SecondParameter<typeof customInstance>;
137
- }
138
- ): UseQueryOptions<
139
- Awaited<ReturnType<typeof getApplication>>,
140
- TError,
141
- TData
142
- > & { queryKey: QueryKey } => {
143
- const { query: queryOptions, request: requestOptions } = options ?? {};
144
-
145
- const queryKey =
146
- queryOptions?.queryKey ?? getGetApplicationQueryKey(applicationId);
147
-
148
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({
149
- signal,
150
- }) => getApplication(applicationId, requestOptions, signal);
151
-
152
- return { queryKey, queryFn, enabled: !!applicationId, ...queryOptions };
153
- };
154
-
155
- export type GetApplicationQueryResult = NonNullable<
156
- Awaited<ReturnType<typeof getApplication>>
157
- >;
158
- export type GetApplicationQueryError = ErrorType<void | DmError>;
159
-
160
- export const useGetApplication = <
161
- TData = Awaited<ReturnType<typeof getApplication>>,
162
- TError = ErrorType<void | DmError>
163
- >(
164
- applicationId: string,
165
- options?: {
166
- query?: UseQueryOptions<
167
- Awaited<ReturnType<typeof getApplication>>,
168
- TError,
169
- TData
170
- >;
171
- request?: SecondParameter<typeof customInstance>;
172
- }
173
- ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
174
- const queryOptions = getGetApplicationQueryOptions(applicationId, options);
175
-
176
- const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {
177
- queryKey: QueryKey;
178
- };
179
-
180
- query.queryKey = queryOptions.queryKey;
130
+
131
+ const {query: queryOptions, request: requestOptions} = options ?? {};
132
+
133
+ const queryKey = queryOptions?.queryKey ?? getGetApplicationQueryKey(applicationId);
134
+
135
+
136
+
137
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({ signal }) => getApplication(applicationId, requestOptions, signal);
138
+
139
+
140
+
141
+
142
+
143
+ return { queryKey, queryFn, enabled: !!(applicationId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData> & { queryKey: QueryKey }
144
+ }
145
+
146
+ export type GetApplicationQueryResult = NonNullable<Awaited<ReturnType<typeof getApplication>>>
147
+ export type GetApplicationQueryError = ErrorType<void | DmError>
148
+
149
+ /**
150
+ * @summary Get details of a specific Application
151
+ */
152
+ export const useGetApplication = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
153
+ applicationId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
154
+
155
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
156
+
157
+ const queryOptions = getGetApplicationQueryOptions(applicationId,options)
158
+
159
+ const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
160
+
161
+ query.queryKey = queryOptions.queryKey ;
181
162
 
182
163
  return query;
183
- };
164
+ }
165
+
166
+
167
+
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v6.15.0 🍺
2
+ * Generated by orval v6.20.0 🍺
3
3
  * Do not edit manually.
4
4
  * Dataset Manager API
5
5
  * The Dataset Manager API service.
@@ -8,79 +8,91 @@ A service that allows *registered* users to make **Datasets** and associated **M
8
8
 
9
9
  * OpenAPI spec version: 1.2
10
10
  */
11
- import { useQuery } from "@tanstack/react-query";
11
+ import {
12
+ useQuery
13
+ } from '@tanstack/react-query'
12
14
  import type {
13
- UseQueryOptions,
14
15
  QueryFunction,
15
- UseQueryResult,
16
16
  QueryKey,
17
- } from "@tanstack/react-query";
18
- import type { ModeGetResponse, DmError } from "../data-manager-api.schemas";
19
- import { customInstance } from ".././custom-instance";
20
- import type { ErrorType } from ".././custom-instance";
17
+ UseQueryOptions,
18
+ UseQueryResult
19
+ } from '@tanstack/react-query'
20
+ import type {
21
+ DmError,
22
+ ModeGetResponse
23
+ } from '../data-manager-api.schemas'
24
+ import { customInstance } from '.././custom-instance';
25
+ import type { ErrorType } from '.././custom-instance';
26
+
21
27
 
22
28
  // eslint-disable-next-line
23
- type SecondParameter<T extends (...args: any) => any> = T extends (
29
+ type SecondParameter<T extends (...args: any) => any> = T extends (
24
30
  config: any,
25
- args: infer P
31
+ args: infer P,
26
32
  ) => any
27
33
  ? P
28
34
  : never;
29
35
 
36
+
30
37
  /**
31
38
  * @summary Gets the Data Manager mode that's running behind the API
32
39
  */
33
40
  export const getMode = (
34
- options?: SecondParameter<typeof customInstance>,
35
- signal?: AbortSignal
41
+
42
+ options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
43
+ ) => {
44
+
45
+
46
+ return customInstance<ModeGetResponse>(
47
+ {url: `/mode`, method: 'get', signal
48
+ },
49
+ options);
50
+ }
51
+
52
+
53
+ export const getGetModeQueryKey = () => {
54
+
55
+ return ["data-manager-api", `/mode`] as const;
56
+ }
57
+
58
+
59
+ export const getGetModeQueryOptions = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
36
60
  ) => {
37
- return customInstance<ModeGetResponse>(
38
- { url: `/mode`, method: "get", signal },
39
- options
40
- );
41
- };
42
-
43
- export const getGetModeQueryKey = () => ["data-manager-api", `/mode`] as const;
44
-
45
- export const getGetModeQueryOptions = <
46
- TData = Awaited<ReturnType<typeof getMode>>,
47
- TError = ErrorType<void | DmError>
48
- >(options?: {
49
- query?: UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>;
50
- request?: SecondParameter<typeof customInstance>;
51
- }): UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData> & {
52
- queryKey: QueryKey;
53
- } => {
54
- const { query: queryOptions, request: requestOptions } = options ?? {};
55
-
56
- const queryKey = queryOptions?.queryKey ?? getGetModeQueryKey();
57
-
58
- const queryFn: QueryFunction<Awaited<ReturnType<typeof getMode>>> = ({
59
- signal,
60
- }) => getMode(requestOptions, signal);
61
-
62
- return { queryKey, queryFn, ...queryOptions };
63
- };
64
-
65
- export type GetModeQueryResult = NonNullable<
66
- Awaited<ReturnType<typeof getMode>>
67
- >;
68
- export type GetModeQueryError = ErrorType<void | DmError>;
69
-
70
- export const useGetMode = <
71
- TData = Awaited<ReturnType<typeof getMode>>,
72
- TError = ErrorType<void | DmError>
73
- >(options?: {
74
- query?: UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>;
75
- request?: SecondParameter<typeof customInstance>;
76
- }): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
77
- const queryOptions = getGetModeQueryOptions(options);
78
-
79
- const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {
80
- queryKey: QueryKey;
81
- };
82
-
83
- query.queryKey = queryOptions.queryKey;
61
+
62
+ const {query: queryOptions, request: requestOptions} = options ?? {};
63
+
64
+ const queryKey = queryOptions?.queryKey ?? getGetModeQueryKey();
65
+
66
+
67
+
68
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getMode>>> = ({ signal }) => getMode(requestOptions, signal);
69
+
70
+
71
+
72
+
73
+
74
+ return { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData> & { queryKey: QueryKey }
75
+ }
76
+
77
+ export type GetModeQueryResult = NonNullable<Awaited<ReturnType<typeof getMode>>>
78
+ export type GetModeQueryError = ErrorType<void | DmError>
79
+
80
+ /**
81
+ * @summary Gets the Data Manager mode that's running behind the API
82
+ */
83
+ export const useGetMode = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
84
+ options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
85
+
86
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
87
+
88
+ const queryOptions = getGetModeQueryOptions(options)
89
+
90
+ const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
91
+
92
+ query.queryKey = queryOptions.queryKey ;
84
93
 
85
94
  return query;
86
- };
95
+ }
96
+
97
+
98
+