@olaboot/esm-form-engine-lib 4.1.0

package/dist/registry/inbuilt-components/inbuiltValidators.d.ts

@@ -0,0 +1,7 @@
+import { type FormFieldValidator } from '../../types';
+import { type RegistryItem } from '../registry';
+/**
+ * @internal
+ */
+export declare const inbuiltValidators: Array<RegistryItem<FormFieldValidator>>;
+//# sourceMappingURL=inbuiltValidators.d.ts.map

package/dist/registry/inbuilt-components/inbuiltValidators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbuiltValidators.d.ts","sourceRoot":"","sources":["../../../src/registry/inbuilt-components/inbuiltValidators.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAKtD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAqBrE,CAAC"}

package/dist/registry/inbuilt-components/inbuiltValidators.js

@@ -0,0 +1,29 @@
+import { conditionalAnsweredValidator } from "../../validators/conditional-answered-validator.js";
+import { DateValidator } from "../../validators/date-validator.js";
+import { DefaultValueValidator } from "../../validators/default-value-validator.js";
+import { FieldValidator } from "../../validators/form-validator.js";
+import { ExpressionValidator } from "../../validators/js-expression-validator.js";
+/**
+ * @internal
+ */ export const inbuiltValidators = [
+    {
+        name: 'default_value',
+        component: DefaultValueValidator
+    },
+    {
+        name: 'form_field',
+        component: FieldValidator
+    },
+    {
+        name: 'date',
+        component: DateValidator
+    },
+    {
+        name: 'js_expression',
+        component: ExpressionValidator
+    },
+    {
+        name: 'conditionalAnswered',
+        component: conditionalAnsweredValidator
+    }
+];

package/dist/registry/inbuilt-components/template-component-map.d.ts

@@ -0,0 +1,5 @@
+export declare const templateToComponentMap: {
+    name: string;
+    baseControlComponent: import("react").FC<import("../..").FormFieldInputProps<any>>;
+}[];
+//# sourceMappingURL=template-component-map.d.ts.map

package/dist/registry/inbuilt-components/template-component-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-component-map.d.ts","sourceRoot":"","sources":["../../../src/registry/inbuilt-components/template-component-map.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,sBAAsB;;;GAyBlC,CAAC"}

package/dist/registry/inbuilt-components/template-component-map.js

@@ -0,0 +1,27 @@
+import UiSelectExtended from "../../components/inputs/ui-select-extended/ui-select-extended.component.js";
+export const templateToComponentMap = [
+    {
+        name: 'drug',
+        baseControlComponent: UiSelectExtended
+    },
+    {
+        name: 'problem',
+        baseControlComponent: UiSelectExtended
+    },
+    {
+        name: 'encounter-provider',
+        baseControlComponent: UiSelectExtended
+    },
+    {
+        name: 'encounter-location',
+        baseControlComponent: UiSelectExtended
+    },
+    {
+        name: 'select-concept-answers',
+        baseControlComponent: UiSelectExtended
+    },
+    {
+        name: 'encounter-role',
+        baseControlComponent: UiSelectExtended
+    }
+];

package/dist/registry/registry.d.ts

@@ -0,0 +1,61 @@
+import { type FormField, type DataSource, type FormFieldInputProps, type FormFieldValidator, type FormFieldValueAdapter, type FormSchemaTransformer, type PostSubmissionAction } from '../types';
+/**
+ * @internal
+ */
+export interface RegistryItem<T> {
+    name?: string;
+    component: T;
+    type?: string;
+    /**
+     * @deprecated
+     */
+    alias?: string;
+}
+export interface ComponentRegistration<T> {
+    name: string;
+    load: () => Promise<{
+        default: T;
+    }>;
+}
+export interface CustomControlRegistration extends ComponentRegistration<React.ComponentType<FormFieldInputProps>> {
+    type: string;
+    alias?: string;
+}
+export interface FieldValueAdapterRegistration extends ComponentRegistration<FormFieldValueAdapter> {
+    type: string;
+}
+export interface FormsRegistryStoreState {
+    controls: CustomControlRegistration[];
+    fieldValidators: ComponentRegistration<FormFieldValidator>[];
+    fieldValueAdapters: FieldValueAdapterRegistration[];
+    postSubmissionActions: ComponentRegistration<PostSubmissionAction>[];
+    dataSources: ComponentRegistration<DataSource<any>>[];
+    expressionHelpers: Record<string, Function>;
+    formSchemaTransformers: ComponentRegistration<FormSchemaTransformer>[];
+}
+export declare function registerControl(registration: CustomControlRegistration): void;
+export declare function registerPostSubmissionAction(registration: ComponentRegistration<PostSubmissionAction>): void;
+export declare function registerFieldValueAdapter(registration: FieldValueAdapterRegistration): void;
+export declare function registerFieldValidator(registration: ComponentRegistration<FormFieldValidator>): void;
+export declare function registerCustomDataSource(registration: ComponentRegistration<DataSource<any>>): void;
+export declare function registerExpressionHelper(name: string, fn: Function): void;
+export declare function registerFormSchemaTransformers(registration: ComponentRegistration<FormSchemaTransformer>): void;
+/**
+ * A convenience function that returns the appropriate control for a given rendering type.
+ */
+export declare function getRegisteredControl(renderType: string): Promise<import("react").ComponentType<FormFieldInputProps<any>>>;
+/**
+ * Retrieves the appropriate field control for a question, considering missing concepts.
+ * If the question is of type 'obs' and has a missing concept, it falls back to a disabled text input.
+ * Otherwise, it retrieves the registered control based on the rendering specified in the question.
+ * @param question - The FormField representing the question.
+ * @returns The field control to be used for rendering the question.
+ */
+export declare function getFieldControlWithFallback(question: FormField): Promise<import("react").ComponentType<FormFieldInputProps<any>>>;
+export declare function getRegisteredFieldValueAdapter(type: string): Promise<FormFieldValueAdapter>;
+export declare function getRegisteredFormSchemaTransformers(): Promise<FormSchemaTransformer[]>;
+export declare function getRegisteredPostSubmissionAction(actionId: string): Promise<PostSubmissionAction>;
+export declare function getRegisteredValidator(name: string): Promise<FormFieldValidator>;
+export declare function getRegisteredDataSource(name: string): Promise<DataSource<any>>;
+export declare function getRegisteredExpressionHelpers(): Record<string, Function>;
+//# sourceMappingURL=registry.d.ts.map

package/dist/registry/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/registry/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAC1B,MAAM,UAAU,CAAC;AAYlB;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAE7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,CAAC,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,OAAO,CAAC;QAAE,OAAO,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB,CAAC,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAChH,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB,CAAC,qBAAqB,CAAC;IACjG,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IACtC,eAAe,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAC7D,kBAAkB,EAAE,6BAA6B,EAAE,CAAC;IACpD,qBAAqB,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,EAAE,CAAC;IACrE,WAAW,EAAE,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;IACtD,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5C,sBAAsB,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,EAAE,CAAC;CACxE;AAsBD,wBAAgB,eAAe,CAAC,YAAY,EAAE,yBAAyB,QAEtE;AAED,wBAAgB,4BAA4B,CAAC,YAAY,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,QAErG;AAED,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,6BAA6B,QAEpF;AAED,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,QAE7F;AAED,wBAAgB,wBAAwB,CAAC,YAAY,EAAE,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAE5F;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,QAElE;AAED,wBAAgB,8BAA8B,CAAC,YAAY,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,QAUxG;AAID;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,UAAU,EAAE,MAAM,oEAgB5D;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,SAAS,oEAW9D;AAED,wBAAsB,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAcjG;AAED,wBAAsB,mCAAmC,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAyB5F;AAED,wBAAsB,iCAAiC,CAAC,QAAQ,EAAE,MAAM,iCA6BvE;AAED,wBAAsB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAatF;AAED,wBAAsB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAqBpF;AAED,wBAAgB,8BAA8B,6BAE7C"}

package/dist/registry/registry.js

@@ -0,0 +1,184 @@
+import { getGlobalStore } from "@openmrs/esm-framework";
+import { FormsStore } from "../constants.js";
+import { inbuiltControls } from "./inbuilt-components/inbuiltControls.js";
+import { inbuiltValidators } from "./inbuilt-components/inbuiltValidators.js";
+import { inbuiltDataSources } from "./inbuilt-components/inbuiltDataSources.js";
+import { getControlTemplate } from "./inbuilt-components/control-templates.js";
+import { inbuiltPostSubmissionActions } from "./inbuilt-components/InbuiltPostSubmissionActions.js";
+import { inbuiltFormTransformers } from "./inbuilt-components/inbuiltTransformers.js";
+import { inbuiltFieldValueAdapters } from "./inbuilt-components/inbuiltFieldValueAdapters.js";
+import { hasRendering } from "../utils/common-utils.js";
+const registryCache = {
+    validators: {},
+    controls: {},
+    fieldValueAdapters: {},
+    postSubmissionActions: {},
+    dataSources: {},
+    formSchemaTransformers: {}
+};
+// Registers
+export function registerControl(registration) {
+    getFormsStore().controls.push(registration);
+}
+export function registerPostSubmissionAction(registration) {
+    getFormsStore().postSubmissionActions.push(registration);
+}
+export function registerFieldValueAdapter(registration) {
+    getFormsStore().fieldValueAdapters.push(registration);
+}
+export function registerFieldValidator(registration) {
+    getFormsStore().fieldValidators.push(registration);
+}
+export function registerCustomDataSource(registration) {
+    getFormsStore().dataSources.push(registration);
+}
+export function registerExpressionHelper(name, fn) {
+    getFormsStore().expressionHelpers[name] = fn;
+}
+export function registerFormSchemaTransformers(registration) {
+    const store = getFormsStore();
+    const existingIndex = store.formSchemaTransformers.findIndex((reg)=>reg.name === registration.name);
+    if (existingIndex !== -1) {
+        // If registration with the same name exists, override it
+        store.formSchemaTransformers[existingIndex] = registration;
+    } else {
+        store.formSchemaTransformers.push(registration);
+    }
+}
+// Getters
+/**
+ * A convenience function that returns the appropriate control for a given rendering type.
+ */ export async function getRegisteredControl(renderType) {
+    if (registryCache.controls[renderType]) {
+        return registryCache.controls[renderType];
+    }
+    let component = inbuiltControls.find((control)=>control.name === renderType || control?.alias === renderType)?.component;
+    // if undefined, try searching through the registered custom controls
+    if (!component) {
+        const importedControl = await getFormsStore().controls.find((control)=>control.name === renderType || control?.alias === renderType)?.load?.();
+        component = importedControl?.default;
+    }
+    registryCache.controls[renderType] = component;
+    return component;
+}
+/**
+ * Retrieves the appropriate field control for a question, considering missing concepts.
+ * If the question is of type 'obs' and has a missing concept, it falls back to a disabled text input.
+ * Otherwise, it retrieves the registered control based on the rendering specified in the question.
+ * @param question - The FormField representing the question.
+ * @returns The field control to be used for rendering the question.
+ */ export function getFieldControlWithFallback(question) {
+    // Check if the question has a missing concept
+    if (hasMissingConcept(question) && !hasRendering(question, 'file')) {
+        // If so, render a disabled text input
+        question.disabled = true;
+        question.isDisabled = true;
+        return getRegisteredControl('text');
+    }
+    // Retrieve the registered control based on the specified rendering
+    return getRegisteredControl(question.questionOptions.rendering);
+}
+export async function getRegisteredFieldValueAdapter(type) {
+    if (registryCache.fieldValueAdapters[type]) {
+        return registryCache.fieldValueAdapters[type];
+    }
+    let adapter = inbuiltFieldValueAdapters.find((adapter)=>adapter.type === type)?.component;
+    // if undefined, try searching through the registered custom handlers
+    if (!adapter) {
+        const adapterImport = await getFormsStore().fieldValueAdapters.find((adapter)=>adapter.type === type)?.load?.();
+        adapter = adapterImport?.default;
+    }
+    registryCache.fieldValueAdapters[type] = adapter;
+    return adapter;
+}
+export async function getRegisteredFormSchemaTransformers() {
+    const transformers = [];
+    const cachedTransformers = registryCache.formSchemaTransformers;
+    if (Object.keys(cachedTransformers).length) {
+        return Object.values(cachedTransformers);
+    }
+    const formTransformersFromStore = getFormsStore().formSchemaTransformers || [];
+    const customTransformers = await Promise.all(formTransformersFromStore.map(async (transformer)=>{
+        const transformerImport = await transformer.load?.();
+        return transformerImport?.default;
+    }));
+    transformers.push(...customTransformers.filter((transformer)=>transformer !== undefined));
+    transformers.push(...inbuiltFormTransformers.map((inbuiltTransformer)=>inbuiltTransformer.component));
+    transformers.forEach((transformer)=>{
+        const inbuiltTransformer = inbuiltFormTransformers.find((t)=>t.component === transformer);
+        registryCache.formSchemaTransformers[inbuiltTransformer.name] = transformer;
+    });
+    return transformers;
+}
+export async function getRegisteredPostSubmissionAction(actionId) {
+    const cachedAction = registryCache.postSubmissionActions[actionId];
+    if (cachedAction) {
+        return cachedAction;
+    }
+    const inbuiltRegistration = inbuiltPostSubmissionActions.find((registration)=>registration.name === actionId);
+    if (inbuiltRegistration) {
+        const lazy = inbuiltRegistration.load;
+        const actionImport = await lazy();
+        registryCache.postSubmissionActions[actionId] = actionImport.default;
+        return actionImport.default;
+    }
+    const formsStoreRegistration = getFormsStore().postSubmissionActions.find((registration)=>registration.name === actionId);
+    if (formsStoreRegistration) {
+        const lazy = formsStoreRegistration.load;
+        const actionImport = await lazy();
+        registryCache.postSubmissionActions[actionId] = actionImport.default;
+        return actionImport.default;
+    } else {
+        console.error(`No loader found for PostSubmissionAction registration of id: ${actionId}`);
+    }
+    return null;
+}
+export async function getRegisteredValidator(name) {
+    if (registryCache.validators[name]) {
+        return registryCache.validators[name];
+    }
+    let validator = inbuiltValidators.find((validator)=>validator.name === name)?.component;
+    if (!validator) {
+        const validatorImport = await getFormsStore().fieldValidators.find((validator)=>validator.name === name)?.load?.();
+        validator = validatorImport?.default;
+    }
+    registryCache.validators[name] = validator;
+    return validator;
+}
+export async function getRegisteredDataSource(name) {
+    if (registryCache.dataSources[name]) {
+        return registryCache.dataSources[name];
+    }
+    let ds = inbuiltDataSources.find((dataSource)=>dataSource.name === name)?.component;
+    if (!ds) {
+        const template = getControlTemplate(name);
+        if (template) {
+            ds = inbuiltDataSources.find((dataSource)=>dataSource.name === template.datasource.name)?.component;
+        } else {
+            const dataSourceImport = await getFormsStore().dataSources.find((ds)=>ds.name === name)?.load?.();
+            if (!dataSourceImport) {
+                throw new Error('Datasource not found');
+            }
+            ds = dataSourceImport.default;
+        }
+    }
+    registryCache.dataSources[name] = ds;
+    return ds;
+}
+export function getRegisteredExpressionHelpers() {
+    return getFormsStore().expressionHelpers;
+}
+function getFormsStore() {
+    return getGlobalStore(FormsStore, {
+        controls: [],
+        postSubmissionActions: [],
+        expressionHelpers: {},
+        fieldValidators: [],
+        fieldValueAdapters: [],
+        dataSources: [],
+        formSchemaTransformers: []
+    }).getState();
+}
+function hasMissingConcept(question) {
+    return question.type == 'obs' && !question.questionOptions.concept && question.questionOptions.rendering !== 'fixed-value';
+}

package/dist/registry/registry.test.js

@@ -0,0 +1,17 @@
+import { getRegisteredControl } from "./registry.js";
+import MultiSelect from "../components/inputs/multi-select/multi-select.component.js";
+import Number from "../components/inputs/number/number.component.js";
+describe.skip('registry', ()=>{
+    it('should load the NumberField component with alias "numeric"', async ()=>{
+        const result = await getRegisteredControl('numeric');
+        expect(result).toEqual(Number);
+    });
+    it('should load the MultiSelect component with alias "multiCheckbox"', async ()=>{
+        const result = await getRegisteredControl('multiCheckbox');
+        expect(result).toEqual(MultiSelect);
+    });
+    it('should return undefined if no matching component is found', async ()=>{
+        const result = await getRegisteredControl('unknown');
+        expect(result).toBeUndefined();
+    });
+});

package/dist/setup-tests.js

@@ -0,0 +1,30 @@
+import "@testing-library/jest-dom";
+import "jest-when";
+global.ResizeObserver = require('resize-observer-polyfill');
+// https://github.com/jsdom/jsdom/issues/1695
+window.HTMLElement.prototype.scrollIntoView = function() {};
+Object.defineProperty(window, 'i18next', {
+    writable: true,
+    configurable: true,
+    value: {
+        language: 'en',
+        t: jest.fn()
+    }
+});
+// Mock getComputedStyle for consistent font size
+Object.defineProperty(window, 'getComputedStyle', {
+    value: ()=>({
+            fontSize: '16px',
+            getPropertyValue: ()=>''
+        })
+});
+// Mock window.getComputedStyle for elements
+Object.defineProperty(HTMLElement.prototype, 'style', {
+    configurable: true,
+    get () {
+        return {
+            getPropertyValue: ()=>'',
+            setProperty: ()=>{}
+        };
+    }
+});

package/dist/transformers/default-schema-transformer.d.ts

@@ -0,0 +1,4 @@
+import { type FormSchemaTransformer, type RenderType } from '../types';
+export type RenderTypeExtended = 'multiCheckbox' | 'numeric' | RenderType;
+export declare const DefaultFormSchemaTransformer: FormSchemaTransformer;
+//# sourceMappingURL=default-schema-transformer.d.ts.map

package/dist/transformers/default-schema-transformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-schema-transformer.d.ts","sourceRoot":"","sources":["../../src/transformers/default-schema-transformer.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,qBAAqB,EAC1B,KAAK,UAAU,EAGhB,MAAM,UAAU,CAAC;AAIlB,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG,SAAS,GAAG,UAAU,CAAC;AAE1E,eAAO,MAAM,4BAA4B,EAAE,qBAyB1C,CAAC"}