@trackunit/react-core-hooks 0.2.169 → 0.2.171

package/index.cjs.js

@@ -5,11 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var React = require('react');
 var jsxRuntime = require('react/jsx-runtime');
 var irisAppRuntimeCore = require('@trackunit/iris-app-runtime-core');
-var reactRouterDom = require('react-router-dom');
 var sharedUtils = require('@trackunit/shared-utils');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
 function _interopNamespace(e) {
   if (e && e.__esModule) return e;
   var n = Object.create(null);
@@ -29,7 +26,6 @@ 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
@@ -274,22 +270,6 @@ const useHasAccessTo = (options) => {
     return { hasAccess };
 };
 
-/**
- * A react hook for notifying host about location changes
- */
-const useURLSynchronization = () => {
-    const location = reactRouterDom.useLocation();
-    React__default["default"].useEffect(() => {
-        const deepLink = {
-            path: location.pathname,
-            search: location.search,
-            hash: location.hash,
-            pathname: "",
-        };
-        irisAppRuntimeCore.NavigationRuntime.setDeepLink(deepLink);
-    }, [location]);
-};
-
 /**
  * A hook to expose asset runtime for React components
  *
@@ -328,61 +308,6 @@ const useAssetRuntime = () => {
     return { assetInfo, loading, error };
 };
 
-/**
- * A hook to expose custom field runtime methods
- *
- * @returns {UseCustomFieldRuntime} CustomFieldRuntime
- */
-const useCustomFieldRuntime = () => {
-    return irisAppRuntimeCore.CustomFieldRuntime;
-};
-
-/**
- * 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"});
- */
-const useCustomFieldRuntimeForEntity = (entity) => {
-    const { getCustomFieldsFor, setCustomFieldsFromFormData, setCustomFieldsFor } = useCustomFieldRuntime();
-    const [customFields, setCustomFields] = React.useState();
-    React.useEffect(() => {
-        if (entity.id) {
-            (() => __awaiter(void 0, void 0, void 0, function* () {
-                setCustomFields(yield getCustomFieldsFor(entity));
-            }))();
-        }
-        else {
-            setCustomFields([]);
-        }
-    }, [entity, getCustomFieldsFor]);
-    const setCustomFieldsForEntity = (values) => __awaiter(void 0, void 0, void 0, function* () {
-        if (entity.id) {
-            yield setCustomFieldsFor(entity, values);
-        }
-    });
-    const setCustomFieldsFromFormDataForEntity = (formData) => __awaiter(void 0, void 0, void 0, function* () {
-        if (entity.id) {
-            yield setCustomFieldsFromFormData(entity, formData, customFields || []);
-        }
-    });
-    return {
-        customFields,
-        setCustomFieldsFromFormDataForEntity,
-        setCustomFieldsForEntity,
-    };
-};
-
 /**
  * A hook to expose event runtime for React components
  *
@@ -422,6 +347,44 @@ const useEventRuntime = () => {
     return { eventInfo, loading, error };
 };
 
+/**
+ * A hook to expose getIrisAppName for React components
+ *
+ * @requires ParamsRuntime
+ * @returns {UseIrisAppName} appName, loading, error
+ * @example
+ * import { useIrisAppName } from "@trackunit/react-core-hooks";
+ * const { appName } = useIrisAppName();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (appName) {
+ *       // do something with appName
+ *     }
+ *   })();
+ * }, [appName]);
+ */
+const useIrisAppName = () => {
+    const [appName, setAppName] = React.useState();
+    const [loading, setLoading] = React.useState(true);
+    const [error, setError] = React.useState();
+    React.useEffect(() => {
+        const getAppName = () => __awaiter(void 0, void 0, void 0, function* () {
+            setLoading(true);
+            try {
+                const updatedAppName = yield irisAppRuntimeCore.ParamsRuntime.getAppName();
+                setLoading(false);
+                setAppName(updatedAppName);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get iris app name"));
+            }
+        });
+        getAppName();
+    }, []);
+    return { appName, loading, error };
+};
+
 /**
  * A hook to expose site runtime for React components
  *
@@ -693,17 +656,15 @@ exports.useCurrentUser = useCurrentUser;
 exports.useCurrentUserLanguage = useCurrentUserLanguage;
 exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
 exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
-exports.useCustomFieldRuntime = useCustomFieldRuntime;
-exports.useCustomFieldRuntimeForEntity = useCustomFieldRuntimeForEntity;
 exports.useEnvironment = useEnvironment;
 exports.useEventRuntime = useEventRuntime;
 exports.useFilterBarContext = useFilterBarContext;
 exports.useHasAccessTo = useHasAccessTo;
+exports.useIrisAppName = useIrisAppName;
 exports.useNavigateInHost = useNavigateInHost;
 exports.useOemBrandingContext = useOemBrandingContext;
 exports.useSiteRuntime = useSiteRuntime;
 exports.useTextSearch = useTextSearch;
 exports.useToast = useToast;
 exports.useToken = useToken;
-exports.useURLSynchronization = useURLSynchronization;
 exports.useUserSubscription = useUserSubscription;

package/index.esm.js

@@ -1,8 +1,7 @@
 import * as React from 'react';
-import React__default, { createContext, useContext, useState, useEffect, useMemo } from 'react';
+import { createContext, useContext, useState, useEffect, useMemo } from 'react';
 import { jsx } from 'react/jsx-runtime';
-import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, EventRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
-import { useLocation } from 'react-router-dom';
+import { AssetRuntime, EventRuntime, ParamsRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { filterByMultiple } from '@trackunit/shared-utils';
 
 const AnalyticsContext = createContext(null);
@@ -248,22 +247,6 @@ const useHasAccessTo = (options) => {
     return { hasAccess };
 };
 
-/**
- * A react hook for notifying host about location changes
- */
-const useURLSynchronization = () => {
-    const location = useLocation();
-    React__default.useEffect(() => {
-        const deepLink = {
-            path: location.pathname,
-            search: location.search,
-            hash: location.hash,
-            pathname: "",
-        };
-        NavigationRuntime.setDeepLink(deepLink);
-    }, [location]);
-};
-
 /**
  * A hook to expose asset runtime for React components
  *
@@ -302,61 +285,6 @@ const useAssetRuntime = () => {
     return { assetInfo, loading, error };
 };
 
-/**
- * A hook to expose custom field runtime methods
- *
- * @returns {UseCustomFieldRuntime} CustomFieldRuntime
- */
-const useCustomFieldRuntime = () => {
-    return CustomFieldRuntime;
-};
-
-/**
- * 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"});
- */
-const useCustomFieldRuntimeForEntity = (entity) => {
-    const { getCustomFieldsFor, setCustomFieldsFromFormData, setCustomFieldsFor } = useCustomFieldRuntime();
-    const [customFields, setCustomFields] = useState();
-    useEffect(() => {
-        if (entity.id) {
-            (() => __awaiter(void 0, void 0, void 0, function* () {
-                setCustomFields(yield getCustomFieldsFor(entity));
-            }))();
-        }
-        else {
-            setCustomFields([]);
-        }
-    }, [entity, getCustomFieldsFor]);
-    const setCustomFieldsForEntity = (values) => __awaiter(void 0, void 0, void 0, function* () {
-        if (entity.id) {
-            yield setCustomFieldsFor(entity, values);
-        }
-    });
-    const setCustomFieldsFromFormDataForEntity = (formData) => __awaiter(void 0, void 0, void 0, function* () {
-        if (entity.id) {
-            yield setCustomFieldsFromFormData(entity, formData, customFields || []);
-        }
-    });
-    return {
-        customFields,
-        setCustomFieldsFromFormDataForEntity,
-        setCustomFieldsForEntity,
-    };
-};
-
 /**
  * A hook to expose event runtime for React components
  *
@@ -396,6 +324,44 @@ const useEventRuntime = () => {
     return { eventInfo, loading, error };
 };
 
+/**
+ * A hook to expose getIrisAppName for React components
+ *
+ * @requires ParamsRuntime
+ * @returns {UseIrisAppName} appName, loading, error
+ * @example
+ * import { useIrisAppName } from "@trackunit/react-core-hooks";
+ * const { appName } = useIrisAppName();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (appName) {
+ *       // do something with appName
+ *     }
+ *   })();
+ * }, [appName]);
+ */
+const useIrisAppName = () => {
+    const [appName, setAppName] = useState();
+    const [loading, setLoading] = useState(true);
+    const [error, setError] = useState();
+    useEffect(() => {
+        const getAppName = () => __awaiter(void 0, void 0, void 0, function* () {
+            setLoading(true);
+            try {
+                const updatedAppName = yield ParamsRuntime.getAppName();
+                setLoading(false);
+                setAppName(updatedAppName);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get iris app name"));
+            }
+        });
+        getAppName();
+    }, []);
+    return { appName, loading, error };
+};
+
 /**
  * A hook to expose site runtime for React components
  *
@@ -646,4 +612,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useEventRuntime, useFilterBarContext, useHasAccessTo, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useEnvironment, useEventRuntime, useFilterBarContext, useHasAccessTo, useIrisAppName, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.169",
+  "version": "0.2.171",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,8 +10,6 @@
     "@trackunit/react-core-contexts-api": "*",
     "react": "^18.2.0",
     "@trackunit/iris-app-runtime-core": "*",
-    "react-router-dom": "6.18.0",
-    "@trackunit/iris-app-runtime-core-api": "*",
     "jest-fetch-mock": "^3.0.3",
     "@trackunit/shared-utils": "*"
   },

package/src/index.d.ts

@@ -5,11 +5,9 @@ export * from "./environment/EnvironmentContextProvider";
 export * from "./filter-bar/FilterBarProvider";
 export * from "./irisOemApp/IrisOemAppContextProvider";
 export * from "./navigation/NavigationContextProvider";
-export * from "./navigation/useURLSynchronization";
 export * from "./runtimes/useAssetRuntime";
-export * from "./runtimes/useCustomFieldRuntime";
-export * from "./runtimes/useCustomFieldRuntimeForEntity";
 export * from "./runtimes/useEventRuntime";
+export * from "./runtimes/useParamsRuntime";
 export * from "./runtimes/useSiteRuntime";
 export * from "./subscription/UserSubscriptionProvider";
 export * from "./toast/ToastProvider";

package/src/runtimes/useParamsRuntime.d.ts

@@ -0,0 +1,22 @@
+export interface UseIrisAppName {
+    appName: string | undefined;
+    loading: boolean;
+    error: Error | undefined;
+}
+/**
+ * A hook to expose getIrisAppName for React components
+ *
+ * @requires ParamsRuntime
+ * @returns {UseIrisAppName} appName, loading, error
+ * @example
+ * import { useIrisAppName } from "@trackunit/react-core-hooks";
+ * const { appName } = useIrisAppName();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (appName) {
+ *       // do something with appName
+ *     }
+ *   })();
+ * }, [appName]);
+ */
+export declare const useIrisAppName: () => UseIrisAppName;

package/src/navigation/useURLSynchronization.d.ts

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

package/src/runtimes/useCustomFieldRuntime.d.ts

@@ -1,9 +0,0 @@
-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 +0,0 @@
-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>;
-};