@equinor/fusion-framework-react-app 6.0.10 → 6.1.0

package/dist/types/help-center/index.d.ts

@@ -0,0 +1,9 @@
+import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
+import type { HelpCenterOpenEventDetail } from './useHelpCenter';
+export { useHelpCenter } from './useHelpCenter';
+export type { HelpCenterOpenEventDetail };
+declare module '@equinor/fusion-framework-module-event' {
+    interface FrameworkEventMap {
+        '@Portal::FusionHelp::open': FrameworkEvent<FrameworkEventInit<HelpCenterOpenEventDetail>>;
+    }
+}

package/dist/types/help-center/useHelpCenter.d.ts

@@ -0,0 +1,22 @@
+type HelpCenterEventDetailBase<T extends string, V extends Record<string, unknown> = {}> = {
+    page: T;
+} & V;
+type OpenHelpDetail = HelpCenterEventDetailBase<'home'>;
+type OpenArticleDetail = HelpCenterEventDetailBase<'article', {
+    articleId: string;
+}>;
+type OpenFaqsDetail = HelpCenterEventDetailBase<'faqs'>;
+type OpenSearchDetail = HelpCenterEventDetailBase<'search', {
+    search: string;
+}>;
+type OpenGovernanceDetail = HelpCenterEventDetailBase<'governance'>;
+export type HelpCenterOpenEventDetail = OpenHelpDetail | OpenArticleDetail | OpenFaqsDetail | OpenSearchDetail | OpenGovernanceDetail;
+export declare const EVENT_NAME = "@Portal::FusionHelp::open";
+export declare const useHelpCenter: () => {
+    openHelp: () => void;
+    openArticle: (articleId: string) => void;
+    openFaqs: () => void;
+    openSearch: (search: string) => void;
+    openGovernance: () => void;
+};
+export default useHelpCenter;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "6.0.10";
+export declare const version = "6.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react-app",
-  "version": "6.0.10",
+  "version": "6.1.0",
   "description": "",
   "main": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -25,6 +25,10 @@
       "types": "./dist/types/framework/index.d.ts",
       "import": "./dist/esm/framework/index.js"
     },
+    "./help-center": {
+      "types": "./dist/types/help-center/index.d.ts",
+      "import": "./dist/esm/help-center/index.js"
+    },
     "./http": {
       "types": "./dist/types/http/index.d.ts",
       "import": "./dist/esm/http/index.js"
@@ -60,10 +64,10 @@
   "dependencies": {
     "@equinor/fusion-framework-app": "^9.3.10",
     "@equinor/fusion-framework-module": "^4.3.8",
-    "@equinor/fusion-framework-module-navigation": "^4.0.10",
-    "@equinor/fusion-framework-react": "^7.4.8",
     "@equinor/fusion-framework-module-app": "^6.1.10",
+    "@equinor/fusion-framework-module-navigation": "^4.0.10",
     "@equinor/fusion-framework-react-module": "^3.1.9",
+    "@equinor/fusion-framework-react": "^7.4.8",
     "@equinor/fusion-framework-react-module-http": "^8.0.5"
   },
   "devDependencies": {
@@ -74,9 +78,9 @@
     "rxjs": "^7.8.1",
     "typescript": "^5.8.2",
     "@equinor/fusion-framework-module-ag-grid": "^33.2.3",
-    "@equinor/fusion-framework-module-msal": "^4.0.3",
-    "@equinor/fusion-framework-module-feature-flag": "^1.1.15",
     "@equinor/fusion-framework-module-event": "^4.3.3",
+    "@equinor/fusion-framework-module-feature-flag": "^1.1.15",
+    "@equinor/fusion-framework-module-msal": "^4.0.3",
     "@equinor/fusion-framework-react-module-bookmark": "^3.0.8",
     "@equinor/fusion-framework-react-module-context": "^6.2.24",
     "@equinor/fusion-observable": "^8.4.7"

package/src/help-center/README.md

@@ -0,0 +1,21 @@
+## Help center
+
+### useHelpCenter
+
+A hook to open the help center side sheet programmatically.
+
+```typescript
+const {
+  openHelp,
+  openArticle,
+  openFaqs,
+  openSearch,
+  openGovernance
+} = useHelpCenter();
+
+openHelp();
+openArticle('article-slug-name');
+openFaqs();
+openSearch('search-input');
+openGovernance();
+```

package/src/help-center/index.ts

@@ -0,0 +1,11 @@
+import type { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
+import type { HelpCenterOpenEventDetail } from './useHelpCenter';
+
+export { useHelpCenter } from './useHelpCenter';
+export type { HelpCenterOpenEventDetail };
+
+declare module '@equinor/fusion-framework-module-event' {
+  interface FrameworkEventMap {
+    '@Portal::FusionHelp::open': FrameworkEvent<FrameworkEventInit<HelpCenterOpenEventDetail>>;
+  }
+}

package/src/help-center/useHelpCenter.ts

@@ -0,0 +1,97 @@
+import { useCallback } from 'react';
+import useAppModule from '../useAppModule';
+
+type HelpCenterEventDetailBase<T extends string, V extends Record<string, unknown> = {}> = {
+  page: T;
+} & V;
+
+type OpenHelpDetail = HelpCenterEventDetailBase<'home'>;
+
+type OpenArticleDetail = HelpCenterEventDetailBase<
+  'article',
+  {
+    articleId: string;
+  }
+>;
+
+type OpenFaqsDetail = HelpCenterEventDetailBase<'faqs'>;
+
+type OpenSearchDetail = HelpCenterEventDetailBase<
+  'search',
+  {
+    search: string;
+  }
+>;
+
+type OpenGovernanceDetail = HelpCenterEventDetailBase<'governance'>;
+
+export type HelpCenterOpenEventDetail =
+  | OpenHelpDetail
+  | OpenArticleDetail
+  | OpenFaqsDetail
+  | OpenSearchDetail
+  | OpenGovernanceDetail;
+
+export const EVENT_NAME = '@Portal::FusionHelp::open';
+
+export const useHelpCenter = () => {
+  const eventModule = useAppModule('event');
+
+  const openHelp = useCallback((): void => {
+    eventModule.dispatchEvent(EVENT_NAME, {
+      detail: {
+        page: 'home',
+      },
+    });
+  }, [eventModule.dispatchEvent]);
+
+  const openArticle = useCallback(
+    (articleId: string): void => {
+      eventModule.dispatchEvent(EVENT_NAME, {
+        detail: {
+          page: 'article',
+          articleId: articleId,
+        },
+      });
+    },
+    [eventModule.dispatchEvent],
+  );
+
+  const openFaqs = useCallback((): void => {
+    eventModule.dispatchEvent(EVENT_NAME, {
+      detail: {
+        page: 'faqs',
+      },
+    });
+  }, [eventModule.dispatchEvent]);
+
+  const openSearch = useCallback(
+    (search: string): void => {
+      eventModule.dispatchEvent(EVENT_NAME, {
+        detail: {
+          page: 'search',
+          search: search,
+        },
+      });
+    },
+    [eventModule.dispatchEvent],
+  );
+
+  const openGovernance = useCallback((): void => {
+    eventModule.dispatchEvent(EVENT_NAME, {
+      detail: {
+        page: 'governance',
+      },
+    });
+  }, [eventModule.dispatchEvent]);
+
+  return {
+    openHelp,
+    openArticle,
+    openFaqs,
+    openSearch,
+    openGovernance,
+  };
+};
+
+export default useHelpCenter;

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '6.0.10';
+export const version = '6.1.0';