@openmrs/esm-routes 10.0.1-pre.5652 → 10.0.1-pre.5664

package/.turbo/turbo-build.log

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

package/dist/loaders/components.d.ts

@@ -1,4 +1,4 @@
-import { type ExtensionDefinition, type FeatureFlagDefinition, type ModalDefinition, type WorkspaceDefinition, type WorkspaceDefinition2, type WorkspaceGroupDefinition, type WorkspaceGroupDefinition2, type WorkspaceWindowDefinition2 } from '@openmrs/esm-globals';
+import { type ExtensionDefinition, type FeatureFlagDefinition, type ModalDefinition, type WorkspaceDefinition2, type WorkspaceGroupDefinition2, type WorkspaceWindowDefinition2 } from '@openmrs/esm-globals';
 /**
  * This function registers an extension definition with the framework and will
  * attach the extension to any configured slots.
@@ -14,20 +14,6 @@ export declare function tryRegisterExtension(appName: string, extension: Extensi
  * @param modal An object that describes the modal, derived from `routes.json`
  */
 export declare function tryRegisterModal(appName: string, modal: ModalDefinition): void;
-/**
- * This function registers a workspace definition with the framework so that it can be launched.
- *
- * @param appName The name of the app defining this workspace
- * @param workspace An object that describes the workspace, derived from `routes.json`
- */
-export declare function tryRegisterWorkspace(appName: string, workspace: WorkspaceDefinition): void;
-/**
- * This function registers a workspace group definition with the framework so that it can be launched.
- *
- * @param appName The name of the app defining this workspace
- * @param workspace An object that describes the workspace, derived from `routes.json`
- */
-export declare function tryRegisterWorkspaceGroup(appName: string, workspaceGroup: WorkspaceGroupDefinition): void;
 export declare function tryRegisterWorkspaceGroups2(appName: string, workspaceGroupDefs: Array<WorkspaceGroupDefinition2>): void;
 export declare function tryRegisterWorkspace2(appName: string, workspaceDefs: Array<WorkspaceDefinition2>): void;
 export declare function tryRegisterWorkspaceWindows2(appName: string, workspaceWindowDefs: Array<WorkspaceWindowDefinition2>): void;

package/dist/loaders/components.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/loaders/components.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAChC,MAAM,sBAAsB,CAAC;AAI9B;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,mBAAmB,QA2CnF;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,QA0BvE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,mBAAmB,QAkDnF;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,wBAAwB,QAelG;AAED,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,KAAK,CAAC,yBAAyB,CAAC,QAEhH;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,CAAC,oBAAoB,CAAC,QAEhG;AAED,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,KAAK,CAAC,0BAA0B,CAAC,QAiBnH;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,QAgCzF"}
+{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/loaders/components.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAChC,MAAM,sBAAsB,CAAC;AAI9B;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,mBAAmB,QA2CnF;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,QA0BvE;AAED,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,KAAK,CAAC,yBAAyB,CAAC,QAEhH;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,CAAC,oBAAoB,CAAC,QAEhG;AAED,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,KAAK,CAAC,0BAA0B,CAAC,QAiBnH;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,QAgCzF"}

package/dist/loaders/components.js

@@ -1,4 +1,4 @@
-import { attach, registerExtension, registerModal, registerWorkspace, registerWorkspaceGroup, registerWorkspaceGroups2, registerWorkspaces2, registerWorkspaceWindows2 } from "@openmrs/esm-extensions";
+import { attach, registerExtension, registerModal, registerWorkspaceGroups2, registerWorkspaces2, registerWorkspaceWindows2 } from "@openmrs/esm-extensions";
 import { registerFeatureFlag } from "@openmrs/esm-feature-flags";
 import { loadLifeCycles } from "./load-lifecycles.js";
 /**
@@ -65,68 +65,6 @@ To fix this, ensure that you define a 'component' field inside the modal definit
         load: ()=>loadLifeCycles(appName, modal.component)
     });
 }
-/**
- * This function registers a workspace definition with the framework so that it can be launched.
- *
- * @param appName The name of the app defining this workspace
- * @param workspace An object that describes the workspace, derived from `routes.json`
- */ export function tryRegisterWorkspace(appName, workspace) {
-    const name = workspace.name;
-    if (!name) {
-        console.error(`A workspace definition in ${appName} is missing a name and thus cannot be registered.
-To fix this, ensure that you define the "name" field inside the workspace definition.`, workspace);
-        return;
-    }
-    const title = workspace.title;
-    if (!title) {
-        console.error(`A workspace definition in ${appName} is missing a title and thus cannot be registered.
-To fix this, ensure that you define the "title" field inside the workspace definition.`, workspace);
-        return;
-    }
-    if (!workspace.component) {
-        console.error(`The workspace ${name} from ${appName} is missing a 'component' entry and thus cannot be registered.
-To fix this, ensure that you define a 'component' field inside the workspace definition.`, workspace);
-        return;
-    }
-    registerWorkspace({
-        name,
-        title,
-        component: workspace.component,
-        moduleName: appName,
-        type: workspace.type,
-        canHide: workspace.canHide,
-        canMaximize: workspace.canMaximize,
-        width: workspace.width,
-        preferredWindowSize: workspace.preferredWindowSize,
-        groups: workspace.groups,
-        load: ()=>loadLifeCycles(appName, workspace.component)
-    });
-    for (const group of workspace.groups || []){
-        registerWorkspaceGroup({
-            name: group,
-            members: [
-                name
-            ]
-        });
-    }
-}
-/**
- * This function registers a workspace group definition with the framework so that it can be launched.
- *
- * @param appName The name of the app defining this workspace
- * @param workspace An object that describes the workspace, derived from `routes.json`
- */ export function tryRegisterWorkspaceGroup(appName, workspaceGroup) {
-    const name = workspaceGroup.name;
-    if (!name) {
-        console.error(`A workspace group definition in ${appName} is missing a name and thus cannot be registered.
-To fix this, ensure that you define the "name" field inside the workspace definition.`, workspaceGroup);
-        return;
-    }
-    registerWorkspaceGroup({
-        name,
-        members: workspaceGroup.members ?? []
-    });
-}
 export function tryRegisterWorkspaceGroups2(appName, workspaceGroupDefs) {
     registerWorkspaceGroups2(appName, workspaceGroupDefs);
 }

package/dist/loaders/pages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pages.d.ts","sourceRoot":"","sources":["../../src/loaders/pages.ts"],"names":[],"mappings":"AAGA,OAAO,EAKL,KAAK,gBAAgB,EAItB,MAAM,sBAAsB,CAAC;AA8D9B;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,QAIpE;AAmGD;;;;GAIG;AACH,wBAAgB,wBAAwB,SAoCvC"}
+{"version":3,"file":"pages.d.ts","sourceRoot":"","sources":["../../src/loaders/pages.ts"],"names":[],"mappings":"AAGA,OAAO,EAIL,KAAK,gBAAgB,EAGtB,MAAM,sBAAsB,CAAC;AA4D9B;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,QAIpE;AA4ED;;;;GAIG;AACH,wBAAgB,wBAAwB,SAoCvC"}

package/dist/loaders/pages.js

@@ -3,7 +3,7 @@ import { registerModuleWithConfigSystem } from "@openmrs/esm-config";
 import { batchExtensionUpdates } from "@openmrs/esm-extensions";
 import { getFeatureFlag } from "@openmrs/esm-feature-flags";
 import { routeRegex } from "./helpers.js";
-import { tryRegisterExtension, tryRegisterFeatureFlag, tryRegisterModal, tryRegisterWorkspace, tryRegisterWorkspace2, tryRegisterWorkspaceGroup, tryRegisterWorkspaceGroups2, tryRegisterWorkspaceWindows2 } from "./components.js";
+import { tryRegisterExtension, tryRegisterFeatureFlag, tryRegisterModal, tryRegisterWorkspace2, tryRegisterWorkspaceGroups2, tryRegisterWorkspaceWindows2 } from "./components.js";
 import { loadLifeCycles } from "./load-lifecycles.js";
 // this is the global holder of all pages registered in the app
 const pages = [];
@@ -63,8 +63,6 @@ function registerAppRoutes(appName, routes) {
         registerModuleWithConfigSystem(appName);
         const availableExtensions = routes.extensions ?? [];
         const availableModals = routes.modals ?? [];
-        const availableWorkspaces = routes.workspaces ?? [];
-        const availableWorkspaceGroups = routes.workspaceGroups ?? [];
         const availableFeatureFlags = routes.featureFlags ?? [];
         const availableWorkspaceGroups2 = routes.workspaceGroups2 ?? [];
         const availableWorkspaceWindows2 = routes.workspaceWindows2 ?? [];
@@ -93,20 +91,9 @@ function registerAppRoutes(appName, routes) {
                 console.warn(`A modal for ${appName} could not be registered as it does not appear to have the required properties`, modal);
             }
         });
-        availableWorkspaces.forEach((workspace)=>{
-            if (workspace && typeof workspace === 'object' && Object.hasOwn(workspace, 'name') && Object.hasOwn(workspace, 'component')) {
-                tryRegisterWorkspace(appName, workspace);
-            } else {
-                console.warn(`A workspace for ${appName} could not be registered as it does not appear to have the required properties`, workspace);
-            }
-        });
-        availableWorkspaceGroups.forEach((workspaceGroup)=>{
-            if (workspaceGroup && typeof workspaceGroup === 'object' && Object.hasOwn(workspaceGroup, 'name')) {
-                tryRegisterWorkspaceGroup(appName, workspaceGroup);
-            } else {
-                console.warn(`A workspace group for ${appName} could not be registered as it does not appear to have the required properties`, workspaceGroup);
-            }
-        });
+        if (Object.hasOwn(routes, 'workspaces') || Object.hasOwn(routes, 'workspaceGroups')) {
+            console.warn(`${appName} defines workspaces or workspaceGroups in its routes.json, which are no longer supported and won't be registered. Use workspaces2, workspaceWindows2 and workspaceGroups2 instead.`);
+        }
         tryRegisterWorkspaceGroups2(appName, availableWorkspaceGroups2);
         tryRegisterWorkspaceWindows2(appName, availableWorkspaceWindows2);
         tryRegisterWorkspace2(appName, availableWorkspaces2);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-routes",
-  "version": "10.0.1-pre.5652",
+  "version": "10.0.1-pre.5664",
   "license": "MPL-2.0",
   "description": "Utilities for working with the routes registry",
   "type": "module",
@@ -47,21 +47,21 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@openmrs/esm-config": "^10.0.1-pre.5652",
-    "@openmrs/esm-dynamic-loading": "^10.0.1-pre.5652",
-    "@openmrs/esm-extensions": "^10.0.1-pre.5652",
-    "@openmrs/esm-feature-flags": "^10.0.1-pre.5652",
-    "@openmrs/esm-globals": "^10.0.1-pre.5652",
-    "@openmrs/esm-utils": "^10.0.1-pre.5652",
+    "@openmrs/esm-config": "^10.0.1-pre.5664",
+    "@openmrs/esm-dynamic-loading": "^10.0.1-pre.5664",
+    "@openmrs/esm-extensions": "^10.0.1-pre.5664",
+    "@openmrs/esm-feature-flags": "^10.0.1-pre.5664",
+    "@openmrs/esm-globals": "^10.0.1-pre.5664",
+    "@openmrs/esm-utils": "^10.0.1-pre.5664",
     "single-spa": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-config": "10.0.1-pre.5652",
-    "@openmrs/esm-dynamic-loading": "10.0.1-pre.5652",
-    "@openmrs/esm-extensions": "10.0.1-pre.5652",
-    "@openmrs/esm-feature-flags": "10.0.1-pre.5652",
-    "@openmrs/esm-globals": "10.0.1-pre.5652",
-    "@openmrs/esm-utils": "10.0.1-pre.5652",
+    "@openmrs/esm-config": "10.0.1-pre.5664",
+    "@openmrs/esm-dynamic-loading": "10.0.1-pre.5664",
+    "@openmrs/esm-extensions": "10.0.1-pre.5664",
+    "@openmrs/esm-feature-flags": "10.0.1-pre.5664",
+    "@openmrs/esm-globals": "10.0.1-pre.5664",
+    "@openmrs/esm-utils": "10.0.1-pre.5664",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@vitest/coverage-v8": "^4.1.2",

package/src/loaders/components.ts

@@ -2,8 +2,6 @@ import {
   attach,
   registerExtension,
   registerModal,
-  registerWorkspace,
-  registerWorkspaceGroup,
   registerWorkspaceGroups2,
   registerWorkspaces2,
   registerWorkspaceWindows2,
@@ -12,9 +10,7 @@ import {
   type ExtensionDefinition,
   type FeatureFlagDefinition,
   type ModalDefinition,
-  type WorkspaceDefinition,
   type WorkspaceDefinition2,
-  type WorkspaceGroupDefinition,
   type WorkspaceGroupDefinition2,
   type WorkspaceWindowDefinition2,
 } from '@openmrs/esm-globals';
@@ -107,87 +103,6 @@ To fix this, ensure that you define a 'component' field inside the modal definit
   });
 }
 
-/**
- * This function registers a workspace definition with the framework so that it can be launched.
- *
- * @param appName The name of the app defining this workspace
- * @param workspace An object that describes the workspace, derived from `routes.json`
- */
-export function tryRegisterWorkspace(appName: string, workspace: WorkspaceDefinition) {
-  const name = workspace.name;
-  if (!name) {
-    console.error(
-      `A workspace definition in ${appName} is missing a name and thus cannot be registered.
-To fix this, ensure that you define the "name" field inside the workspace definition.`,
-      workspace,
-    );
-    return;
-  }
-
-  const title = workspace.title;
-  if (!title) {
-    console.error(
-      `A workspace definition in ${appName} is missing a title and thus cannot be registered.
-To fix this, ensure that you define the "title" field inside the workspace definition.`,
-      workspace,
-    );
-    return;
-  }
-
-  if (!workspace.component) {
-    console.error(
-      `The workspace ${name} from ${appName} is missing a 'component' entry and thus cannot be registered.
-To fix this, ensure that you define a 'component' field inside the workspace definition.`,
-      workspace,
-    );
-    return;
-  }
-
-  registerWorkspace({
-    name,
-    title,
-    component: workspace.component,
-    moduleName: appName,
-    type: workspace.type,
-    canHide: workspace.canHide,
-    canMaximize: workspace.canMaximize,
-    width: workspace.width,
-    preferredWindowSize: workspace.preferredWindowSize,
-    groups: workspace.groups,
-    load: () => loadLifeCycles(appName, workspace.component),
-  });
-
-  for (const group of workspace.groups || []) {
-    registerWorkspaceGroup({
-      name: group,
-      members: [name],
-    });
-  }
-}
-
-/**
- * This function registers a workspace group definition with the framework so that it can be launched.
- *
- * @param appName The name of the app defining this workspace
- * @param workspace An object that describes the workspace, derived from `routes.json`
- */
-export function tryRegisterWorkspaceGroup(appName: string, workspaceGroup: WorkspaceGroupDefinition) {
-  const name = workspaceGroup.name;
-  if (!name) {
-    console.error(
-      `A workspace group definition in ${appName} is missing a name and thus cannot be registered.
-To fix this, ensure that you define the "name" field inside the workspace definition.`,
-      workspaceGroup,
-    );
-    return;
-  }
-
-  registerWorkspaceGroup({
-    name,
-    members: workspaceGroup.members ?? [],
-  });
-}
-
 export function tryRegisterWorkspaceGroups2(appName: string, workspaceGroupDefs: Array<WorkspaceGroupDefinition2>) {
   registerWorkspaceGroups2(appName, workspaceGroupDefs);
 }

package/src/loaders/pages.ts

@@ -2,14 +2,12 @@ import { type ActivityFn, pathToActiveWhen, registerApplication } from 'single-s
 import { registerModuleWithConfigSystem } from '@openmrs/esm-config';
 import { batchExtensionUpdates } from '@openmrs/esm-extensions';
 import {
-  type WorkspaceGroupDefinition,
   type ExtensionDefinition,
   type FeatureFlagDefinition,
   type ModalDefinition,
   type OpenmrsAppRoutes,
   type RegisteredPageDefinition,
   type RouteDefinition,
-  type WorkspaceDefinition,
 } from '@openmrs/esm-globals';
 import { getFeatureFlag } from '@openmrs/esm-feature-flags';
 import { routeRegex } from './helpers';
@@ -17,9 +15,7 @@ import {
   tryRegisterExtension,
   tryRegisterFeatureFlag,
   tryRegisterModal,
-  tryRegisterWorkspace,
   tryRegisterWorkspace2,
-  tryRegisterWorkspaceGroup,
   tryRegisterWorkspaceGroups2,
   tryRegisterWorkspaceWindows2,
 } from './components';
@@ -93,8 +89,6 @@ function registerAppRoutes(appName: string, routes: OpenmrsAppRoutes) {
 
     const availableExtensions: Array<ExtensionDefinition> = routes.extensions ?? [];
     const availableModals: Array<ModalDefinition> = routes.modals ?? [];
-    const availableWorkspaces: Array<WorkspaceDefinition> = routes.workspaces ?? [];
-    const availableWorkspaceGroups: Array<WorkspaceGroupDefinition> = routes.workspaceGroups ?? [];
     const availableFeatureFlags: Array<FeatureFlagDefinition> = routes.featureFlags ?? [];
     const availableWorkspaceGroups2 = routes.workspaceGroups2 ?? [];
     const availableWorkspaceWindows2 = routes.workspaceWindows2 ?? [];
@@ -141,32 +135,11 @@ function registerAppRoutes(appName: string, routes: OpenmrsAppRoutes) {
       }
     });
 
-    availableWorkspaces.forEach((workspace) => {
-      if (
-        workspace &&
-        typeof workspace === 'object' &&
-        Object.hasOwn(workspace, 'name') &&
-        Object.hasOwn(workspace, 'component')
-      ) {
-        tryRegisterWorkspace(appName, workspace);
-      } else {
-        console.warn(
-          `A workspace for ${appName} could not be registered as it does not appear to have the required properties`,
-          workspace,
-        );
-      }
-    });
-
-    availableWorkspaceGroups.forEach((workspaceGroup) => {
-      if (workspaceGroup && typeof workspaceGroup === 'object' && Object.hasOwn(workspaceGroup, 'name')) {
-        tryRegisterWorkspaceGroup(appName, workspaceGroup);
-      } else {
-        console.warn(
-          `A workspace group for ${appName} could not be registered as it does not appear to have the required properties`,
-          workspaceGroup,
-        );
-      }
-    });
+    if (Object.hasOwn(routes, 'workspaces') || Object.hasOwn(routes, 'workspaceGroups')) {
+      console.warn(
+        `${appName} defines workspaces or workspaceGroups in its routes.json, which are no longer supported and won't be registered. Use workspaces2, workspaceWindows2 and workspaceGroups2 instead.`,
+      );
+    }
     tryRegisterWorkspaceGroups2(appName, availableWorkspaceGroups2);
     tryRegisterWorkspaceWindows2(appName, availableWorkspaceWindows2);
     tryRegisterWorkspace2(appName, availableWorkspaces2);