@trackunit/react-core-hooks 0.2.64 → 0.2.66

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.64",
+  "version": "0.2.66",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -11,11 +11,11 @@
   "type": "module",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core": "0.3.50",
-    "@trackunit/iris-app-runtime-core-api": "0.3.44",
-    "@trackunit/react-core-contexts-api": "0.2.40",
+    "@trackunit/iris-app-runtime-core": "0.3.52",
+    "@trackunit/iris-app-runtime-core-api": "0.3.46",
+    "@trackunit/react-core-contexts-api": "0.2.42",
     "react": "18.2.0",
-    "react-router-dom": "6.4.5"
+    "react-router-dom": "6.11.2"
   },
   "peerDependencies": {}
 }

package/src/analytics/AnalyticsProvider.d.ts

@@ -1,23 +1,23 @@
-/// <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.
- *
- * @requires AnalyticsProvider
- * @example
- * import { useAnalytics, useEnvironment } from "@trackunit/react-core-hooks";
- * const { logPageView, logEvent } = useAnalytics(AllEvents);
- *
- * // log page view event
- * useEffect(() => {
- *   logPageView({ pageName: "login" });
- * }, [logPageView]);
- *
- * // log event when appropriate
- * logEvent("Login", { loginPage: "New Manager" });
- *
- * @see {@link IAnalyticsContext}
- */
-export declare const useAnalytics: <T extends Record<string, Event<BaseEvent | UnspecifiedEvent>>>(type: T) => IAnalyticsContext<T>;
+/// <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.
+ *
+ * @requires AnalyticsProvider
+ * @example
+ * import { useAnalytics, useEnvironment } from "@trackunit/react-core-hooks";
+ * const { logPageView, logEvent } = useAnalytics(AllEvents);
+ *
+ * // log page view event
+ * useEffect(() => {
+ *   logPageView({ pageName: "login" });
+ * }, [logPageView]);
+ *
+ * // log event when appropriate
+ * logEvent("Login", { loginPage: "New Manager" });
+ *
+ * @see {@link IAnalyticsContext}
+ */
+export declare const useAnalytics: <T extends Record<string, Event<BaseEvent | UnspecifiedEvent>>>(type: T) => IAnalyticsContext<T>;

package/src/assetSorting/AssetSortingProvider.d.ts

@@ -1,36 +1,36 @@
-/// <reference types="react" />
-import { IAssetSortingContext } from "@trackunit/react-core-contexts-api";
-/**
- * This is a provider for the AssetSortingContext.
- */
-export declare const AssetSortingProvider: import("react").Provider<IAssetSortingContext | null>;
-/**
- * This is a hook to use the AssetSortingContext.
- *
- * @requires AssetSortingProvider
- * @example
- * import { useAssetSorting } from "@trackunit/react-core-hooks";
- * const { sortingState, setSortBy } = useAssetSorting();
- *
- * const initialSort = useMemo(
- *   () => ({
- *     property: {
- *       label: sortingState.sortBy,
- *       value: sortingState.sortBy,
- *     },
- *     order: sortingState.order,
- *   }),
- *   [sortingState]
- * );
- *
- * return (
- *   <Table
- *     ...
- *     headerOnSort={setSortBy}
- *     headerInitialSort={initialSort}
- *   />
- * );
- *
- * @see {@link IAssetSortingContext}
- */
-export declare const useAssetSorting: () => IAssetSortingContext;
+/// <reference types="react" />
+import { IAssetSortingContext } from "@trackunit/react-core-contexts-api";
+/**
+ * This is a provider for the AssetSortingContext.
+ */
+export declare const AssetSortingProvider: import("react").Provider<IAssetSortingContext | null>;
+/**
+ * This is a hook to use the AssetSortingContext.
+ *
+ * @requires AssetSortingProvider
+ * @example
+ * import { useAssetSorting } from "@trackunit/react-core-hooks";
+ * const { sortingState, setSortBy } = useAssetSorting();
+ *
+ * const initialSort = useMemo(
+ *   () => ({
+ *     property: {
+ *       label: sortingState.sortBy,
+ *       value: sortingState.sortBy,
+ *     },
+ *     order: sortingState.order,
+ *   }),
+ *   [sortingState]
+ * );
+ *
+ * return (
+ *   <Table
+ *     ...
+ *     headerOnSort={setSortBy}
+ *     headerInitialSort={initialSort}
+ *   />
+ * );
+ *
+ * @see {@link IAssetSortingContext}
+ */
+export declare const useAssetSorting: () => IAssetSortingContext;

package/src/environment/EnvironmentContextProvider.d.ts

@@ -1,23 +1,23 @@
-/// <reference types="react" />
-import { IEnvironmentContext } from "@trackunit/react-core-contexts-api";
-interface IProps {
-    value: IEnvironmentContext;
-    children?: React.ReactNode;
-}
-/**
- * This is a provider for the EnvironmentContext.
- */
-export declare const EnvironmentContextProvider: (props: IProps) => JSX.Element;
-/**
- * This is a hook to use the EnvironmentContext.
- *
- * @requires EnvironmentContext
- * @example
- * import { useEnvironment } from "@trackunit/react-core-hooks";
- * const { googleMapsApiKey } = useEnvironment();
- * // use api key for something...
- *
- * @see (@link IEnvironmentContext)
- */
-export declare const useEnvironment: () => IEnvironmentContext;
-export {};
+/// <reference types="react" />
+import { IEnvironmentContext } from "@trackunit/react-core-contexts-api";
+interface IProps {
+    value: IEnvironmentContext;
+    children?: React.ReactNode;
+}
+/**
+ * This is a provider for the EnvironmentContext.
+ */
+export declare const EnvironmentContextProvider: (props: IProps) => JSX.Element;
+/**
+ * This is a hook to use the EnvironmentContext.
+ *
+ * @requires EnvironmentContext
+ * @example
+ * import { useEnvironment } from "@trackunit/react-core-hooks";
+ * const { googleMapsApiKey } = useEnvironment();
+ * // use api key for something...
+ *
+ * @see (@link IEnvironmentContext)
+ */
+export declare const useEnvironment: () => IEnvironmentContext;
+export {};

package/src/global-selection/GlobalSelectionProvider.d.ts

@@ -1,26 +1,26 @@
-import { IGlobalSelectionContext } from "@trackunit/react-core-contexts-api";
-import * as React from "react";
-/**
- * This is a hook to use the GlobalSelectionContext.
- *
- * @requires GlobalSelectionProvider
- * @example
- * import { useGlobalSelection } from "@trackunit/react-core-hooks";
- *
- * export const useActiveGlobalGroupIdFilter = () => {
- *   const { selection } = useGlobalSelection();
- *   return (selection?.type === "group") ? selection.groupId : undefined;
- * };
- *
- * @see {@link IGlobalSelectionContext}
- */
-export declare const useGlobalSelection: () => IGlobalSelectionContext;
-interface IProps {
-    value: IGlobalSelectionContext;
-    children?: React.ReactNode;
-}
-/**
- * This is a provider for the GlobalSelectionContext.
- */
-export declare const GlobalSelectionProvider: (props: IProps) => JSX.Element;
-export {};
+import { IGlobalSelectionContext } from "@trackunit/react-core-contexts-api";
+import * as React from "react";
+/**
+ * This is a hook to use the GlobalSelectionContext.
+ *
+ * @requires GlobalSelectionProvider
+ * @example
+ * import { useGlobalSelection } from "@trackunit/react-core-hooks";
+ *
+ * export const useActiveGlobalGroupIdFilter = () => {
+ *   const { selection } = useGlobalSelection();
+ *   return (selection?.type === "group") ? selection.groupId : undefined;
+ * };
+ *
+ * @see {@link IGlobalSelectionContext}
+ */
+export declare const useGlobalSelection: () => IGlobalSelectionContext;
+interface IProps {
+    value: IGlobalSelectionContext;
+    children?: React.ReactNode;
+}
+/**
+ * This is a provider for the GlobalSelectionContext.
+ */
+export declare const GlobalSelectionProvider: (props: IProps) => JSX.Element;
+export {};

package/src/index.d.ts

@@ -1,16 +1,16 @@
-export * from "./analytics/AnalyticsProvider";
-export * from "./assetSorting/AssetSortingProvider";
-export * from "./environment/EnvironmentContextProvider";
-export * from "./global-selection/GlobalSelectionProvider";
-export * from "./irisOemApp/IrisOemAppContextProvider";
-export * from "./runtimes/navigation";
-export * from "./runtimes/navigation/useNavigationRuntime";
-export * from "./runtimes/useAssetRuntime";
-export * from "./runtimes/useCustomFieldRuntime";
-export * from "./runtimes/useCustomFieldRuntimeForEntity";
-export * from "./runtimes/useRestRuntime";
-export * from "./runtimes/useSiteRuntime";
-export * from "./subscription/UserSubscriptionProvider";
-export * from "./toast/ToastProvider";
-export * from "./token/TokenProvider";
-export * from "./user/CurrentUserProvider";
+export * from "./analytics/AnalyticsProvider";
+export * from "./assetSorting/AssetSortingProvider";
+export * from "./environment/EnvironmentContextProvider";
+export * from "./global-selection/GlobalSelectionProvider";
+export * from "./irisOemApp/IrisOemAppContextProvider";
+export * from "./runtimes/navigation";
+export * from "./runtimes/navigation/useNavigationRuntime";
+export * from "./runtimes/useAssetRuntime";
+export * from "./runtimes/useCustomFieldRuntime";
+export * from "./runtimes/useCustomFieldRuntimeForEntity";
+export * from "./runtimes/useRestRuntime";
+export * from "./runtimes/useSiteRuntime";
+export * from "./subscription/UserSubscriptionProvider";
+export * from "./toast/ToastProvider";
+export * from "./token/TokenProvider";
+export * from "./user/CurrentUserProvider";

package/src/irisOemApp/IrisOemAppContextProvider.d.ts

@@ -1,24 +1,24 @@
-/// <reference types="react" />
-import { IOemBrandingContext } from "@trackunit/react-core-contexts-api";
-/**
- * This is a hook to use the IOemBrandingContext.
- *
- * @requires OemBrandingContextProvider
- * @example
- * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
- * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
- * // use oem branding
- * const branding = getOemBranding("some brand")
- *
- * @see {@link IOemBrandingContext}
- */
-export declare const useOemBrandingContext: () => IOemBrandingContext;
-interface IProps {
-    value: IOemBrandingContext;
-    children?: React.ReactNode;
-}
-/**
- * This is a provider for the IOemBrandingContext.
- */
-export declare const OemBrandingContextProvider: (props: IProps) => JSX.Element;
-export {};
+/// <reference types="react" />
+import { IOemBrandingContext } from "@trackunit/react-core-contexts-api";
+/**
+ * This is a hook to use the IOemBrandingContext.
+ *
+ * @requires OemBrandingContextProvider
+ * @example
+ * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
+ * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
+ * // use oem branding
+ * const branding = getOemBranding("some brand")
+ *
+ * @see {@link IOemBrandingContext}
+ */
+export declare const useOemBrandingContext: () => IOemBrandingContext;
+interface IProps {
+    value: IOemBrandingContext;
+    children?: React.ReactNode;
+}
+/**
+ * This is a provider for the IOemBrandingContext.
+ */
+export declare const OemBrandingContextProvider: (props: IProps) => JSX.Element;
+export {};

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

@@ -1 +1 @@
-export * from "./useURLSynchronization";
+export * from "./useURLSynchronization";

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

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

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

@@ -1,17 +1,17 @@
-import { INavigationRuntime } from "@trackunit/iris-app-runtime-core";
-export interface UseNavigationRuntime extends INavigationRuntime {
-}
-/**
- * A hook to expose navigation runtime for React components
- *
- * @requires NavigationRuntime
- * @returns {UseNavigationRuntime} navigationRuntime
- * @example
- * import { useNavigationRuntime } from "@trackunit/react-core-hooks";
- * const { navigateTo } = useNavigationRuntime();
- * // ...
- * <Link onClick={() => gotoAssetHome(asset.id)} to="">
- *   {asset.name}
- * </Link>
- */
-export declare const useNavigationRuntime: () => UseNavigationRuntime;
+import { INavigationRuntime } from "@trackunit/iris-app-runtime-core";
+export interface UseNavigationRuntime extends INavigationRuntime {
+}
+/**
+ * A hook to expose navigation runtime for React components
+ *
+ * @requires NavigationRuntime
+ * @returns {UseNavigationRuntime} navigationRuntime
+ * @example
+ * import { useNavigationRuntime } from "@trackunit/react-core-hooks";
+ * const { navigateTo } = useNavigationRuntime();
+ * // ...
+ * <Link onClick={() => gotoAssetHome(asset.id)} to="">
+ *   {asset.name}
+ * </Link>
+ */
+export declare const useNavigationRuntime: () => UseNavigationRuntime;

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

@@ -1,4 +1,4 @@
-/**
- * A react hook for notifying host about location changes
- */
-export declare const useURLSynchronization: () => void;
+/**
+ * A react hook for notifying host about location changes
+ */
+export declare const useURLSynchronization: () => void;

package/src/runtimes/useAssetRuntime.d.ts

@@ -1,22 +1,22 @@
-import { AssetInfo } from "@trackunit/iris-app-runtime-core";
-export interface UseAssetRuntime {
-    assetInfo: AssetInfo | undefined;
-}
-/**
- * A hook to expose asset runtime for React components
- *
- * @requires AssetRuntime
- * @returns {UseAssetRuntime} assetRuntime
- * @example
- * import { useAssetRuntime } from "@trackunit/react-core-hooks";
- * const { assetInfo } = useAssetRuntime();
- * useEffect(() => {
- *   (async () => {
- *     if (assetInfo) {
- *       getAssetLocation({ variables: { id: assetInfo.assetId } });
- *     }
- *   })();
- * }, [assetInfo, getAssetLocation]);
- *
- */
-export declare const useAssetRuntime: () => UseAssetRuntime;
+import { AssetInfo } from "@trackunit/iris-app-runtime-core";
+export interface UseAssetRuntime {
+    assetInfo: AssetInfo | undefined;
+}
+/**
+ * A hook to expose asset runtime for React components
+ *
+ * @requires AssetRuntime
+ * @returns {UseAssetRuntime} assetRuntime
+ * @example
+ * import { useAssetRuntime } from "@trackunit/react-core-hooks";
+ * const { assetInfo } = useAssetRuntime();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (assetInfo) {
+ *       getAssetLocation({ variables: { id: assetInfo.assetId } });
+ *     }
+ *   })();
+ * }, [assetInfo, getAssetLocation]);
+ *
+ */
+export declare const useAssetRuntime: () => UseAssetRuntime;

package/src/runtimes/useCustomFieldRuntime.d.ts

@@ -1,9 +1,9 @@
-import { ICustomFieldRuntime } from "@trackunit/iris-app-runtime-core";
-export interface UseCustomFieldRuntime extends ICustomFieldRuntime {
-}
-/**
- * A hook to expose custom field runtime methods
- *
- * @returns {UseCustomFieldRuntime} CustomFieldRuntime
- */
-export declare const useCustomFieldRuntime: () => UseCustomFieldRuntime;
+import { ICustomFieldRuntime } from "@trackunit/iris-app-runtime-core";
+export interface UseCustomFieldRuntime extends ICustomFieldRuntime {
+}
+/**
+ * A hook to expose custom field runtime methods
+ *
+ * @returns {UseCustomFieldRuntime} CustomFieldRuntime
+ */
+export declare const useCustomFieldRuntime: () => UseCustomFieldRuntime;

package/src/runtimes/useCustomFieldRuntimeForEntity.d.ts

@@ -1,23 +1,23 @@
-import { ValueAndDefinition } from "@trackunit/iris-app-runtime-core";
-import { EntityIdentity, ValueAndDefinitionKey } from "@trackunit/iris-app-runtime-core-api";
-/**
- * This hook is a wrapper around useCustomFieldRuntime that automatically fetches and sets custom fields for a given entity.
- *
- * @param entity The entity to fetch and set custom fields for.
- * @returns The custom fields for the entity, and functions to set custom fields for the entity.
- * @example
- * import { useAssetRuntime, useCustomFieldRuntimeForEntity } from '@trackunit/react-core-hooks';
- * const { assetInfo } = useAssetRuntime();
- * const { customFields, setCustomFieldsForEntity } = useCustomFieldRuntimeForEntity( {
- *   id: assetInfo?.assetId || '',
- *   type: 'ASSET'
- * });
- *
- * // set custom field data
- * setCustomFieldsForEntity({"key": "value"});
- */
-export declare const useCustomFieldRuntimeForEntity: (entity: EntityIdentity) => {
-    customFields: ValueAndDefinition[] | undefined;
-    setCustomFieldsFromFormDataForEntity: (formData: Record<string, boolean | string | string[] | number>) => Promise<void>;
-    setCustomFieldsForEntity: (values: ValueAndDefinitionKey[]) => Promise<void>;
-};
+import { ValueAndDefinition } from "@trackunit/iris-app-runtime-core";
+import { EntityIdentity, ValueAndDefinitionKey } from "@trackunit/iris-app-runtime-core-api";
+/**
+ * This hook is a wrapper around useCustomFieldRuntime that automatically fetches and sets custom fields for a given entity.
+ *
+ * @param entity The entity to fetch and set custom fields for.
+ * @returns The custom fields for the entity, and functions to set custom fields for the entity.
+ * @example
+ * import { useAssetRuntime, useCustomFieldRuntimeForEntity } from '@trackunit/react-core-hooks';
+ * const { assetInfo } = useAssetRuntime();
+ * const { customFields, setCustomFieldsForEntity } = useCustomFieldRuntimeForEntity( {
+ *   id: assetInfo?.assetId || '',
+ *   type: 'ASSET'
+ * });
+ *
+ * // set custom field data
+ * setCustomFieldsForEntity({"key": "value"});
+ */
+export declare const useCustomFieldRuntimeForEntity: (entity: EntityIdentity) => {
+    customFields: ValueAndDefinition[] | undefined;
+    setCustomFieldsFromFormDataForEntity: (formData: Record<string, boolean | string | string[] | number>) => Promise<void>;
+    setCustomFieldsForEntity: (values: ValueAndDefinitionKey[]) => Promise<void>;
+};

package/src/runtimes/useRestRuntime.d.ts

@@ -1,10 +1,10 @@
-import { IRestRuntime } from "@trackunit/iris-app-runtime-core";
-interface UseRestRuntime extends IRestRuntime {
-}
-/**
- * A hook to expose rest runtime to be used in React components
- *
- * @returns {UseRestRuntime} a RestRuntime
- */
-export declare const useRestRuntime: () => UseRestRuntime;
-export {};
+import { IRestRuntime } from "@trackunit/iris-app-runtime-core";
+interface UseRestRuntime extends IRestRuntime {
+}
+/**
+ * A hook to expose rest runtime to be used in React components
+ *
+ * @returns {UseRestRuntime} a RestRuntime
+ */
+export declare const useRestRuntime: () => UseRestRuntime;
+export {};

package/src/runtimes/useSiteRuntime.d.ts

@@ -1,23 +1,23 @@
-import { SiteInfo } from "@trackunit/iris-app-runtime-core";
-export interface UseSiteRuntime {
-    siteInfo?: SiteInfo;
-}
-/**
- * A hook to expose site runtime for React components
- *
- * @requires SiteRuntime
- * @returns {UseSiteRuntime} siteRuntime
- * @example
- * import { useSiteRuntime } from "@trackunit/react-core-hooks";
- * const { siteInfo } = useSiteRuntime();
- * // use siteInfo to get assets for instance.
- * useEffect(() => {
- *   (async () => {
- *     if (siteInfo?.siteId) {
- *       getSiteAssets({ variables: { siteId: siteInfo?.siteId, siteIdStr: siteInfo?.siteId } });
- *     }
- *   })();
- * }, [getSiteAssets, siteInfo]);
- *
- */
-export declare const useSiteRuntime: () => UseSiteRuntime;
+import { SiteInfo } from "@trackunit/iris-app-runtime-core";
+export interface UseSiteRuntime {
+    siteInfo?: SiteInfo;
+}
+/**
+ * A hook to expose site runtime for React components
+ *
+ * @requires SiteRuntime
+ * @returns {UseSiteRuntime} siteRuntime
+ * @example
+ * import { useSiteRuntime } from "@trackunit/react-core-hooks";
+ * const { siteInfo } = useSiteRuntime();
+ * // use siteInfo to get assets for instance.
+ * useEffect(() => {
+ *   (async () => {
+ *     if (siteInfo?.siteId) {
+ *       getSiteAssets({ variables: { siteId: siteInfo?.siteId, siteIdStr: siteInfo?.siteId } });
+ *     }
+ *   })();
+ * }, [getSiteAssets, siteInfo]);
+ *
+ */
+export declare const useSiteRuntime: () => UseSiteRuntime;

package/src/subscription/UserSubscriptionProvider.d.ts

@@ -1,24 +1,24 @@
-import { IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
-import * as React from "react";
-interface IProps {
-    value: IUserSubscriptionContext;
-    children?: React.ReactNode;
-}
-/**
- * This is a provider for the UserSubscriptionContext.
- */
-export declare const UserSubscriptionProvider: (props: IProps) => JSX.Element;
-/**
- * This is a hook to use the UserSubscriptionContext.
- *
- * @requires UserSubscriptionProvider
- * @example
- * import { useUserSubscription } from "@trackunit/react-core-hooks";
- * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
- * // use it for something
- * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
- *
- * @see {@link IUserSubscriptionContext}
- */
-export declare const useUserSubscription: () => IUserSubscriptionContext;
-export {};
+import { IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
+import * as React from "react";
+interface IProps {
+    value: IUserSubscriptionContext;
+    children?: React.ReactNode;
+}
+/**
+ * This is a provider for the UserSubscriptionContext.
+ */
+export declare const UserSubscriptionProvider: (props: IProps) => JSX.Element;
+/**
+ * This is a hook to use the UserSubscriptionContext.
+ *
+ * @requires UserSubscriptionProvider
+ * @example
+ * import { useUserSubscription } from "@trackunit/react-core-hooks";
+ * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
+ * // use it for something
+ * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
+ *
+ * @see {@link IUserSubscriptionContext}
+ */
+export declare const useUserSubscription: () => IUserSubscriptionContext;
+export {};