@trackunit/react-core-hooks 1.7.90 → 1.7.91

package/index.cjs.js

@@ -295,6 +295,31 @@ const useExportDataContext = () => {
     return context;
 };
 
+const FeatureFlagContext = react.createContext(null);
+/**
+ * This is a provider for the FeatureFlagContext.
+ */
+const FeatureFlagContextProvider = (props) => {
+    return jsxRuntime.jsx(FeatureFlagContext.Provider, { ...props });
+};
+/**
+ * This is a hook to use the FeatureFlagContext.
+ *
+ * @requires FeatureFlagContext
+ * @example
+ * import { useFeatureFlags } from "@trackunit/react-core-hooks";
+ * const { flags } = useFeatureFlags();
+ * // use flags to control visibility/access ...
+ * @see (@link FeatureFlagContext)
+ */
+const useFeatureFlags = () => {
+    const context = react.useContext(FeatureFlagContext);
+    if (!context) {
+        throw new Error("useFeatureFlags must be used within a FeatureFlagContext");
+    }
+    return context;
+};
+
 /**
  * Fetch any url as a blob and return a blob url.
  * This is used to get and display logos and images related to Iris Apps.
@@ -1356,6 +1381,7 @@ exports.EnvironmentContextProvider = EnvironmentContextProvider;
 exports.ErrorHandlingContext = ErrorHandlingContext;
 exports.ErrorHandlingContextProvider = ErrorHandlingContextProvider;
 exports.ExportDataContext = ExportDataContext;
+exports.FeatureFlagContextProvider = FeatureFlagContextProvider;
 exports.FilterBarProvider = FilterBarProvider;
 exports.ModalDialogContextProvider = ModalDialogContextProvider;
 exports.NavigationContextProvider = NavigationContextProvider;
@@ -1383,6 +1409,7 @@ exports.useErrorHandlerOrNull = useErrorHandlerOrNull;
 exports.useEventRuntime = useEventRuntime;
 exports.useExportDataContext = useExportDataContext;
 exports.useFeatureBranchQueryString = useFeatureBranchQueryString;
+exports.useFeatureFlags = useFeatureFlags;
 exports.useFilterBarContext = useFilterBarContext;
 exports.useHasAccessTo = useHasAccessTo;
 exports.useImageUploader = useImageUploader;

package/index.esm.js

@@ -293,6 +293,31 @@ const useExportDataContext = () => {
     return context;
 };
 
+const FeatureFlagContext = createContext(null);
+/**
+ * This is a provider for the FeatureFlagContext.
+ */
+const FeatureFlagContextProvider = (props) => {
+    return jsx(FeatureFlagContext.Provider, { ...props });
+};
+/**
+ * This is a hook to use the FeatureFlagContext.
+ *
+ * @requires FeatureFlagContext
+ * @example
+ * import { useFeatureFlags } from "@trackunit/react-core-hooks";
+ * const { flags } = useFeatureFlags();
+ * // use flags to control visibility/access ...
+ * @see (@link FeatureFlagContext)
+ */
+const useFeatureFlags = () => {
+    const context = useContext(FeatureFlagContext);
+    if (!context) {
+        throw new Error("useFeatureFlags must be used within a FeatureFlagContext");
+    }
+    return context;
+};
+
 /**
  * Fetch any url as a blob and return a blob url.
  * This is used to get and display logos and images related to Iris Apps.
@@ -1344,4 +1369,4 @@ const useWidgetConfig = () => {
     return result;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, ExportDataContext, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, WidgetConfigContext, WidgetConfigProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomEncoding, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription, useWatch, useWidgetConfig, useWidgetConfigAsync };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, ExportDataContext, FeatureFlagContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, WidgetConfigContext, WidgetConfigProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomEncoding, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription, useWatch, useWidgetConfig, useWidgetConfigAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.7.90",
+  "version": "1.7.91",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,11 +9,11 @@
   "dependencies": {
     "react": "19.0.0",
     "zod": "^3.23.8",
-    "@trackunit/iris-app-runtime-core": "1.8.86",
+    "@trackunit/iris-app-runtime-core": "1.8.87",
     "@trackunit/shared-utils": "1.9.77",
     "fflate": "^0.8.2",
     "es-toolkit": "^1.39.10",
-    "@trackunit/iris-app-runtime-core-api": "1.7.86"
+    "@trackunit/iris-app-runtime-core-api": "1.7.87"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/featureFlags/FeatureFlagContextProvider.d.ts

@@ -0,0 +1,22 @@
+import { FeatureFlagState } from "@trackunit/iris-app-runtime-core-api";
+import { ReactNode } from "react";
+export interface FeatureFlagContextProviderProps {
+    children?: ReactNode;
+    /** Override the value of the FeatureFlag context. Useful for testing purposes. */
+    value: FeatureFlagState;
+}
+/**
+ * This is a provider for the FeatureFlagContext.
+ */
+export declare const FeatureFlagContextProvider: (props: FeatureFlagContextProviderProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * This is a hook to use the FeatureFlagContext.
+ *
+ * @requires FeatureFlagContext
+ * @example
+ * import { useFeatureFlags } from "@trackunit/react-core-hooks";
+ * const { flags } = useFeatureFlags();
+ * // use flags to control visibility/access ...
+ * @see (@link FeatureFlagContext)
+ */
+export declare const useFeatureFlags: () => FeatureFlagState;

package/src/index.d.ts

@@ -5,6 +5,7 @@ export * from "./encoding/useCustomEncoding";
 export * from "./environment/EnvironmentContextProvider";
 export * from "./errorHandling/ErrorHandlingProvider";
 export * from "./exportData/ExportDataContextState";
+export * from "./featureFlags/FeatureFlagContextProvider";
 export * from "./fetchAssetBlobUrl";
 export * from "./filter-bar/FilterBarProvider";
 export * from "./images/useImageUploader";