@trackunit/react-core-hooks 0.2.25 → 0.2.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.js CHANGED
@@ -79,30 +79,12 @@ const useURLSynchronization = () => {
79
79
  };
80
80
 
81
81
  /**
82
- * A hook to expose asset runtime for React components
82
+ * A hook to expose navigation runtime for React components
83
83
  *
84
- * @returns {UseAssetRuntime} assetRuntime
84
+ * @returns {UseNavigationRuntime} navigationRuntime
85
85
  */
86
- const useAssetRuntime = () => {
87
- return AssetRuntime;
88
- };
89
-
90
- /**
91
- * A hook to expose custom field runtime methods
92
- *
93
- * @returns {UseCustomFieldRuntime} CustomFieldRuntime
94
- */
95
- const useCustomFieldRuntime = () => {
96
- return CustomFieldRuntime;
97
- };
98
-
99
- /**
100
- * A hook to expose rest runtime to be used in React components
101
- *
102
- * @returns {UseRestRuntime} a RestRuntime
103
- */
104
- const useRestRuntime = () => {
105
- return RestRuntime;
86
+ const useNavigationRuntime = () => {
87
+ return NavigationRuntime;
106
88
  };
107
89
 
108
90
  /******************************************************************************
@@ -130,6 +112,41 @@ function __awaiter(thisArg, _arguments, P, generator) {
130
112
  });
131
113
  }
132
114
 
115
+ /**
116
+ * A hook to expose asset runtime for React components
117
+ *
118
+ * @returns {UseAssetRuntime} assetRuntime
119
+ */
120
+ const useAssetRuntime = () => {
121
+ const [assetInfo, setAssetInfo] = useState();
122
+ useEffect(() => {
123
+ const getAssetInfo = () => __awaiter(void 0, void 0, void 0, function* () {
124
+ const updatedAssetInfo = yield AssetRuntime.getAssetInfo();
125
+ setAssetInfo(updatedAssetInfo);
126
+ });
127
+ getAssetInfo();
128
+ }, []);
129
+ return { assetInfo };
130
+ };
131
+
132
+ /**
133
+ * A hook to expose custom field runtime methods
134
+ *
135
+ * @returns {UseCustomFieldRuntime} CustomFieldRuntime
136
+ */
137
+ const useCustomFieldRuntime = () => {
138
+ return CustomFieldRuntime;
139
+ };
140
+
141
+ /**
142
+ * A hook to expose rest runtime to be used in React components
143
+ *
144
+ * @returns {UseRestRuntime} a RestRuntime
145
+ */
146
+ const useRestRuntime = () => {
147
+ return RestRuntime;
148
+ };
149
+
133
150
  /**
134
151
  * A hook to expose site runtime for React components
135
152
  *
@@ -193,4 +210,4 @@ const useCurrentUser = () => {
193
210
  return context;
194
211
  };
195
212
 
196
- export { AssetSortingProvider, CurrentUserProvider, DeveloperSettingsContext, DeveloperSettingsProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useDeveloperSettings, useEnvironment, useGlobalSelection, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };
213
+ 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/react-core-hooks",
3
- "version": "0.2.25",
3
+ "version": "0.2.26",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "module": "./index.js",
@@ -10,7 +10,7 @@
10
10
  "dependencies": {
11
11
  "@trackunit/react-core-contexts-api": "0.2.14",
12
12
  "react": "18.2.0",
13
- "@trackunit/iris-app-runtime-core": "0.3.15",
13
+ "@trackunit/iris-app-runtime-core": "0.3.16",
14
14
  "react-router-dom": "6.4.5"
15
15
  },
16
16
  "peerDependencies": {}
package/src/index.d.ts CHANGED
@@ -3,6 +3,7 @@ export * from "./developerSettings/DeveloperSettingsProvider";
3
3
  export * from "./environment/EnvironmentContextProvider";
4
4
  export * from "./global-selection/GlobalSelectionProvider";
5
5
  export * from "./runtimes/navigation";
6
+ export * from "./runtimes/navigation/useNavigationRuntime";
6
7
  export * from "./runtimes/useAssetRuntime";
7
8
  export * from "./runtimes/useCustomFieldRuntime";
8
9
  export * from "./runtimes/useRestRuntime";
@@ -0,0 +1,9 @@
1
+ import { INavigationRuntime } from "@trackunit/iris-app-runtime-core";
2
+ export interface UseNavigationRuntime extends INavigationRuntime {
3
+ }
4
+ /**
5
+ * A hook to expose navigation runtime for React components
6
+ *
7
+ * @returns {UseNavigationRuntime} navigationRuntime
8
+ */
9
+ export declare const useNavigationRuntime: () => UseNavigationRuntime;
@@ -1,5 +1,6 @@
1
- import { IAssetRuntime } from "@trackunit/iris-app-runtime-core";
2
- export interface UseAssetRuntime extends IAssetRuntime {
1
+ import { AssetInfo } from "@trackunit/iris-app-runtime-core";
2
+ export interface UseAssetRuntime {
3
+ assetInfo: AssetInfo | undefined;
3
4
  }
4
5
  /**
5
6
  * A hook to expose asset runtime for React components
@@ -1,5 +1,5 @@
1
1
  import { ICustomFieldRuntime } from "@trackunit/iris-app-runtime-core";
2
- interface UseCustomFieldRuntime extends ICustomFieldRuntime {
2
+ export interface UseCustomFieldRuntime extends ICustomFieldRuntime {
3
3
  }
4
4
  /**
5
5
  * A hook to expose custom field runtime methods
@@ -7,4 +7,3 @@ interface UseCustomFieldRuntime extends ICustomFieldRuntime {
7
7
  * @returns {UseCustomFieldRuntime} CustomFieldRuntime
8
8
  */
9
9
  export declare const useCustomFieldRuntime: () => UseCustomFieldRuntime;
10
- export {};