@openmrs/esm-extensions 7.0.1-pre.3259 → 7.0.1-pre.3273

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 10 files with swc (95.42ms)
+[0] Successfully compiled: 11 files with swc (171.4ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './helpers';
 export * from './left-nav';
 export * from './modals';
 export * from './workspaces';
+export * from './workspaces2';
 export * from './render';
 export * from './store';
 export * from './types';

package/dist/index.js

@@ -3,6 +3,7 @@ export * from "./helpers.js";
 export * from "./left-nav.js";
 export * from "./modals.js";
 export * from "./workspaces.js";
+export * from "./workspaces2.js";
 export * from "./render.js";
 export * from "./store.js";
 export * from "./types.js";

package/dist/workspaces.d.ts

@@ -52,7 +52,7 @@ export declare function registerWorkspaceGroup(workspaceGroup: WorkspaceGroupReg
  */
 export declare function getWorkspaceRegistration(name: string): WorkspaceRegistration;
 /**
- * This provides the workspace group registration and is also compatibile with the
+ * This provides the workspace group registration and is also compatible with the
  * old way of registering workspace groups (as extensions), but isn't recommended.
  *
  * @param name of the workspace

package/dist/workspaces.js

@@ -99,7 +99,7 @@ const workspaceExtensionWarningsIssued = new Set();
     }
 }
 /**
- * This provides the workspace group registration and is also compatibile with the
+ * This provides the workspace group registration and is also compatible with the
  * old way of registering workspace groups (as extensions), but isn't recommended.
  *
  * @param name of the workspace

package/dist/workspaces2.d.ts

@@ -0,0 +1,51 @@
+import { type WorkspaceDefinition2, type WorkspaceGroupDefinition2, type WorkspaceWindowDefinition2 } from '@openmrs/esm-globals';
+export interface OpenedWorkspace {
+    workspaceName: string;
+    props: Record<string, any> | null;
+    hasUnsavedChanges: boolean;
+    /** Unique identifier for the workspace instance, used to track unique instances of the same workspace */
+    uuid: string;
+}
+export interface OpenedWindow {
+    windowName: string;
+    /** Root workspace at index 0, child workspaces follow */
+    openedWorkspaces: Array<OpenedWorkspace>;
+    props: Record<string, any> | null;
+    maximized: boolean;
+    hidden: boolean;
+}
+export interface WorkspaceStoreState2 {
+    registeredGroupsByName: Record<string, WorkspaceGroupDefinition2>;
+    registeredWindowsByName: Record<string, WorkspaceWindowDefinition2 & {
+        moduleName: string;
+    }>;
+    registeredWorkspacesByName: Record<string, WorkspaceDefinition2 & {
+        moduleName: string;
+    }>;
+    openedGroup: {
+        groupName: string;
+        props: Record<string, any> | null;
+    } | null;
+    /** Most recently opened window at the end of array. Each element has a unique windowName */
+    openedWindows: Array<OpenedWindow>;
+    workspaceTitleByWorkspaceName: Record<string, string>;
+}
+export declare const workspace2Store: import("zustand").StoreApi<WorkspaceStoreState2>;
+/**
+ * Given a workspace name, return the window that the workspace belongs to
+ * @param workspaceName
+ * @returns
+ */
+export declare function getWindowByWorkspaceName(workspaceName: string): WorkspaceWindowDefinition2 & {
+    moduleName: string;
+};
+/**
+ * Given a window name, return the group that the window belongs to
+ * @param windowName
+ * @returns
+ */
+export declare function getGroupByWindowName(windowName: string): WorkspaceGroupDefinition2;
+export declare function getOpenedWindowIndexByWorkspace(workspaceName: string): number;
+export declare function registerWorkspaceGroups2(workspaceGroupDefs: Array<WorkspaceGroupDefinition2>): void;
+export declare function registerWorkspaceWindows2(appName: string, workspaceWindowDefs: Array<WorkspaceWindowDefinition2>): void;
+export declare function registerWorkspaces2(moduleName: string, workspaceDefs: Array<WorkspaceDefinition2>): void;

package/dist/workspaces2.js

@@ -0,0 +1,112 @@
+import { createGlobalStore } from "@openmrs/esm-state";
+const initialState = {
+    registeredGroupsByName: {},
+    registeredWindowsByName: {},
+    registeredWorkspacesByName: {},
+    openedGroup: null,
+    openedWindows: [],
+    workspaceTitleByWorkspaceName: {}
+};
+export const workspace2Store = createGlobalStore('workspace2', initialState);
+/**
+ * Given a workspace name, return the window that the workspace belongs to
+ * @param workspaceName
+ * @returns
+ */ export function getWindowByWorkspaceName(workspaceName) {
+    const { registeredWorkspacesByName, registeredWindowsByName } = workspace2Store.getState();
+    const workspace = registeredWorkspacesByName[workspaceName];
+    if (!workspace) {
+        throw new Error(`No workspace found with name: ${workspaceName}`);
+    } else {
+        const workspaceWindow = registeredWindowsByName[workspace.window];
+        if (!workspaceWindow) {
+            throw new Error(`No workspace window found with name: ${workspace.window} for workspace: ${workspaceName}`);
+        } else {
+            return workspaceWindow;
+        }
+    }
+}
+/**
+ * Given a window name, return the group that the window belongs to
+ * @param windowName
+ * @returns
+ */ export function getGroupByWindowName(windowName) {
+    const { registeredGroupsByName, registeredWindowsByName } = workspace2Store.getState();
+    const workspaceWindow = registeredWindowsByName[windowName];
+    if (!workspaceWindow) {
+        throw new Error(`No workspace window found with name: ${windowName}`);
+    } else {
+        const group = registeredGroupsByName[workspaceWindow.group];
+        if (!group) {
+            throw new Error(`No workspace group found with name: ${workspaceWindow.group} for window: ${windowName}`);
+        } else {
+            return group;
+        }
+    }
+}
+export function getOpenedWindowIndexByWorkspace(workspaceName) {
+    const { openedWindows } = workspace2Store.getState();
+    return openedWindows.findIndex((a)=>a.openedWorkspaces.find((openedWorkspace)=>openedWorkspace.workspaceName === workspaceName));
+}
+export function registerWorkspaceGroups2(workspaceGroupDefs) {
+    if (workspaceGroupDefs.length == 0) {
+        return;
+    }
+    const { registeredGroupsByName } = workspace2Store.getState();
+    const newRegisteredGroupsByName = {
+        ...registeredGroupsByName
+    };
+    for (const workspaceGroupDef of workspaceGroupDefs){
+        if (newRegisteredGroupsByName[workspaceGroupDef.name]) {
+            throw new Error(`Cannot register workspace group ${workspaceGroupDef.name} more than once`);
+        }
+        newRegisteredGroupsByName[workspaceGroupDef.name] = workspaceGroupDef;
+    }
+    workspace2Store.setState({
+        registeredGroupsByName: newRegisteredGroupsByName
+    });
+}
+export function registerWorkspaceWindows2(appName, workspaceWindowDefs) {
+    if (workspaceWindowDefs.length == 0) {
+        return;
+    }
+    const { registeredWindowsByName } = workspace2Store.getState();
+    const newRegisteredWindowsByName = {
+        ...registeredWindowsByName
+    };
+    for (const windowDef of workspaceWindowDefs){
+        if (newRegisteredWindowsByName[windowDef.name]) {
+            throw new Error(`Cannot register workspace window ${windowDef.name} more than once`);
+        }
+        const registeredWindowDef = {
+            ...windowDef,
+            moduleName: appName
+        };
+        newRegisteredWindowsByName[windowDef.name] = registeredWindowDef;
+    }
+    workspace2Store.setState({
+        registeredWindowsByName: newRegisteredWindowsByName
+    });
+}
+export function registerWorkspaces2(moduleName, workspaceDefs) {
+    if (workspaceDefs.length == 0) {
+        return;
+    }
+    const { registeredWorkspacesByName } = workspace2Store.getState();
+    const newRegisteredWorkspacesByName = {
+        ...registeredWorkspacesByName
+    };
+    for (const workspaceDef of workspaceDefs){
+        if (newRegisteredWorkspacesByName[workspaceDef.name]) {
+            throw new Error(`Cannot register workspace ${workspaceDef.name} more than once`);
+        }
+        const workspaceDefWithLoader = {
+            ...workspaceDef,
+            moduleName
+        };
+        newRegisteredWorkspacesByName[workspaceDef.name] = workspaceDefWithLoader;
+    }
+    workspace2Store.setState({
+        registeredWorkspacesByName: newRegisteredWorkspacesByName
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-extensions",
-  "version": "7.0.1-pre.3259",
+  "version": "7.0.1-pre.3273",
   "license": "MPL-2.0",
   "description": "Coordinates extensions and extension points in the OpenMRS Frontend",
   "type": "module",
@@ -64,12 +64,12 @@
     "single-spa": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "7.0.1-pre.3259",
-    "@openmrs/esm-config": "7.0.1-pre.3259",
-    "@openmrs/esm-expression-evaluator": "7.0.1-pre.3259",
-    "@openmrs/esm-feature-flags": "7.0.1-pre.3259",
-    "@openmrs/esm-state": "7.0.1-pre.3259",
-    "@openmrs/esm-utils": "7.0.1-pre.3259",
+    "@openmrs/esm-api": "7.0.1-pre.3273",
+    "@openmrs/esm-config": "7.0.1-pre.3273",
+    "@openmrs/esm-expression-evaluator": "7.0.1-pre.3273",
+    "@openmrs/esm-feature-flags": "7.0.1-pre.3273",
+    "@openmrs/esm-state": "7.0.1-pre.3273",
+    "@openmrs/esm-utils": "7.0.1-pre.3273",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/index.ts

@@ -3,6 +3,7 @@ export * from './helpers';
 export * from './left-nav';
 export * from './modals';
 export * from './workspaces';
+export * from './workspaces2';
 export * from './render';
 export * from './store';
 export * from './types';

package/src/workspaces.ts

@@ -152,7 +152,7 @@ export function getWorkspaceRegistration(name: string): WorkspaceRegistration {
 }
 
 /**
- * This provides the workspace group registration and is also compatibile with the
+ * This provides the workspace group registration and is also compatible with the
  * old way of registering workspace groups (as extensions), but isn't recommended.
  *
  * @param name of the workspace

package/src/workspaces2.ts

@@ -0,0 +1,149 @@
+import {
+  type WorkspaceDefinition2,
+  type WorkspaceGroupDefinition2,
+  type WorkspaceWindowDefinition2,
+} from '@openmrs/esm-globals';
+import { createGlobalStore } from '@openmrs/esm-state';
+
+export interface OpenedWorkspace {
+  workspaceName: string;
+  props: Record<string, any> | null;
+  hasUnsavedChanges: boolean;
+  /** Unique identifier for the workspace instance, used to track unique instances of the same workspace */
+  uuid: string;
+}
+export interface OpenedWindow {
+  windowName: string;
+  /** Root workspace at index 0, child workspaces follow */
+  openedWorkspaces: Array<OpenedWorkspace>;
+  props: Record<string, any> | null;
+  maximized: boolean;
+  hidden: boolean;
+}
+export interface WorkspaceStoreState2 {
+  registeredGroupsByName: Record<string, WorkspaceGroupDefinition2>;
+  registeredWindowsByName: Record<string, WorkspaceWindowDefinition2 & { moduleName: string }>;
+  registeredWorkspacesByName: Record<string, WorkspaceDefinition2 & { moduleName: string }>;
+  openedGroup: {
+    groupName: string;
+    props: Record<string, any> | null;
+  } | null;
+  /** Most recently opened window at the end of array. Each element has a unique windowName */
+  openedWindows: Array<OpenedWindow>;
+
+  workspaceTitleByWorkspaceName: Record<string, string>;
+}
+
+const initialState: WorkspaceStoreState2 = {
+  registeredGroupsByName: {},
+  registeredWindowsByName: {},
+  registeredWorkspacesByName: {},
+  openedGroup: null,
+  openedWindows: [],
+  workspaceTitleByWorkspaceName: {},
+};
+
+export const workspace2Store = createGlobalStore<WorkspaceStoreState2>('workspace2', initialState);
+
+/**
+ * Given a workspace name, return the window that the workspace belongs to
+ * @param workspaceName
+ * @returns
+ */
+export function getWindowByWorkspaceName(workspaceName: string) {
+  const { registeredWorkspacesByName, registeredWindowsByName } = workspace2Store.getState();
+  const workspace = registeredWorkspacesByName[workspaceName];
+  if (!workspace) {
+    throw new Error(`No workspace found with name: ${workspaceName}`);
+  } else {
+    const workspaceWindow = registeredWindowsByName[workspace.window];
+    if (!workspaceWindow) {
+      throw new Error(`No workspace window found with name: ${workspace.window} for workspace: ${workspaceName}`);
+    } else {
+      return workspaceWindow;
+    }
+  }
+}
+
+/**
+ * Given a window name, return the group that the window belongs to
+ * @param windowName
+ * @returns
+ */
+export function getGroupByWindowName(windowName: string) {
+  const { registeredGroupsByName, registeredWindowsByName } = workspace2Store.getState();
+  const workspaceWindow = registeredWindowsByName[windowName];
+  if (!workspaceWindow) {
+    throw new Error(`No workspace window found with name: ${windowName}`);
+  } else {
+    const group = registeredGroupsByName[workspaceWindow.group];
+    if (!group) {
+      throw new Error(`No workspace group found with name: ${workspaceWindow.group} for window: ${windowName}`);
+    } else {
+      return group;
+    }
+  }
+}
+
+export function getOpenedWindowIndexByWorkspace(workspaceName: string) {
+  const { openedWindows } = workspace2Store.getState();
+  return openedWindows.findIndex((a) =>
+    a.openedWorkspaces.find((openedWorkspace) => openedWorkspace.workspaceName === workspaceName),
+  );
+}
+
+export function registerWorkspaceGroups2(workspaceGroupDefs: Array<WorkspaceGroupDefinition2>) {
+  if (workspaceGroupDefs.length == 0) {
+    return;
+  }
+  const { registeredGroupsByName } = workspace2Store.getState();
+  const newRegisteredGroupsByName = { ...registeredGroupsByName };
+  for (const workspaceGroupDef of workspaceGroupDefs) {
+    if (newRegisteredGroupsByName[workspaceGroupDef.name]) {
+      throw new Error(`Cannot register workspace group ${workspaceGroupDef.name} more than once`);
+    }
+    newRegisteredGroupsByName[workspaceGroupDef.name] = workspaceGroupDef;
+  }
+
+  workspace2Store.setState({
+    registeredGroupsByName: newRegisteredGroupsByName,
+  });
+}
+
+export function registerWorkspaceWindows2(appName: string, workspaceWindowDefs: Array<WorkspaceWindowDefinition2>) {
+  if (workspaceWindowDefs.length == 0) {
+    return;
+  }
+  const { registeredWindowsByName } = workspace2Store.getState();
+  const newRegisteredWindowsByName = { ...registeredWindowsByName };
+  for (const windowDef of workspaceWindowDefs) {
+    if (newRegisteredWindowsByName[windowDef.name]) {
+      throw new Error(`Cannot register workspace window ${windowDef.name} more than once`);
+    }
+    const registeredWindowDef = { ...windowDef, moduleName: appName };
+    newRegisteredWindowsByName[windowDef.name] = registeredWindowDef;
+  }
+
+  workspace2Store.setState({
+    registeredWindowsByName: newRegisteredWindowsByName,
+  });
+}
+
+export function registerWorkspaces2(moduleName: string, workspaceDefs: Array<WorkspaceDefinition2>) {
+  if (workspaceDefs.length == 0) {
+    return;
+  }
+  const { registeredWorkspacesByName } = workspace2Store.getState();
+  const newRegisteredWorkspacesByName = { ...registeredWorkspacesByName };
+  for (const workspaceDef of workspaceDefs) {
+    if (newRegisteredWorkspacesByName[workspaceDef.name]) {
+      throw new Error(`Cannot register workspace ${workspaceDef.name} more than once`);
+    }
+    const workspaceDefWithLoader = { ...workspaceDef, moduleName };
+    newRegisteredWorkspacesByName[workspaceDef.name] = workspaceDefWithLoader;
+  }
+
+  workspace2Store.setState({
+    registeredWorkspacesByName: newRegisteredWorkspacesByName,
+  });
+}