@trackunit/react-core-hooks 0.2.16 → 0.2.18

package/index.js

@@ -1,8 +1,8 @@
 import { jsx } from 'react/jsx-runtime';
 import * as React from 'react';
-import React__default, { createContext, useContext } from 'react';
+import React__default, { createContext, useContext, useState, useEffect } from 'react';
 import { useFlags } from 'launchdarkly-react-client-sdk';
-import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime } from '@trackunit/iris-app-runtime-core';
+import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { useLocation } from 'react-router-dom';
 
 const AssetSortingContext = createContext(null);
@@ -109,6 +109,48 @@ const useRestRuntime = () => {
     return RestRuntime;
 };
 
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+/**
+ * A hook to expose site runtime for React components
+ *
+ * @returns {UseSiteRuntime} siteRuntime
+ */
+const useSiteRuntime = () => {
+    const [siteInfo, setSiteInfo] = useState();
+    useEffect(() => {
+        const getSiteInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            const updatedSiteInfo = yield SiteRuntime.getSiteInfo();
+            setSiteInfo(updatedSiteInfo);
+        });
+        getSiteInfo();
+    }, []);
+    return { siteInfo };
+};
+
 const UserSubscriptionContext = React.createContext(null);
 const UserSubscriptionProvider = (props) => {
     return jsx(UserSubscriptionContext.Provider, Object.assign({}, props));
@@ -155,4 +197,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AssetSortingProvider, CurrentUserProvider, DeveloperSettingsContext, DeveloperSettingsProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useDeveloperSettings, useEnvironment, useGlobalSelection, useRestRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AssetSortingProvider, CurrentUserProvider, DeveloperSettingsContext, DeveloperSettingsProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useDeveloperSettings, useEnvironment, useGlobalSelection, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.16",
+  "version": "0.2.18",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -8,10 +8,10 @@
   "type": "module",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@trackunit/react-core-contexts-api": "0.2.8",
+    "@trackunit/react-core-contexts-api": "0.2.9",
     "react": "18.2.0",
     "launchdarkly-react-client-sdk": "2.29.3",
-    "@trackunit/iris-app-runtime-core": "0.3.7",
+    "@trackunit/iris-app-runtime-core": "0.3.9",
     "react-router-dom": "6.4.5"
   },
   "peerDependencies": {}

package/src/index.d.ts

@@ -6,6 +6,7 @@ export * from "./runtimes/navigation";
 export * from "./runtimes/useAssetRuntime";
 export * from "./runtimes/useCustomFieldRuntime";
 export * from "./runtimes/useRestRuntime";
+export * from "./runtimes/useSiteRuntime";
 export * from "./subscription/UserSubscriptionProvider";
 export * from "./toast/ToastProvider";
 export * from "./token/TokenProvider";

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

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

package/src/runtimes/useSiteRuntime.d.ts

@@ -0,0 +1,10 @@
+import { SiteInfo } from "@trackunit/iris-app-runtime-core";
+export interface UseSiteRuntime {
+    siteInfo?: SiteInfo;
+}
+/**
+ * A hook to expose site runtime for React components
+ *
+ * @returns {UseSiteRuntime} siteRuntime
+ */
+export declare const useSiteRuntime: () => UseSiteRuntime;