@trackunit/react-core-hooks 0.2.24-alpha-307439490d.0 → 0.2.26

package/index.js

@@ -63,8 +63,7 @@ const useGlobalSelection = () => {
 const GlobalSelectionProvider = (props) => jsx(GlobalSelectionContext.Provider, Object.assign({}, props));
 
 /**
- * A react hook for notifying host about location change
- *
+ * A react hook for notifying host about location changes
  */
 const useURLSynchronization = () => {
     const location = useLocation();
@@ -80,30 +79,12 @@ const useURLSynchronization = () => {
 };
 
 /**
- * A hook to expose asset runtime for React components
- *
- * @returns {UseAssetRuntime} assetRuntime
- */
-const useAssetRuntime = () => {
-    return AssetRuntime;
-};
-
-/**
- * A hook to expose custom field runtime methods
- *
- * @returns {UseCustomFieldRuntime} CustomFieldRuntime
- */
-const useCustomFieldRuntime = () => {
-    return CustomFieldRuntime;
-};
-
-/**
- * A hook to expose rest runtime to be used in React components
+ * A hook to expose navigation runtime for React components
  *
- * @returns {UseRestRuntime} a RestRuntime
+ * @returns {UseNavigationRuntime} navigationRuntime
  */
-const useRestRuntime = () => {
-    return RestRuntime;
+const useNavigationRuntime = () => {
+    return NavigationRuntime;
 };
 
 /******************************************************************************
@@ -131,6 +112,41 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+/**
+ * A hook to expose asset runtime for React components
+ *
+ * @returns {UseAssetRuntime} assetRuntime
+ */
+const useAssetRuntime = () => {
+    const [assetInfo, setAssetInfo] = useState();
+    useEffect(() => {
+        const getAssetInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            const updatedAssetInfo = yield AssetRuntime.getAssetInfo();
+            setAssetInfo(updatedAssetInfo);
+        });
+        getAssetInfo();
+    }, []);
+    return { assetInfo };
+};
+
+/**
+ * A hook to expose custom field runtime methods
+ *
+ * @returns {UseCustomFieldRuntime} CustomFieldRuntime
+ */
+const useCustomFieldRuntime = () => {
+    return CustomFieldRuntime;
+};
+
+/**
+ * A hook to expose rest runtime to be used in React components
+ *
+ * @returns {UseRestRuntime} a RestRuntime
+ */
+const useRestRuntime = () => {
+    return RestRuntime;
+};
+
 /**
  * A hook to expose site runtime for React components
  *
@@ -194,4 +210,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AssetSortingProvider, CurrentUserProvider, DeveloperSettingsContext, DeveloperSettingsProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useDeveloperSettings, useEnvironment, useGlobalSelection, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AssetSortingProvider, CurrentUserProvider, DeveloperSettingsContext, DeveloperSettingsProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useDeveloperSettings, useEnvironment, useGlobalSelection, useNavigationRuntime, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.24-alpha-307439490d.0",
+  "version": "0.2.26",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -8,9 +8,9 @@
   "type": "module",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@trackunit/react-core-contexts-api": "0.2.14-alpha-307439490d.0",
+    "@trackunit/react-core-contexts-api": "0.2.14",
     "react": "18.2.0",
-    "@trackunit/iris-app-runtime-core": "0.3.15-alpha-307439490d.0",
+    "@trackunit/iris-app-runtime-core": "0.3.16",
     "react-router-dom": "6.4.5"
   },
   "peerDependencies": {}

package/src/index.d.ts

@@ -3,6 +3,7 @@ export * from "./developerSettings/DeveloperSettingsProvider";
 export * from "./environment/EnvironmentContextProvider";
 export * from "./global-selection/GlobalSelectionProvider";
 export * from "./runtimes/navigation";
+export * from "./runtimes/navigation/useNavigationRuntime";
 export * from "./runtimes/useAssetRuntime";
 export * from "./runtimes/useCustomFieldRuntime";
 export * from "./runtimes/useRestRuntime";

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

@@ -0,0 +1,9 @@
+import { INavigationRuntime } from "@trackunit/iris-app-runtime-core";
+export interface UseNavigationRuntime extends INavigationRuntime {
+}
+/**
+ * A hook to expose navigation runtime for React components
+ *
+ * @returns {UseNavigationRuntime} navigationRuntime
+ */
+export declare const useNavigationRuntime: () => UseNavigationRuntime;

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

@@ -1,5 +1,4 @@
 /**
- * A react hook for notifying host about location change
- *
+ * A react hook for notifying host about location changes
  */
 export declare const useURLSynchronization: () => void;

package/src/runtimes/useAssetRuntime.d.ts

@@ -1,5 +1,6 @@
-import { IAssetRuntime } from "@trackunit/iris-app-runtime-core";
-export interface UseAssetRuntime extends IAssetRuntime {
+import { AssetInfo } from "@trackunit/iris-app-runtime-core";
+export interface UseAssetRuntime {
+    assetInfo: AssetInfo | undefined;
 }
 /**
  * A hook to expose asset runtime for React components

package/src/runtimes/useCustomFieldRuntime.d.ts

@@ -1,5 +1,5 @@
 import { ICustomFieldRuntime } from "@trackunit/iris-app-runtime-core";
-interface UseCustomFieldRuntime extends ICustomFieldRuntime {
+export interface UseCustomFieldRuntime extends ICustomFieldRuntime {
 }
 /**
  * A hook to expose custom field runtime methods
@@ -7,4 +7,3 @@ interface UseCustomFieldRuntime extends ICustomFieldRuntime {
  * @returns {UseCustomFieldRuntime} CustomFieldRuntime
  */
 export declare const useCustomFieldRuntime: () => UseCustomFieldRuntime;
-export {};