@equinor/fusion-framework-react-app 6.1.2 → 6.1.4

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

@@ -1,4 +1,4 @@
-type HelpCenterEventDetailBase<T extends string, V extends Record<string, unknown> = {}> = {
+type HelpCenterEventDetailBase<T extends string, V extends Record<string, unknown> = Record<string, unknown>> = {
     page: T;
 } & V;
 type OpenHelpDetail = HelpCenterEventDetailBase<'home'>;
@@ -12,11 +12,37 @@ type OpenSearchDetail = HelpCenterEventDetailBase<'search', {
 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;
-};
+/**
+ * Interface for requesting help features.
+ */
+export interface HelpCenter {
+    /**
+     * Requesting the portal to open the help sidesheet on the normal page
+     */
+    openHelp(): void;
+    /**
+     * Requesting the portal to open the help sidesheet on the article page.
+     *
+     * @param {string} articleId - The articleId, slug or identifier to show.
+     */
+    openArticle(articleId: string): void;
+    /**
+     * Requesting the portal to open the help sidesheet on the FAQs page.
+     */
+    openFaqs(): void;
+    /**
+     * Requesting the portal to open the help sidesheet on the search page.
+     *
+     * @param {string} search - The search string.
+     */
+    openSearch(search: string): void;
+    /**
+     * Requesting the portal to open the help sidesheet on the governance tab.
+     */
+    openGovernance(): void;
+}
+/**
+ * Hook for accessing help center.
+ */
+export declare const useHelpCenter: () => HelpCenter;
 export default useHelpCenter;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "6.1.2";
+export declare const version = "6.1.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react-app",
-  "version": "6.1.2",
+  "version": "6.1.4",
   "description": "",
   "main": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -96,13 +96,13 @@
     "directory": "packages/react"
   },
   "dependencies": {
-    "@equinor/fusion-framework-module-app": "^6.1.12",
-    "@equinor/fusion-framework-module": "^4.4.1",
-    "@equinor/fusion-framework-module-navigation": "^5.0.1",
-    "@equinor/fusion-framework-react": "^7.4.10",
-    "@equinor/fusion-framework-app": "^9.3.12",
-    "@equinor/fusion-framework-react-module-http": "^9.0.1",
-    "@equinor/fusion-framework-react-module": "^3.1.11"
+    "@equinor/fusion-framework-app": "^9.3.13",
+    "@equinor/fusion-framework-module-app": "^6.1.13",
+    "@equinor/fusion-framework-module-navigation": "^5.0.2",
+    "@equinor/fusion-framework-react": "^7.4.11",
+    "@equinor/fusion-framework-react-module-http": "^9.0.2",
+    "@equinor/fusion-framework-react-module": "^3.1.12",
+    "@equinor/fusion-framework-module": "^4.4.2"
   },
   "devDependencies": {
     "@types/react": "^18.2.50",
@@ -111,20 +111,20 @@
     "react-dom": "^18.2.0",
     "rxjs": "^7.8.1",
     "typescript": "^5.8.2",
-    "@equinor/fusion-framework-module-ag-grid": "^34.0.1",
-    "@equinor/fusion-framework-module-event": "^4.3.5",
-    "@equinor/fusion-framework-module-msal": "^4.0.5",
-    "@equinor/fusion-framework-module-feature-flag": "^1.1.17",
-    "@equinor/fusion-framework-react-module-bookmark": "^4.0.1",
-    "@equinor/fusion-observable": "^8.4.8",
-    "@equinor/fusion-framework-react-module-context": "^6.2.26"
+    "@equinor/fusion-framework-module-event": "^4.3.6",
+    "@equinor/fusion-framework-module-ag-grid": "^34.0.2",
+    "@equinor/fusion-framework-module-msal": "^4.0.6",
+    "@equinor/fusion-framework-module-feature-flag": "^1.1.18",
+    "@equinor/fusion-framework-react-module-bookmark": "^4.0.2",
+    "@equinor/fusion-framework-react-module-context": "^6.2.27",
+    "@equinor/fusion-observable": "^8.4.9"
   },
   "peerDependencies": {
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0",
     "rxjs": "^7.8.1",
-    "@equinor/fusion-framework-module-msal": "^4.0.5"
+    "@equinor/fusion-framework-module-msal": "^4.0.6"
   },
   "peerDependenciesMeta": {
     "@equinor/fusion-framework-react-module-ag-grid": {

package/src/help-center/useHelpCenter.ts

@@ -1,7 +1,10 @@
 import { useCallback } from 'react';
 import useAppModule from '../useAppModule';
 
-type HelpCenterEventDetailBase<T extends string, V extends Record<string, unknown> = {}> = {
+type HelpCenterEventDetailBase<
+  T extends string,
+  V extends Record<string, unknown> = Record<string, unknown>,
+> = {
   page: T;
 } & V;
 
@@ -34,7 +37,44 @@ export type HelpCenterOpenEventDetail =
 
 export const EVENT_NAME = '@Portal::FusionHelp::open';
 
-export const useHelpCenter = () => {
+/**
+ * Interface for requesting help features.
+ */
+export interface HelpCenter {
+  /**
+   * Requesting the portal to open the help sidesheet on the normal page
+   */
+  openHelp(): void;
+
+  /**
+   * Requesting the portal to open the help sidesheet on the article page.
+   *
+   * @param {string} articleId - The articleId, slug or identifier to show.
+   */
+  openArticle(articleId: string): void;
+
+  /**
+   * Requesting the portal to open the help sidesheet on the FAQs page.
+   */
+  openFaqs(): void;
+
+  /**
+   * Requesting the portal to open the help sidesheet on the search page.
+   *
+   * @param {string} search - The search string.
+   */
+  openSearch(search: string): void;
+
+  /**
+   * Requesting the portal to open the help sidesheet on the governance tab.
+   */
+  openGovernance(): void;
+}
+
+/**
+ * Hook for accessing help center.
+ */
+export const useHelpCenter = (): HelpCenter => {
   const eventModule = useAppModule('event');
 
   const openHelp = useCallback((): void => {

package/src/version.ts

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