@trackunit/react-core-hooks 0.2.110 → 0.2.112-alpha-500b40a315.0

package/index.cjs.js

@@ -203,6 +203,29 @@ const OemBrandingContextProvider = (props) => {
     return jsxRuntime.jsx(OemBrandingContext.Provider, Object.assign({}, props));
 };
 
+const NavigationContext = React.createContext(null);
+/**
+ * This is a provider for the NavigationContext.
+ */
+const NavigationContextProvider = (props) => {
+    return jsxRuntime.jsx(NavigationContext.Provider, Object.assign({}, props));
+};
+/**
+ * This is a hook to use the NavigationContext.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useNavigateInHost } from "@trackunit/react-core-hooks";
+ * @see (@link INavigationContext)
+ */
+const useNavigateInHost = () => {
+    const context = React.useContext(NavigationContext);
+    if (!context) {
+        throw new Error("useNavigateInHost must be used within an NavigationContext");
+    }
+    return context;
+};
+
 /**
  * A react hook for notifying host about location changes
  */
@@ -219,23 +242,6 @@ const useURLSynchronization = () => {
     }, [location]);
 };
 
-/**
- * A hook to expose navigation runtime for React components
- *
- * @requires NavigationRuntime
- * @returns {UseNavigationRuntime} navigationRuntime
- * @example
- * import { useNavigationRuntime } from "@trackunit/react-core-hooks";
- * const { gotoAssetHome } = useNavigationRuntime();
- * // ...
- * <Link onClick={() => gotoAssetHome(asset.id)} to="">
- *   {asset.name}
- * </Link>
- */
-const useNavigationRuntime = () => {
-    return irisAppRuntimeCore.NavigationRuntime;
-};
-
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -593,6 +599,7 @@ exports.CurrentUserProvider = CurrentUserProvider;
 exports.EnvironmentContextProvider = EnvironmentContextProvider;
 exports.FilterBarProvider = FilterBarProvider;
 exports.GlobalSelectionProvider = GlobalSelectionProvider;
+exports.NavigationContextProvider = NavigationContextProvider;
 exports.OemBrandingContextProvider = OemBrandingContextProvider;
 exports.ToastProvider = ToastProvider;
 exports.TokenProvider = TokenProvider;
@@ -609,7 +616,7 @@ exports.useCustomFieldRuntimeForEntity = useCustomFieldRuntimeForEntity;
 exports.useEnvironment = useEnvironment;
 exports.useFilterBarContext = useFilterBarContext;
 exports.useGlobalSelection = useGlobalSelection;
-exports.useNavigationRuntime = useNavigationRuntime;
+exports.useNavigateInHost = useNavigateInHost;
 exports.useOemBrandingContext = useOemBrandingContext;
 exports.useRestRuntime = useRestRuntime;
 exports.useSiteRuntime = useSiteRuntime;

package/index.esm.js

@@ -177,6 +177,29 @@ const OemBrandingContextProvider = (props) => {
     return jsx(OemBrandingContext.Provider, Object.assign({}, props));
 };
 
+const NavigationContext = createContext(null);
+/**
+ * This is a provider for the NavigationContext.
+ */
+const NavigationContextProvider = (props) => {
+    return jsx(NavigationContext.Provider, Object.assign({}, props));
+};
+/**
+ * This is a hook to use the NavigationContext.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useNavigateInHost } from "@trackunit/react-core-hooks";
+ * @see (@link INavigationContext)
+ */
+const useNavigateInHost = () => {
+    const context = useContext(NavigationContext);
+    if (!context) {
+        throw new Error("useNavigateInHost must be used within an NavigationContext");
+    }
+    return context;
+};
+
 /**
  * A react hook for notifying host about location changes
  */
@@ -193,23 +216,6 @@ const useURLSynchronization = () => {
     }, [location]);
 };
 
-/**
- * A hook to expose navigation runtime for React components
- *
- * @requires NavigationRuntime
- * @returns {UseNavigationRuntime} navigationRuntime
- * @example
- * import { useNavigationRuntime } from "@trackunit/react-core-hooks";
- * const { gotoAssetHome } = useNavigationRuntime();
- * // ...
- * <Link onClick={() => gotoAssetHome(asset.id)} to="">
- *   {asset.name}
- * </Link>
- */
-const useNavigationRuntime = () => {
-    return NavigationRuntime;
-};
-
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -559,4 +565,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, GlobalSelectionProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useFilterBarContext, useGlobalSelection, useNavigationRuntime, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, GlobalSelectionProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useFilterBarContext, useGlobalSelection, useNavigateInHost, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.110",
+  "version": "0.2.112-alpha-500b40a315.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
     "node": ">=18.x"
   },
-  "module": "./index.esm.js",
-  "main": "./index.cjs.js",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core": "0.3.91",
-    "@trackunit/iris-app-runtime-core-api": "0.3.82",
-    "@trackunit/react-core-contexts-api": "0.2.68",
-    "@trackunit/shared-utils": "0.0.15",
-    "react": "18.2.0",
-    "react-router-dom": "6.11.2"
+    "@trackunit/react-core-contexts-api": "*",
+    "react": "^18.2.0",
+    "@trackunit/iris-app-runtime-core": "*",
+    "react-router-dom": "6.11.2",
+    "@trackunit/iris-app-runtime-core-api": "*",
+    "jest-fetch-mock": "^3.0.3",
+    "@trackunit/shared-utils": "*"
   },
-  "peerDependencies": {}
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js"
 }

package/src/index.d.ts

@@ -4,8 +4,8 @@ export * from "./environment/EnvironmentContextProvider";
 export * from "./filter-bar/FilterBarProvider";
 export * from "./global-selection/GlobalSelectionProvider";
 export * from "./irisOemApp/IrisOemAppContextProvider";
-export * from "./runtimes/navigation";
-export * from "./runtimes/navigation/useNavigationRuntime";
+export * from "./navigation/NavigationContextProvider";
+export * from "./navigation/useURLSynchronization";
 export * from "./runtimes/useAssetRuntime";
 export * from "./runtimes/useCustomFieldRuntime";
 export * from "./runtimes/useCustomFieldRuntimeForEntity";

package/src/navigation/NavigationContextProvider.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { INavigationContext } from "@trackunit/react-core-contexts-api";
+interface IProps {
+    value: INavigationContext;
+    children?: React.ReactNode;
+}
+/**
+ * This is a provider for the NavigationContext.
+ */
+export declare const NavigationContextProvider: (props: IProps) => JSX.Element;
+/**
+ * This is a hook to use the NavigationContext.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useNavigateInHost } from "@trackunit/react-core-hooks";
+ * @see (@link INavigationContext)
+ */
+export declare const useNavigateInHost: () => INavigationContext;
+export {};

package/src/runtimes/navigation/index.d.ts

@@ -1 +0,0 @@
-export * from "./useURLSynchronization";

package/src/runtimes/navigation/useDeeplink.d.ts

@@ -1,4 +0,0 @@
-export type DeepLink = {
-    path: string;
-    search: Location["search"];
-};

package/src/runtimes/navigation/useNavigationRuntime.d.ts

@@ -1,17 +0,0 @@
-import { INavigationRuntime } from "@trackunit/iris-app-runtime-core";
-export interface UseNavigationRuntime extends INavigationRuntime {
-}
-/**
- * A hook to expose navigation runtime for React components
- *
- * @requires NavigationRuntime
- * @returns {UseNavigationRuntime} navigationRuntime
- * @example
- * import { useNavigationRuntime } from "@trackunit/react-core-hooks";
- * const { gotoAssetHome } = useNavigationRuntime();
- * // ...
- * <Link onClick={() => gotoAssetHome(asset.id)} to="">
- *   {asset.name}
- * </Link>
- */
-export declare const useNavigationRuntime: () => UseNavigationRuntime;