@hitachivantara/app-shell-shared 2.0.0-next.1 → 2.0.0-next.2

package/dist/AppShellModelContext.js

@@ -0,0 +1,15 @@
+import { createContext, useContext } from "react";
+const HvAppShellModelContext = createContext(void 0);
+const useHvAppShellModel = () => {
+  const context = useContext(HvAppShellModelContext);
+  if (!context) {
+    throw new Error(
+      "useHvAppShellModel must be used within HvAppShellModelContext.Provider"
+    );
+  }
+  return context;
+};
+export {
+  HvAppShellModelContext,
+  useHvAppShellModel
+};

package/dist/bundles/app-shell-shared.esm.js

@@ -1,9 +1,20 @@
-import { createContext, useContext, useMemo, useState, useEffect } from "react";
+import { createContext, useContext, useMemo, useState, useEffect, useRef, useCallback, createElement } from "react";
+import { useAsync } from "@hitachivantara/app-shell-services";
 import { useLocation } from "react-router-dom";
 const HvAppShellContext = createContext(void 0);
 const useHvAppShellConfig = () => {
   return useContext(HvAppShellContext);
 };
+const HvAppShellModelContext = createContext(void 0);
+const useHvAppShellModel = () => {
+  const context = useContext(HvAppShellModelContext);
+  if (!context) {
+    throw new Error(
+      "useHvAppShellModel must be used within HvAppShellModelContext.Provider"
+    );
+  }
+  return context;
+};
 const HvAppShellViewContext = createContext(void 0);
 const HvAppShellRuntimeContext = createContext(void 0);
 const HvAppShellCombinedProvidersContext = createContext(void 0);
@@ -159,7 +170,7 @@ const findFirstLeafItem = (data) => {
 const MAX_TOP_MENU_DEPTH = 2;
 const useHvMenuItems = () => {
   const { pathname, search, state: locationState } = useLocation();
-  const appShellContext = useHvAppShellConfig();
+  const { navigationMode, menu } = useHvAppShellModel();
   const { i18n } = useContext(HvAppShellRuntimeContext) ?? {};
   const tConfig = useMemo(
     () => i18n?.getFixedT(i18n.language, CONFIG_TRANSLATIONS_NAMESPACE) ?? // should not happen, but fallback if the i18n instance is not available
@@ -167,9 +178,9 @@ const useHvMenuItems = () => {
     [i18n]
   );
   const items = useMemo(() => {
-    const menuItemsDepth = appShellContext.navigationMode === "ONLY_TOP" ? MAX_TOP_MENU_DEPTH : void 0;
-    return createMenuItems(tConfig, appShellContext.menu, menuItemsDepth);
-  }, [appShellContext, tConfig]);
+    const menuItemsDepth = navigationMode === "ONLY_TOP" ? MAX_TOP_MENU_DEPTH : void 0;
+    return createMenuItems(tConfig, menu, menuItemsDepth);
+  }, [navigationMode, menu, tConfig]);
   const [selectedMenuItemId, setSelectedMenuItemId] = useState(searchHrefInMenuItems(items, addPrefixToHref(pathname), search));
   const [rootMenuItemId, setRootMenuItemId] = useState(
     getRootIdFromItemId(selectedMenuItemId)
@@ -208,13 +219,61 @@ const useHvMenuItems = () => {
     rootMenuItemId
   };
 };
+const generateKey = () => {
+  return `hooks-${Date.now()}-${Math.round(1e3 * Math.random())}`;
+};
+const DynamicHooksEvaluatorInner = ({
+  hooks,
+  onEvaluate
+}) => {
+  const results = [];
+  for (const { hook, params = [] } of hooks) {
+    const result = hook(...params);
+    results.push(result);
+  }
+  useEffect(() => onEvaluate(results), []);
+  return null;
+};
+const DynamicHooksEvaluator = ({
+  hooks,
+  onEvaluate
+}) => {
+  const skipRenderRef = useRef(false);
+  const keyRef = useRef(generateKey());
+  const hooksRef = useRef(hooks);
+  if (hooksRef.current !== hooks) {
+    skipRenderRef.current = false;
+    hooksRef.current = hooks;
+  }
+  if (skipRenderRef.current) {
+    skipRenderRef.current = false;
+  } else {
+    keyRef.current = generateKey();
+  }
+  const onEvaluateWrapper = useCallback(
+    (results) => {
+      skipRenderRef.current = true;
+      onEvaluate(results);
+    },
+    [onEvaluate]
+  );
+  return createElement(DynamicHooksEvaluatorInner, {
+    key: keyRef.current,
+    hooks,
+    onEvaluate: onEvaluateWrapper
+  });
+};
 export {
   CONFIG_TRANSLATIONS_NAMESPACE,
+  DynamicHooksEvaluator,
   HvAppShellCombinedProvidersContext,
   HvAppShellContext,
+  HvAppShellModelContext,
   HvAppShellRuntimeContext,
   HvAppShellViewContext,
+  useAsync,
   useHvAppShellCombinedProviders,
   useHvAppShellConfig,
+  useHvAppShellModel,
   useHvMenuItems
 };

package/dist/components/DynamicHooksEvaluator/DynamicHooksEvaluator.js

@@ -0,0 +1,48 @@
+import { useRef, useCallback, createElement, useEffect } from "react";
+const generateKey = () => {
+  return `hooks-${Date.now()}-${Math.round(1e3 * Math.random())}`;
+};
+const DynamicHooksEvaluatorInner = ({
+  hooks,
+  onEvaluate
+}) => {
+  const results = [];
+  for (const { hook, params = [] } of hooks) {
+    const result = hook(...params);
+    results.push(result);
+  }
+  useEffect(() => onEvaluate(results), []);
+  return null;
+};
+const DynamicHooksEvaluator = ({
+  hooks,
+  onEvaluate
+}) => {
+  const skipRenderRef = useRef(false);
+  const keyRef = useRef(generateKey());
+  const hooksRef = useRef(hooks);
+  if (hooksRef.current !== hooks) {
+    skipRenderRef.current = false;
+    hooksRef.current = hooks;
+  }
+  if (skipRenderRef.current) {
+    skipRenderRef.current = false;
+  } else {
+    keyRef.current = generateKey();
+  }
+  const onEvaluateWrapper = useCallback(
+    (results) => {
+      skipRenderRef.current = true;
+      onEvaluate(results);
+    },
+    [onEvaluate]
+  );
+  return createElement(DynamicHooksEvaluatorInner, {
+    key: keyRef.current,
+    hooks,
+    onEvaluate: onEvaluateWrapper
+  });
+};
+export {
+  DynamicHooksEvaluator
+};

package/dist/hooks/useMenuItems.js

@@ -1,13 +1,13 @@
 import { useContext, useMemo, useState, useEffect } from "react";
 import { useLocation } from "react-router-dom";
-import { useHvAppShellConfig } from "../AppShellContext.js";
+import { useHvAppShellModel } from "../AppShellModelContext.js";
 import { HvAppShellRuntimeContext } from "../AppShellRuntimeContext.js";
 import { CONFIG_TRANSLATIONS_NAMESPACE } from "../i18n/index.js";
 import { createMenuItems, searchHrefInMenuItems, addPrefixToHref, getRootIdFromItemId, findItemById, findFirstLeafItem } from "../utils/navigationUtils.js";
 const MAX_TOP_MENU_DEPTH = 2;
 const useHvMenuItems = () => {
   const { pathname, search, state: locationState } = useLocation();
-  const appShellContext = useHvAppShellConfig();
+  const { navigationMode, menu } = useHvAppShellModel();
   const { i18n } = useContext(HvAppShellRuntimeContext) ?? {};
   const tConfig = useMemo(
     () => i18n?.getFixedT(i18n.language, CONFIG_TRANSLATIONS_NAMESPACE) ?? // should not happen, but fallback if the i18n instance is not available
@@ -15,9 +15,9 @@ const useHvMenuItems = () => {
     [i18n]
   );
   const items = useMemo(() => {
-    const menuItemsDepth = appShellContext.navigationMode === "ONLY_TOP" ? MAX_TOP_MENU_DEPTH : void 0;
-    return createMenuItems(tConfig, appShellContext.menu, menuItemsDepth);
-  }, [appShellContext, tConfig]);
+    const menuItemsDepth = navigationMode === "ONLY_TOP" ? MAX_TOP_MENU_DEPTH : void 0;
+    return createMenuItems(tConfig, menu, menuItemsDepth);
+  }, [navigationMode, menu, tConfig]);
   const [selectedMenuItemId, setSelectedMenuItemId] = useState(searchHrefInMenuItems(items, addPrefixToHref(pathname), search));
   const [rootMenuItemId, setRootMenuItemId] = useState(
     getRootIdFromItemId(selectedMenuItemId)

package/dist/index.d.ts

@@ -1,40 +1,71 @@
+import { AsyncResult } from '@hitachivantara/app-shell-services';
 import { ComponentType } from 'react';
 import { Context } from 'react';
-import { ServicesConfig as HvAppShellServicesConfig } from '@hitachivantara/app-shell-services';
+import { FunctionComponentElement } from 'react';
 import { HvBaseTheme } from '@hitachivantara/uikit-react-core';
 import { HvContainerProps } from '@hitachivantara/uikit-react-core';
 import { HvThemeColorMode } from '@hitachivantara/uikit-react-core';
 import { i18n } from 'i18next';
-import { ReactNode } from 'react';
+import { PropsWithChildren } from 'react';
+import { ServiceId } from '@hitachivantara/app-shell-services';
+import { ServiceProviderConfig } from '@hitachivantara/app-shell-services';
+import { useAsync } from '@hitachivantara/app-shell-services';
+
+export { AsyncResult }
 
 export declare const CONFIG_TRANSLATIONS_NAMESPACE = "configTranslations";
 
-export declare type HvAppShellAppSwitcherConfig = {
+export declare const DynamicHooksEvaluator: <THook extends (...args: any[]) => TResult, TResult = ReturnType<THook>>({ hooks, onEvaluate, }: DynamicHooksEvaluatorProps<THook, TResult>) => FunctionComponentElement<DynamicHooksEvaluatorProps<THook, TResult>>;
+
+declare interface DynamicHooksEvaluatorProps<THook extends (...args: any[]) => TResult, TResult> {
+    hooks: HookWithParams<THook, TResult>[];
+    onEvaluate: (results: TResult[]) => void;
+}
+
+declare interface HookWithParams<THook extends (...args: any[]) => TResult, TResult = ReturnType<THook>> {
+    hook: THook;
+    params?: Parameters<THook>;
+}
+
+export declare interface HvAppShellAppSwitcherConfig {
     title?: string;
     showLogo?: boolean;
     apps: HvAppShellAppSwitcherItemConfig[];
-};
+}
 
-export declare type HvAppShellAppSwitcherItemConfig = {
+export declare interface HvAppShellAppSwitcherItemConfig {
     label: string;
     description?: string;
     url: string;
     target: "NEW" | "SELF";
     icon?: HvAppShellIcon;
-};
+}
 
 export declare const HvAppShellCombinedProvidersContext: Context<HvAppShellCombinedProvidersContextValue | undefined>;
 
-export declare interface HvAppShellCombinedProvidersContextValue {
-    providers?: Array<{
-        component: ComponentType<{
-            children: ReactNode;
-        }>;
-        config?: Record<string, unknown>;
-    }>;
+declare interface HvAppShellCombinedProvidersContextValue {
+    providers?: HvAppShellProvidersComponent[];
 }
 
-export declare type HvAppShellConfig = {
+export declare interface HvAppShellConditionalConfig {
+    conditions?: HvAppShellConditionConfig[];
+}
+
+export declare interface HvAppShellConditionalModel {
+    key: string;
+    conditions?: HvAppShellConditionModel[];
+}
+
+export declare interface HvAppShellConditionConfig {
+    bundle: string;
+    config?: Record<string, unknown>;
+}
+
+export declare interface HvAppShellConditionModel extends HvAppShellConditionConfig {
+    globalIndex: number;
+}
+
+export declare interface HvAppShellConfig {
     baseUrl?: string;
     name?: string;
     logo?: HvAppShellLogo | null;
@@ -45,61 +76,119 @@ export declare type HvAppShellConfig = {
     mainPanel?: HvAppShellMainPanelConfig;
     theming?: HvAppShellThemingConfig;
     header?: HvAppShellHeader;
+    systemProviders?: HvAppShellSystemProvidersConfig[];
     providers?: HvAppShellProvidersConfig[];
     services?: HvAppShellServicesConfig;
-};
+}
 
 export declare const HvAppShellContext: Context<HvAppShellConfig | undefined>;
 
 export declare type HvAppShellContextValue = HvAppShellConfig;
 
-export declare type HvAppShellHeader = {
+export declare interface HvAppShellHeader {
     actions: HvAppShellHeaderAction[];
-};
+}
 
-export declare type HvAppShellHeaderAction = {
+export declare interface HvAppShellHeaderAction extends HvAppShellConditionalConfig {
     bundle: string;
     config?: HvAppShellHelp | HvAppShellAppSwitcherConfig | Record<string, unknown>;
-};
+}
+
+export declare interface HvAppShellHeaderActionModel extends HvAppShellConditionalModel, Omit<HvAppShellHeaderAction, "conditions"> {
+}
 
-export declare type HvAppShellHelp = {
+export declare interface HvAppShellHeaderModel extends Omit<HvAppShellHeader, "actions"> {
+    actions: HvAppShellHeaderActionModel[];
+}
+
+export declare interface HvAppShellHelp {
     url: string;
     description?: string;
-};
+}
 
-export declare type HvAppShellIcon = {
+export declare interface HvAppShellIcon {
     iconType: "uikit";
     name: string;
-};
+}
 
-export declare type HvAppShellLogo = {
+export declare interface HvAppShellLogo {
     name?: "LUMADA" | "HITACHI" | "PENTAHO+" | "PENTAHO";
     description?: string;
-};
+}
 
 export declare interface HvAppShellMainPanelConfig extends ViewHvContainerProps {
     views?: HvAppShellTopViewConfig[];
 }
 
-export declare type HvAppShellMenuConfig = {
+export declare interface HvAppShellMainPanelModel extends Omit<HvAppShellMainPanelConfig, "views"> {
+    views?: HvAppShellTopViewModel[];
+}
+
+export declare interface HvAppShellMenuConfig extends HvAppShellConditionalConfig {
     label: string;
     icon?: HvAppShellIcon;
     target?: string;
     submenus?: HvAppShellMenuConfig[];
-};
+}
+
+export declare interface HvAppShellMenuModel extends HvAppShellConditionalModel, Omit<HvAppShellMenuConfig, "conditions" | "submenus"> {
+    submenus?: HvAppShellMenuModel[];
+}
+
+export declare interface HvAppShellModel extends Omit<HvAppShellConfig, "menu" | "mainPanel" | "header" | "systemProviders" | "providers" | "services"> {
+    menu?: HvAppShellMenuModel[];
+    mainPanel?: HvAppShellMainPanelModel;
+    header?: HvAppShellHeaderModel;
+    systemProviders?: HvAppShellSystemProvidersModel[];
+    providers?: HvAppShellProvidersModel[];
+    services?: HvAppShellServicesModel;
+    /** All conditions present in the model, indexed by globalIndex */
+    allConditions: HvAppShellConditionModel[];
+    /** All preloaded bundles (conditions and providers) */
+    preloadedBundles: PreloadedBundles;
+}
+
+export declare const HvAppShellModelContext: Context<HvAppShellModelContextValue | undefined>;
+
+export declare interface HvAppShellModelContextValue extends HvAppShellModel {
+}
 
-export declare type HvAppShellProvidersConfig = {
+export declare interface HvAppShellProvidersBaseConfig {
     bundle: string;
     config?: Record<string, unknown>;
+}
+
+export declare type HvAppShellProvidersComponent = Omit<HvAppShellProvidersModel, "bundle"> & {
+    component: ComponentType<PropsWithChildren>;
 };
 
+export declare interface HvAppShellProvidersConfig extends HvAppShellProvidersBaseConfig, HvAppShellConditionalConfig {
+}
+
+export declare interface HvAppShellProvidersModel extends HvAppShellConditionalModel, Omit<HvAppShellProvidersConfig, "conditions"> {
+}
+
 export declare const HvAppShellRuntimeContext: Context<HvAppShellRuntimeContextValue | undefined>;
 
 export declare interface HvAppShellRuntimeContextValue {
     i18n: i18n;
 }
 
-export { HvAppShellServicesConfig }
+export declare type HvAppShellServiceProviderConfig = ServiceProviderConfig & HvAppShellConditionalConfig;
+
+export declare type HvAppShellServiceProviderModel = HvAppShellConditionalModel & ServiceProviderConfig;
+
+export declare interface HvAppShellServicesConfig extends Record<ServiceId, HvAppShellServiceProviderConfig[]> {
+}
+
+export declare type HvAppShellServicesModel = Record<ServiceId, HvAppShellServiceProviderModel[]>;
+
+export declare interface HvAppShellSystemProvidersConfig extends HvAppShellProvidersBaseConfig {
+}
+
+export declare type HvAppShellSystemProvidersModel = HvAppShellSystemProvidersConfig & {
+    key: string;
+};
 
 export declare type HvAppShellThemingConfig = {
     theme?: HvBaseTheme | (string & {});
@@ -109,18 +198,25 @@ export declare type HvAppShellThemingConfig = {
 export declare interface HvAppShellTopViewConfig extends HvAppShellViewsConfig, ViewHvContainerProps {
 }
 
+export declare interface HvAppShellTopViewModel extends HvAppShellViewsModel, Omit<ViewHvContainerProps, "key"> {
+}
+
 export declare const HvAppShellViewContext: Context<HvAppShellViewContextValue | undefined>;
 
 export declare interface HvAppShellViewContextValue {
     id: string;
 }
 
-export declare type HvAppShellViewsConfig = {
+export declare interface HvAppShellViewsConfig extends HvAppShellConditionalConfig {
     bundle: string;
     route: RouteString;
     config?: Record<string, unknown>;
     views?: HvAppShellViewsConfig[];
-};
+}
+
+export declare interface HvAppShellViewsModel extends HvAppShellConditionalModel, Omit<HvAppShellViewsConfig, "conditions" | "views"> {
+    views: HvAppShellViewsModel[];
+}
 
 export declare interface MenuItem {
     id: string;
@@ -137,14 +233,25 @@ export declare interface MenuItemsContext {
     rootMenuItemId: string | undefined;
 }
 
+export declare type PreloadedBundles = Map<string, unknown>;
+
 declare type RouteString = `/${string}`;
 
+export { useAsync }
+
+export declare type UseCondition = (config?: Record<string, unknown>) => UseConditionResult;
+
+export declare type UseConditionResult = AsyncResult<boolean, Error, "result">;
+
 export declare const useHvAppShellCombinedProviders: () => HvAppShellCombinedProvidersContextValue;
 
 export declare const useHvAppShellConfig: () => HvAppShellContextValue;
 
+export declare const useHvAppShellModel: () => HvAppShellModel;
+
 export declare const useHvMenuItems: () => MenuItemsContext;
 
-declare type ViewHvContainerProps = Omit<HvContainerProps, "children">;
+export declare interface ViewHvContainerProps extends Omit<HvContainerProps, "children"> {
+}
 
 export { }

package/dist/index.js

@@ -1,16 +1,23 @@
 import { HvAppShellContext, useHvAppShellConfig } from "./AppShellContext.js";
+import { HvAppShellModelContext, useHvAppShellModel } from "./AppShellModelContext.js";
 import { HvAppShellViewContext } from "./AppShellViewContext.js";
 import { HvAppShellRuntimeContext } from "./AppShellRuntimeContext.js";
 import { HvAppShellCombinedProvidersContext, useHvAppShellCombinedProviders } from "./AppShellCombinedProvidersContext.js";
+import { useAsync } from "@hitachivantara/app-shell-services";
 import { CONFIG_TRANSLATIONS_NAMESPACE } from "./i18n/index.js";
 import { useHvMenuItems } from "./hooks/useMenuItems.js";
+import { DynamicHooksEvaluator } from "./components/DynamicHooksEvaluator/DynamicHooksEvaluator.js";
 export {
   CONFIG_TRANSLATIONS_NAMESPACE,
+  DynamicHooksEvaluator,
   HvAppShellCombinedProvidersContext,
   HvAppShellContext,
+  HvAppShellModelContext,
   HvAppShellRuntimeContext,
   HvAppShellViewContext,
+  useAsync,
   useHvAppShellCombinedProviders,
   useHvAppShellConfig,
+  useHvAppShellModel,
   useHvMenuItems
 };

package/package.json

@@ -1,28 +1,28 @@
 {
   "name": "@hitachivantara/app-shell-shared",
-  "version": "2.0.0-next.1",
+  "version": "2.0.0-next.2",
   "type": "module",
   "private": false,
   "author": "Hitachi Vantara UI Kit Team",
   "description": "AppShell Shared",
-  "homepage": "https://github.com/lumada-design/hv-uikit-react",
+  "homepage": "https://github.com/pentaho/hv-uikit-react",
   "sideEffects": false,
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lumada-design/hv-uikit-react.git",
+    "url": "git+https://github.com/pentaho/hv-uikit-react.git",
     "directory": "packages/app-shell-shared"
   },
-  "bugs": "https://github.com/lumada-design/hv-uikit-react/issues",
+  "bugs": "https://github.com/pentaho/hv-uikit-react/issues",
   "dependencies": {
-    "@hitachivantara/app-shell-services": "^1.1.2"
+    "@hitachivantara/app-shell-services": "^2.0.0-next.2"
   },
   "peerDependencies": {
     "react": "^18.2.0",
     "react-router-dom": "^6.9.0"
   },
   "optionalDependencies": {
-    "@hitachivantara/uikit-react-core": "^6.0.0-next.2"
+    "@hitachivantara/uikit-react-core": "^6.0.0-next.3"
   },
   "files": [
     "dist"
@@ -40,7 +40,7 @@
     "access": "public",
     "directory": "package"
   },
-  "gitHead": "0b07240fb2ef75e046d8e6aaf0ff71bf2415c73f",
+  "gitHead": "f404f47dd2c0a9d4033b9acccc87282aa9e42119",
   "types": "./dist/types/index.d.ts",
   "module": "dist/index.js"
 }