@trackunit/react-core-hooks 1.12.69 → 1.14.0

package/index.cjs.js

@@ -230,6 +230,99 @@ const useFilterBarContext = () => {
     return context;
 };
 
+const useStandaloneGeolocation = ({ enabled, requestOnMount, }) => {
+    const [position, setPosition] = react.useState(null);
+    const queryGeolocationPermission = react.useCallback(async () => {
+        if (!enabled || typeof navigator === "undefined") {
+            return null;
+        }
+        try {
+            const status = await navigator.permissions.query({ name: "geolocation" });
+            return status.state;
+        }
+        catch {
+            return null;
+        }
+    }, [enabled]);
+    const getCurrentPosition = react.useCallback(async () => {
+        if (!enabled || typeof navigator === "undefined") {
+            return null;
+        }
+        return await new Promise(resolve => {
+            try {
+                navigator.geolocation.getCurrentPosition(currentPosition => {
+                    resolve([currentPosition.coords.longitude, currentPosition.coords.latitude]);
+                }, () => {
+                    resolve(null);
+                });
+            }
+            catch {
+                resolve(null);
+            }
+        });
+    }, [enabled]);
+    const getPosition = react.useCallback(async (options) => {
+        const prompt = options?.prompt !== false;
+        if (!prompt) {
+            const permissionState = await queryGeolocationPermission();
+            if (permissionState !== "granted") {
+                return null;
+            }
+        }
+        const currentPosition = await getCurrentPosition();
+        if (currentPosition !== null) {
+            setPosition(currentPosition);
+        }
+        return currentPosition;
+    }, [getCurrentPosition, queryGeolocationPermission]);
+    react.useEffect(() => {
+        if (!enabled || requestOnMount !== true) {
+            return;
+        }
+        void queryGeolocationPermission()
+            .then(permissionState => {
+            if (permissionState !== "granted") {
+                return null;
+            }
+            return getCurrentPosition();
+        })
+            .then(currentPosition => {
+            if (currentPosition !== null) {
+                setPosition(currentPosition);
+            }
+        });
+    }, [enabled, getCurrentPosition, queryGeolocationPermission, requestOnMount]);
+    return react.useMemo(() => ({
+        position,
+        getPosition,
+    }), [getPosition, position]);
+};
+/**
+ * Hook providing geolocation capabilities.
+ *
+ * In the host, geolocation is resolved directly via the browser API.
+ * In Iris Apps, requests are proxied to the host via the iframe bridge,
+ * so permission is only requested once at the host level.
+ *
+ * @example
+ * ```ts
+ * const { position, getPosition } = useGeolocation();
+ *
+ * // User-initiated request (e.g. "My Location" button)
+ * onClick: () => {
+ *   void getPosition().then(pos => { if (pos) fitBounds(pos); });
+ * }
+ * ```
+ */
+const useGeolocation = (options) => {
+    const context = react.useContext(reactCoreContextsApi.GeolocationContext);
+    const standaloneGeolocation = useStandaloneGeolocation({
+        enabled: context === null,
+        requestOnMount: options?.requestOnMount,
+    });
+    return context ?? standaloneGeolocation;
+};
+
 /**
  * This is a hook to use the TokenContext.
  *
@@ -1109,6 +1202,7 @@ exports.useExportDataContext = useExportDataContext;
 exports.useFeatureBranchQueryString = useFeatureBranchQueryString;
 exports.useFeatureFlags = useFeatureFlags;
 exports.useFilterBarContext = useFilterBarContext;
+exports.useGeolocation = useGeolocation;
 exports.useHasAccessTo = useHasAccessTo;
 exports.useImageUploader = useImageUploader;
 exports.useIrisAppId = useIrisAppId;

package/index.esm.js

@@ -1,5 +1,5 @@
-import { AnalyticsContext, AssetSortingContext, ConfirmationDialogContext, EnvironmentContext, ErrorHandlingContext, ExportDataContext, FeatureFlagContext, FilterBarContext, TokenContext, ModalDialogContext, NavigationContext, OemBrandingContext, UserSubscriptionContext, TimeRangeContext, ToastContext, CurrentUserContext, CurrentUserPreferenceContext, WidgetConfigContext } from '@trackunit/react-core-contexts-api';
-import { useContext, useMemo, useState, useCallback, useReducer, useEffect, useRef } from 'react';
+import { AnalyticsContext, AssetSortingContext, ConfirmationDialogContext, EnvironmentContext, ErrorHandlingContext, ExportDataContext, FeatureFlagContext, FilterBarContext, GeolocationContext, TokenContext, ModalDialogContext, NavigationContext, OemBrandingContext, UserSubscriptionContext, TimeRangeContext, ToastContext, CurrentUserContext, CurrentUserPreferenceContext, WidgetConfigContext } from '@trackunit/react-core-contexts-api';
+import { useContext, useMemo, useState, useCallback, useEffect, useReducer, useRef } from 'react';
 import { isEqual } from 'es-toolkit';
 import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime, WidgetConfigRuntime } from '@trackunit/iris-app-runtime-core';
 
@@ -228,6 +228,99 @@ const useFilterBarContext = () => {
     return context;
 };
 
+const useStandaloneGeolocation = ({ enabled, requestOnMount, }) => {
+    const [position, setPosition] = useState(null);
+    const queryGeolocationPermission = useCallback(async () => {
+        if (!enabled || typeof navigator === "undefined") {
+            return null;
+        }
+        try {
+            const status = await navigator.permissions.query({ name: "geolocation" });
+            return status.state;
+        }
+        catch {
+            return null;
+        }
+    }, [enabled]);
+    const getCurrentPosition = useCallback(async () => {
+        if (!enabled || typeof navigator === "undefined") {
+            return null;
+        }
+        return await new Promise(resolve => {
+            try {
+                navigator.geolocation.getCurrentPosition(currentPosition => {
+                    resolve([currentPosition.coords.longitude, currentPosition.coords.latitude]);
+                }, () => {
+                    resolve(null);
+                });
+            }
+            catch {
+                resolve(null);
+            }
+        });
+    }, [enabled]);
+    const getPosition = useCallback(async (options) => {
+        const prompt = options?.prompt !== false;
+        if (!prompt) {
+            const permissionState = await queryGeolocationPermission();
+            if (permissionState !== "granted") {
+                return null;
+            }
+        }
+        const currentPosition = await getCurrentPosition();
+        if (currentPosition !== null) {
+            setPosition(currentPosition);
+        }
+        return currentPosition;
+    }, [getCurrentPosition, queryGeolocationPermission]);
+    useEffect(() => {
+        if (!enabled || requestOnMount !== true) {
+            return;
+        }
+        void queryGeolocationPermission()
+            .then(permissionState => {
+            if (permissionState !== "granted") {
+                return null;
+            }
+            return getCurrentPosition();
+        })
+            .then(currentPosition => {
+            if (currentPosition !== null) {
+                setPosition(currentPosition);
+            }
+        });
+    }, [enabled, getCurrentPosition, queryGeolocationPermission, requestOnMount]);
+    return useMemo(() => ({
+        position,
+        getPosition,
+    }), [getPosition, position]);
+};
+/**
+ * Hook providing geolocation capabilities.
+ *
+ * In the host, geolocation is resolved directly via the browser API.
+ * In Iris Apps, requests are proxied to the host via the iframe bridge,
+ * so permission is only requested once at the host level.
+ *
+ * @example
+ * ```ts
+ * const { position, getPosition } = useGeolocation();
+ *
+ * // User-initiated request (e.g. "My Location" button)
+ * onClick: () => {
+ *   void getPosition().then(pos => { if (pos) fitBounds(pos); });
+ * }
+ * ```
+ */
+const useGeolocation = (options) => {
+    const context = useContext(GeolocationContext);
+    const standaloneGeolocation = useStandaloneGeolocation({
+        enabled: context === null,
+        requestOnMount: options?.requestOnMount,
+    });
+    return context ?? standaloneGeolocation;
+};
+
 /**
  * This is a hook to use the TokenContext.
  *
@@ -1087,4 +1180,4 @@ const useWidgetConfig = () => {
     return result;
 };
 
-export { fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserFavoriteAdvancedSensors, useCurrentUserFavoriteInsights, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTimeRange, useToast, useToken, useUserPermission, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };
+export { fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserFavoriteAdvancedSensors, useCurrentUserFavoriteInsights, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useGeolocation, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTimeRange, useToast, useToken, useUserPermission, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.12.69",
+  "version": "1.14.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,9 +9,9 @@
   "dependencies": {
     "react": "19.0.0",
     "es-toolkit": "^1.39.10",
-    "@trackunit/iris-app-runtime-core": "1.13.61",
-    "@trackunit/iris-app-runtime-core-api": "1.12.58",
-    "@trackunit/react-core-contexts-api": "1.13.59"
+    "@trackunit/iris-app-runtime-core": "1.14.0",
+    "@trackunit/iris-app-runtime-core-api": "1.13.0",
+    "@trackunit/react-core-contexts-api": "1.14.0"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/geolocation/useGeolocation.d.ts

@@ -0,0 +1,23 @@
+import { type GeolocationContextValue } from "@trackunit/react-core-contexts-api";
+type UseGeolocationOptions = Readonly<{
+    requestOnMount?: boolean;
+}>;
+/**
+ * Hook providing geolocation capabilities.
+ *
+ * In the host, geolocation is resolved directly via the browser API.
+ * In Iris Apps, requests are proxied to the host via the iframe bridge,
+ * so permission is only requested once at the host level.
+ *
+ * @example
+ * ```ts
+ * const { position, getPosition } = useGeolocation();
+ *
+ * // User-initiated request (e.g. "My Location" button)
+ * onClick: () => {
+ *   void getPosition().then(pos => { if (pos) fitBounds(pos); });
+ * }
+ * ```
+ */
+export declare const useGeolocation: (options?: UseGeolocationOptions) => GeolocationContextValue;
+export {};

package/src/index.d.ts

@@ -7,6 +7,7 @@ export * from "./exportData/useExportDataContext";
 export * from "./featureFlags/useFeatureFlags";
 export * from "./fetchAssetBlobUrl";
 export * from "./filterBar/useFilterBarContext";
+export * from "./geolocation/useGeolocation";
 export * from "./images/useImageUploader";
 export * from "./images/useIrisAppImage";
 export * from "./modalDialog/useModalDialogContext";