@trackunit/react-core-hooks 1.7.83 → 1.7.84

package/index.cjs.js

@@ -23,7 +23,7 @@ const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
  *
  * // log event when appropriate
  * logEvent("Login", { loginPage: "New Manager" });
- * @see { IAnalyticsContext}
+ * @see { AnalyticsRuntimeApiSync}
  */
 const useAnalytics = (events) => {
     const context = react.useContext(AnalyticsContext);
@@ -88,7 +88,7 @@ const AssetSortingProvider = AssetSortingContext.Provider;
  *     headerInitialSort={initialSort}
  *   />
  * );
- * @see { AssetSortingContextValue}
+ * @see { AssetSortingState}
  */
 const useAssetSorting = () => {
     const context = react.useContext(AssetSortingContext);
@@ -229,7 +229,7 @@ const EnvironmentContextProvider = (props) => {
  * import { useEnvironment } from "@trackunit/react-core-hooks";
  * const { googleMapsApiKey } = useEnvironment();
  * // use api key for something...
- * @see (@link IEnvironmentContext)
+ * @see (@link EnvironmentState)
  */
 const useEnvironment = () => {
     const context = react.useContext(EnvironmentContext);
@@ -487,32 +487,6 @@ const useIrisAppImage = () => {
     };
 };
 
-const OEMBrandingService = react.createContext(null);
-/**
- * This is a hook to use the OemBrandingContext.
- *
- * @requires OemBrandingContextProvider
- * @example
- * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
- * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
- * // use oem branding
- * const branding = getOemBranding("some brand")
- * @see { OemBrandingContext}
- */
-const useOemBrandingContext = () => {
-    const context = react.useContext(OEMBrandingService);
-    if (!context) {
-        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
-    }
-    return context;
-};
-/**
- * This is a provider for the OemBrandingContext.
- */
-const OemBrandingContextProvider = (props) => {
-    return jsxRuntime.jsx(OEMBrandingService.Provider, { ...props });
-};
-
 /**
  * The usePrevious hook is a useful tool for tracking the previous value of a variable in a functional component. This can be particularly handy in scenarios where it is necessary to compare the current value with the previous one, such as triggering actions or rendering based on changes.
  *
@@ -710,7 +684,7 @@ const NavigationContextProvider = (props) => {
  * @requires NavigationContext
  * @example
  * import { useNavigateInHost } from "@trackunit/react-core-hooks";
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  */
 const useNavigateInHost = () => {
     const context = react.useContext(NavigationContext);
@@ -727,12 +701,12 @@ const useNavigateInHost = () => {
  * @example
  * import { useHasAccessTo } from "@trackunit/react-core-hooks";
  * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  * @see (@link HasAccessToOptions)
  * @see (@link HasAccessToOptions.assetId)
  * @see (@link HasAccessToOptions.page)
  * @see (@link HasAccessToOptions.siteId)
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  */
 const useHasAccessTo = (options) => {
     const context = react.useContext(NavigationContext);
@@ -752,6 +726,32 @@ const useHasAccessTo = (options) => {
     return { hasAccess };
 };
 
+const OEMBrandingService = react.createContext(null);
+/**
+ * This is a hook to use the OemBrandingContext.
+ *
+ * @requires OemBrandingContextProvider
+ * @example
+ * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
+ * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
+ * // use oem branding
+ * const branding = getOemBranding("some brand")
+ * @see { OemBrandingContext}
+ */
+const useOemBrandingContext = () => {
+    const context = react.useContext(OEMBrandingService);
+    if (!context) {
+        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
+    }
+    return context;
+};
+/**
+ * This is a provider for the OemBrandingContext.
+ */
+const OemBrandingContextProvider = (props) => {
+    return jsxRuntime.jsx(OEMBrandingService.Provider, { ...props });
+};
+
 /**
  * A hook to expose asset runtime for React components
  *
@@ -1083,7 +1083,7 @@ const CurrentUserPreferenceProvider = (props) => {
  *
  * language: Gets the language setting of the current user.
  * setLanguage: Sets the language setting of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 const useCurrentUserLanguage = () => {
     const context = react.useContext(CurrentUserPreferenceContext);
@@ -1111,7 +1111,7 @@ const useCurrentUserLanguage = () => {
  *
  * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
  * setTimeZonePreference: Sets the timezone preference of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 const useCurrentUserTimeZonePreference = () => {
     const context = react.useContext(CurrentUserPreferenceContext);
@@ -1135,7 +1135,7 @@ const useCurrentUserTimeZonePreference = () => {
  *
  * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
  * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 const useCurrentUserSystemOfMeasurement = () => {
     const context = react.useContext(CurrentUserPreferenceContext);

package/index.esm.js

@@ -21,7 +21,7 @@ const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
  *
  * // log event when appropriate
  * logEvent("Login", { loginPage: "New Manager" });
- * @see { IAnalyticsContext}
+ * @see { AnalyticsRuntimeApiSync}
  */
 const useAnalytics = (events) => {
     const context = useContext(AnalyticsContext);
@@ -86,7 +86,7 @@ const AssetSortingProvider = AssetSortingContext.Provider;
  *     headerInitialSort={initialSort}
  *   />
  * );
- * @see { AssetSortingContextValue}
+ * @see { AssetSortingState}
  */
 const useAssetSorting = () => {
     const context = useContext(AssetSortingContext);
@@ -227,7 +227,7 @@ const EnvironmentContextProvider = (props) => {
  * import { useEnvironment } from "@trackunit/react-core-hooks";
  * const { googleMapsApiKey } = useEnvironment();
  * // use api key for something...
- * @see (@link IEnvironmentContext)
+ * @see (@link EnvironmentState)
  */
 const useEnvironment = () => {
     const context = useContext(EnvironmentContext);
@@ -485,32 +485,6 @@ const useIrisAppImage = () => {
     };
 };
 
-const OEMBrandingService = createContext(null);
-/**
- * This is a hook to use the OemBrandingContext.
- *
- * @requires OemBrandingContextProvider
- * @example
- * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
- * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
- * // use oem branding
- * const branding = getOemBranding("some brand")
- * @see { OemBrandingContext}
- */
-const useOemBrandingContext = () => {
-    const context = useContext(OEMBrandingService);
-    if (!context) {
-        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
-    }
-    return context;
-};
-/**
- * This is a provider for the OemBrandingContext.
- */
-const OemBrandingContextProvider = (props) => {
-    return jsx(OEMBrandingService.Provider, { ...props });
-};
-
 /**
  * The usePrevious hook is a useful tool for tracking the previous value of a variable in a functional component. This can be particularly handy in scenarios where it is necessary to compare the current value with the previous one, such as triggering actions or rendering based on changes.
  *
@@ -708,7 +682,7 @@ const NavigationContextProvider = (props) => {
  * @requires NavigationContext
  * @example
  * import { useNavigateInHost } from "@trackunit/react-core-hooks";
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  */
 const useNavigateInHost = () => {
     const context = useContext(NavigationContext);
@@ -725,12 +699,12 @@ const useNavigateInHost = () => {
  * @example
  * import { useHasAccessTo } from "@trackunit/react-core-hooks";
  * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  * @see (@link HasAccessToOptions)
  * @see (@link HasAccessToOptions.assetId)
  * @see (@link HasAccessToOptions.page)
  * @see (@link HasAccessToOptions.siteId)
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  */
 const useHasAccessTo = (options) => {
     const context = useContext(NavigationContext);
@@ -750,6 +724,32 @@ const useHasAccessTo = (options) => {
     return { hasAccess };
 };
 
+const OEMBrandingService = createContext(null);
+/**
+ * This is a hook to use the OemBrandingContext.
+ *
+ * @requires OemBrandingContextProvider
+ * @example
+ * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
+ * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
+ * // use oem branding
+ * const branding = getOemBranding("some brand")
+ * @see { OemBrandingContext}
+ */
+const useOemBrandingContext = () => {
+    const context = useContext(OEMBrandingService);
+    if (!context) {
+        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
+    }
+    return context;
+};
+/**
+ * This is a provider for the OemBrandingContext.
+ */
+const OemBrandingContextProvider = (props) => {
+    return jsx(OEMBrandingService.Provider, { ...props });
+};
+
 /**
  * A hook to expose asset runtime for React components
  *
@@ -1081,7 +1081,7 @@ const CurrentUserPreferenceProvider = (props) => {
  *
  * language: Gets the language setting of the current user.
  * setLanguage: Sets the language setting of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 const useCurrentUserLanguage = () => {
     const context = useContext(CurrentUserPreferenceContext);
@@ -1109,7 +1109,7 @@ const useCurrentUserLanguage = () => {
  *
  * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
  * setTimeZonePreference: Sets the timezone preference of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 const useCurrentUserTimeZonePreference = () => {
     const context = useContext(CurrentUserPreferenceContext);
@@ -1133,7 +1133,7 @@ const useCurrentUserTimeZonePreference = () => {
  *
  * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
  * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 const useCurrentUserSystemOfMeasurement = () => {
     const context = useContext(CurrentUserPreferenceContext);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.7.83",
+  "version": "1.7.84",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,11 +9,11 @@
   "dependencies": {
     "react": "19.0.0",
     "zod": "^3.23.8",
-    "@trackunit/iris-app-runtime-core": "1.8.79",
+    "@trackunit/iris-app-runtime-core": "1.8.80",
     "@trackunit/shared-utils": "1.9.73",
     "fflate": "^0.8.2",
     "es-toolkit": "^1.39.10",
-    "@trackunit/iris-app-runtime-core-api": "1.7.79"
+    "@trackunit/iris-app-runtime-core-api": "1.7.80"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/analytics/AnalyticsProvider.d.ts

@@ -1,6 +1,6 @@
-import { EventDictionary, IAnalyticsContext } from "@trackunit/iris-app-runtime-core-api";
-export declare const AnalyticsContext: import("react").Context<IAnalyticsContext<Record<string, never>> | null>;
-export declare const AnalyticsContextProvider: import("react").Provider<IAnalyticsContext<Record<string, never>> | null>;
+import { AnalyticsRuntimeApiSync, EventDictionary } from "@trackunit/iris-app-runtime-core-api";
+export declare const AnalyticsContext: import("react").Context<AnalyticsRuntimeApiSync<Record<string, never>> | null>;
+export declare const AnalyticsContextProvider: import("react").Provider<AnalyticsRuntimeApiSync<Record<string, never>> | null>;
 /**
  * Hook to get the analytics context.
  *
@@ -15,6 +15,6 @@ export declare const AnalyticsContextProvider: import("react").Provider<IAnalyti
  *
  * // log event when appropriate
  * logEvent("Login", { loginPage: "New Manager" });
- * @see { IAnalyticsContext}
+ * @see { AnalyticsRuntimeApiSync}
  */
-export declare const useAnalytics: <TEvents extends EventDictionary = never>(events: TEvents) => IAnalyticsContext<TEvents>;
+export declare const useAnalytics: <TEvents extends EventDictionary = never>(events: TEvents) => AnalyticsRuntimeApiSync<TEvents>;

package/src/assetSorting/AssetSortingProvider.d.ts

@@ -1,8 +1,8 @@
-import { AssetSortingContextValue } from "@trackunit/iris-app-runtime-core-api";
+import { AssetSortingState } from "@trackunit/iris-app-runtime-core-api";
 /**
  * This is a provider for the AssetSortingContext.
  */
-export declare const AssetSortingProvider: import("react").Provider<AssetSortingContextValue | null>;
+export declare const AssetSortingProvider: import("react").Provider<AssetSortingState | null>;
 /**
  * This is a hook to use the AssetSortingContext.
  *
@@ -29,6 +29,6 @@ export declare const AssetSortingProvider: import("react").Provider<AssetSorting
  *     headerInitialSort={initialSort}
  *   />
  * );
- * @see { AssetSortingContextValue}
+ * @see { AssetSortingState}
  */
-export declare const useAssetSorting: () => AssetSortingContextValue;
+export declare const useAssetSorting: () => AssetSortingState;

package/src/confirmationDialog/ConfirmationDialogProvider.d.ts

@@ -1,14 +1,14 @@
-import { ConfirmationDialogContextValue } from "@trackunit/iris-app-runtime-core-api";
+import { ConfirmationDialogRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 import { ReactNode } from "react";
 export interface ConfirmationDialogContextProviderProps {
-    value: ConfirmationDialogContextValue;
+    value: ConfirmationDialogRuntimeApi;
     children: ReactNode;
 }
 /**
  * This is a provider for the ConfirmationDialogContext.
  */
-export declare const ConfirmationDialogProvider: (props: ConfirmationDialogContextProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const ConfirmationDialogProvider: (props: ConfirmationDialogContextProviderProps) => ReactNode;
 /**
  * This is a hook to use the ConfirmationDialogContext.
  */
-export declare const useConfirmationDialog: () => ConfirmationDialogContextValue;
+export declare const useConfirmationDialog: () => ConfirmationDialogRuntimeApi;

package/src/environment/EnvironmentContextProvider.d.ts

@@ -1,6 +1,6 @@
-import { IEnvironmentContext } from "@trackunit/iris-app-runtime-core-api";
+import { EnvironmentState } from "@trackunit/iris-app-runtime-core-api";
 interface EnvironmentContextProviderProps {
-    value: IEnvironmentContext;
+    value: EnvironmentState;
     children?: React.ReactNode;
 }
 /**
@@ -15,7 +15,7 @@ export declare const EnvironmentContextProvider: (props: EnvironmentContextProvi
  * import { useEnvironment } from "@trackunit/react-core-hooks";
  * const { googleMapsApiKey } = useEnvironment();
  * // use api key for something...
- * @see (@link IEnvironmentContext)
+ * @see (@link EnvironmentState)
  */
-export declare const useEnvironment: () => IEnvironmentContext;
+export declare const useEnvironment: () => EnvironmentState;
 export {};

package/src/index.d.ts

@@ -9,11 +9,11 @@ export * from "./fetchAssetBlobUrl";
 export * from "./filter-bar/FilterBarProvider";
 export * from "./images/useImageUploader";
 export * from "./images/useIrisAppImage";
-export * from "./irisOemApp/IrisOemAppContextProvider";
 export * from "./localStorage/useLocalStorage";
 export * from "./localStorage/useLocalStorageReducer";
 export * from "./modalDialog/ModalDialogProvider";
 export * from "./navigation/NavigationContextProvider";
+export * from "./oemBranding/OemBrandingContextProvider";
 export * from "./runtimes/useAssetRuntime";
 export * from "./runtimes/useCustomerRuntime";
 export * from "./runtimes/useEventRuntime";

package/src/modalDialog/ModalDialogProvider.d.ts

@@ -1,7 +1,7 @@
-import { ModalDialogContextValue } from "@trackunit/iris-app-runtime-core-api";
+import { ModalDialogRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 import { ReactNode } from "react";
 export interface ModalDialogProviderProps {
-    value: ModalDialogContextValue;
+    value: ModalDialogRuntimeApi;
     children: ReactNode;
 }
 /**
@@ -11,4 +11,4 @@ export declare const ModalDialogContextProvider: (props: ModalDialogProviderProp
 /**
  * This is a hook to use the useModalDialogContext.
  */
-export declare const useModalDialogContext: () => ModalDialogContextValue;
+export declare const useModalDialogContext: () => ModalDialogRuntimeApi;

package/src/navigation/NavigationContextProvider.d.ts

@@ -1,6 +1,6 @@
-import { HasAccessToOptions, INavigationContext } from "@trackunit/iris-app-runtime-core-api";
+import { HasAccessToOptions, NavigationRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 interface NavigationContextProviderProps {
-    value: INavigationContext;
+    value: NavigationRuntimeApi;
     children?: React.ReactNode;
 }
 /**
@@ -13,9 +13,9 @@ export declare const NavigationContextProvider: (props: NavigationContextProvide
  * @requires NavigationContext
  * @example
  * import { useNavigateInHost } from "@trackunit/react-core-hooks";
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  */
-export declare const useNavigateInHost: () => INavigationContext;
+export declare const useNavigateInHost: () => NavigationRuntimeApi;
 /**
  * This is a hook to use the hasAccessTo in host.
  * You can use this to ensure the page you link to is available for the user to see.
@@ -24,12 +24,12 @@ export declare const useNavigateInHost: () => INavigationContext;
  * @example
  * import { useHasAccessTo } from "@trackunit/react-core-hooks";
  * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  * @see (@link HasAccessToOptions)
  * @see (@link HasAccessToOptions.assetId)
  * @see (@link HasAccessToOptions.page)
  * @see (@link HasAccessToOptions.siteId)
- * @see (@link INavigationContext)
+ * @see (@link NavigationRuntimeApi)
  */
 export declare const useHasAccessTo: (options: HasAccessToOptions) => {
     hasAccess: boolean | undefined;

package/src/{irisOemApp/IrisOemAppContextProvider.d.ts → oemBranding/OemBrandingContextProvider.d.ts}

@@ -1,4 +1,4 @@
-import { OemBrandingContext } from "@trackunit/iris-app-runtime-core-api";
+import { OemBrandingRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 /**
  * This is a hook to use the OemBrandingContext.
  *
@@ -10,9 +10,9 @@ import { OemBrandingContext } from "@trackunit/iris-app-runtime-core-api";
  * const branding = getOemBranding("some brand")
  * @see { OemBrandingContext}
  */
-export declare const useOemBrandingContext: () => OemBrandingContext;
+export declare const useOemBrandingContext: () => OemBrandingRuntimeApi;
 interface OemBrandingContextProviderProps {
-    value: OemBrandingContext;
+    value: OemBrandingRuntimeApi;
     children?: React.ReactNode;
 }
 /**

package/src/user/CurrentUserPreferenceProvider.d.ts

@@ -1,7 +1,7 @@
-import { IUserPreferencesContext } from "@trackunit/iris-app-runtime-core-api";
+import { CurrentUserPreferenceState } from "@trackunit/iris-app-runtime-core-api";
 import { ReactNode } from "react";
 interface Props {
-    value: IUserPreferencesContext;
+    value: CurrentUserPreferenceState;
     children?: ReactNode;
 }
 /**
@@ -18,7 +18,7 @@ export declare const CurrentUserPreferenceProvider: (props: Props) => import("re
  *
  * language: Gets the language setting of the current user.
  * setLanguage: Sets the language setting of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 export declare const useCurrentUserLanguage: () => {
     language: string | undefined;
@@ -34,7 +34,7 @@ export declare const useCurrentUserLanguage: () => {
  *
  * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
  * setTimeZonePreference: Sets the timezone preference of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 export declare const useCurrentUserTimeZonePreference: () => {
     timeZonePreference: import("@trackunit/iris-app-runtime-core-api").TimeZonePreferenceType | undefined;
@@ -50,7 +50,7 @@ export declare const useCurrentUserTimeZonePreference: () => {
  *
  * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
  * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
- * @see { IUserPreferencesContext}
+ * @see { CurrentUserPreferenceState}
  */
 export declare const useCurrentUserSystemOfMeasurement: () => {
     systemOfMeasurement: import("@trackunit/iris-app-runtime-core-api").SystemOfMeasurementType | null;