@equinor/fusion-framework-react-app 5.3.0 → 5.4.0

package/dist/esm/settings/index.js

@@ -0,0 +1,3 @@
+export { useAppSetting } from './useAppSetting';
+export { useAppSettings } from './useAppSettings';
+//# sourceMappingURL=index.js.map

package/dist/esm/settings/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/settings/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/esm/settings/useAppSetting.js

@@ -0,0 +1,77 @@
+import { useCallback, useLayoutEffect, useMemo, useState } from 'react';
+import { BehaviorSubject, map } from 'rxjs';
+import { useCurrentApp } from '@equinor/fusion-framework-react/app';
+import { useAppSettingsStatus } from './useAppSettingsStatus';
+import { useObservableState } from '@equinor/fusion-observable/react';
+/**
+ * Custom hook to manage application settings.
+ *
+ * @template TSettings - The type of the settings object. Defaults to `AppSettings`.
+ * @template TProp - The type of the property key in the settings object. Defaults to `keyof TSettings`.
+ *
+ * @param {TProp} prop - The property key in the settings object to manage.
+ * @param {TSettings[TProp]} [defaultValue] - The default value for the setting.
+ * @param hooks - Optional hooks to handle the status changes and errors.
+ *
+ * @returns {Array} An array containing:
+ * - `setting`: The current setting value or undefined.
+ * - `setSetting`: A function to update the setting.
+ *
+ * @example
+ * const { setting, setSetting } = useAppSetting('theme');
+ *
+ * @example
+ * // with default value
+ * const { setting, setSetting } = useAppSetting('theme', 'dark');
+ *
+ * @example
+ * // with hooks
+ * const [isLoading, setIsLoading] = useState(false);
+ * const [isUpdating, setIsUpdating] = useState(false);
+ * const [error, setError] = useState<Error | null>(null);
+ *
+ * const { setting, setSetting } = useAppSetting('theme', 'dark', {
+ *    onLoading: setIsLoading,
+ *    onUpdating: setIsUpdating,
+ *    onError: setError,
+ *    onUpdated: useCallback(() => console.log('Settings updated'), [])
+ * });
+ */
+export const useAppSetting = (prop, defaultValue, hooks) => {
+    const [{ onError, onUpdated, onLoading, onUpdating }] = useState(() => hooks !== null && hooks !== void 0 ? hooks : {});
+    const { currentApp = null } = useCurrentApp();
+    // create a subject to manage the setting value
+    const subject = useMemo(() => {
+        return new BehaviorSubject(defaultValue);
+        // Only create a new subject when the current app changes
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [currentApp]);
+    useLayoutEffect(() => {
+        const sub = currentApp === null || currentApp === void 0 ? void 0 : currentApp.settings$.pipe(map((settings) => settings[prop])).subscribe(subject);
+        return () => sub === null || sub === void 0 ? void 0 : sub.unsubscribe();
+    }, [currentApp, subject, prop]);
+    // subscribe to the setting value
+    const { value: setting } = useObservableState(subject);
+    // update function
+    const setSetting = useCallback((update) => {
+        if (!currentApp) {
+            return onError === null || onError === void 0 ? void 0 : onError(new Error('App is not available'));
+        }
+        // resolve setting value with the provided value or function
+        const value = typeof update === 'function'
+            ? update(subject.value)
+            : update;
+        currentApp.updateSetting(prop, value).subscribe({
+            error: onError,
+            complete: onUpdated,
+        });
+    }, [currentApp, subject, prop, onError, onUpdated]);
+    // status hooks
+    useAppSettingsStatus(currentApp, {
+        onLoading,
+        onUpdating,
+    });
+    return [setting, setSetting];
+};
+export default useAppSetting;
+//# sourceMappingURL=useAppSetting.js.map

package/dist/esm/settings/useAppSetting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAppSetting.js","sourceRoot":"","sources":["../../../src/settings/useAppSetting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,OAAO,EAAE,oBAAoB,EAA+B,MAAM,wBAAwB,CAAC;AAG3F,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAItE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAIzB,IAAW,EACX,YAA+B,EAC/B,KAGC,EAIH,EAAE;IACA,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC;IAEpF,MAAM,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;IAE9C,+CAA+C;IAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE;QACzB,OAAO,IAAI,eAAe,CAA+B,YAAY,CAAC,CAAC;QACvE,yDAAyD;QACzD,uDAAuD;IAC3D,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB,eAAe,CAAC,GAAG,EAAE;QACjB,MAAM,GAAG,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,SAAS,CAC5B,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAE,QAAsB,CAAC,IAAI,CAAC,CAAC,EACrD,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,OAAO,GAAG,EAAE,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,EAAE,CAAC;IACpC,CAAC,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhC,iCAAiC;IACjC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAEvD,kBAAkB;IAClB,MAAM,UAAU,GAAG,WAAW,CAC1B,CAAC,MAAkE,EAAE,EAAE;QACnE,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,4DAA4D;QAC5D,MAAM,KAAK,GACP,OAAO,MAAM,KAAK,UAAU;YACxB,CAAC,CAAE,MAAkD,CAAC,OAAO,CAAC,KAAK,CAAC;YACpE,CAAC,CAAC,MAAM,CAAC;QAEjB,UAAU,CAAC,aAAa,CAAmB,IAAI,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC;YAC9D,KAAK,EAAE,OAAO;YACd,QAAQ,EAAE,SAAS;SACtB,CAAC,CAAC;IACP,CAAC,EACD,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAClD,CAAC;IAEF,eAAe;IACf,oBAAoB,CAAC,UAAU,EAAE;QAC7B,SAAS;QACT,UAAU;KACb,CAAC,CAAC;IAEH,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/esm/settings/useAppSettings.js

@@ -0,0 +1,75 @@
+import { useCallback, useLayoutEffect, useMemo } from 'react';
+import { BehaviorSubject } from 'rxjs';
+import { useCurrentApp } from '@equinor/fusion-framework-react/app';
+import { useObservableState } from '@equinor/fusion-observable/react';
+import { useAppSettingsStatus } from './useAppSettingsStatus';
+/**
+ * Custom hook to manage application settings.
+ *
+ * @template TSettings - The type of the settings object, extending Record<string, any>. Defaults to AppSettings.
+ *
+ * @param {TSettings} [defaultValue] - The default value for the settings.
+ * @param hooks - Optional hooks to handle the status changes and errors.
+ *
+ * @note
+ * `defaultValue` will only be used on the first render.
+ * `hooks`must be memoized to avoid unnecessary re-renders.
+ *
+ * @returns {Array} An array containing:
+ * - `settings`: The current settings object.
+ * - `setSettings`: A function to update the settings.
+ *
+ * @example
+ * const [settings, setSettings] = useAppSettings();
+ *
+ * @example
+ * const [settings, setSettings] = useAppSettings({ theme: 'dark' });
+ *
+ * @example
+ * const [isLoading, setIsLoading] = useState(false);
+ * const [isUpdating, setIsUpdating] = useState(false);
+ * const [error, setError] = useState<Error | null>(null);
+ *
+ * const onUpdated = useCallback(() => console.log('Settings updated'), []);
+ *
+ * const [settings, setSettings] = useAppSettings({ theme: 'dark' }, {
+ *  onLoading: setIsLoading,
+ *  onUpdating: setIsUpdating,
+ *  onError: setError,
+ *  onUpdated,
+ * });
+ */
+export const useAppSettings = (defaultValue, hooks) => {
+    const { onError, onUpdated, onLoading, onUpdating } = hooks !== null && hooks !== void 0 ? hooks : {};
+    const { currentApp = null } = useCurrentApp();
+    const subject = useMemo(() => {
+        return new BehaviorSubject(defaultValue !== null && defaultValue !== void 0 ? defaultValue : {});
+        // Only create a new subject when the current app changes
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [currentApp]);
+    // connect the subject to the current app settings stream
+    useLayoutEffect(() => {
+        const sub = (currentApp === null || currentApp === void 0 ? void 0 : currentApp.settings$).subscribe(subject);
+        return () => sub === null || sub === void 0 ? void 0 : sub.unsubscribe();
+    }, [currentApp, subject]);
+    // subscribe to the subject to get the latest settings
+    const { value: settings } = useObservableState(subject, { initial: defaultValue });
+    const setSettings = useCallback((update) => {
+        if (!currentApp) {
+            return onError === null || onError === void 0 ? void 0 : onError(new Error('App is not available'));
+        }
+        // resolve settings with the provided value or function
+        const settings = typeof update === 'function' ? update(subject.value) : update;
+        currentApp.updateSettings(settings).subscribe({
+            next: () => {
+                onUpdated === null || onUpdated === void 0 ? void 0 : onUpdated();
+                onError === null || onError === void 0 ? void 0 : onError(null);
+            },
+            error: onError,
+        });
+    }, [currentApp, subject, onError, onUpdated]);
+    useAppSettingsStatus(currentApp, { onLoading, onUpdating });
+    return [settings, setSettings];
+};
+export default useAppSettings;
+//# sourceMappingURL=useAppSettings.js.map

package/dist/esm/settings/useAppSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAppSettings.js","sourceRoot":"","sources":["../../../src/settings/useAppSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAc,MAAM,MAAM,CAAC;AAInD,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,EAAE,oBAAoB,EAA+B,MAAM,wBAAwB,CAAC;AAI3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC1B,YAAwB,EACxB,KAGC,EAC6E,EAAE;IAChF,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC;IAClE,MAAM,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;IAE9C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE;QACzB,OAAO,IAAI,eAAe,CAAY,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAK,EAAgB,CAAC,CAAC;QACzE,yDAAyD;QACzD,uDAAuD;IAC3D,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB,yDAAyD;IACzD,eAAe,CAAC,GAAG,EAAE;QACjB,MAAM,GAAG,GAAG,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,SAAmC,CAAA,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAChF,OAAO,GAAG,EAAE,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,EAAE,CAAC;IACpC,CAAC,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAE1B,sDAAsD;IACtD,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,kBAAkB,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IAEnF,MAAM,WAAW,GAAG,WAAW,CAC3B,CAAC,MAAqD,EAAE,EAAE;QACtD,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,uDAAuD;QACvD,MAAM,QAAQ,GAAG,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAE/E,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC;YAC1C,IAAI,EAAE,GAAG,EAAE;gBACP,SAAS,aAAT,SAAS,uBAAT,SAAS,EAAI,CAAC;gBACd,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,IAAI,CAAC,CAAC;YACpB,CAAC;YACD,KAAK,EAAE,OAAO;SACjB,CAAC,CAAC;IACP,CAAC,EACD,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,CAC5C,CAAC;IAEF,oBAAoB,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAE5D,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/esm/settings/useAppSettingsStatus.js

@@ -0,0 +1,39 @@
+import { useLayoutEffect } from 'react';
+import { map } from 'rxjs';
+/**
+ * Custom hook to handle app settings status updates.
+ *
+ * @param {IApp | null} app - The app instance to monitor settings status.
+ * @param {AppSettingsStatusHooks} [hooks] - Optional hooks to handle loading and updating status.
+ * @param {function} [hooks.onLoading] - Callback function to handle loading status.
+ * @param {function} [hooks.onUpdating] - Callback function to handle updating status.
+ *
+ * @returns {void}
+ *
+ * @example
+ * const hooks = useMemo(() => ({
+ *   onLoading: (isLoading) => console.log('Loading:', isLoading),
+ *   onUpdating: (isUpdating) => console.log('Updating:', isUpdating),
+ * }, []);
+ * useAppSettingsStatus(app, hooks);
+ */
+export const useAppSettingsStatus = (app, hooks) => {
+    const { onLoading, onUpdating } = hooks !== null && hooks !== void 0 ? hooks : {};
+    useLayoutEffect(() => {
+        if (app && onLoading) {
+            const subscription = app.status$
+                .pipe(map((status) => status.has('fetch_settings')))
+                .subscribe(onLoading);
+            return () => subscription.unsubscribe();
+        }
+    }, [app, onLoading]);
+    useLayoutEffect(() => {
+        if (app && onUpdating) {
+            const subscription = app.status$
+                .pipe(map((status) => status.has('update_settings')))
+                .subscribe(onUpdating);
+            return () => subscription.unsubscribe();
+        }
+    }, [app, onUpdating]);
+};
+//# sourceMappingURL=useAppSettingsStatus.js.map

package/dist/esm/settings/useAppSettingsStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAppSettingsStatus.js","sourceRoot":"","sources":["../../../src/settings/useAppSettingsStatus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAS3B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,GAAgB,EAAE,KAA8B,EAAE,EAAE;IACrF,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC;IAE9C,eAAe,CAAC,GAAG,EAAE;QACjB,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;YACnB,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO;iBAC3B,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;iBACnD,SAAS,CAAC,SAAS,CAAC,CAAC;YAC1B,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QAC5C,CAAC;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;IAErB,eAAe,CAAC,GAAG,EAAE;QACjB,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;YACpB,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO;iBAC3B,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;iBACpD,SAAS,CAAC,UAAU,CAAC,CAAC;YAC3B,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QAC5C,CAAC;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC;AAC1B,CAAC,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '5.3.0';
+export const version = '5.4.0';
 //# sourceMappingURL=version.js.map