@trackunit/react-core-hooks 0.2.45 → 0.2.46

package/index.cjs

@@ -188,6 +188,42 @@ 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.
+ */
+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 rest runtime to be used in React components
  *
@@ -297,6 +333,7 @@ exports.useAssetRuntime = useAssetRuntime;
 exports.useAssetSorting = useAssetSorting;
 exports.useCurrentUser = useCurrentUser;
 exports.useCustomFieldRuntime = useCustomFieldRuntime;
+exports.useCustomFieldRuntimeForEntity = useCustomFieldRuntimeForEntity;
 exports.useDeveloperSettings = useDeveloperSettings;
 exports.useEnvironment = useEnvironment;
 exports.useGlobalSelection = useGlobalSelection;

package/index.js

@@ -162,6 +162,42 @@ 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.
+ */
+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 rest runtime to be used in React components
  *
@@ -258,4 +294,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AssetSortingProvider, CurrentUserProvider, DeveloperSettingsContext, DeveloperSettingsProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useDeveloperSettings, useEnvironment, useGlobalSelection, useNavigationRuntime, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AssetSortingProvider, CurrentUserProvider, DeveloperSettingsContext, DeveloperSettingsProvider, EnvironmentContextProvider, GlobalSelectionProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useDeveloperSettings, useEnvironment, useGlobalSelection, useNavigationRuntime, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.45",
+  "version": "0.2.46",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -8,8 +8,8 @@
   "type": "module",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core": "0.3.32",
-    "@trackunit/iris-app-runtime-core-api": "0.3.27",
+    "@trackunit/iris-app-runtime-core": "0.3.33",
+    "@trackunit/iris-app-runtime-core-api": "0.3.28",
     "@trackunit/react-core-contexts-api": "0.2.26",
     "react": "18.2.0",
     "react-router-dom": "6.4.5"

package/src/index.d.ts

@@ -6,6 +6,7 @@ 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";