@openmrs/esm-framework 5.0.3-pre.898 → 5.0.3-pre.905

package/docs/API.md

@@ -102,6 +102,7 @@
 
 - [getFeatureFlag](API.md#getfeatureflag)
 - [registerFeatureFlag](API.md#registerfeatureflag)
+- [useFeatureFlag](API.md#usefeatureflag)
 
 ### Framework Functions
 
@@ -405,7 +406,7 @@ ___
 
 ### ExtensionDefinition
 
-Ƭ **ExtensionDefinition**: { `meta?`: { `[k: string]`: `unknown`;  } ; `name`: `string` ; `offline?`: `boolean` ; `online?`: `boolean` ; `order?`: `number` ; `privileges?`: `string` \| `string`[] ; `slot?`: `string` ; `slots?`: `string`[]  } & { `component`: `string`  } \| { `component?`: `never`  }
+Ƭ **ExtensionDefinition**: { `featureFlag?`: `string` ; `meta?`: { `[k: string]`: `unknown`;  } ; `name`: `string` ; `offline?`: `boolean` ; `online?`: `boolean` ; `order?`: `number` ; `privileges?`: `string` \| `string`[] ; `slot?`: `string` ; `slots?`: `string`[]  } & { `component`: `string`  } \| { `component?`: `never`  }
 
 A definition of an extension as extracted from an app's routes.json
 
@@ -444,7 +445,7 @@ Basically, this is the same as the app routes, with each routes definition keyed
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:251](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L251)
+[packages/framework/esm-globals/src/types.ts:255](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L255)
 
 ___
 
@@ -2257,7 +2258,7 @@ writing a module for a specific implementation.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:174](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L174)
+[packages/framework/esm-extensions/src/extensions.ts:175](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L175)
 
 ___
 
@@ -2280,7 +2281,7 @@ Avoid using this. Extension attachments should be considered declarative.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:205](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L205)
+[packages/framework/esm-extensions/src/extensions.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L206)
 
 ___
 
@@ -2302,7 +2303,7 @@ Avoid using this. Extension attachments should be considered declarative.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L229)
+[packages/framework/esm-extensions/src/extensions.ts:230](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L230)
 
 ___
 
@@ -2326,13 +2327,13 @@ An array of extensions assigned to the named slot
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:360](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L360)
+[packages/framework/esm-extensions/src/extensions.ts:373](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L373)
 
 ___
 
 ### getConnectedExtensions
 
-▸ **getConnectedExtensions**(`assignedExtensions`, `online?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
+▸ **getConnectedExtensions**(`assignedExtensions`, `online?`, `enabledFeatureFlags?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
 
 Filters a list of extensions according to whether they support the
 current connectivity status.
@@ -2343,6 +2344,7 @@ current connectivity status.
 | :------ | :------ | :------ | :------ |
 | `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | The list of extensions to filter. |
 | `online` | ``null`` \| `boolean` | `null` | Whether the app is currently online. If `null`, uses `navigator.onLine`. |
+| `enabledFeatureFlags` | ``null`` \| `string`[] | `null` | The names of all enabled feature flags. If `null`, looks    up the feature flags using the feature flags API. |
 
 #### Returns
 
@@ -2352,7 +2354,7 @@ A list of extensions that should be rendered
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:287](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L287)
+[packages/framework/esm-extensions/src/extensions.ts:290](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L290)
 
 ___
 
@@ -2384,7 +2386,7 @@ getExtensionNameFromId("baz")
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:118](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L118)
+[packages/framework/esm-extensions/src/extensions.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L119)
 
 ___
 
@@ -2401,7 +2403,7 @@ state of the extension system.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L130)
+[packages/framework/esm-extensions/src/store.ts:132](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L132)
 
 ___
 
@@ -2487,7 +2489,7 @@ ___
 ▸ **useConnectedExtensions**(`slotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
 
 Gets the assigned extension for a given extension slot name.
-Considers if offline or online.
+Considers if offline or online, and what feature flags are enabled.
 
 #### Parameters
 
@@ -2501,7 +2503,7 @@ Considers if offline or online.
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L15)
+[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L17)
 
 ___
 
@@ -2632,6 +2634,39 @@ It can then be used to turn on or off features in the code.
 
 ___
 
+### useFeatureFlag
+
+▸ **useFeatureFlag**(`flagName`): `boolean`
+
+Use this function to tell whether a feature flag is toggled on or off.
+
+Example:
+
+```tsx
+import { useFeatureFlag } from "@openmrs/esm-react-utils";
+
+export function MyComponent() {
+ const isMyFeatureFlagOn = useFeatureFlag("my-feature-flag");
+ return <>{isMyFeatureFlagOn && <ExperimentalFeature />}</>;
+}
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `flagName` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useFeatureFlag.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useFeatureFlag.ts#L19)
+
+___
+
 ## Framework Functions
 
 ### getAsyncExtensionLifecycle

package/docs/interfaces/AssignedExtension.md

@@ -7,6 +7,7 @@
 ### Extension Properties
 
 - [config](AssignedExtension.md#config)
+- [featureFlag](AssignedExtension.md#featureflag)
 - [id](AssignedExtension.md#id)
 - [meta](AssignedExtension.md#meta)
 - [moduleName](AssignedExtension.md#modulename)
@@ -24,7 +25,17 @@ The extension's config. Note that this will be `null` until the slot is mounted.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L81)
+[packages/framework/esm-extensions/src/store.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L82)
+
+___
+
+### featureFlag
+
+• `Optional` **featureFlag**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L85)
 
 ___
 
@@ -34,7 +45,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L76)
+[packages/framework/esm-extensions/src/store.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L77)
 
 ___
 
@@ -44,7 +55,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L79)
+[packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L80)
 
 ___
 
@@ -54,7 +65,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L78)
+[packages/framework/esm-extensions/src/store.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L79)
 
 ___
 
@@ -64,7 +75,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L77)
+[packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L78)
 
 ___
 
@@ -74,7 +85,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L83)
+[packages/framework/esm-extensions/src/store.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L84)
 
 ___
 
@@ -84,4 +95,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L82)
+[packages/framework/esm-extensions/src/store.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L83)

package/docs/interfaces/ConnectedExtension.md

@@ -21,7 +21,7 @@ The extension's config. Note that this will be `null` until the slot is mounted.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L91)
+[packages/framework/esm-extensions/src/store.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L93)
 
 ___
 
@@ -31,7 +31,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L87)
+[packages/framework/esm-extensions/src/store.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L89)
 
 ___
 
@@ -41,7 +41,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L89)
+[packages/framework/esm-extensions/src/store.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L91)
 
 ___
 
@@ -51,4 +51,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L88)
+[packages/framework/esm-extensions/src/store.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L90)

package/docs/interfaces/ExtensionRegistration.md

@@ -6,6 +6,7 @@
 
 ### Extension Properties
 
+- [featureFlag](ExtensionRegistration.md#featureflag)
 - [meta](ExtensionRegistration.md#meta)
 - [moduleName](ExtensionRegistration.md#modulename)
 - [name](ExtensionRegistration.md#name)
@@ -20,6 +21,16 @@
 
 ## Extension Properties
 
+### featureFlag
+
+• `Optional` **featureFlag**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L25)
+
+___
+
 ### meta
 
 • **meta**: [`ExtensionMeta`](ExtensionMeta.md)

package/docs/interfaces/ExtensionSlotState.md

@@ -17,7 +17,7 @@
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L72)
+[packages/framework/esm-extensions/src/store.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L73)
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L71)
+[packages/framework/esm-extensions/src/store.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L72)

package/docs/interfaces/ExtensionStore.md

@@ -16,4 +16,4 @@
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L67)
+[packages/framework/esm-extensions/src/store.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L68)

package/docs/interfaces/OpenmrsAppRoutes.md

@@ -23,7 +23,7 @@ A list of backend modules necessary for this frontend module and the correspondi
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:236](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L236)
+[packages/framework/esm-globals/src/types.ts:240](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L240)
 
 ___
 
@@ -35,7 +35,7 @@ An array of all extensions supported by this frontend module. Extensions can be
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L244)
+[packages/framework/esm-globals/src/types.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L248)
 
 ___
 
@@ -47,7 +47,7 @@ An array of all pages supported by this frontend module. Pages are automatically
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:240](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L240)
+[packages/framework/esm-globals/src/types.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L244)
 
 ___
 
@@ -59,4 +59,4 @@ The version of this frontend module.
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:232](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L232)
+[packages/framework/esm-globals/src/types.ts:236](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L236)

package/docs/interfaces/ResourceLoader.md

@@ -20,4 +20,4 @@
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L254)
+[packages/framework/esm-globals/src/types.ts:258](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L258)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "5.0.3-pre.898",
+  "version": "5.0.3-pre.905",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -36,19 +36,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^5.0.3-pre.898",
-    "@openmrs/esm-breadcrumbs": "^5.0.3-pre.898",
-    "@openmrs/esm-config": "^5.0.3-pre.898",
-    "@openmrs/esm-dynamic-loading": "^5.0.3-pre.898",
-    "@openmrs/esm-error-handling": "^5.0.3-pre.898",
-    "@openmrs/esm-extensions": "^5.0.3-pre.898",
-    "@openmrs/esm-feature-flags": "^5.0.3-pre.898",
-    "@openmrs/esm-globals": "^5.0.3-pre.898",
-    "@openmrs/esm-offline": "^5.0.3-pre.898",
-    "@openmrs/esm-react-utils": "^5.0.3-pre.898",
-    "@openmrs/esm-state": "^5.0.3-pre.898",
-    "@openmrs/esm-styleguide": "^5.0.3-pre.898",
-    "@openmrs/esm-utils": "^5.0.3-pre.898",
+    "@openmrs/esm-api": "^5.0.3-pre.905",
+    "@openmrs/esm-breadcrumbs": "^5.0.3-pre.905",
+    "@openmrs/esm-config": "^5.0.3-pre.905",
+    "@openmrs/esm-dynamic-loading": "^5.0.3-pre.905",
+    "@openmrs/esm-error-handling": "^5.0.3-pre.905",
+    "@openmrs/esm-extensions": "^5.0.3-pre.905",
+    "@openmrs/esm-feature-flags": "^5.0.3-pre.905",
+    "@openmrs/esm-globals": "^5.0.3-pre.905",
+    "@openmrs/esm-offline": "^5.0.3-pre.905",
+    "@openmrs/esm-react-utils": "^5.0.3-pre.905",
+    "@openmrs/esm-state": "^5.0.3-pre.905",
+    "@openmrs/esm-styleguide": "^5.0.3-pre.905",
+    "@openmrs/esm-utils": "^5.0.3-pre.905",
     "dayjs": "^1.10.7"
   },
   "peerDependencies": {
@@ -66,5 +66,5 @@
     "jest-environment-jsdom": "28.1.0",
     "webpack": "^5.88.0"
   },
-  "gitHead": "e2d10cb63be0c37b1baa9d2b5871aec9c57453fd"
+  "gitHead": "ecb9bc8ba8ea622143dd2e231cfb3117da31e982"
 }

package/src/integration-tests/extension-config.test.tsx

@@ -253,8 +253,8 @@ describe("Interaction between configuration and extension systems", () => {
     });
 
     await waitFor(() => {
-      expect(screen.queryByText("green")).not.toBeInTheDocument();
       expect(screen.getByTestId("slot")).toHaveTextContent(/black/);
+      expect(screen.queryByText("green")).not.toBeInTheDocument();
     });
   });