@trackunit/react-core-hooks 0.2.35-alpha-beca370860.0 → 0.2.38

package/index.cjs

@@ -31,7 +31,13 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 
 const AssetSortingContext = React.createContext(null);
+/**
+ * This is a provider for the AssetSortingContext.
+ */
 const AssetSortingProvider = (props) => jsxRuntime.jsx(AssetSortingContext.Provider, Object.assign({}, props));
+/**
+ * This is a hook to use the AssetSortingContext.
+ */
 const useAssetSorting = () => {
     const context = React.useContext(AssetSortingContext);
     if (!context) {
@@ -43,6 +49,9 @@ const useAssetSorting = () => {
 const DeveloperSettingsContext = React__namespace.createContext({
     localFeatureFlagsEnabled: false,
 });
+/**
+ * This is a hook to use the DeveloperSettingsContext.
+ */
 const useDeveloperSettings = () => {
     const context = React__namespace.useContext(DeveloperSettingsContext);
     if (!context) {
@@ -50,6 +59,9 @@ const useDeveloperSettings = () => {
     }
     return context;
 };
+/**
+ * This is the provider for Developer Settings
+ */
 const DeveloperSettingsProvider = ({ value, children }) => {
     const [localFeatureFlagsEnabled, setLocalFeatureFlagsEnabled] = React__namespace.useState(false);
     const [localFeatureFlags, setLocalFeatureFlags] = React__namespace.useState();
@@ -67,9 +79,15 @@ const DeveloperSettingsProvider = ({ value, children }) => {
 };
 
 const EnvironmentContext = React.createContext(null);
+/**
+ * This is a provider for the EnvironmentContext.
+ */
 const EnvironmentContextProvider = (props) => {
     return jsxRuntime.jsx(EnvironmentContext.Provider, Object.assign({}, props));
 };
+/**
+ * This is a hook to use the EnvironmentContext.
+ */
 const useEnvironment = () => {
     const context = React.useContext(EnvironmentContext);
     if (!context) {
@@ -79,6 +97,9 @@ const useEnvironment = () => {
 };
 
 const GlobalSelectionContext = React__namespace.createContext(null);
+/**
+ * This is a hook to use the GlobalSelectionContext.
+ */
 const useGlobalSelection = () => {
     const context = React__namespace.useContext(GlobalSelectionContext);
     if (!context) {
@@ -86,6 +107,9 @@ const useGlobalSelection = () => {
     }
     return context;
 };
+/**
+ * This is a provider for the GlobalSelectionContext.
+ */
 const GlobalSelectionProvider = (props) => jsxRuntime.jsx(GlobalSelectionContext.Provider, Object.assign({}, props));
 
 /**
@@ -191,9 +215,15 @@ const useSiteRuntime = () => {
 };
 
 const UserSubscriptionContext = React__namespace.createContext(null);
+/**
+ * This is a provider for the UserSubscriptionContext.
+ */
 const UserSubscriptionProvider = (props) => {
     return jsxRuntime.jsx(UserSubscriptionContext.Provider, Object.assign({}, props));
 };
+/**
+ * This is a hook to use the UserSubscriptionContext.
+ */
 const useUserSubscription = () => {
     const context = React__namespace.useContext(UserSubscriptionContext);
     if (!context) {
@@ -203,7 +233,13 @@ const useUserSubscription = () => {
 };
 
 const ToastContext = React__namespace.createContext(null);
+/**
+ * This is a provider for the ToastContext.
+ */
 const ToastProvider = (props) => jsxRuntime.jsx(ToastContext.Provider, Object.assign({}, props));
+/**
+ * This is a hook to use the ToastContext.
+ */
 const useToast = () => {
     const toastContext = React__namespace.useContext(ToastContext);
     if (!toastContext) {
@@ -213,6 +249,9 @@ const useToast = () => {
 };
 
 const TokenContext = React__namespace.createContext(null);
+/**
+ * This is a hook to use the TokenContext.
+ */
 const useToken = () => {
     const context = React__namespace.useContext(TokenContext);
     if (!context) {
@@ -220,14 +259,23 @@ const useToken = () => {
     }
     return context;
 };
+/**
+ * This is a provider for the TokenContext.
+ */
 const TokenProvider = (props) => {
     return jsxRuntime.jsx(TokenContext.Provider, Object.assign({}, props));
 };
 
 const CurrentUserContext = React__namespace.createContext(null);
+/**
+ * This is a provider for the CurrentUserContext.
+ */
 const CurrentUserProvider = (props) => {
     return jsxRuntime.jsx(CurrentUserContext.Provider, Object.assign({}, props));
 };
+/**
+ * This is a hook to use the CurrentUserContext.
+ */
 const useCurrentUser = () => {
     const context = React__namespace.useContext(CurrentUserContext);
     if (!context) {

package/index.js

@@ -5,7 +5,13 @@ import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime, SiteR
 import { useLocation } from 'react-router-dom';
 
 const AssetSortingContext = createContext(null);
+/**
+ * This is a provider for the AssetSortingContext.
+ */
 const AssetSortingProvider = (props) => jsx(AssetSortingContext.Provider, Object.assign({}, props));
+/**
+ * This is a hook to use the AssetSortingContext.
+ */
 const useAssetSorting = () => {
     const context = useContext(AssetSortingContext);
     if (!context) {
@@ -17,6 +23,9 @@ const useAssetSorting = () => {
 const DeveloperSettingsContext = React.createContext({
     localFeatureFlagsEnabled: false,
 });
+/**
+ * This is a hook to use the DeveloperSettingsContext.
+ */
 const useDeveloperSettings = () => {
     const context = React.useContext(DeveloperSettingsContext);
     if (!context) {
@@ -24,6 +33,9 @@ const useDeveloperSettings = () => {
     }
     return context;
 };
+/**
+ * This is the provider for Developer Settings
+ */
 const DeveloperSettingsProvider = ({ value, children }) => {
     const [localFeatureFlagsEnabled, setLocalFeatureFlagsEnabled] = React.useState(false);
     const [localFeatureFlags, setLocalFeatureFlags] = React.useState();
@@ -41,9 +53,15 @@ const DeveloperSettingsProvider = ({ value, children }) => {
 };
 
 const EnvironmentContext = createContext(null);
+/**
+ * This is a provider for the EnvironmentContext.
+ */
 const EnvironmentContextProvider = (props) => {
     return jsx(EnvironmentContext.Provider, Object.assign({}, props));
 };
+/**
+ * This is a hook to use the EnvironmentContext.
+ */
 const useEnvironment = () => {
     const context = useContext(EnvironmentContext);
     if (!context) {
@@ -53,6 +71,9 @@ const useEnvironment = () => {
 };
 
 const GlobalSelectionContext = React.createContext(null);
+/**
+ * This is a hook to use the GlobalSelectionContext.
+ */
 const useGlobalSelection = () => {
     const context = React.useContext(GlobalSelectionContext);
     if (!context) {
@@ -60,6 +81,9 @@ const useGlobalSelection = () => {
     }
     return context;
 };
+/**
+ * This is a provider for the GlobalSelectionContext.
+ */
 const GlobalSelectionProvider = (props) => jsx(GlobalSelectionContext.Provider, Object.assign({}, props));
 
 /**
@@ -165,9 +189,15 @@ const useSiteRuntime = () => {
 };
 
 const UserSubscriptionContext = React.createContext(null);
+/**
+ * This is a provider for the UserSubscriptionContext.
+ */
 const UserSubscriptionProvider = (props) => {
     return jsx(UserSubscriptionContext.Provider, Object.assign({}, props));
 };
+/**
+ * This is a hook to use the UserSubscriptionContext.
+ */
 const useUserSubscription = () => {
     const context = React.useContext(UserSubscriptionContext);
     if (!context) {
@@ -177,7 +207,13 @@ const useUserSubscription = () => {
 };
 
 const ToastContext = React.createContext(null);
+/**
+ * This is a provider for the ToastContext.
+ */
 const ToastProvider = (props) => jsx(ToastContext.Provider, Object.assign({}, props));
+/**
+ * This is a hook to use the ToastContext.
+ */
 const useToast = () => {
     const toastContext = React.useContext(ToastContext);
     if (!toastContext) {
@@ -187,6 +223,9 @@ const useToast = () => {
 };
 
 const TokenContext = React.createContext(null);
+/**
+ * This is a hook to use the TokenContext.
+ */
 const useToken = () => {
     const context = React.useContext(TokenContext);
     if (!context) {
@@ -194,14 +233,23 @@ const useToken = () => {
     }
     return context;
 };
+/**
+ * This is a provider for the TokenContext.
+ */
 const TokenProvider = (props) => {
     return jsx(TokenContext.Provider, Object.assign({}, props));
 };
 
 const CurrentUserContext = React.createContext(null);
+/**
+ * This is a provider for the CurrentUserContext.
+ */
 const CurrentUserProvider = (props) => {
     return jsx(CurrentUserContext.Provider, Object.assign({}, props));
 };
+/**
+ * This is a hook to use the CurrentUserContext.
+ */
 const useCurrentUser = () => {
     const context = React.useContext(CurrentUserContext);
     if (!context) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.35-alpha-beca370860.0",
+  "version": "0.2.38",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -8,10 +8,11 @@
   "type": "module",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@trackunit/react-core-contexts-api": "0.2.22-alpha-beca370860.0",
+    "@trackunit/react-core-contexts-api": "0.2.23",
     "react": "18.2.0",
-    "@trackunit/iris-app-runtime-core": "0.3.25-alpha-beca370860.0",
-    "react-router-dom": "6.4.5"
+    "@trackunit/iris-app-runtime-core": "0.3.26",
+    "react-router-dom": "6.4.5",
+    "@trackunit/iris-app-runtime-core-api": "0.3.24"
   },
   "peerDependencies": {}
 }

package/src/assetSorting/AssetSortingProvider.d.ts

@@ -4,6 +4,12 @@ interface Props {
     children?: React.ReactNode;
     value: IAssetSortingContext;
 }
+/**
+ * This is a provider for the AssetSortingContext.
+ */
 export declare const AssetSortingProvider: (props: Props) => JSX.Element;
+/**
+ * This is a hook to use the AssetSortingContext.
+ */
 export declare const useAssetSorting: () => IAssetSortingContext;
 export {};

package/src/developerSettings/DeveloperSettingsProvider.d.ts

@@ -1,10 +1,16 @@
 import { IDeveloperSettingsContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
 export declare const DeveloperSettingsContext: React.Context<IDeveloperSettingsContext>;
+/**
+ * This is a hook to use the DeveloperSettingsContext.
+ */
 export declare const useDeveloperSettings: () => IDeveloperSettingsContext;
 interface IProps {
     value: IDeveloperSettingsContext;
     children: React.ReactNode;
 }
+/**
+ * This is the provider for Developer Settings
+ */
 export declare const DeveloperSettingsProvider: ({ value, children }: IProps) => JSX.Element;
 export {};

package/src/environment/EnvironmentContextProvider.d.ts

@@ -4,6 +4,12 @@ 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.
+ */
 export declare const useEnvironment: () => IEnvironmentContext;
 export {};

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

@@ -1,9 +1,15 @@
 import { IGlobalSelectionContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
+/**
+ * This is a hook to use the GlobalSelectionContext.
+ */
 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/runtimes/useCustomFieldRuntimeForEntity.d.ts

@@ -0,0 +1,13 @@
+import { ValueAndDefinition } from "@trackunit/iris-app-runtime-core";
+import { EntityIdentity, ValueAndDefinitionKey } from "@trackunit/iris-app-runtime-core-api";
+/**
+ * Hook for getting and setting custom fields for an entity
+ *
+ * @param entity the entity to use
+ * @returns the hook for custom fields for the entity
+ */
+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/subscription/UserSubscriptionProvider.d.ts

@@ -4,6 +4,12 @@ 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.
+ */
 export declare const useUserSubscription: () => IUserSubscriptionContext;
 export {};

package/src/toast/ToastProvider.d.ts

@@ -4,5 +4,11 @@ export interface ContextProviderProps {
     value: IToastContext;
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the ToastContext.
+ */
 export declare const ToastProvider: (props: ContextProviderProps) => JSX.Element;
+/**
+ * This is a hook to use the ToastContext.
+ */
 export declare const useToast: () => IToastContext;

package/src/token/TokenProvider.d.ts

@@ -1,9 +1,15 @@
 import { ITokenContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
+/**
+ * This is a hook to use the TokenContext.
+ */
 export declare const useToken: () => ITokenContext;
 interface IProps {
     value: ITokenContext;
     children?: React.ReactNode;
 }
+/**
+ * This is a provider for the TokenContext.
+ */
 export declare const TokenProvider: (props: IProps) => JSX.Element;
 export {};

package/src/user/CurrentUserProvider.d.ts

@@ -4,6 +4,12 @@ interface Props {
     value: ICurrentUserContext;
     children?: React.ReactNode;
 }
+/**
+ * This is a provider for the CurrentUserContext.
+ */
 export declare const CurrentUserProvider: (props: Props) => JSX.Element;
+/**
+ * This is a hook to use the CurrentUserContext.
+ */
 export declare const useCurrentUser: () => ICurrentUserContext;
 export {};