@equinor/roma-framework 0.0.7-BETA.2 → 0.0.7-BETA.4

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 (8) hide show
  1. package/dev-portal/index.html +2 -0
  2. package/dev-portal/lib/api/roma/api/setting-controller/setting-controller.d.ts +117 -148
  3. package/dev-portal/lib/api/roma/model/settingDto.d.ts +3 -0
  4. package/dev-portal/package.json +1 -1
  5. package/lib/api/roma/api/setting-controller/setting-controller.d.ts +117 -148
  6. package/lib/api/roma/model/settingDto.d.ts +3 -0
  7. package/package.json +1 -1
  8. package/roma-framework.mjs +166 -236
package/dev-portal/index.html CHANGED
@@ -5,6 +5,8 @@
5
5
  <title>Workbench</title>
6
6
  <base href='/'/>
7
7
  <script>
8
+ // To make wysiwyg editor work
9
+ window.global = window;
8
10
  // Hack to avoid duplicate registration of custom elements
9
11
  const _customElementsDefine = window.customElements.define;
10
12
  window.customElements.define = (name, cl, conf) => {
package/dev-portal/lib/api/roma/api/setting-controller/setting-controller.d.ts CHANGED
@@ -11,288 +11,257 @@ import type { BodyType, ErrorType } from '../../use-client';
11
11
  type AwaitedInput<T> = PromiseLike<T> | T;
12
12
  type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
13
13
  /**
14
- * @summary Get a Setting by userId/settingKey
14
+ * @summary Get a users private Setting by id
15
15
  */
16
- export declare const useGetSettingByUserAndSettingKeyHook: () => (userId: string, settingKey: string, signal?: AbortSignal) => Promise<SettingDto>;
17
- export declare const getGetSettingByUserAndSettingKeyQueryKey: (userId: string, settingKey: string) => readonly [`/api/settings/user/${string}/setting/${string}`];
18
- export declare const useGetSettingByUserAndSettingKeyQueryOptions: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, settingKey: string, options?: {
16
+ export declare const useGetSettingByUserAndIdHook: () => (userId: string, id: string, signal?: AbortSignal) => Promise<SettingDto>;
17
+ export declare const getGetSettingByUserAndIdQueryKey: (userId: string, id: string) => readonly [`/api/settings/user/${string}/id/${string}`];
18
+ export declare const useGetSettingByUserAndIdQueryOptions: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, id: string, options?: {
19
19
  query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
20
20
  } | undefined) => UseQueryOptions<SettingDto, TError, TData, QueryKey> & {
21
21
  queryKey: QueryKey;
22
22
  };
23
- export type GetSettingByUserAndSettingKeyQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingByUserAndSettingKeyHook>>>>;
24
- export type GetSettingByUserAndSettingKeyQueryError = ErrorType<void>;
23
+ export type GetSettingByUserAndIdQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingByUserAndIdHook>>>>;
24
+ export type GetSettingByUserAndIdQueryError = ErrorType<void>;
25
25
  /**
26
- * @summary Get a Setting by userId/settingKey
26
+ * @summary Get a users private Setting by id
27
27
  */
28
- export declare const useGetSettingByUserAndSettingKey: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, settingKey: string, options?: {
28
+ export declare const useGetSettingByUserAndId: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, id: string, options?: {
29
29
  query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
30
30
  } | undefined) => UseQueryResult<TData, TError> & {
31
31
  queryKey: QueryKey;
32
32
  };
33
33
  /**
34
- * @summary Create or update a Setting by userId/settingKey
34
+ * @summary Update a private Setting by id
35
35
  */
36
- export declare const useCreateOrUpdateSettingByUserAndSettingKeyHook: () => (userId: string, settingKey: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
37
- export declare const useCreateOrUpdateSettingByUserAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
36
+ export declare const useUpdateByUserIdAndIdHook: () => (userId: string, id: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
37
+ export declare const useUpdateByUserIdAndIdMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
38
38
  mutation?: UseMutationOptions<SettingDto, TError, {
39
39
  userId: string;
40
- settingKey: string;
40
+ id: string;
41
41
  data: BodyType<SettingDto>;
42
42
  }, TContext> | undefined;
43
43
  } | undefined) => UseMutationOptions<SettingDto, TError, {
44
44
  userId: string;
45
- settingKey: string;
45
+ id: string;
46
46
  data: BodyType<SettingDto>;
47
47
  }, TContext>;
48
- export type CreateOrUpdateSettingByUserAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useCreateOrUpdateSettingByUserAndSettingKeyHook>>>>;
49
- export type CreateOrUpdateSettingByUserAndSettingKeyMutationBody = BodyType<SettingDto>;
50
- export type CreateOrUpdateSettingByUserAndSettingKeyMutationError = ErrorType<void>;
48
+ export type UpdateByUserIdAndIdMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useUpdateByUserIdAndIdHook>>>>;
49
+ export type UpdateByUserIdAndIdMutationBody = BodyType<SettingDto>;
50
+ export type UpdateByUserIdAndIdMutationError = ErrorType<void>;
51
51
  /**
52
- * @summary Create or update a Setting by userId/settingKey
52
+ * @summary Update a private Setting by id
53
53
  */
54
- export declare const useCreateOrUpdateSettingByUserAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
54
+ export declare const useUpdateByUserIdAndId: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
55
55
  mutation?: UseMutationOptions<SettingDto, TError, {
56
56
  userId: string;
57
- settingKey: string;
57
+ id: string;
58
58
  data: BodyType<SettingDto>;
59
59
  }, TContext> | undefined;
60
60
  } | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
61
61
  userId: string;
62
- settingKey: string;
62
+ id: string;
63
63
  data: BodyType<SettingDto>;
64
64
  }, TContext>;
65
65
  /**
66
- * @summary Delete a Setting by userId/settingKey
66
+ * @summary Delete a private Setting by id
67
67
  */
68
- export declare const useDeleteSettingByUserAndSettingKeyHook: () => (userId: string, settingKey: string) => Promise<SettingDto>;
69
- export declare const useDeleteSettingByUserAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
68
+ export declare const useDeletePrivateSettingByIdHook: () => (userId: string, id: string) => Promise<SettingDto>;
69
+ export declare const useDeletePrivateSettingByIdMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
70
70
  mutation?: UseMutationOptions<SettingDto, TError, {
71
71
  userId: string;
72
- settingKey: string;
72
+ id: string;
73
73
  }, TContext> | undefined;
74
74
  } | undefined) => UseMutationOptions<SettingDto, TError, {
75
75
  userId: string;
76
- settingKey: string;
76
+ id: string;
77
77
  }, TContext>;
78
- export type DeleteSettingByUserAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeleteSettingByUserAndSettingKeyHook>>>>;
79
- export type DeleteSettingByUserAndSettingKeyMutationError = ErrorType<void>;
78
+ export type DeletePrivateSettingByIdMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeletePrivateSettingByIdHook>>>>;
79
+ export type DeletePrivateSettingByIdMutationError = ErrorType<void>;
80
80
  /**
81
- * @summary Delete a Setting by userId/settingKey
81
+ * @summary Delete a private Setting by id
82
82
  */
83
- export declare const useDeleteSettingByUserAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
83
+ export declare const useDeletePrivateSettingById: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
84
84
  mutation?: UseMutationOptions<SettingDto, TError, {
85
85
  userId: string;
86
- settingKey: string;
86
+ id: string;
87
87
  }, TContext> | undefined;
88
88
  } | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
89
89
  userId: string;
90
- settingKey: string;
90
+ id: string;
91
91
  }, TContext>;
92
92
  /**
93
- * @summary Get Setting by appShortName/settingKey/userId
93
+ * @summary Get a users public Setting by id
94
94
  */
95
- export declare const useGetSettingByUserAndAppShortNameAndSetttingKeyHook: () => (userId: string, appShortName: string, settingKey: string, signal?: AbortSignal) => Promise<SettingDto>;
96
- export declare const getGetSettingByUserAndAppShortNameAndSetttingKeyQueryKey: (userId: string, appShortName: string, settingKey: string) => readonly [`/api/settings/user/${string}/application/${string}/setting/${string}`];
97
- export declare const useGetSettingByUserAndAppShortNameAndSetttingKeyQueryOptions: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, appShortName: string, settingKey: string, options?: {
95
+ export declare const useGetPublicSettingByUserAndIdHook: () => (appShortName: string, id: string, signal?: AbortSignal) => Promise<SettingDto>;
96
+ export declare const getGetPublicSettingByUserAndIdQueryKey: (appShortName: string, id: string) => readonly [`/api/settings/application/${string}/id/${string}`];
97
+ export declare const useGetPublicSettingByUserAndIdQueryOptions: <TData = SettingDto, TError = import("../../use-client").HttpError>(appShortName: string, id: string, options?: {
98
98
  query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
99
99
  } | undefined) => UseQueryOptions<SettingDto, TError, TData, QueryKey> & {
100
100
  queryKey: QueryKey;
101
101
  };
102
- export type GetSettingByUserAndAppShortNameAndSetttingKeyQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingByUserAndAppShortNameAndSetttingKeyHook>>>>;
103
- export type GetSettingByUserAndAppShortNameAndSetttingKeyQueryError = ErrorType<void>;
102
+ export type GetPublicSettingByUserAndIdQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetPublicSettingByUserAndIdHook>>>>;
103
+ export type GetPublicSettingByUserAndIdQueryError = ErrorType<void>;
104
104
  /**
105
- * @summary Get Setting by appShortName/settingKey/userId
105
+ * @summary Get a users public Setting by id
106
106
  */
107
- export declare const useGetSettingByUserAndAppShortNameAndSetttingKey: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, appShortName: string, settingKey: string, options?: {
107
+ export declare const useGetPublicSettingByUserAndId: <TData = SettingDto, TError = import("../../use-client").HttpError>(appShortName: string, id: string, options?: {
108
108
  query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
109
109
  } | undefined) => UseQueryResult<TData, TError> & {
110
110
  queryKey: QueryKey;
111
111
  };
112
112
  /**
113
- * @summary Create or update a Setting by appShortName/settingKey/userId
113
+ * @summary Update a public Setting for a given appShortName by id
114
114
  */
115
- export declare const useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyHook: () => (userId: string, appShortName: string, settingKey: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
116
- export declare const useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
115
+ export declare const useUpdatePublicSettingByAppShortNameAndIdHook: () => (appShortName: string, id: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
116
+ export declare const useUpdatePublicSettingByAppShortNameAndIdMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
117
117
  mutation?: UseMutationOptions<SettingDto, TError, {
118
- userId: string;
119
118
  appShortName: string;
120
- settingKey: string;
119
+ id: string;
121
120
  data: BodyType<SettingDto>;
122
121
  }, TContext> | undefined;
123
122
  } | undefined) => UseMutationOptions<SettingDto, TError, {
124
- userId: string;
125
123
  appShortName: string;
126
- settingKey: string;
124
+ id: string;
127
125
  data: BodyType<SettingDto>;
128
126
  }, TContext>;
129
- export type CreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyHook>>>>;
130
- export type CreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationBody = BodyType<SettingDto>;
131
- export type CreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationError = ErrorType<void>;
127
+ export type UpdatePublicSettingByAppShortNameAndIdMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useUpdatePublicSettingByAppShortNameAndIdHook>>>>;
128
+ export type UpdatePublicSettingByAppShortNameAndIdMutationBody = BodyType<SettingDto>;
129
+ export type UpdatePublicSettingByAppShortNameAndIdMutationError = ErrorType<void>;
132
130
  /**
133
- * @summary Create or update a Setting by appShortName/settingKey/userId
131
+ * @summary Update a public Setting for a given appShortName by id
134
132
  */
135
- export declare const useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
133
+ export declare const useUpdatePublicSettingByAppShortNameAndId: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
136
134
  mutation?: UseMutationOptions<SettingDto, TError, {
137
- userId: string;
138
135
  appShortName: string;
139
- settingKey: string;
136
+ id: string;
140
137
  data: BodyType<SettingDto>;
141
138
  }, TContext> | undefined;
142
139
  } | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
143
- userId: string;
144
140
  appShortName: string;
145
- settingKey: string;
141
+ id: string;
146
142
  data: BodyType<SettingDto>;
147
143
  }, TContext>;
148
144
  /**
149
- * @summary Delete a Setting by appShortName/settingKey/userId
145
+ * @summary Delete a public Setting for a appShortName by id
150
146
  */
151
- export declare const useDeleteSettingByUserAndAppShortNameAndSettingKeyHook: () => (userId: string, appShortName: string, settingKey: string) => Promise<SettingDto>;
152
- export declare const useDeleteSettingByUserAndAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
147
+ export declare const useDeletePublicSettingByIdHook: () => (appShortName: string, id: string) => Promise<SettingDto>;
148
+ export declare const useDeletePublicSettingByIdMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
153
149
  mutation?: UseMutationOptions<SettingDto, TError, {
154
- userId: string;
155
150
  appShortName: string;
156
- settingKey: string;
151
+ id: string;
157
152
  }, TContext> | undefined;
158
153
  } | undefined) => UseMutationOptions<SettingDto, TError, {
159
- userId: string;
160
154
  appShortName: string;
161
- settingKey: string;
155
+ id: string;
162
156
  }, TContext>;
163
- export type DeleteSettingByUserAndAppShortNameAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeleteSettingByUserAndAppShortNameAndSettingKeyHook>>>>;
164
- export type DeleteSettingByUserAndAppShortNameAndSettingKeyMutationError = ErrorType<void>;
157
+ export type DeletePublicSettingByIdMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeletePublicSettingByIdHook>>>>;
158
+ export type DeletePublicSettingByIdMutationError = ErrorType<void>;
165
159
  /**
166
- * @summary Delete a Setting by appShortName/settingKey/userId
160
+ * @summary Delete a public Setting for a appShortName by id
167
161
  */
168
- export declare const useDeleteSettingByUserAndAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
162
+ export declare const useDeletePublicSettingById: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
169
163
  mutation?: UseMutationOptions<SettingDto, TError, {
170
- userId: string;
171
164
  appShortName: string;
172
- settingKey: string;
165
+ id: string;
173
166
  }, TContext> | undefined;
174
167
  } | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
175
- userId: string;
176
168
  appShortName: string;
177
- settingKey: string;
169
+ id: string;
178
170
  }, TContext>;
179
171
  /**
180
- * @summary Get Setting by appShortName/settingKey
172
+ * @summary Get all private Settings by userId
181
173
  */
182
- export declare const useGetByAppShortNameAndSettingKeyHook: () => (appShortName: string, settingKey: string, signal?: AbortSignal) => Promise<SettingDto>;
183
- export declare const getGetByAppShortNameAndSettingKeyQueryKey: (appShortName: string, settingKey: string) => readonly [`/api/settings/application/${string}/setting/${string}`];
184
- export declare const useGetByAppShortNameAndSettingKeyQueryOptions: <TData = SettingDto, TError = import("../../use-client").HttpError>(appShortName: string, settingKey: string, options?: {
185
- query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
186
- } | undefined) => UseQueryOptions<SettingDto, TError, TData, QueryKey> & {
174
+ export declare const useGetSettingsByUserIdHook: () => (userId: string, signal?: AbortSignal) => Promise<SettingDto[]>;
175
+ export declare const getGetSettingsByUserIdQueryKey: (userId: string) => readonly [`/api/settings/user/${string}`];
176
+ export declare const useGetSettingsByUserIdQueryOptions: <TData = SettingDto[], TError = import("../../use-client").HttpError>(userId: string, options?: {
177
+ query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
178
+ } | undefined) => UseQueryOptions<SettingDto[], TError, TData, QueryKey> & {
187
179
  queryKey: QueryKey;
188
180
  };
189
- export type GetByAppShortNameAndSettingKeyQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetByAppShortNameAndSettingKeyHook>>>>;
190
- export type GetByAppShortNameAndSettingKeyQueryError = ErrorType<void>;
181
+ export type GetSettingsByUserIdQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingsByUserIdHook>>>>;
182
+ export type GetSettingsByUserIdQueryError = ErrorType<void>;
191
183
  /**
192
- * @summary Get Setting by appShortName/settingKey
184
+ * @summary Get all private Settings by userId
193
185
  */
194
- export declare const useGetByAppShortNameAndSettingKey: <TData = SettingDto, TError = import("../../use-client").HttpError>(appShortName: string, settingKey: string, options?: {
195
- query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
186
+ export declare const useGetSettingsByUserId: <TData = SettingDto[], TError = import("../../use-client").HttpError>(userId: string, options?: {
187
+ query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
196
188
  } | undefined) => UseQueryResult<TData, TError> & {
197
189
  queryKey: QueryKey;
198
190
  };
199
191
  /**
200
- * @summary Create or update a Setting by appShortName/settingKey
192
+ * @summary Create a private Setting for a given user
201
193
  */
202
- export declare const useCreateOrUpdateAppShortNameAndSettingKeyHook: () => (appShortName: string, settingKey: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
203
- export declare const useCreateOrUpdateAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
194
+ export declare const useCreateSettingByUserIdHook: () => (userId: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
195
+ export declare const useCreateSettingByUserIdMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
204
196
  mutation?: UseMutationOptions<SettingDto, TError, {
205
- appShortName: string;
206
- settingKey: string;
197
+ userId: string;
207
198
  data: BodyType<SettingDto>;
208
199
  }, TContext> | undefined;
209
200
  } | undefined) => UseMutationOptions<SettingDto, TError, {
210
- appShortName: string;
211
- settingKey: string;
201
+ userId: string;
212
202
  data: BodyType<SettingDto>;
213
203
  }, TContext>;
214
- export type CreateOrUpdateAppShortNameAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useCreateOrUpdateAppShortNameAndSettingKeyHook>>>>;
215
- export type CreateOrUpdateAppShortNameAndSettingKeyMutationBody = BodyType<SettingDto>;
216
- export type CreateOrUpdateAppShortNameAndSettingKeyMutationError = ErrorType<void>;
204
+ export type CreateSettingByUserIdMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useCreateSettingByUserIdHook>>>>;
205
+ export type CreateSettingByUserIdMutationBody = BodyType<SettingDto>;
206
+ export type CreateSettingByUserIdMutationError = ErrorType<void>;
217
207
  /**
218
- * @summary Create or update a Setting by appShortName/settingKey
208
+ * @summary Create a private Setting for a given user
219
209
  */
220
- export declare const useCreateOrUpdateAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
210
+ export declare const useCreateSettingByUserId: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
221
211
  mutation?: UseMutationOptions<SettingDto, TError, {
222
- appShortName: string;
223
- settingKey: string;
212
+ userId: string;
224
213
  data: BodyType<SettingDto>;
225
214
  }, TContext> | undefined;
226
215
  } | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
227
- appShortName: string;
228
- settingKey: string;
216
+ userId: string;
229
217
  data: BodyType<SettingDto>;
230
218
  }, TContext>;
231
219
  /**
232
- * @summary Delete a Setting by appShortName/settingKey
233
- */
234
- export declare const useDeleteAppShortNameAndSettingKeyHook: () => (appShortName: string, settingKey: string) => Promise<SettingDto>;
235
- export declare const useDeleteAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
236
- mutation?: UseMutationOptions<SettingDto, TError, {
237
- appShortName: string;
238
- settingKey: string;
239
- }, TContext> | undefined;
240
- } | undefined) => UseMutationOptions<SettingDto, TError, {
241
- appShortName: string;
242
- settingKey: string;
243
- }, TContext>;
244
- export type DeleteAppShortNameAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeleteAppShortNameAndSettingKeyHook>>>>;
245
- export type DeleteAppShortNameAndSettingKeyMutationError = ErrorType<void>;
246
- /**
247
- * @summary Delete a Setting by appShortName/settingKey
248
- */
249
- export declare const useDeleteAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
250
- mutation?: UseMutationOptions<SettingDto, TError, {
251
- appShortName: string;
252
- settingKey: string;
253
- }, TContext> | undefined;
254
- } | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
255
- appShortName: string;
256
- settingKey: string;
257
- }, TContext>;
258
- /**
259
- * @summary Get list of Settings by appShortName/userId
220
+ * @summary Get all public or mine Settings by appShortName
260
221
  */
261
- export declare const useGetSettingByUserAndAppShortNameHook: () => (userId: string, appShortName: string, signal?: AbortSignal) => Promise<SettingDto[]>;
262
- export declare const getGetSettingByUserAndAppShortNameQueryKey: (userId: string, appShortName: string) => readonly [`/api/settings/user/${string}/application/${string}`];
263
- export declare const useGetSettingByUserAndAppShortNameQueryOptions: <TData = SettingDto[], TError = import("../../use-client").HttpError>(userId: string, appShortName: string, options?: {
222
+ export declare const useGetSettingsByAppShortNameHook: () => (appShortName: string, signal?: AbortSignal) => Promise<SettingDto[]>;
223
+ export declare const getGetSettingsByAppShortNameQueryKey: (appShortName: string) => readonly [`/api/settings/application/${string}`];
224
+ export declare const useGetSettingsByAppShortNameQueryOptions: <TData = SettingDto[], TError = import("../../use-client").HttpError>(appShortName: string, options?: {
264
225
  query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
265
226
  } | undefined) => UseQueryOptions<SettingDto[], TError, TData, QueryKey> & {
266
227
  queryKey: QueryKey;
267
228
  };
268
- export type GetSettingByUserAndAppShortNameQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingByUserAndAppShortNameHook>>>>;
269
- export type GetSettingByUserAndAppShortNameQueryError = ErrorType<void>;
229
+ export type GetSettingsByAppShortNameQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingsByAppShortNameHook>>>>;
230
+ export type GetSettingsByAppShortNameQueryError = ErrorType<void>;
270
231
  /**
271
- * @summary Get list of Settings by appShortName/userId
232
+ * @summary Get all public or mine Settings by appShortName
272
233
  */
273
- export declare const useGetSettingByUserAndAppShortName: <TData = SettingDto[], TError = import("../../use-client").HttpError>(userId: string, appShortName: string, options?: {
234
+ export declare const useGetSettingsByAppShortName: <TData = SettingDto[], TError = import("../../use-client").HttpError>(appShortName: string, options?: {
274
235
  query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
275
236
  } | undefined) => UseQueryResult<TData, TError> & {
276
237
  queryKey: QueryKey;
277
238
  };
278
239
  /**
279
- * @summary Get list of Settings by appShortName
240
+ * @summary Create a public Setting for a given appShortName
280
241
  */
281
- export declare const useGetSettingsAppShortNameHook: () => (appShortName: string, signal?: AbortSignal) => Promise<SettingDto[]>;
282
- export declare const getGetSettingsAppShortNameQueryKey: (appShortName: string) => readonly [`/api/settings/application/${string}`];
283
- export declare const useGetSettingsAppShortNameQueryOptions: <TData = SettingDto[], TError = import("../../use-client").HttpError>(appShortName: string, options?: {
284
- query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
285
- } | undefined) => UseQueryOptions<SettingDto[], TError, TData, QueryKey> & {
286
- queryKey: QueryKey;
287
- };
288
- export type GetSettingsAppShortNameQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingsAppShortNameHook>>>>;
289
- export type GetSettingsAppShortNameQueryError = ErrorType<void>;
242
+ export declare const useCreatePublicSettingByUserIdHook: () => (appShortName: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
243
+ export declare const useCreatePublicSettingByUserIdMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
244
+ mutation?: UseMutationOptions<SettingDto, TError, {
245
+ appShortName: string;
246
+ data: BodyType<SettingDto>;
247
+ }, TContext> | undefined;
248
+ } | undefined) => UseMutationOptions<SettingDto, TError, {
249
+ appShortName: string;
250
+ data: BodyType<SettingDto>;
251
+ }, TContext>;
252
+ export type CreatePublicSettingByUserIdMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useCreatePublicSettingByUserIdHook>>>>;
253
+ export type CreatePublicSettingByUserIdMutationBody = BodyType<SettingDto>;
254
+ export type CreatePublicSettingByUserIdMutationError = ErrorType<void>;
290
255
  /**
291
- * @summary Get list of Settings by appShortName
256
+ * @summary Create a public Setting for a given appShortName
292
257
  */
293
- export declare const useGetSettingsAppShortName: <TData = SettingDto[], TError = import("../../use-client").HttpError>(appShortName: string, options?: {
294
- query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
295
- } | undefined) => UseQueryResult<TData, TError> & {
296
- queryKey: QueryKey;
297
- };
258
+ export declare const useCreatePublicSettingByUserId: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
259
+ mutation?: UseMutationOptions<SettingDto, TError, {
260
+ appShortName: string;
261
+ data: BodyType<SettingDto>;
262
+ }, TContext> | undefined;
263
+ } | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
264
+ appShortName: string;
265
+ data: BodyType<SettingDto>;
266
+ }, TContext>;
298
267
  export {};
package/dev-portal/lib/api/roma/model/settingDto.d.ts CHANGED
@@ -8,6 +8,9 @@
8
8
  import type { SettingDtoValue } from './settingDtoValue';
9
9
  export interface SettingDto {
10
10
  appShortName?: string;
11
+ id?: string;
12
+ isPublic?: boolean;
11
13
  setting?: string;
14
+ userId?: string;
12
15
  value: SettingDtoValue;
13
16
  }
package/dev-portal/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@equinor/roma-framework",
3
- "version": "0.0.7-BETA.2",
3
+ "version": "0.0.7-BETA.4",
4
4
  "repository": "https://github.com/equinor/tops-roma",
5
5
  "types": "./index.d.ts",
6
6
  "private": false,