@openmrs/esm-styleguide 10.0.1-pre.5720 → 10.0.1-pre.5738

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 117 files, copied 171 files with swc (199.02ms)
+[0] Successfully compiled: 117 files, copied 171 files with swc (167.72ms)
 [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/workspace2.component.d.ts

@@ -36,15 +36,16 @@ export interface Workspace2DefinitionProps<WorkspaceProps extends object = objec
     windowName: string;
     isRootWorkspace: boolean;
     showActionMenu: boolean;
-    /**
-     * Records the title of this workspace, for display in the workspace window header.
-     * @internal Called by `<Workspace2>`; use its `title` prop instead.
-     */
+}
+/**
+ * The props the framework actually passes to a workspace: the public `Workspace2DefinitionProps` plus
+ * the setters `<Workspace2>` uses to report its `title` and `hasUnsavedChanges` to the workspace window.
+ * Not part of the public API.
+ */
+export interface Workspace2InternalProps<WorkspaceProps extends object = object, WindowProps extends object = object, GroupProps extends object = object> extends Workspace2DefinitionProps<WorkspaceProps, WindowProps, GroupProps> {
+    /** Records the title of this workspace, for display in the workspace window header. */
     setWorkspaceTitle(title: string): void;
-    /**
-     * Records whether this workspace has unsaved changes.
-     * @internal Called by `<Workspace2>`; use its `hasUnsavedChanges` prop instead.
-     */
+    /** Records whether this workspace has unsaved changes. */
     setHasUnsavedChanges(hasUnsavedChanges: boolean): void;
 }
 export type Workspace2Definition<WorkspaceProps extends object, WindowProps extends object, GroupProps extends object> = React.FC<Workspace2DefinitionProps<WorkspaceProps, WindowProps, GroupProps>>;

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;AAGzD,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;IAExB;;;OAGG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,oBAAoB,CAAC,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;CACxD;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,CAiBhD,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;AAGzD,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;;;;GAIG;AACH,MAAM,WAAW,uBAAuB,CACtC,cAAc,SAAS,MAAM,GAAG,MAAM,EACtC,WAAW,SAAS,MAAM,GAAG,MAAM,EACnC,UAAU,SAAS,MAAM,GAAG,MAAM,CAClC,SAAQ,yBAAyB,CAAC,cAAc,EAAE,WAAW,EAAE,UAAU,CAAC;IAC1E,uFAAuF;IACvF,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC,0DAA0D;IAC1D,oBAAoB,CAAC,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;CACxD;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,CAiBhD,CAAC"}

package/package.json

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

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

@@ -16,7 +16,7 @@ import { loadLifeCycles } from '@openmrs/esm-routes';
 import { getCoreTranslation } from '@openmrs/esm-translations';
 import { ArrowRightIcon, CloseIcon } from '../icons';
 import { closeWorkspaceGroup2, getOpenedWindowWidth, useWorkspace2Store } from './workspace2';
-import { type Workspace2DefinitionProps } from './workspace2.component';
+import { type Workspace2InternalProps } from './workspace2.component';
 import { type WorkspaceWindowActions } from './workspace-window-actions';
 import styles from './workspace2.module.scss';
 
@@ -127,7 +127,7 @@ const ActiveWorkspace: React.FC<ActiveWorkspaceProps> = ({
   isLeafWorkspace,
   showActionMenu,
 }) => {
-  const props: Workspace2DefinitionProps = useMemo(
+  const props: Workspace2InternalProps = useMemo(
     () =>
       openedWorkspace && {
         closeWorkspace: async (options = {}) => {

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

@@ -5,7 +5,7 @@ import { workspace2Store, type OpenedWindow, type OpenedWorkspace } from '@openm
 import { loadLifeCycles } from '@openmrs/esm-routes';
 import ActiveWorkspaceWindow from './active-workspace-window.component';
 import styles from './workspace2.module.scss';
-import { type Workspace2DefinitionProps } from './workspace2.component';
+import { type Workspace2InternalProps } from './workspace2.component';
 import { type WorkspaceWindowActions } from './workspace-window-actions';
 
 vi.mock('@openmrs/esm-routes', () => ({
@@ -14,13 +14,13 @@ vi.mock('@openmrs/esm-routes', () => ({
 
 // Records the props each parcel was handed, keyed by workspace name, so tests can call them the way
 // the workspace component would.
-const { parcelProps } = vi.hoisted(() => ({ parcelProps: {} as Record<string, Workspace2DefinitionProps> }));
+const { parcelProps } = vi.hoisted(() => ({ parcelProps: {} as Record<string, Workspace2InternalProps> }));
 vi.mock('single-spa-react/parcel', () => ({
   default: ({
     config,
     wrapClassName,
     ...props
-  }: { config: { name: string }; wrapClassName?: string } & Workspace2DefinitionProps) => {
+  }: { config: { name: string }; wrapClassName?: string } & Workspace2InternalProps) => {
     parcelProps[props.workspaceName] = props;
     // Surface the wrapper class the real Parcel would apply, so tests can assert stacking/visibility.
     return (

package/src/workspaces2/exported-workspace.test.tsx

@@ -5,7 +5,7 @@ import { workspace2Store } from '@openmrs/esm-extensions';
 import { loadLifeCycles } from '@openmrs/esm-routes';
 import { showModal } from '../modals';
 import { ExportedWorkspace, type ExportedWorkspaceWindowInfo } from './exported-workspace.component';
-import { type Workspace2DefinitionProps } from './workspace2.component';
+import { type Workspace2InternalProps } from './workspace2.component';
 
 vi.mock('@openmrs/esm-routes', () => ({
   loadLifeCycles: vi.fn(),
@@ -18,9 +18,9 @@ vi.mock('../modals', () => ({
 // The parcel is where the workspace component (and its <Workspace2>) would mount. We stub it out,
 // surface the workspace name it was handed, and record its props (keyed by workspace name) so tests
 // can call them the way the workspace component would.
-const { parcelProps } = vi.hoisted(() => ({ parcelProps: {} as Record<string, Workspace2DefinitionProps> }));
+const { parcelProps } = vi.hoisted(() => ({ parcelProps: {} as Record<string, Workspace2InternalProps> }));
 vi.mock('single-spa-react/parcel', () => ({
-  default: (props: Workspace2DefinitionProps) => {
+  default: (props: Workspace2InternalProps) => {
     parcelProps[props.workspaceName] = props;
     return <div data-testid="parcel">{props.workspaceName}</div>;
   },

package/src/workspaces2/workspace2.component.tsx

@@ -42,17 +42,22 @@ export interface Workspace2DefinitionProps<
   windowName: string;
   isRootWorkspace: boolean;
   showActionMenu: boolean;
+}
 
-  /**
-   * Records the title of this workspace, for display in the workspace window header.
-   * @internal Called by `<Workspace2>`; use its `title` prop instead.
-   */
+/**
+ * The props the framework actually passes to a workspace: the public `Workspace2DefinitionProps` plus
+ * the setters `<Workspace2>` uses to report its `title` and `hasUnsavedChanges` to the workspace window.
+ * Not part of the public API.
+ */
+export interface Workspace2InternalProps<
+  WorkspaceProps extends object = object,
+  WindowProps extends object = object,
+  GroupProps extends object = object,
+> extends Workspace2DefinitionProps<WorkspaceProps, WindowProps, GroupProps> {
+  /** Records the title of this workspace, for display in the workspace window header. */
   setWorkspaceTitle(title: string): void;
 
-  /**
-   * Records whether this workspace has unsaved changes.
-   * @internal Called by `<Workspace2>`; use its `hasUnsavedChanges` prop instead.
-   */
+  /** Records whether this workspace has unsaved changes. */
   setHasUnsavedChanges(hasUnsavedChanges: boolean): void;
 }
 
@@ -71,7 +76,7 @@ export type Workspace2Definition<
 export const Workspace2: React.FC<Workspace2Props> = ({ title, children, hasUnsavedChanges = false }) => {
   // These are bound to this workspace instance, in whichever store holds it (the global store, or an
   // `<ExportedWorkspace>`'s local store). They skip writes that change nothing.
-  const { setHasUnsavedChanges, setWorkspaceTitle } = useWorkspace2Context();
+  const { setHasUnsavedChanges, setWorkspaceTitle } = useWorkspace2Context() as Workspace2InternalProps;
 
   useEffect(() => {
     setHasUnsavedChanges(hasUnsavedChanges ?? false);