@openmrs/esm-globals 7.0.1-pre.3258 → 7.0.1-pre.3273

package/.turbo/turbo-build.log

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

package/dist/types.d.ts

@@ -127,9 +127,9 @@ export type PageDefinition = {
      */
     offline?: boolean;
     /**
-     * Determines the order in which this page is rendered in the app-shell, which is useful for situations where DOM ordering matters.
+     * If supplied, the page will be rendered within the DOM element with the specified ID. Defaults to "omrs-apps-container" if not supplied.
      */
-    order?: number;
+    containerDomId?: string;
 } & ({
     /**
      * Either a string or a boolean.
@@ -161,9 +161,7 @@ export type PageDefinition = {
  * @internal
  * A definition of a page after the app has been registered.
  */
-export type RegisteredPageDefinition = Omit<PageDefinition, 'order'> & AppComponent & {
-    order: number;
-};
+export type RegisteredPageDefinition = PageDefinition & AppComponent;
 /**
  * A definition of an extension as extracted from an app's routes.json
  */
@@ -292,6 +290,26 @@ export interface WorkspaceGroupDefinition {
      */
     members?: Array<string>;
 }
+export interface WorkspaceGroupDefinition2 {
+    name: string;
+    closeable?: boolean;
+    overlay?: boolean;
+}
+export interface WorkspaceWindowDefinition2 {
+    name: string;
+    icon?: string;
+    canHide: boolean;
+    canMaximize: boolean;
+    overlay: boolean;
+    group: string;
+    order?: number;
+    width?: 'narrow' | 'wider' | 'extra-wide';
+}
+export interface WorkspaceDefinition2 {
+    name: string;
+    component: string;
+    window: string;
+}
 /**
  * A definition of a feature flag extracted from the routes.json
  */
@@ -331,6 +349,12 @@ export interface OpenmrsAppRoutes {
     workspaces?: Array<WorkspaceDefinition>;
     /** An array of all workspace groups supported by this frontend module. */
     workspaceGroups?: Array<WorkspaceGroupDefinition>;
+    /** An array of all workspace groups (v2) supported by this frontend module. */
+    workspaceGroups2?: Array<WorkspaceGroupDefinition2>;
+    /** An array of all workspace windows (v2) supported by this frontend module. */
+    workspaceWindows2?: Array<WorkspaceWindowDefinition2>;
+    /** An array of all workspaces (v2) supported by this frontend module. */
+    workspaces2?: Array<WorkspaceDefinition2>;
 }
 /**
  * This interfaces describes the format of the overall routes.json loaded by the app shell.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-globals",
-  "version": "7.0.1-pre.3258",
+  "version": "7.0.1-pre.3273",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/index.js",

package/src/types.ts

@@ -1,4 +1,3 @@
-import type { LifeCycles } from 'single-spa';
 import type { i18n } from 'i18next';
 
 declare global {
@@ -136,9 +135,9 @@ export type PageDefinition = {
    */
   offline?: boolean;
   /**
-   * Determines the order in which this page is rendered in the app-shell, which is useful for situations where DOM ordering matters.
+   * If supplied, the page will be rendered within the DOM element with the specified ID. Defaults to "omrs-apps-container" if not supplied.
    */
-  order?: number;
+  containerDomId?: string;
 } & (
   | {
       /**
@@ -174,7 +173,7 @@ export type PageDefinition = {
  * @internal
  * A definition of a page after the app has been registered.
  */
-export type RegisteredPageDefinition = Omit<PageDefinition, 'order'> & AppComponent & { order: number };
+export type RegisteredPageDefinition = PageDefinition & AppComponent;
 
 /**
  * A definition of an extension as extracted from an app's routes.json
@@ -311,6 +310,29 @@ export interface WorkspaceGroupDefinition {
   members?: Array<string>;
 }
 
+export interface WorkspaceGroupDefinition2 {
+  name: string;
+  closeable?: boolean;
+  overlay?: boolean;
+}
+
+export interface WorkspaceWindowDefinition2 {
+  name: string;
+  icon?: string;
+  canHide: boolean;
+  canMaximize: boolean;
+  overlay: boolean;
+  group: string;
+  order?: number;
+  width?: 'narrow' | 'wider' | 'extra-wide';
+}
+
+export interface WorkspaceDefinition2 {
+  name: string;
+  component: string;
+  window: string;
+}
+
 /**
  * A definition of a feature flag extracted from the routes.json
  */
@@ -353,6 +375,15 @@ export interface OpenmrsAppRoutes {
   workspaces?: Array<WorkspaceDefinition>;
   /** An array of all workspace groups supported by this frontend module. */
   workspaceGroups?: Array<WorkspaceGroupDefinition>;
+
+  /** An array of all workspace groups (v2) supported by this frontend module. */
+  workspaceGroups2?: Array<WorkspaceGroupDefinition2>;
+
+  /** An array of all workspace windows (v2) supported by this frontend module. */
+  workspaceWindows2?: Array<WorkspaceWindowDefinition2>;
+
+  /** An array of all workspaces (v2) supported by this frontend module. */
+  workspaces2?: Array<WorkspaceDefinition2>;
 }
 
 /**