@entur-partner/common 10.0.1 → 10.0.2-alpha.0

package/dist/ProjectProvider.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+export declare const useProject: () => {
+    defaultProjectId: string;
+    projectName: string;
+};
+type ProjectProviderProps = {
+    defaultProjectId: string;
+    projectName: string;
+    children: React.ReactNode;
+};
+/**
+ * A Provider to sync project id across micro-frontends. Used by useNavigateParams to ensure project id is always present in the url.
+ */
+export declare const ProjectProvider: ({ defaultProjectId, projectName, children, }: ProjectProviderProps) => React.JSX.Element;
+export {};

package/dist/common.cjs.development.js

@@ -196,10 +196,42 @@ var AuditInfo = function AuditInfo(_ref) {
   }));
 };
 
+var ProjectContext = /*#__PURE__*/React.createContext(undefined);
+var useProject = function useProject() {
+  var context = React.useContext(ProjectContext);
+  if (!context) {
+    throw new Error("Must be used within a ProjectProvider");
+  }
+  return {
+    defaultProjectId: context.defaultProjectId,
+    projectName: context.projectName
+  };
+};
+/**
+ * A Provider to sync project id across micro-frontends. Used by useNavigateParams to ensure project id is always present in the url.
+ */
+var ProjectProvider = function ProjectProvider(_ref) {
+  var defaultProjectId = _ref.defaultProjectId,
+    projectName = _ref.projectName,
+    children = _ref.children;
+  return React.createElement(ProjectContext.Provider, {
+    value: {
+      defaultProjectId: defaultProjectId,
+      projectName: projectName
+    }
+  }, children);
+};
+
 var Breadcrumbs = function Breadcrumbs(_ref) {
   var prependBreadcrumbItem = _ref.prependBreadcrumbItem,
     pathname = _ref.pathname,
     onBreadcrumbLookup = _ref.onBreadcrumbLookup;
+  var _useProject = useProject(),
+    projectName = _useProject.projectName,
+    defaultProjectId = _useProject.defaultProjectId;
+  var _useSearchParams = reactRouterDom.useSearchParams(),
+    searchParams = _useSearchParams[0];
+  var projectValue = searchParams.get(projectName);
   var paths = util.splitUrlPath(pathname);
   var breadcrumbs = paths.map(function (path) {
     return {
@@ -220,10 +252,13 @@ var Breadcrumbs = function Breadcrumbs(_ref) {
         as: "span"
       }, title);
     }
+    if (!projectValue) {
+      searchParams.set(projectName, defaultProjectId);
+    }
     return React.createElement(menu.BreadcrumbItem, {
       key: path,
       as: reactRouterDom.Link,
-      to: path
+      to: path + "?" + searchParams.toString()
     }, title);
   });
   if (prependBreadcrumbItem) {
@@ -1106,6 +1141,37 @@ function useEventListener(eventName, handler, element) {
   }, [eventName, element]);
 }
 
+/**
+ * A custom hook that wraps the useNavigate hook from react-router-dom for MicroFrontend State
+ *
+ * @param to can be a string path, a To object, or a number (delta)
+ * @param options contains options for modifying the navigation
+ * @returns a function that navigates to the specified path with organisationId in the search params
+ */
+function useNavigateParams() {
+  var _useProject = useProject(),
+    projectName = _useProject.projectName,
+    defaultProjectId = _useProject.defaultProjectId;
+  var navigate = reactRouterDom.useNavigate();
+  var _useSearchParams = reactRouterDom.useSearchParams(),
+    searchParams = _useSearchParams[0];
+  var projectValue = searchParams.get(projectName);
+  var navigateParam = function navigateParam(to, options) {
+    if (options === void 0) {
+      options = {};
+    }
+    if (projectValue == null) {
+      searchParams.set(projectName, defaultProjectId);
+    }
+    if (typeof to === "number") {
+      navigate(to + "?" + searchParams.toString(), options);
+    } else {
+      navigate(to + "?" + searchParams.toString(), options);
+    }
+  };
+  return navigateParam;
+}
+
 exports.ActionBar = ActionBar;
 exports.ActionBarLeft = ActionBarLeft;
 exports.ActionBarRight = ActionBarRight;
@@ -1130,6 +1196,7 @@ exports.OrganisationDropDown = OrganisationDropDown;
 exports.PageTitle = PageTitle;
 exports.Pager = Pager;
 exports.PermissionCheck = PermissionCheck;
+exports.ProjectProvider = ProjectProvider;
 exports.RouteLeavingGuard = RouteLeavingGuard;
 exports.Stack = Stack;
 exports.StatusLabel = StatusLabel;
@@ -1143,4 +1210,6 @@ exports.responsiveProp = responsiveProp;
 exports.useDocumentTitle = useDocumentTitle;
 exports.useEventListener = useEventListener;
 exports.useFeatureToggle = useFeatureToggle;
+exports.useNavigateParams = useNavigateParams;
+exports.useProject = useProject;
 //# sourceMappingURL=common.cjs.development.js.map