@openmrs/esm-styleguide 10.0.1-pre.5498 → 10.0.1-pre.5501

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 123 files, copied 168 files with swc (322.91ms)
+[0] Successfully compiled: 123 files, copied 168 files with swc (224.95ms)
 [0] swc --strip-leading-paths --copy-files src -d dist && svgo -rf dist --quiet exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/workspaces2/active-workspace-window.component.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"active-workspace-window.component.d.ts","sourceRoot":"","sources":["../../src/workspaces2/active-workspace-window.component.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAuC,MAAM,OAAO,CAAC;AAK5D,OAAO,EAAE,KAAK,YAAY,EAA8D,MAAM,yBAAyB,CAAC;AAOxH,UAAU,oBAAoB;IAC5B,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;CACzB;AACD;;GAEG;AACH,QAAA,MAAM,qBAAqB,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CA4CzD,CAAC;AA2IF,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"active-workspace-window.component.d.ts","sourceRoot":"","sources":["../../src/workspaces2/active-workspace-window.component.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAuC,MAAM,OAAO,CAAC;AAK5D,OAAO,EAAE,KAAK,YAAY,EAA8D,MAAM,yBAAyB,CAAC;AAOxH,UAAU,oBAAoB;IAC5B,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;CACzB;AACD;;GAEG;AACH,QAAA,MAAM,qBAAqB,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CA4CzD,CAAC;AA4IF,eAAe,qBAAqB,CAAC"}

package/dist/workspaces2/active-workspace-window.component.js

@@ -112,6 +112,7 @@ const ActiveWorkspace = ({ lifeCycle, openedWorkspace, openedWindow, isRootWorks
             workspaceProps: openedWorkspace.props,
             windowProps: openedWindow.props,
             groupProps: openedGroup && openedGroup.props ? openedGroup.props : null,
+            workspaceMeta: workspace2Store.getState().registeredWorkspacesByName[openedWorkspace.workspaceName]?.meta ?? {},
             isRootWorkspace,
             isLeafWorkspace,
             windowName: openedWindow.windowName,

package/dist/workspaces2/workspace2.component.d.ts

@@ -27,6 +27,11 @@ export interface Workspace2DefinitionProps<WorkspaceProps extends object = objec
     workspaceProps: WorkspaceProps | null;
     windowProps: WindowProps | null;
     groupProps: GroupProps | null;
+    /**
+     * The workspace's `meta` from its registration (the `meta` field of its `workspaces2` entry in
+     * `routes.json`).
+     */
+    workspaceMeta?: Readonly<Record<string, unknown>>;
     workspaceName: string;
     windowName: string;
     isRootWorkspace: boolean;

package/dist/workspaces2/workspace2.component.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workspace2.component.d.ts","sourceRoot":"","sources":["../../src/workspaces2/workspace2.component.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAa,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAWzD,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB,CACxC,cAAc,SAAS,MAAM,GAAG,MAAM,EACtC,WAAW,SAAS,MAAM,GAAG,MAAM,EACnC,UAAU,SAAS,MAAM,GAAG,MAAM;IAElC;;;;;;OAMG;IACH,oBAAoB,CAAC,KAAK,SAAS,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzG;;;;;;OAMG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvG,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IACtC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,oBAAoB,CAC9B,cAAc,SAAS,MAAM,EAC7B,WAAW,SAAS,MAAM,EAC1B,UAAU,SAAS,MAAM,IACvB,KAAK,CAAC,EAAE,CAAC,yBAAyB,CAAC,cAAc,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAmJhD,CAAC"}
+{"version":3,"file":"workspace2.component.d.ts","sourceRoot":"","sources":["../../src/workspaces2/workspace2.component.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAa,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAWzD,UAAU,eAAe;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB,CACxC,cAAc,SAAS,MAAM,GAAG,MAAM,EACtC,WAAW,SAAS,MAAM,GAAG,MAAM,EACnC,UAAU,SAAS,MAAM,GAAG,MAAM;IAElC;;;;;;OAMG;IACH,oBAAoB,CAAC,KAAK,SAAS,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzG;;;;;;OAMG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvG,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IACtC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,oBAAoB,CAC9B,cAAc,SAAS,MAAM,EAC7B,WAAW,SAAS,MAAM,EAC1B,UAAU,SAAS,MAAM,IACvB,KAAK,CAAC,EAAE,CAAC,yBAAyB,CAAC,cAAc,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAmJhD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-styleguide",
-  "version": "10.0.1-pre.5498",
+  "version": "10.0.1-pre.5501",
   "license": "MPL-2.0",
   "description": "The styleguide for OpenMRS SPA",
   "module": "dist/internal.js",
@@ -78,18 +78,18 @@
     "react-aria-components": "^1.7.1"
   },
   "peerDependencies": {
-    "@openmrs/esm-api": "^10.0.1-pre.5498",
-    "@openmrs/esm-config": "^10.0.1-pre.5498",
-    "@openmrs/esm-emr-api": "^10.0.1-pre.5498",
-    "@openmrs/esm-error-handling": "^10.0.1-pre.5498",
-    "@openmrs/esm-extensions": "^10.0.1-pre.5498",
-    "@openmrs/esm-globals": "^10.0.1-pre.5498",
-    "@openmrs/esm-navigation": "^10.0.1-pre.5498",
-    "@openmrs/esm-react-utils": "^10.0.1-pre.5498",
-    "@openmrs/esm-routes": "^10.0.1-pre.5498",
-    "@openmrs/esm-state": "^10.0.1-pre.5498",
-    "@openmrs/esm-translations": "^10.0.1-pre.5498",
-    "@openmrs/esm-utils": "^10.0.1-pre.5498",
+    "@openmrs/esm-api": "^10.0.1-pre.5501",
+    "@openmrs/esm-config": "^10.0.1-pre.5501",
+    "@openmrs/esm-emr-api": "^10.0.1-pre.5501",
+    "@openmrs/esm-error-handling": "^10.0.1-pre.5501",
+    "@openmrs/esm-extensions": "^10.0.1-pre.5501",
+    "@openmrs/esm-globals": "^10.0.1-pre.5501",
+    "@openmrs/esm-navigation": "^10.0.1-pre.5501",
+    "@openmrs/esm-react-utils": "^10.0.1-pre.5501",
+    "@openmrs/esm-routes": "^10.0.1-pre.5501",
+    "@openmrs/esm-state": "^10.0.1-pre.5501",
+    "@openmrs/esm-translations": "^10.0.1-pre.5501",
+    "@openmrs/esm-utils": "^10.0.1-pre.5501",
     "dayjs": "1.x",
     "i18next": "25.x",
     "react": "18.x",
@@ -99,18 +99,18 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "10.0.1-pre.5498",
-    "@openmrs/esm-config": "10.0.1-pre.5498",
-    "@openmrs/esm-emr-api": "10.0.1-pre.5498",
-    "@openmrs/esm-error-handling": "10.0.1-pre.5498",
-    "@openmrs/esm-extensions": "10.0.1-pre.5498",
-    "@openmrs/esm-globals": "10.0.1-pre.5498",
-    "@openmrs/esm-navigation": "10.0.1-pre.5498",
-    "@openmrs/esm-react-utils": "10.0.1-pre.5498",
-    "@openmrs/esm-routes": "10.0.1-pre.5498",
-    "@openmrs/esm-state": "10.0.1-pre.5498",
-    "@openmrs/esm-translations": "10.0.1-pre.5498",
-    "@openmrs/esm-utils": "10.0.1-pre.5498",
+    "@openmrs/esm-api": "10.0.1-pre.5501",
+    "@openmrs/esm-config": "10.0.1-pre.5501",
+    "@openmrs/esm-emr-api": "10.0.1-pre.5501",
+    "@openmrs/esm-error-handling": "10.0.1-pre.5501",
+    "@openmrs/esm-extensions": "10.0.1-pre.5501",
+    "@openmrs/esm-globals": "10.0.1-pre.5501",
+    "@openmrs/esm-navigation": "10.0.1-pre.5501",
+    "@openmrs/esm-react-utils": "10.0.1-pre.5501",
+    "@openmrs/esm-routes": "10.0.1-pre.5501",
+    "@openmrs/esm-state": "10.0.1-pre.5501",
+    "@openmrs/esm-translations": "10.0.1-pre.5501",
+    "@openmrs/esm-utils": "10.0.1-pre.5501",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@types/geopattern": "^1.2.9",

package/src/workspaces2/active-workspace-window.component.tsx

@@ -150,6 +150,7 @@ const ActiveWorkspace: React.FC<ActiveWorkspaceProps> = ({
         workspaceProps: openedWorkspace.props,
         windowProps: openedWindow.props,
         groupProps: openedGroup && openedGroup.props ? openedGroup.props : null,
+        workspaceMeta: workspace2Store.getState().registeredWorkspacesByName[openedWorkspace.workspaceName]?.meta ?? {},
         isRootWorkspace,
         isLeafWorkspace,
         windowName: openedWindow.windowName,

package/src/workspaces2/active-workspace-window.test.tsx

@@ -9,8 +9,15 @@ vi.mock('@openmrs/esm-routes', () => ({
   loadLifeCycles: vi.fn(),
 }));
 
+// Captures the props single-spa-react's <Parcel> is handed, so the passthrough of workspace props
+// (workspaceMeta included) can be asserted. Hoisted so the mock factory can reference it.
+const { parcelProps } = vi.hoisted(() => ({ parcelProps: [] as Array<Record<string, any>> }));
+
 vi.mock('single-spa-react/parcel', () => ({
-  default: ({ config }: { config: { name: string } }) => <div data-testid="parcel">{config.name}</div>,
+  default: (props: { config: { name: string } }) => {
+    parcelProps.push(props);
+    return <div data-testid="parcel">{props.config.name}</div>;
+  },
 }));
 
 const mockLoadLifeCycles = vi.mocked(loadLifeCycles);
@@ -37,6 +44,7 @@ describe('ActiveWorkspaceWindow', () => {
           component: 'form',
           window: 'test-window',
           moduleName: 'test-module',
+          meta: { columns: 3, title: 'Form' },
         },
         'admit-workspace': {
           name: 'admit-workspace',
@@ -55,6 +63,7 @@ describe('ActiveWorkspaceWindow', () => {
 
   afterEach(() => {
     vi.clearAllMocks();
+    parcelProps.length = 0;
   });
 
   it('does not render a replaced workspace with the previous workspace lifecycle at the same stack position', async () => {
@@ -96,4 +105,32 @@ describe('ActiveWorkspaceWindow', () => {
     });
     expect(screen.getByTestId('parcel')).toHaveTextContent('admit-lifecycle');
   });
+
+  it("passes the workspace's registered meta to the parcel via workspaceMeta", async () => {
+    mockLoadLifeCycles.mockResolvedValue({ name: 'form-lifecycle' } as never);
+
+    const formWorkspace = makeOpenedWorkspace('form-workspace', 'uuid-form');
+    render(<ActiveWorkspaceWindow openedWindow={makeOpenedWindow([formWorkspace])} showActionMenu={false} />);
+
+    await act(async () => {
+      await Promise.resolve();
+    });
+
+    const props = parcelProps.find((p) => p.config.name === 'form-lifecycle');
+    expect(props?.workspaceMeta).toEqual({ columns: 3, title: 'Form' });
+  });
+
+  it('passes an empty workspaceMeta when the workspace declares no meta', async () => {
+    mockLoadLifeCycles.mockResolvedValue({ name: 'admit-lifecycle' } as never);
+
+    const admitWorkspace = makeOpenedWorkspace('admit-workspace', 'uuid-admit');
+    render(<ActiveWorkspaceWindow openedWindow={makeOpenedWindow([admitWorkspace])} showActionMenu={false} />);
+
+    await act(async () => {
+      await Promise.resolve();
+    });
+
+    const props = parcelProps.find((p) => p.config.name === 'admit-lifecycle');
+    expect(props?.workspaceMeta).toEqual({});
+  });
 });

package/src/workspaces2/workspace2.component.tsx

@@ -41,6 +41,11 @@ export interface Workspace2DefinitionProps<
   workspaceProps: WorkspaceProps | null;
   windowProps: WindowProps | null;
   groupProps: GroupProps | null;
+  /**
+   * The workspace's `meta` from its registration (the `meta` field of its `workspaces2` entry in
+   * `routes.json`).
+   */
+  workspaceMeta?: Readonly<Record<string, unknown>>;
   workspaceName: string;
   windowName: string;
   isRootWorkspace: boolean;