@openmrs/esm-extensions 6.0.3-pre.2631 → 6.0.3-pre.2634

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-extensions",
-  "version": "6.0.3-pre.2631",
+  "version": "6.0.3-pre.2634",
   "license": "MPL-2.0",
   "description": "Coordinates extensions and extension points in the OpenMRS Frontend",
   "browser": "dist/openmrs-esm-extensions.js",
@@ -47,12 +47,12 @@
     "single-spa": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "6.0.3-pre.2631",
-    "@openmrs/esm-config": "6.0.3-pre.2631",
-    "@openmrs/esm-expression-evaluator": "6.0.3-pre.2631",
-    "@openmrs/esm-feature-flags": "6.0.3-pre.2631",
-    "@openmrs/esm-state": "6.0.3-pre.2631",
-    "@openmrs/esm-utils": "6.0.3-pre.2631",
+    "@openmrs/esm-api": "6.0.3-pre.2634",
+    "@openmrs/esm-config": "6.0.3-pre.2634",
+    "@openmrs/esm-expression-evaluator": "6.0.3-pre.2634",
+    "@openmrs/esm-feature-flags": "6.0.3-pre.2634",
+    "@openmrs/esm-state": "6.0.3-pre.2634",
+    "@openmrs/esm-utils": "6.0.3-pre.2634",
     "single-spa": "^6.0.1"
   },
   "dependencies": {

package/src/workspaces.ts

@@ -1,6 +1,6 @@
 import { type ReactNode } from 'react';
 import { type LifeCycles } from 'single-spa';
-import { type WorkspaceWindowState } from '@openmrs/esm-globals';
+import { type WorkspaceGroupDefinition, type WorkspaceWindowState } from '@openmrs/esm-globals';
 import { type ExtensionRegistration, getExtensionRegistration } from '.';
 import { createGlobalStore } from '@openmrs/esm-state';
 import { translateFrom } from '@openmrs/esm-translations';
@@ -17,9 +17,13 @@ export interface WorkspaceRegistration {
   preferredWindowSize: WorkspaceWindowState;
   load: () => Promise<{ default?: LifeCycles } & LifeCycles>;
   moduleName: string;
-  groups?: Array<string>;
+  groups: Array<string>;
 }
 
+export type WorkspaceGroupRegistration = WorkspaceGroupDefinition & {
+  members: Array<string>;
+};
+
 interface WorkspaceRegistrationStore {
   workspaces: Record<string, WorkspaceRegistration>;
 }
@@ -28,6 +32,14 @@ const workspaceRegistrationStore = createGlobalStore<WorkspaceRegistrationStore>
   workspaces: {},
 });
 
+interface WorkspaceGroupRegistrationStore {
+  workspaceGroups: Record<string, { name: string; members: Array<string> }>;
+}
+
+const workspaceGroupStore = createGlobalStore<WorkspaceGroupRegistrationStore>('workspaceGroups', {
+  workspaceGroups: {},
+});
+
 /** See [[WorkspaceDefinition]] for more information about these properties */
 export interface RegisterWorkspaceOptions {
   name: string;
@@ -64,6 +76,23 @@ export function registerWorkspace(workspace: RegisterWorkspaceOptions) {
   }));
 }
 
+/**
+ * Tells the workspace system about a workspace group. This is used by the app shell
+ * to register workspace groups defined in the `routes.json` file.
+ * @internal
+ */
+export function registerWorkspaceGroup(workspaceGroup: WorkspaceGroupRegistration) {
+  workspaceGroupStore.setState((state) => ({
+    workspaceGroups: {
+      ...state.workspaceGroups,
+      [workspaceGroup.name]: {
+        name: workspaceGroup.name,
+        members: workspaceGroup.members,
+      },
+    },
+  }));
+}
+
 const workspaceExtensionWarningsIssued = new Set();
 /**
  * This exists for compatibility with the old way of registering
@@ -94,7 +123,7 @@ export function getWorkspaceRegistration(name: string): WorkspaceRegistration {
         canHide: workspaceExtension.meta?.canHide ?? false,
         canMaximize: workspaceExtension.meta?.canMaximize ?? false,
         width: workspaceExtension.meta?.width ?? 'narrow',
-        groups: workspaceExtension?.meta?.groups ?? [],
+        groups: workspaceExtension.meta?.groups ?? [],
       };
     } else {
       throw new Error(`No workspace named '${name}' has been registered.`);
@@ -102,6 +131,21 @@ export function getWorkspaceRegistration(name: string): WorkspaceRegistration {
   }
 }
 
+/**
+ * This provides the workspace group registration and is also compatibile with the
+ * old way of registering workspace groups (as extensions), but isn't recommended.
+ *
+ * @param name of the workspace
+ */
+export function getWorkspaceGroupRegistration(name: string): WorkspaceGroupRegistration {
+  const registeredWorkspaces = workspaceGroupStore.getState().workspaceGroups;
+  if (registeredWorkspaces[name]) {
+    return registeredWorkspaces[name];
+  } else {
+    throw new Error(`No workspace group named '${name}' has been registered.`);
+  }
+}
+
 function getTitleFromExtension(ext: ExtensionRegistration) {
   const title = ext?.meta?.title;
   if (typeof title === 'string') {
@@ -111,3 +155,37 @@ function getTitleFromExtension(ext: ExtensionRegistration) {
   }
   return ext.name;
 }
+
+function createNewWorkspaceGroupInfo(groupName: string): WorkspaceGroupRegistration {
+  return {
+    name: groupName,
+    members: [],
+  };
+}
+
+export function attachWorkspaceToGroup(workspaceName: string, groupName: string) {
+  workspaceGroupStore.setState((state) => {
+    const group = state.workspaceGroups[groupName];
+    if (group) {
+      return {
+        workspaceGroups: {
+          ...state.workspaceGroups,
+          [groupName]: {
+            ...group,
+            members: [...group.members, workspaceName],
+          },
+        },
+      };
+    } else {
+      return {
+        workspaceGroups: {
+          ...state.workspaceGroups,
+          [groupName]: {
+            ...createNewWorkspaceGroupInfo(groupName),
+            members: [workspaceName],
+          },
+        },
+      };
+    }
+  });
+}