@trackunit/react-core-hooks 0.2.51 → 0.2.53

package/index.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var jsxRuntime = require('react/jsx-runtime');
 var React = require('react');
+var jsxRuntime = require('react/jsx-runtime');
 var irisAppRuntimeCore = require('@trackunit/iris-app-runtime-core');
 var reactRouterDom = require('react-router-dom');
 
@@ -30,11 +30,24 @@ function _interopNamespace(e) {
 var React__namespace = /*#__PURE__*/_interopNamespace(React);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 
+const AnalyticsContext = React.createContext(null);
+const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
+/**
+ * Hook to get the analytics context.
+ */
+const useAnalytics = (type) => {
+    const context = React.useContext(AnalyticsContext);
+    if (!context) {
+        throw new Error("useAnalytics must be used within an AnalyticsProvider");
+    }
+    return context;
+};
+
 const AssetSortingContext = React.createContext(null);
 /**
  * This is a provider for the AssetSortingContext.
  */
-const AssetSortingProvider = (props) => jsxRuntime.jsx(AssetSortingContext.Provider, Object.assign({}, props));
+const AssetSortingProvider = AssetSortingContext.Provider;
 /**
  * This is a hook to use the AssetSortingContext.
  */
@@ -288,6 +301,8 @@ const useCurrentUser = () => {
     return context;
 };
 
+exports.AnalyticsContext = AnalyticsContext;
+exports.AnalyticsContextProvider = AnalyticsContextProvider;
 exports.AssetSortingProvider = AssetSortingProvider;
 exports.CurrentUserProvider = CurrentUserProvider;
 exports.EnvironmentContextProvider = EnvironmentContextProvider;
@@ -295,6 +310,7 @@ exports.GlobalSelectionProvider = GlobalSelectionProvider;
 exports.ToastProvider = ToastProvider;
 exports.TokenProvider = TokenProvider;
 exports.UserSubscriptionProvider = UserSubscriptionProvider;
+exports.useAnalytics = useAnalytics;
 exports.useAssetRuntime = useAssetRuntime;
 exports.useAssetSorting = useAssetSorting;
 exports.useCurrentUser = useCurrentUser;

package/index.js

@@ -1,14 +1,27 @@
-import { jsx } from 'react/jsx-runtime';
 import * as React from 'react';
 import React__default, { createContext, useContext, useState, useEffect } from 'react';
+import { jsx } from 'react/jsx-runtime';
 import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { useLocation } from 'react-router-dom';
 
+const AnalyticsContext = createContext(null);
+const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
+/**
+ * Hook to get the analytics context.
+ */
+const useAnalytics = (type) => {
+    const context = useContext(AnalyticsContext);
+    if (!context) {
+        throw new Error("useAnalytics must be used within an AnalyticsProvider");
+    }
+    return context;
+};
+
 const AssetSortingContext = createContext(null);
 /**
  * This is a provider for the AssetSortingContext.
  */
-const AssetSortingProvider = (props) => jsx(AssetSortingContext.Provider, Object.assign({}, props));
+const AssetSortingProvider = AssetSortingContext.Provider;
 /**
  * This is a hook to use the AssetSortingContext.
  */
@@ -262,4 +275,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AssetSortingProvider, CurrentUserProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useGlobalSelection, useNavigationRuntime, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useGlobalSelection, useNavigationRuntime, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.51",
+  "version": "0.2.53",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -8,9 +8,9 @@
   "type": "module",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core": "0.3.38",
-    "@trackunit/iris-app-runtime-core-api": "0.3.32",
-    "@trackunit/react-core-contexts-api": "0.2.29",
+    "@trackunit/iris-app-runtime-core": "0.3.40",
+    "@trackunit/iris-app-runtime-core-api": "0.3.34",
+    "@trackunit/react-core-contexts-api": "0.2.31",
     "react": "18.2.0",
     "react-router-dom": "6.4.5"
   },

package/src/analytics/AnalyticsProvider.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { BaseEvent, Event, IAnalyticsContext, UnspecifiedEvent } from "@trackunit/react-core-contexts-api";
+export declare const AnalyticsContext: import("react").Context<IAnalyticsContext<{}> | null>;
+export declare const AnalyticsContextProvider: import("react").Provider<IAnalyticsContext<{}> | null>;
+/**
+ * Hook to get the analytics context.
+ */
+export declare const useAnalytics: <T extends Record<string, Event<BaseEvent | UnspecifiedEvent>>>(type: T) => IAnalyticsContext<T>;

package/src/assetSorting/AssetSortingProvider.d.ts

@@ -1,15 +1,10 @@
 /// <reference types="react" />
 import { IAssetSortingContext } from "@trackunit/react-core-contexts-api";
-interface Props {
-    children?: React.ReactNode;
-    value: IAssetSortingContext;
-}
 /**
  * This is a provider for the AssetSortingContext.
  */
-export declare const AssetSortingProvider: (props: Props) => JSX.Element;
+export declare const AssetSortingProvider: import("react").Provider<IAssetSortingContext | null>;
 /**
  * This is a hook to use the AssetSortingContext.
  */
 export declare const useAssetSorting: () => IAssetSortingContext;
-export {};

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./analytics/AnalyticsProvider";
 export * from "./assetSorting/AssetSortingProvider";
 export * from "./environment/EnvironmentContextProvider";
 export * from "./global-selection/GlobalSelectionProvider";