@openmrs/esm-extensions 6.3.1-pre.3012 → 6.3.1-pre.3014

package/.turbo/turbo-build.log

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

package/dist/extensions.d.ts

@@ -1,6 +1,5 @@
 /** @module @category Extension */
-import { type AssignedExtension } from '.';
-import { type ExtensionRegistration, type ExtensionInternalStore } from './store';
+import { type AssignedExtension, type ExtensionRegistration, type ExtensionInternalStore } from './store';
 /**
  * Given an extension ID, which is a string uniquely identifying
  * an instance of an extension within an extension slot, this

package/dist/extensions.js

@@ -12,8 +12,8 @@ import { featureFlagsStore } from "@openmrs/esm-feature-flags";
 import { subscribeConnectivityChanged } from "@openmrs/esm-globals";
 import { isOnline as isOnlineFn } from "@openmrs/esm-utils";
 import { isEqual } from "lodash-es";
-import { checkStatusFor, getExtensionInternalStore } from "./index.js";
-import { getExtensionStore, updateInternalExtensionStore } from "./store.js";
+import { checkStatusFor } from "./helpers.js";
+import { getExtensionStore, getExtensionInternalStore, updateInternalExtensionStore } from "./store.js";
 const extensionInternalStore = getExtensionInternalStore();
 const extensionStore = getExtensionStore();
 const slotsConfigStore = getExtensionSlotsConfigStore();

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-export * from './store';
 export * from './extensions';
+export * from './helpers';
+export * from './left-nav';
 export * from './modals';
 export * from './workspaces';
-export * from './helpers';
 export * from './render';
-/** @deprecated Use `getExtensionStore`. The structure of this store has also changed. */
-declare const internalStore: import("zustand").StoreApi<import("./store").ExtensionInternalStore>;
-export { internalStore as extensionStore };
+export * from './store';
+export * from './types';

package/dist/index.js

@@ -1,12 +1,8 @@
-export * from "./store.js";
 export * from "./extensions.js";
+export * from "./helpers.js";
+export * from "./left-nav.js";
 export * from "./modals.js";
 export * from "./workspaces.js";
-export * from "./helpers.js";
 export * from "./render.js";
-// Temporary compatibility hack
-// What is now `extensionInternalStore` used to be exposed
-// and used as `extensionStore`.
-import { getExtensionInternalStore } from "./store.js";
-/** @deprecated Use `getExtensionStore`. The structure of this store has also changed. */ const internalStore = getExtensionInternalStore();
-export { internalStore as extensionStore };
+export * from "./store.js";
+export * from "./types.js";

package/dist/left-nav.d.ts

@@ -0,0 +1,31 @@
+import { type ComponentConfig } from './types';
+export interface LeftNavStore {
+    slotName: string | null;
+    basePath: string;
+    mode: 'normal' | 'collapsed';
+    componentContext?: ComponentConfig;
+}
+/** @internal */
+export declare const leftNavStore: import("zustand").StoreApi<LeftNavStore>;
+export interface SetLeftNavParams {
+    name: string;
+    basePath: string;
+    /**
+     * In normal mode, the left nav is shown in desktop mode, and collapse into hamburger menu button in tablet mode
+     * In collapsed mode, the left nav is always collapsed, regardless of desktop / tablet mode
+     */
+    mode?: 'normal' | 'collapsed';
+    componentContext?: ComponentConfig;
+}
+/**
+ * Sets the current left nav context. Must be paired with {@link unsetLeftNav}.
+ *
+ * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
+ */
+export declare function setLeftNav({ name, basePath, mode, componentContext }: SetLeftNavParams): void;
+/**
+ * Unsets the left nav context if the current context is for the supplied name.
+ *
+ * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
+ */
+export declare function unsetLeftNav(name: string): void;

package/dist/left-nav.js

@@ -0,0 +1,27 @@
+import { createGlobalStore } from "@openmrs/esm-state";
+/** @internal */ export const leftNavStore = createGlobalStore('left-nav', {
+    slotName: null,
+    basePath: window.spaBase,
+    mode: 'normal'
+});
+/**
+ * Sets the current left nav context. Must be paired with {@link unsetLeftNav}.
+ *
+ * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
+ */ export function setLeftNav({ name, basePath, mode, componentContext }) {
+    leftNavStore.setState({
+        slotName: name,
+        basePath,
+        mode: mode ?? 'normal',
+        componentContext
+    });
+}
+/**
+ * Unsets the left nav context if the current context is for the supplied name.
+ *
+ * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
+ */ export function unsetLeftNav(name) {
+    if (leftNavStore.getState().slotName === name) {
+        leftNavStore.setState(leftNavStore.getInitialState(), true);
+    }
+}

package/dist/public.d.ts

@@ -1,4 +1,6 @@
 export { getExtensionNameFromId, registerExtension, attach, detach, detachAll, getAssignedExtensions, registerExtensionSlot, } from './extensions';
+export { type LeftNavStore, setLeftNav, unsetLeftNav, type SetLeftNavParams } from './left-nav';
 export { type CancelLoading, renderExtension } from './render';
 export { type ExtensionMeta, type ExtensionRegistration, type ExtensionStore, type AssignedExtension, type ConnectedExtension, type ExtensionSlotState, getExtensionStore, } from './store';
 export { type WorkspaceRegistration } from './workspaces';
+export { type ExtensionData, type ComponentConfig } from './types';

package/dist/public.js

@@ -1,3 +1,4 @@
 export { getExtensionNameFromId, registerExtension, attach, detach, detachAll, getAssignedExtensions, registerExtensionSlot } from "./extensions.js";
+export { setLeftNav, unsetLeftNav } from "./left-nav.js";
 export { renderExtension } from "./render.js";
 export { getExtensionStore } from "./store.js";

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+export interface ExtensionData {
+    extensionSlotName: string;
+    extensionSlotModuleName: string;
+    extensionId: string;
+}
+export interface ComponentConfig {
+    moduleName: string;
+    featureName: string;
+    extension?: ExtensionData;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export { };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-extensions",
-  "version": "6.3.1-pre.3012",
+  "version": "6.3.1-pre.3014",
   "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": "6.3.1-pre.3012",
-    "@openmrs/esm-config": "6.3.1-pre.3012",
-    "@openmrs/esm-expression-evaluator": "6.3.1-pre.3012",
-    "@openmrs/esm-feature-flags": "6.3.1-pre.3012",
-    "@openmrs/esm-state": "6.3.1-pre.3012",
-    "@openmrs/esm-utils": "6.3.1-pre.3012",
+    "@openmrs/esm-api": "6.3.1-pre.3014",
+    "@openmrs/esm-config": "6.3.1-pre.3014",
+    "@openmrs/esm-expression-evaluator": "6.3.1-pre.3014",
+    "@openmrs/esm-feature-flags": "6.3.1-pre.3014",
+    "@openmrs/esm-state": "6.3.1-pre.3014",
+    "@openmrs/esm-utils": "6.3.1-pre.3014",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/extensions.ts

@@ -24,12 +24,15 @@ import { type FeatureFlagsStore, featureFlagsStore } from '@openmrs/esm-feature-
 import { subscribeConnectivityChanged } from '@openmrs/esm-globals';
 import { isOnline as isOnlineFn } from '@openmrs/esm-utils';
 import { isEqual } from 'lodash-es';
-import { type AssignedExtension, checkStatusFor, type ExtensionSlotState, getExtensionInternalStore } from '.';
+import { checkStatusFor } from './helpers';
 import {
+  type AssignedExtension,
   type ExtensionRegistration,
   type ExtensionSlotInfo,
   type ExtensionInternalStore,
+  type ExtensionSlotState,
   getExtensionStore,
+  getExtensionInternalStore,
   updateInternalExtensionStore,
 } from './store';
 

package/src/index.ts

@@ -1,14 +1,8 @@
-export * from './store';
 export * from './extensions';
+export * from './helpers';
+export * from './left-nav';
 export * from './modals';
 export * from './workspaces';
-export * from './helpers';
 export * from './render';
-
-// Temporary compatibility hack
-// What is now `extensionInternalStore` used to be exposed
-// and used as `extensionStore`.
-import { getExtensionInternalStore } from './store';
-/** @deprecated Use `getExtensionStore`. The structure of this store has also changed. */
-const internalStore = getExtensionInternalStore();
-export { internalStore as extensionStore };
+export * from './store';
+export * from './types';

package/src/left-nav.ts

@@ -0,0 +1,48 @@
+import type {} from '@openmrs/esm-globals';
+import { createGlobalStore } from '@openmrs/esm-state';
+import { type ComponentConfig } from './types';
+
+export interface LeftNavStore {
+  slotName: string | null;
+  basePath: string;
+  mode: 'normal' | 'collapsed';
+  componentContext?: ComponentConfig;
+}
+
+/** @internal */
+export const leftNavStore = createGlobalStore<LeftNavStore>('left-nav', {
+  slotName: null,
+  basePath: window.spaBase,
+  mode: 'normal',
+});
+
+export interface SetLeftNavParams {
+  name: string;
+  basePath: string;
+  /**
+   * In normal mode, the left nav is shown in desktop mode, and collapse into hamburger menu button in tablet mode
+   * In collapsed mode, the left nav is always collapsed, regardless of desktop / tablet mode
+   */
+  mode?: 'normal' | 'collapsed';
+  componentContext?: ComponentConfig;
+}
+
+/**
+ * Sets the current left nav context. Must be paired with {@link unsetLeftNav}.
+ *
+ * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
+ */
+export function setLeftNav({ name, basePath, mode, componentContext }: SetLeftNavParams) {
+  leftNavStore.setState({ slotName: name, basePath, mode: mode ?? 'normal', componentContext });
+}
+
+/**
+ * Unsets the left nav context if the current context is for the supplied name.
+ *
+ * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
+ */
+export function unsetLeftNav(name: string) {
+  if (leftNavStore.getState().slotName === name) {
+    leftNavStore.setState(leftNavStore.getInitialState(), true);
+  }
+}

package/src/public.ts

@@ -7,6 +7,7 @@ export {
   getAssignedExtensions,
   registerExtensionSlot,
 } from './extensions';
+export { type LeftNavStore, setLeftNav, unsetLeftNav, type SetLeftNavParams } from './left-nav';
 export { type CancelLoading, renderExtension } from './render';
 export {
   type ExtensionMeta,
@@ -18,3 +19,4 @@ export {
   getExtensionStore,
 } from './store';
 export { type WorkspaceRegistration } from './workspaces';
+export { type ExtensionData, type ComponentConfig } from './types';

package/src/types.ts

@@ -0,0 +1,11 @@
+export interface ExtensionData {
+  extensionSlotName: string;
+  extensionSlotModuleName: string;
+  extensionId: string;
+}
+
+export interface ComponentConfig {
+  moduleName: string;
+  featureName: string;
+  extension?: ExtensionData;
+}