@trackunit/react-core-hooks 1.7.54 → 1.7.56

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.cjs.js CHANGED
@@ -276,6 +276,25 @@ const useErrorHandlerOrNull = () => {
276
276
  return react.useContext(ErrorHandlingContext) || null;
277
277
  };
278
278
 
279
+ const ExportDataContext = react.createContext(undefined);
280
+ /**
281
+ * This is a hook to use the ExportDataContext.
282
+ *
283
+ * @requires ExportDataContext
284
+ * @example
285
+ * import { useExportDataContext } from "@trackunit/react-core-hooks";
286
+ * const { exportData } = useExportDataContext();
287
+ * // call exportData to export data...
288
+ * @see (@link ExportDataProps)
289
+ */
290
+ const useExportDataContext = () => {
291
+ const context = react.useContext(ExportDataContext);
292
+ if (context === undefined) {
293
+ throw new Error("useExportDataContext must be used within an ExportDataContext");
294
+ }
295
+ return context;
296
+ };
297
+
279
298
  /**
280
299
  * Fetch any url as a blob and return a blob url.
281
300
  * This is used to get and display logos and images related to Iris Apps.
@@ -1336,6 +1355,7 @@ exports.CurrentUserProvider = CurrentUserProvider;
1336
1355
  exports.EnvironmentContextProvider = EnvironmentContextProvider;
1337
1356
  exports.ErrorHandlingContext = ErrorHandlingContext;
1338
1357
  exports.ErrorHandlingContextProvider = ErrorHandlingContextProvider;
1358
+ exports.ExportDataContext = ExportDataContext;
1339
1359
  exports.FilterBarProvider = FilterBarProvider;
1340
1360
  exports.ModalDialogContextProvider = ModalDialogContextProvider;
1341
1361
  exports.NavigationContextProvider = NavigationContextProvider;
@@ -1361,6 +1381,7 @@ exports.useEnvironment = useEnvironment;
1361
1381
  exports.useErrorHandler = useErrorHandler;
1362
1382
  exports.useErrorHandlerOrNull = useErrorHandlerOrNull;
1363
1383
  exports.useEventRuntime = useEventRuntime;
1384
+ exports.useExportDataContext = useExportDataContext;
1364
1385
  exports.useFeatureBranchQueryString = useFeatureBranchQueryString;
1365
1386
  exports.useFilterBarContext = useFilterBarContext;
1366
1387
  exports.useHasAccessTo = useHasAccessTo;
package/index.esm.js CHANGED
@@ -274,6 +274,25 @@ const useErrorHandlerOrNull = () => {
274
274
  return useContext(ErrorHandlingContext) || null;
275
275
  };
276
276
 
277
+ const ExportDataContext = createContext(undefined);
278
+ /**
279
+ * This is a hook to use the ExportDataContext.
280
+ *
281
+ * @requires ExportDataContext
282
+ * @example
283
+ * import { useExportDataContext } from "@trackunit/react-core-hooks";
284
+ * const { exportData } = useExportDataContext();
285
+ * // call exportData to export data...
286
+ * @see (@link ExportDataProps)
287
+ */
288
+ const useExportDataContext = () => {
289
+ const context = useContext(ExportDataContext);
290
+ if (context === undefined) {
291
+ throw new Error("useExportDataContext must be used within an ExportDataContext");
292
+ }
293
+ return context;
294
+ };
295
+
277
296
  /**
278
297
  * Fetch any url as a blob and return a blob url.
279
298
  * This is used to get and display logos and images related to Iris Apps.
@@ -1325,4 +1344,4 @@ const useWidgetConfig = () => {
1325
1344
  return result;
1326
1345
  };
1327
1346
 
1328
- export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, 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, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription, useWatch, useWidgetConfig, useWidgetConfigAsync };
1347
+ 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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/react-core-hooks",
3
- "version": "1.7.54",
3
+ "version": "1.7.56",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "engines": {
@@ -10,12 +10,13 @@
10
10
  "react": "19.0.0",
11
11
  "jest-fetch-mock": "^3.0.3",
12
12
  "zod": "^3.23.8",
13
- "@trackunit/react-core-contexts-api": "1.8.50",
14
- "@trackunit/iris-app-runtime-core": "1.8.50",
15
- "@trackunit/shared-utils": "1.9.46",
16
- "@trackunit/react-test-setup": "1.4.46",
13
+ "@trackunit/react-core-contexts-api": "1.8.52",
14
+ "@trackunit/iris-app-runtime-core": "1.8.52",
15
+ "@trackunit/shared-utils": "1.9.47",
16
+ "@trackunit/react-test-setup": "1.4.47",
17
17
  "fflate": "^0.8.2",
18
- "es-toolkit": "^1.39.10"
18
+ "es-toolkit": "^1.39.10",
19
+ "@trackunit/iris-app-runtime-core-api": "1.7.52"
19
20
  },
20
21
  "module": "./index.esm.js",
21
22
  "main": "./index.cjs.js",
@@ -0,0 +1,15 @@
1
+ import { ExportDataRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
2
+ export interface ExportDataContextState extends ExportDataRuntimeApi {
3
+ }
4
+ export declare const ExportDataContext: import("react").Context<ExportDataContextState | undefined>;
5
+ /**
6
+ * This is a hook to use the ExportDataContext.
7
+ *
8
+ * @requires ExportDataContext
9
+ * @example
10
+ * import { useExportDataContext } from "@trackunit/react-core-hooks";
11
+ * const { exportData } = useExportDataContext();
12
+ * // call exportData to export data...
13
+ * @see (@link ExportDataProps)
14
+ */
15
+ export declare const useExportDataContext: () => ExportDataContextState;
package/src/index.d.ts CHANGED
@@ -4,6 +4,7 @@ export * from "./confirmationDialog/ConfirmationDialogProvider";
4
4
  export * from "./encoding/useCustomEncoding";
5
5
  export * from "./environment/EnvironmentContextProvider";
6
6
  export * from "./errorHandling/ErrorHandlingProvider";
7
+ export * from "./exportData/ExportDataContextState";
7
8
  export * from "./fetchAssetBlobUrl";
8
9
  export * from "./filter-bar/FilterBarProvider";
9
10
  export * from "./images/useImageUploader";