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

package/dev-portal/lib/api/roma/api/setting-controller/setting-controller.d.ts

@@ -11,7 +11,7 @@ import type { BodyType, ErrorType } from '../../use-client';
 type AwaitedInput<T> = PromiseLike<T> | T;
 type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
 /**
- * @summary Get an application default Settings
+ * @summary Get a Setting by userId/settingKey
  */
 export declare const useGetSettingByUserAndSettingKeyHook: () => (userId: string, settingKey: string, signal?: AbortSignal) => Promise<SettingDto>;
 export declare const getGetSettingByUserAndSettingKeyQueryKey: (userId: string, settingKey: string) => readonly [`/api/settings/user/${string}/setting/${string}`];
@@ -23,7 +23,7 @@ export declare const useGetSettingByUserAndSettingKeyQueryOptions: <TData = Sett
 export type GetSettingByUserAndSettingKeyQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingByUserAndSettingKeyHook>>>>;
 export type GetSettingByUserAndSettingKeyQueryError = ErrorType<void>;
 /**
- * @summary Get an application default Settings
+ * @summary Get a Setting by userId/settingKey
  */
 export declare const useGetSettingByUserAndSettingKey: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, settingKey: string, options?: {
     query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
@@ -31,7 +31,7 @@ export declare const useGetSettingByUserAndSettingKey: <TData = SettingDto, TErr
     queryKey: QueryKey;
 };
 /**
- * @summary Create or update an application default Settings
+ * @summary Create or update a Setting by userId/settingKey
  */
 export declare const useCreateOrUpdateSettingByUserAndSettingKeyHook: () => (userId: string, settingKey: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
 export declare const useCreateOrUpdateSettingByUserAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
@@ -49,7 +49,7 @@ export type CreateOrUpdateSettingByUserAndSettingKeyMutationResult = NonNullable
 export type CreateOrUpdateSettingByUserAndSettingKeyMutationBody = BodyType<SettingDto>;
 export type CreateOrUpdateSettingByUserAndSettingKeyMutationError = ErrorType<void>;
 /**
- * @summary Create or update an application default Settings
+ * @summary Create or update a Setting by userId/settingKey
  */
 export declare const useCreateOrUpdateSettingByUserAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<SettingDto, TError, {
@@ -63,7 +63,7 @@ export declare const useCreateOrUpdateSettingByUserAndSettingKey: <TError = impo
     data: BodyType<SettingDto>;
 }, TContext>;
 /**
- * @summary Delete an application default Settings
+ * @summary Delete a Setting by userId/settingKey
  */
 export declare const useDeleteSettingByUserAndSettingKeyHook: () => (userId: string, settingKey: string) => Promise<SettingDto>;
 export declare const useDeleteSettingByUserAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
@@ -78,7 +78,7 @@ export declare const useDeleteSettingByUserAndSettingKeyMutationOptions: <TError
 export type DeleteSettingByUserAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeleteSettingByUserAndSettingKeyHook>>>>;
 export type DeleteSettingByUserAndSettingKeyMutationError = ErrorType<void>;
 /**
- * @summary Delete an application default Settings
+ * @summary Delete a Setting by userId/settingKey
  */
 export declare const useDeleteSettingByUserAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<SettingDto, TError, {
@@ -89,6 +89,9 @@ export declare const useDeleteSettingByUserAndSettingKey: <TError = import("../.
     userId: string;
     settingKey: string;
 }, TContext>;
+/**
+ * @summary Get Setting by appShortName/settingKey/userId
+ */
 export declare const useGetSettingByUserAndAppShortNameAndSetttingKeyHook: () => (userId: string, appShortName: string, settingKey: string, signal?: AbortSignal) => Promise<SettingDto>;
 export declare const getGetSettingByUserAndAppShortNameAndSetttingKeyQueryKey: (userId: string, appShortName: string, settingKey: string) => readonly [`/api/settings/user/${string}/application/${string}/setting/${string}`];
 export declare const useGetSettingByUserAndAppShortNameAndSetttingKeyQueryOptions: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, appShortName: string, settingKey: string, options?: {
@@ -98,13 +101,16 @@ export declare const useGetSettingByUserAndAppShortNameAndSetttingKeyQueryOption
 };
 export type GetSettingByUserAndAppShortNameAndSetttingKeyQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingByUserAndAppShortNameAndSetttingKeyHook>>>>;
 export type GetSettingByUserAndAppShortNameAndSetttingKeyQueryError = ErrorType<void>;
+/**
+ * @summary Get Setting by appShortName/settingKey/userId
+ */
 export declare const useGetSettingByUserAndAppShortNameAndSetttingKey: <TData = SettingDto, TError = import("../../use-client").HttpError>(userId: string, appShortName: string, settingKey: string, options?: {
     query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
- * @summary Create or update a users ApplicationSettings for given app
+ * @summary Create or update a Setting by appShortName/settingKey/userId
  */
 export declare const useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyHook: () => (userId: string, appShortName: string, settingKey: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
 export declare const useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
@@ -124,7 +130,7 @@ export type CreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationResul
 export type CreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationBody = BodyType<SettingDto>;
 export type CreateOrUpdateSettingByUserAndAppShortNameAndSettingKeyMutationError = ErrorType<void>;
 /**
- * @summary Create or update a users ApplicationSettings for given app
+ * @summary Create or update a Setting by appShortName/settingKey/userId
  */
 export declare const useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<SettingDto, TError, {
@@ -140,7 +146,7 @@ export declare const useCreateOrUpdateSettingByUserAndAppShortNameAndSettingKey:
     data: BodyType<SettingDto>;
 }, TContext>;
 /**
- * @summary Delete an ApplicationSetting for given app
+ * @summary Delete a Setting by appShortName/settingKey/userId
  */
 export declare const useDeleteSettingByUserAndAppShortNameAndSettingKeyHook: () => (userId: string, appShortName: string, settingKey: string) => Promise<SettingDto>;
 export declare const useDeleteSettingByUserAndAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
@@ -157,7 +163,7 @@ export declare const useDeleteSettingByUserAndAppShortNameAndSettingKeyMutationO
 export type DeleteSettingByUserAndAppShortNameAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeleteSettingByUserAndAppShortNameAndSettingKeyHook>>>>;
 export type DeleteSettingByUserAndAppShortNameAndSettingKeyMutationError = ErrorType<void>;
 /**
- * @summary Delete an ApplicationSetting for given app
+ * @summary Delete a Setting by appShortName/settingKey/userId
  */
 export declare const useDeleteSettingByUserAndAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<SettingDto, TError, {
@@ -171,7 +177,86 @@ export declare const useDeleteSettingByUserAndAppShortNameAndSettingKey: <TError
     settingKey: string;
 }, TContext>;
 /**
- * @summary Get Setting
+ * @summary Get Setting by appShortName/settingKey
+ */
+export declare const useGetByAppShortNameAndSettingKeyHook: () => (appShortName: string, settingKey: string, signal?: AbortSignal) => Promise<SettingDto>;
+export declare const getGetByAppShortNameAndSettingKeyQueryKey: (appShortName: string, settingKey: string) => readonly [`/api/settings/application/${string}/setting/${string}`];
+export declare const useGetByAppShortNameAndSettingKeyQueryOptions: <TData = SettingDto, TError = import("../../use-client").HttpError>(appShortName: string, settingKey: string, options?: {
+    query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
+} | undefined) => UseQueryOptions<SettingDto, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+export type GetByAppShortNameAndSettingKeyQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetByAppShortNameAndSettingKeyHook>>>>;
+export type GetByAppShortNameAndSettingKeyQueryError = ErrorType<void>;
+/**
+ * @summary Get Setting by appShortName/settingKey
+ */
+export declare const useGetByAppShortNameAndSettingKey: <TData = SettingDto, TError = import("../../use-client").HttpError>(appShortName: string, settingKey: string, options?: {
+    query?: Partial<UseQueryOptions<SettingDto, TError, TData, QueryKey>> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * @summary Create or update a Setting by appShortName/settingKey
+ */
+export declare const useCreateOrUpdateAppShortNameAndSettingKeyHook: () => (appShortName: string, settingKey: string, settingDto: BodyType<SettingDto>) => Promise<SettingDto>;
+export declare const useCreateOrUpdateAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<SettingDto, TError, {
+        appShortName: string;
+        settingKey: string;
+        data: BodyType<SettingDto>;
+    }, TContext> | undefined;
+} | undefined) => UseMutationOptions<SettingDto, TError, {
+    appShortName: string;
+    settingKey: string;
+    data: BodyType<SettingDto>;
+}, TContext>;
+export type CreateOrUpdateAppShortNameAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useCreateOrUpdateAppShortNameAndSettingKeyHook>>>>;
+export type CreateOrUpdateAppShortNameAndSettingKeyMutationBody = BodyType<SettingDto>;
+export type CreateOrUpdateAppShortNameAndSettingKeyMutationError = ErrorType<void>;
+/**
+ * @summary Create or update a Setting by appShortName/settingKey
+ */
+export declare const useCreateOrUpdateAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<SettingDto, TError, {
+        appShortName: string;
+        settingKey: string;
+        data: BodyType<SettingDto>;
+    }, TContext> | undefined;
+} | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
+    appShortName: string;
+    settingKey: string;
+    data: BodyType<SettingDto>;
+}, TContext>;
+/**
+ * @summary Delete a Setting by appShortName/settingKey
+ */
+export declare const useDeleteAppShortNameAndSettingKeyHook: () => (appShortName: string, settingKey: string) => Promise<SettingDto>;
+export declare const useDeleteAppShortNameAndSettingKeyMutationOptions: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<SettingDto, TError, {
+        appShortName: string;
+        settingKey: string;
+    }, TContext> | undefined;
+} | undefined) => UseMutationOptions<SettingDto, TError, {
+    appShortName: string;
+    settingKey: string;
+}, TContext>;
+export type DeleteAppShortNameAndSettingKeyMutationResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useDeleteAppShortNameAndSettingKeyHook>>>>;
+export type DeleteAppShortNameAndSettingKeyMutationError = ErrorType<void>;
+/**
+ * @summary Delete a Setting by appShortName/settingKey
+ */
+export declare const useDeleteAppShortNameAndSettingKey: <TError = import("../../use-client").HttpError, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<SettingDto, TError, {
+        appShortName: string;
+        settingKey: string;
+    }, TContext> | undefined;
+} | undefined) => import("@tanstack/react-query/build/legacy/types").UseMutationResult<SettingDto, TError, {
+    appShortName: string;
+    settingKey: string;
+}, TContext>;
+/**
+ * @summary Get list of Settings by appShortName/userId
  */
 export declare const useGetSettingByUserAndAppShortNameHook: () => (userId: string, appShortName: string, signal?: AbortSignal) => Promise<SettingDto[]>;
 export declare const getGetSettingByUserAndAppShortNameQueryKey: (userId: string, appShortName: string) => readonly [`/api/settings/user/${string}/application/${string}`];
@@ -183,11 +268,31 @@ export declare const useGetSettingByUserAndAppShortNameQueryOptions: <TData = Se
 export type GetSettingByUserAndAppShortNameQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingByUserAndAppShortNameHook>>>>;
 export type GetSettingByUserAndAppShortNameQueryError = ErrorType<void>;
 /**
- * @summary Get Setting
+ * @summary Get list of Settings by appShortName/userId
  */
 export declare const useGetSettingByUserAndAppShortName: <TData = SettingDto[], TError = import("../../use-client").HttpError>(userId: string, appShortName: string, options?: {
     query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
+/**
+ * @summary Get list of Settings by appShortName
+ */
+export declare const useGetSettingsAppShortNameHook: () => (appShortName: string, signal?: AbortSignal) => Promise<SettingDto[]>;
+export declare const getGetSettingsAppShortNameQueryKey: (appShortName: string) => readonly [`/api/settings/application/${string}`];
+export declare const useGetSettingsAppShortNameQueryOptions: <TData = SettingDto[], TError = import("../../use-client").HttpError>(appShortName: string, options?: {
+    query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
+} | undefined) => UseQueryOptions<SettingDto[], TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+export type GetSettingsAppShortNameQueryResult = NonNullable<Awaited<ReturnType<ReturnType<typeof useGetSettingsAppShortNameHook>>>>;
+export type GetSettingsAppShortNameQueryError = ErrorType<void>;
+/**
+ * @summary Get list of Settings by appShortName
+ */
+export declare const useGetSettingsAppShortName: <TData = SettingDto[], TError = import("../../use-client").HttpError>(appShortName: string, options?: {
+    query?: Partial<UseQueryOptions<SettingDto[], TError, TData, QueryKey>> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
 export {};

package/dev-portal/lib/api/roma/model/settingDtoValue.d.ts

@@ -6,7 +6,5 @@
  * OpenAPI spec version: v1.0.0
  */
 export type SettingDtoValue = {
-    [key: string]: {
-        [key: string]: any;
-    };
+    [key: string]: any;
 };

package/dev-portal/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/roma-framework",
-  "version": "0.0.7-BETA.1",
+  "version": "0.0.7-BETA.2",
   "repository": "https://github.com/equinor/tops-roma",
   "types": "./index.d.ts",
   "private": false,