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

package/index.cjs.js

@@ -203,6 +203,31 @@ const OemBrandingContextProvider = (props) => {
     return jsxRuntime.jsx(OemBrandingContext.Provider, Object.assign({}, props));
 };
 
+/******************************************************************************
+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());
+    });
+}
+
 const NavigationContext = React.createContext(null);
 /**
  * This is a provider for the NavigationContext.
@@ -225,6 +250,40 @@ const useNavigateInHost = () => {
     }
     return context;
 };
+/**
+ * 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.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useHasAccessTo } from "@trackunit/react-core-hooks";
+ * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
+ * @see (@link INavigationContext)
+ * @see (@link HasAccessToOptions)
+ * @see (@link HasAccessToOptions.assetId)
+ * @see (@link HasAccessToOptions.page)
+ * @see (@link HasAccessToOptions.siteId)
+ * @see (@link INavigationContext)
+ */
+const useHasAccessTo = (options) => {
+    const context = React.useContext(NavigationContext);
+    if (!context) {
+        throw new Error("useHasAccessTo must be used within an NavigationContext");
+    }
+    const [hasAccess, setHasAccess] = React.useState();
+    React.useEffect(() => {
+        function checkAccess() {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (options.assetId) {
+                    const doHaveAccess = yield (context === null || context === void 0 ? void 0 : context.hasAccessTo(options));
+                    setHasAccess(() => doHaveAccess);
+                }
+            });
+        }
+        checkAccess();
+    }, [context, options]);
+    return { hasAccess };
+};
 
 /**
  * A react hook for notifying host about location changes
@@ -242,31 +301,6 @@ const useURLSynchronization = () => {
     }, [location]);
 };
 
-/******************************************************************************
-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 asset runtime for React components
  *
@@ -473,7 +507,7 @@ const TokenProvider = (props) => {
  *
  * @param items The list of items to filter.
  * @param props The properties to search in each item.
- * @returns A tuple with the filtered items, the search text and a setter for the search text.
+ * @returns { Maybe<string>[]): [T[], string, Dispatch<string>] } A tuple with the filtered items, the search text and a setter for the search text.
  * @example
  * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
  */
@@ -616,6 +650,7 @@ exports.useCustomFieldRuntimeForEntity = useCustomFieldRuntimeForEntity;
 exports.useEnvironment = useEnvironment;
 exports.useFilterBarContext = useFilterBarContext;
 exports.useGlobalSelection = useGlobalSelection;
+exports.useHasAccessTo = useHasAccessTo;
 exports.useNavigateInHost = useNavigateInHost;
 exports.useOemBrandingContext = useOemBrandingContext;
 exports.useRestRuntime = useRestRuntime;

package/index.esm.js

@@ -177,6 +177,31 @@ const OemBrandingContextProvider = (props) => {
     return jsx(OemBrandingContext.Provider, Object.assign({}, props));
 };
 
+/******************************************************************************
+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());
+    });
+}
+
 const NavigationContext = createContext(null);
 /**
  * This is a provider for the NavigationContext.
@@ -199,6 +224,40 @@ const useNavigateInHost = () => {
     }
     return context;
 };
+/**
+ * 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.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useHasAccessTo } from "@trackunit/react-core-hooks";
+ * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
+ * @see (@link INavigationContext)
+ * @see (@link HasAccessToOptions)
+ * @see (@link HasAccessToOptions.assetId)
+ * @see (@link HasAccessToOptions.page)
+ * @see (@link HasAccessToOptions.siteId)
+ * @see (@link INavigationContext)
+ */
+const useHasAccessTo = (options) => {
+    const context = useContext(NavigationContext);
+    if (!context) {
+        throw new Error("useHasAccessTo must be used within an NavigationContext");
+    }
+    const [hasAccess, setHasAccess] = useState();
+    useEffect(() => {
+        function checkAccess() {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (options.assetId) {
+                    const doHaveAccess = yield (context === null || context === void 0 ? void 0 : context.hasAccessTo(options));
+                    setHasAccess(() => doHaveAccess);
+                }
+            });
+        }
+        checkAccess();
+    }, [context, options]);
+    return { hasAccess };
+};
 
 /**
  * A react hook for notifying host about location changes
@@ -216,31 +275,6 @@ const useURLSynchronization = () => {
     }, [location]);
 };
 
-/******************************************************************************
-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 asset runtime for React components
  *
@@ -447,7 +481,7 @@ const TokenProvider = (props) => {
  *
  * @param items The list of items to filter.
  * @param props The properties to search in each item.
- * @returns A tuple with the filtered items, the search text and a setter for the search text.
+ * @returns { Maybe<string>[]): [T[], string, Dispatch<string>] } A tuple with the filtered items, the search text and a setter for the search text.
  * @example
  * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
  */
@@ -565,4 +599,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-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 };
+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, useHasAccessTo, useNavigateInHost, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.112-alpha-500b40a315.0",
+  "version": "0.2.114",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/navigation/NavigationContextProvider.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { INavigationContext } from "@trackunit/react-core-contexts-api";
+import { HasAccessToOptions, INavigationContext } from "@trackunit/react-core-contexts-api";
 interface IProps {
     value: INavigationContext;
     children?: React.ReactNode;
@@ -17,4 +17,22 @@ export declare const NavigationContextProvider: (props: IProps) => JSX.Element;
  * @see (@link INavigationContext)
  */
 export declare const useNavigateInHost: () => INavigationContext;
+/**
+ * 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.
+ *
+ * @requires NavigationContext
+ * @example
+ * import { useHasAccessTo } from "@trackunit/react-core-hooks";
+ * useHasAccessTo({ assetId: assetInfo?.assetId, page: "movement" })
+ * @see (@link INavigationContext)
+ * @see (@link HasAccessToOptions)
+ * @see (@link HasAccessToOptions.assetId)
+ * @see (@link HasAccessToOptions.page)
+ * @see (@link HasAccessToOptions.siteId)
+ * @see (@link INavigationContext)
+ */
+export declare const useHasAccessTo: (options: HasAccessToOptions) => {
+    hasAccess: boolean | undefined;
+};
 export {};

package/src/useTextSearch.d.ts

@@ -5,7 +5,7 @@ import { Dispatch } from "react";
  *
  * @param items The list of items to filter.
  * @param props The properties to search in each item.
- * @returns A tuple with the filtered items, the search text and a setter for the search text.
+ * @returns { Maybe<string>[]): [T[], string, Dispatch<string>] } A tuple with the filtered items, the search text and a setter for the search text.
  * @example
  * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
  */