@openmrs/esm-framework 5.0.3-pre.882 → 5.0.3-pre.896

package/docs/API.md

@@ -98,6 +98,11 @@
 - [useExtensionSlotMeta](API.md#useextensionslotmeta)
 - [useExtensionStore](API.md#useextensionstore)
 
+### Feature Flags Functions
+
+- [getFeatureFlag](API.md#getfeatureflag)
+- [registerFeatureFlag](API.md#registerfeatureflag)
+
 ### Framework Functions
 
 - [getAsyncExtensionLifecycle](API.md#getasyncextensionlifecycle)
@@ -2574,6 +2579,59 @@ ___
 
 ___
 
+## Feature Flags Functions
+
+### getFeatureFlag
+
+▸ **getFeatureFlag**(`flagName`): `boolean`
+
+Use this function to access the current value of the feature flag
+
+If you are using React, use `useFeatureFlag` instead.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `flagName` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/framework/esm-feature-flags/src/feature-flags.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L83)
+
+___
+
+### registerFeatureFlag
+
+▸ **registerFeatureFlag**(`flagName`, `label`, `description`): `void`
+
+This function creates a feature flag. Call it in top-level code anywhere. It will
+not reset whether the flag is enabled or not, so it's safe to call it multiple times.
+Once a feature flag is created, it will appear with a toggle in the Implementer Tools.
+It can then be used to turn on or off features in the code.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `flagName` | `string` | A code-friendly name for the flag, which will be used to reference it in code |
+| `label` | `string` | A human-friendly name which will be displayed in the Implementer Tools |
+| `description` | `string` | An explanation of what the flag does, which will be displayed in the Implementer Tools |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-feature-flags/src/feature-flags.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L62)
+
+___
+
 ## Framework Functions
 
 ### getAsyncExtensionLifecycle

package/mock.tsx

@@ -213,6 +213,13 @@ export const reportError = jest.fn().mockImplementation((error) => {
   throw error;
 });
 
+/* esm-feature-flags */
+export const registerFeatureFlags = jest.fn();
+export const getFeatureFlag = jest.fn().mockReturnValue(true);
+export const subscribeToFeatureFlag = jest.fn((name: string, callback) =>
+  callback(true)
+);
+
 /* esm-extensions */
 
 export const attach = jest.fn();
@@ -273,6 +280,8 @@ export const useExtensionInternalStore = createGlobalStore(
 
 export const useExtensionStore = getExtensionStore();
 
+export const useFeatureFlag = jest.fn().mockReturnValue(true);
+
 const defaultSelect = (x) => x;
 export function useStore<T = any>(
   store: StoreApi<T>,

package/package.json

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

package/src/index.ts

@@ -4,6 +4,7 @@ export * from "@openmrs/esm-config/src/public";
 export * from "@openmrs/esm-dynamic-loading/src/public";
 export * from "@openmrs/esm-error-handling";
 export * from "@openmrs/esm-extensions/src/public";
+export * from "@openmrs/esm-feature-flags/src/public";
 export * from "@openmrs/esm-globals/src/public";
 export * from "@openmrs/esm-offline/src/public";
 export * from "@openmrs/esm-react-utils/src/public";

package/src/internal.ts

@@ -4,6 +4,7 @@ export * from "@openmrs/esm-config";
 export * from "@openmrs/esm-dynamic-loading";
 export * from "@openmrs/esm-error-handling";
 export * from "@openmrs/esm-extensions";
+export * from "@openmrs/esm-feature-flags";
 export * from "@openmrs/esm-globals";
 export * from "@openmrs/esm-offline";
 export * from "@openmrs/esm-react-utils";