@openmrs/esm-config 4.0.0-pre.0 → 4.0.1-pre.206

package/src/navigation/navigate.ts

@@ -7,8 +7,11 @@ function trimTrailingSlash(str: string) {
   return str.replace(/\/$/, "");
 }
 
+export type TemplateParams = { [key: string]: string };
+
 export interface NavigateOptions {
   to: string;
+  templateParams?: TemplateParams;
 }
 
 /**
@@ -16,19 +19,29 @@ export interface NavigateOptions {
  *
  * Example usage:
  * ```js
- * const config = getConfig();
+ * const config = useConfig();
  * const submitHandler = () => {
  *   navigate({ to: config.links.submitSuccess });
  * };
  * ```
+ * Example return values:
+ * navigate({ to: "/some/path" }); => window.location.assign("/some/path")
+ * navigate({ to: "https://single-spa.js.org/" }); => window.location.assign("https://single-spa.js.org/")
+ * navigate({ to: "${openmrsBase}/some/path" }); => window.location.assign("/openmrs/some/path")
+ * navigate({ to: "/openmrs/spa/foo/page" }); => navigateToUrl("/openmrs/spa/foo/page")
+ * navigate({ to: "${openmrsSpaBase}/bar/page" }); => navigateToUrl("/openmrs/spa/bar/page")
+ * navigate({ to: "/${openmrsSpaBase}/baz/page" }) => navigateToUrl("/openmrs/spa/baz/page")
  *
- * @param to The target path or URL. Supports templating with 'openmrsBase' and 'openmrsSpaBase'.
+ * @param to The target path or URL. Supports templating with 'openmrsBase', 'openmrsSpaBase',
+ * and any additional template parameters defined in `templateParams`.
  * For example, `${openmrsSpaBase}/home` will resolve to `/openmrs/spa/home`
  * for implementations using the standard OpenMRS and SPA base paths.
+ * If `templateParams` contains `{ foo: "bar" }`, then the URL `${openmrsBase}/${foo}`
+ * will become `/openmrs/bar`.
  */
-export function navigate({ to }: NavigateOptions): void {
+export function navigate({ to, templateParams }: NavigateOptions): void {
   const openmrsSpaBase = trimTrailingSlash(window.getOpenmrsSpaBase());
-  const target = interpolateUrl(to);
+  const target = interpolateUrl(to, templateParams);
   const isSpaPath = target.startsWith(openmrsSpaBase);
 
   if (isSpaPath) {

package/src/public.ts

@@ -9,4 +9,4 @@ export {
   provide,
   getConfig,
 } from "./module-config/module-config";
-export { getConfigStore, ConfigStore } from "./module-config/state";
+export { type ConfigStore, getConfigStore } from "./module-config/state";

package/src/types.ts

@@ -27,6 +27,11 @@ export interface Config extends Object {
 
 export interface ConfigObject extends Object {
   [key: string]: any;
+  "Display conditions"?: DisplayConditionsConfigObject;
+}
+
+export interface DisplayConditionsConfigObject {
+  privileges?: string[];
 }
 
 export type ConfigValue =

package/src/validators/validator.ts

@@ -1,13 +1,38 @@
 /** @module @category Config Validation */
 import { Validator, ValidatorFunction } from "../types";
 
+/**
+ * Constructs a custom validator.
+ *
+ * ### Example
+ *
+ * ```typescript
+ * {
+ *   foo: {
+ *     _default: 0,
+ *     _validators: [
+ *       validator(val => val >= 0, "Must not be negative.")
+ *     ]
+ *   }
+ * }
+ * ```
+ * @param validationFunction Takes the configured value as input. Returns true
+ *    if it is valid, false otherwise.
+ * @param message A string message that explains why the value is invalid. Can
+ *    also be a function that takes the value as input and returns a string.
+ * @returns A validator ready for use in a config schema
+ */
 export function validator(
   validationFunction: ValidatorFunction,
-  message: string
+  message: string | ((value: any) => string)
 ): Validator {
   return (value) => {
     if (!validationFunction(value)) {
-      return message;
+      if (typeof message === "function") {
+        return message(value);
+      } else {
+        return message;
+      }
     }
   };
 }

package/src/validators/validators.test.ts

@@ -1,9 +1,16 @@
-import { isUrl, isUrlWithTemplateParameters } from "./validators";
+import {
+  inRange,
+  isUrl,
+  isUrlWithTemplateParameters,
+  oneOf,
+} from "./validators";
 
 describe("all validators", () => {
   it("fail on undefined", () => {
+    expect(inRange(0, 10)(undefined)).toMatch(/.*/);
     expect(isUrl(undefined)).toMatch(/.*/);
     expect(isUrlWithTemplateParameters(["foo"])(undefined)).toMatch(/.*/);
+    expect(oneOf(["foo", "bar"])(undefined)).toMatch(/.*/);
   });
 });
 
@@ -22,3 +29,13 @@ describe("isUrl", () => {
     );
   });
 });
+
+describe("oneOf", () => {
+  it("accepts one of the valid options", () => {
+    expect(oneOf(["foo", "bar"])("foo")).toBeUndefined();
+  });
+
+  it("rejects anything else", () => {
+    expect(oneOf(["foo", "bar"])("baz")).toMatch(/one of.*foo.*bar/i);
+  });
+});

package/src/validators/validators.ts

@@ -45,7 +45,7 @@ export const isUrlWithTemplateParameters = (
     }
 
     return true;
-  }, "should be a URL or path. The allowed template parameters are " + allowedParams.map((p) => "${" + p + "}").join(", "));
+  }, "Should be a URL or path. The allowed template parameters are " + allowedParams.map((p) => "${" + p + "}").join(", "));
 };
 
 /**
@@ -55,8 +55,20 @@ export const isUrlWithTemplateParameters = (
  */
 export const isUrl = isUrlWithTemplateParameters([]);
 
+/**
+ * Verifies that the value is one of the allowed options.
+ * @param allowedValues The list of allowable values
+ */
+export const oneOf = (allowedValues: Array<any>) => {
+  return validator(
+    (val) => allowedValues.includes(val),
+    `Must be one of the following: '${allowedValues.join("', '")}'.`
+  );
+};
+
 export const validators = {
   inRange,
   isUrl,
   isUrlWithTemplateParameters,
+  oneOf,
 };

package/.turbo/turbo-lint.log

@@ -1,2 +0,0 @@
-@openmrs/esm-config:lint: cache hit, replaying output e059960089b05a38
-@openmrs/esm-config:lint: $ eslint src --ext ts,tsx

package/.turbo/turbo-test.log

@@ -1,13 +0,0 @@
-@openmrs/esm-config:test: cache hit, replaying output 938f45b775e0cbf4
-@openmrs/esm-config:test: $ jest --config jest.config.js --passWithNoTests
-@openmrs/esm-config:test: PASS src/navigation/navigate.test.ts
-@openmrs/esm-config:test: PASS src/validators/validators.test.ts
-@openmrs/esm-config:test: PASS src/navigation/interpolate-string.test.ts
-@openmrs/esm-config:test: PASS src/validators/type-validators.test.ts
-@openmrs/esm-config:test: PASS src/module-config/module-config.test.ts
-@openmrs/esm-config:test: 
-@openmrs/esm-config:test: Test Suites: 5 passed, 5 total
-@openmrs/esm-config:test: Tests:       1 skipped, 85 passed, 86 total
-@openmrs/esm-config:test: Snapshots:   0 total
-@openmrs/esm-config:test: Time:        9.879 s
-@openmrs/esm-config:test: Ran all test suites.

package/.turbo/turbo-typescript.log

@@ -1,2 +0,0 @@
-@openmrs/esm-config:typescript: cache hit, replaying output 2eb1242b6e77246a
-@openmrs/esm-config:typescript: $ tsc