@trackunit/react-core-contexts 0.4.105 → 0.4.108

package/index.cjs

@@ -61,6 +61,13 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+/**
+ * This is a provider for the ManagerApolloContext.
+ * It is used to provide the apollo client to the manager app.
+ *
+ * @param {IProps} props The props.
+ * @returns {JSX.Element} The provider.
+ */
 const ManagerApolloProvider = ({ children, isIrisApp }) => {
     const { publicUrl, graphqlLegacyUrl, graphqlManagerUrl, graphqlPublicUrl, graphqlManagerImageUploadUrl, graphqlReportUrl, isDev, tracingHeaders, } = reactCoreHooks.useEnvironment();
     const { token } = reactCoreHooks.useToken();
@@ -162,6 +169,9 @@ const ManagerApolloProvider = ({ children, isIrisApp }) => {
     return jsxRuntime.jsx(client.ApolloProvider, Object.assign({ client: client$1 }, { children: children }));
 };
 
+/**
+ * This is a provider for the ToastContext.
+ */
 const ToastProviderApp = ({ children }) => {
     const value = React.useMemo(() => ({ addToast: irisAppRuntimeCore.ToastRuntime.addToast }), []);
     return jsxRuntime.jsx(reactCoreHooks.ToastProvider, Object.assign({ value: value }, { children: children }));
@@ -181,6 +191,9 @@ const useSubscribeToHostChanges = (methods) => {
     }, [methods]);
 };
 
+/**
+ * This is a provider for the AssetSortingContext.
+ */
 const TileAssetSortingProvider = ({ children }) => {
     const [assetSortingState, setAssetSortingState] = React.useState(null);
     React.useEffect(() => {
@@ -202,6 +215,9 @@ const TileAssetSortingProvider = ({ children }) => {
     return jsxRuntime.jsx(reactCoreHooks.AssetSortingProvider, Object.assign({ value: contextValue }, { children: children }));
 };
 
+/**
+ * This is a provider for the EnvironmentContext.
+ */
 const TileEnvironmentProvider = ({ children }) => {
     const [environment, setEnvironment] = React__namespace.useState(null);
     React__namespace.useEffect(() => {
@@ -223,6 +239,9 @@ const TileEnvironmentProvider = ({ children }) => {
     return jsxRuntime.jsx(reactCoreHooks.EnvironmentContextProvider, Object.assign({ value: environment }, { children: children }));
 };
 
+/**
+ * This is a provider for the GlobalSelectionContext.
+ */
 const TileGlobalSelectionProvider = ({ children }) => {
     const [GlobalSelectionContext, setGlobalSelectionContext] = React.useState(null);
     React.useEffect(() => {
@@ -240,6 +259,9 @@ const TileGlobalSelectionProvider = ({ children }) => {
     return jsxRuntime.jsx(reactCoreHooks.GlobalSelectionProvider, Object.assign({ value: GlobalSelectionContext }, { children: children }));
 };
 
+/**
+ * This is a provider for the TokenContext.
+ */
 const TileTokenProvider = ({ children }) => {
     const [tokenContext, setTokenContext] = React__namespace.useState(null);
     React__namespace.useEffect(() => {
@@ -263,6 +285,9 @@ const TileTokenProvider = ({ children }) => {
     return jsxRuntime.jsx(reactCoreHooks.TokenProvider, Object.assign({ value: tokenContext }, { children: children }));
 };
 
+/**
+ * This is a provider for the CurrentUserContext.
+ */
 const TileCurrentUserProvider = ({ children }) => {
     const [currentuserContext, setCurrentUserContext] = React__namespace.useState(null);
     React__namespace.useEffect(() => {
@@ -276,6 +301,9 @@ const TileCurrentUserProvider = ({ children }) => {
     return jsxRuntime.jsx(reactCoreHooks.CurrentUserProvider, Object.assign({ value: currentuserContext }, { children: children }));
 };
 
+/**
+ * This is a provider for the UserSubscriptionContext.
+ */
 const UserSubscriptionProvider = ({ children }) => {
     const [subscription, setSubscription] = React__namespace.useState(null);
     React__namespace.useEffect(() => {
@@ -289,6 +317,9 @@ const UserSubscriptionProvider = ({ children }) => {
     return jsxRuntime.jsx(reactCoreHooks.UserSubscriptionProvider, Object.assign({ value: subscription }, { children: children }));
 };
 
+/**
+ * This is a provider for the TrackunitDataProviders.
+ */
 const TrackunitDataProviders = ({ children }) => (jsxRuntime.jsx(TileEnvironmentProvider, { children: jsxRuntime.jsx(TileTokenProvider, { children: jsxRuntime.jsx(TileCurrentUserProvider, { children: jsxRuntime.jsx(UserSubscriptionProvider, { children: jsxRuntime.jsx(TileGlobalSelectionProvider, { children: jsxRuntime.jsx(TileAssetSortingProvider, { children: jsxRuntime.jsx(ManagerApolloProvider, Object.assign({ isIrisApp: true }, { children: children })) }) }) }) }) }) }));
 
 const HostNavigator = ({ children }) => {
@@ -296,11 +327,17 @@ const HostNavigator = ({ children }) => {
     // eslint-disable-next-line react/jsx-no-useless-fragment
     return jsxRuntime.jsx(jsxRuntime.Fragment, { children: children });
 };
+/**
+ * This is a router for the Trackunit app.
+ */
 const TrackunitRouter = ({ children }) => {
     var _a;
     return (jsxRuntime.jsx(reactRouterDom.BrowserRouter, Object.assign({ basename: `${((_a = document.getElementById("baseHref")) === null || _a === void 0 ? void 0 : _a.getAttribute("href")) || "<missing baseHref>"}${global.module}` }, { children: jsxRuntime.jsx(HostNavigator, { children: children }) })));
 };
 
+/**
+ * This is a provider for the TrackunitDataProviders.
+ */
 const TrackunitProviders = ({ translations, children }) => {
     if (translations) {
         i18nLibraryTranslation.registerTranslations(translations); // Register the apps translations if passed.

package/index.js

@@ -37,6 +37,13 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+/**
+ * This is a provider for the ManagerApolloContext.
+ * It is used to provide the apollo client to the manager app.
+ *
+ * @param {IProps} props The props.
+ * @returns {JSX.Element} The provider.
+ */
 const ManagerApolloProvider = ({ children, isIrisApp }) => {
     const { publicUrl, graphqlLegacyUrl, graphqlManagerUrl, graphqlPublicUrl, graphqlManagerImageUploadUrl, graphqlReportUrl, isDev, tracingHeaders, } = useEnvironment();
     const { token } = useToken();
@@ -138,6 +145,9 @@ const ManagerApolloProvider = ({ children, isIrisApp }) => {
     return jsx(ApolloProvider, Object.assign({ client: client }, { children: children }));
 };
 
+/**
+ * This is a provider for the ToastContext.
+ */
 const ToastProviderApp = ({ children }) => {
     const value = useMemo(() => ({ addToast: ToastRuntime.addToast }), []);
     return jsx(ToastProvider, Object.assign({ value: value }, { children: children }));
@@ -157,6 +167,9 @@ const useSubscribeToHostChanges = (methods) => {
     }, [methods]);
 };
 
+/**
+ * This is a provider for the AssetSortingContext.
+ */
 const TileAssetSortingProvider = ({ children }) => {
     const [assetSortingState, setAssetSortingState] = useState(null);
     useEffect(() => {
@@ -178,6 +191,9 @@ const TileAssetSortingProvider = ({ children }) => {
     return jsx(AssetSortingProvider, Object.assign({ value: contextValue }, { children: children }));
 };
 
+/**
+ * This is a provider for the EnvironmentContext.
+ */
 const TileEnvironmentProvider = ({ children }) => {
     const [environment, setEnvironment] = React.useState(null);
     React.useEffect(() => {
@@ -199,6 +215,9 @@ const TileEnvironmentProvider = ({ children }) => {
     return jsx(EnvironmentContextProvider, Object.assign({ value: environment }, { children: children }));
 };
 
+/**
+ * This is a provider for the GlobalSelectionContext.
+ */
 const TileGlobalSelectionProvider = ({ children }) => {
     const [GlobalSelectionContext, setGlobalSelectionContext] = useState(null);
     useEffect(() => {
@@ -216,6 +235,9 @@ const TileGlobalSelectionProvider = ({ children }) => {
     return jsx(GlobalSelectionProvider, Object.assign({ value: GlobalSelectionContext }, { children: children }));
 };
 
+/**
+ * This is a provider for the TokenContext.
+ */
 const TileTokenProvider = ({ children }) => {
     const [tokenContext, setTokenContext] = React.useState(null);
     React.useEffect(() => {
@@ -239,6 +261,9 @@ const TileTokenProvider = ({ children }) => {
     return jsx(TokenProvider, Object.assign({ value: tokenContext }, { children: children }));
 };
 
+/**
+ * This is a provider for the CurrentUserContext.
+ */
 const TileCurrentUserProvider = ({ children }) => {
     const [currentuserContext, setCurrentUserContext] = React.useState(null);
     React.useEffect(() => {
@@ -252,6 +277,9 @@ const TileCurrentUserProvider = ({ children }) => {
     return jsx(CurrentUserProvider, Object.assign({ value: currentuserContext }, { children: children }));
 };
 
+/**
+ * This is a provider for the UserSubscriptionContext.
+ */
 const UserSubscriptionProvider = ({ children }) => {
     const [subscription, setSubscription] = React.useState(null);
     React.useEffect(() => {
@@ -265,6 +293,9 @@ const UserSubscriptionProvider = ({ children }) => {
     return jsx(UserSubscriptionProvider$1, Object.assign({ value: subscription }, { children: children }));
 };
 
+/**
+ * This is a provider for the TrackunitDataProviders.
+ */
 const TrackunitDataProviders = ({ children }) => (jsx(TileEnvironmentProvider, { children: jsx(TileTokenProvider, { children: jsx(TileCurrentUserProvider, { children: jsx(UserSubscriptionProvider, { children: jsx(TileGlobalSelectionProvider, { children: jsx(TileAssetSortingProvider, { children: jsx(ManagerApolloProvider, Object.assign({ isIrisApp: true }, { children: children })) }) }) }) }) }) }));
 
 const HostNavigator = ({ children }) => {
@@ -272,11 +303,17 @@ const HostNavigator = ({ children }) => {
     // eslint-disable-next-line react/jsx-no-useless-fragment
     return jsx(Fragment, { children: children });
 };
+/**
+ * This is a router for the Trackunit app.
+ */
 const TrackunitRouter = ({ children }) => {
     var _a;
     return (jsx(BrowserRouter, Object.assign({ basename: `${((_a = document.getElementById("baseHref")) === null || _a === void 0 ? void 0 : _a.getAttribute("href")) || "<missing baseHref>"}${global.module}` }, { children: jsx(HostNavigator, { children: children }) })));
 };
 
+/**
+ * This is a provider for the TrackunitDataProviders.
+ */
 const TrackunitProviders = ({ translations, children }) => {
     if (translations) {
         registerTranslations(translations); // Register the apps translations if passed.

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@trackunit/react-core-contexts",
-  "version": "0.4.105",
+  "version": "0.4.108",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "dependencies": {
     "graphql": "^15.8.0",
-    "@trackunit/iris-app-runtime-core": "0.3.25",
-    "@trackunit/react-core-contexts-api": "0.2.22",
-    "@trackunit/react-core-contexts-test": "0.1.40",
-    "@trackunit/react-core-hooks": "0.2.36",
+    "@trackunit/iris-app-runtime-core": "0.3.26",
+    "@trackunit/react-core-contexts-api": "0.2.23",
+    "@trackunit/react-core-contexts-test": "0.1.43",
+    "@trackunit/react-core-hooks": "0.2.39",
     "react": "18.2.0",
     "@apollo/client": "3.7.10",
     "@sentry/browser": "7.24.2",
     "apollo-upload-client": "17.0.0",
-    "@trackunit/i18n-library-translation": "0.0.35",
-    "@trackunit/react-components": "0.1.75",
+    "@trackunit/i18n-library-translation": "0.0.37",
+    "@trackunit/react-components": "0.1.76",
     "react-router-dom": "6.4.5"
   },
   "module": "./index.js",

package/src/ManagerApolloProvider.d.ts

@@ -3,5 +3,12 @@ interface IProps {
     children: React.ReactNode;
     isIrisApp?: boolean;
 }
+/**
+ * This is a provider for the ManagerApolloContext.
+ * It is used to provide the apollo client to the manager app.
+ *
+ * @param {IProps} props The props.
+ * @returns {JSX.Element} The provider.
+ */
 export declare const ManagerApolloProvider: ({ children, isIrisApp }: IProps) => JSX.Element;
 export {};

package/src/TrackunitDataProviders.d.ts

@@ -2,5 +2,8 @@ import React from "react";
 interface Props {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the TrackunitDataProviders.
+ */
 export declare const TrackunitDataProviders: ({ children }: Props) => JSX.Element;
 export {};

package/src/TrackunitProviders.d.ts

@@ -5,4 +5,7 @@ export interface TrackunitProvidersProps {
     translations?: TranslationResource<string>;
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the TrackunitDataProviders.
+ */
 export declare const TrackunitProviders: ({ translations, children }: TrackunitProvidersProps) => JSX.Element;

package/src/TrackunitRouter.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
+/**
+ * This is a router for the Trackunit app.
+ */
 export declare const TrackunitRouter: ({ children }: {
     children?: React.ReactNode;
 }) => JSX.Element;

package/src/UserSubscriptionProvider.d.ts

@@ -2,5 +2,8 @@ import * as React from "react";
 interface IProps {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the UserSubscriptionContext.
+ */
 declare const UserSubscriptionProvider: ({ children }: IProps) => JSX.Element | null;
 export default UserSubscriptionProvider;

package/src/assetSorting/TileAssetSortingProvider.d.ts

@@ -2,5 +2,8 @@ import { ReactNode } from "react";
 interface Props {
     children: ReactNode;
 }
+/**
+ * This is a provider for the AssetSortingContext.
+ */
 declare const TileAssetSortingProvider: ({ children }: Props) => JSX.Element | null;
 export default TileAssetSortingProvider;

package/src/developerSettings/IrisAppDeveloperSettingsContext.d.ts

@@ -2,5 +2,8 @@ import * as React from "react";
 interface IProps {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the DeveloperSettingsContext.
+ */
 declare const IrisAppDeveloperSettingsProvider: ({ children }: IProps) => JSX.Element | null;
 export default IrisAppDeveloperSettingsProvider;

package/src/environment/TileEnvironmentProvider.d.ts

@@ -2,5 +2,8 @@ import * as React from "react";
 interface IProps {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the EnvironmentContext.
+ */
 declare const TileEnvironmentProvider: ({ children }: IProps) => JSX.Element | null;
 export default TileEnvironmentProvider;

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

@@ -2,5 +2,8 @@
 interface IProps {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the GlobalSelectionContext.
+ */
 declare const TileGlobalSelectionProvider: ({ children }: IProps) => JSX.Element | null;
 export default TileGlobalSelectionProvider;

package/src/toast/ToastProviderApp.d.ts

@@ -2,5 +2,8 @@
 interface Props {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the ToastContext.
+ */
 export declare const ToastProviderApp: ({ children }: Props) => JSX.Element;
 export {};

package/src/token/TileTokenProvider.d.ts

@@ -2,5 +2,8 @@ import * as React from "react";
 interface IProps {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the TokenContext.
+ */
 declare const TileTokenProvider: ({ children }: IProps) => JSX.Element | null;
 export default TileTokenProvider;

package/src/user/TileCurrentUserProvider.d.ts

@@ -2,5 +2,8 @@ import * as React from "react";
 interface IProps {
     children: React.ReactNode;
 }
+/**
+ * This is a provider for the CurrentUserContext.
+ */
 declare const TileCurrentUserProvider: ({ children }: IProps) => JSX.Element | null;
 export default TileCurrentUserProvider;