@icure/form 2.1.2 → 2.1.4

package/generic/model.d.ts

@@ -1,6 +1,7 @@
 import { FieldMetadata, FieldValue } from '../components/model';
 /**
  * VersionedData is a structure that contains the values of a form, organized by id and version.
+ * Versions are ordered most recent first.
  */
 export interface VersionedData<T> {
     [id: string]: Version<T>[];
@@ -50,21 +51,21 @@ export type ID = string;
 export interface FormValuesContainer<Value, Metadata> {
     compute<T, S extends {
         [key: string | symbol]: unknown;
-    }>(formula: string, sandbox?: S): Promise<T | undefined>;
+    }>(formula: string, sandbox?: S): Promise<ComputationResult<T>>;
     getLabel(): string;
     getFormId(): string | undefined;
-    getDefaultValue(label: string): Promise<FieldValue | undefined>;
+    getDefaultValueProvider(label: string): (() => Promise<FieldValue | undefined>) | undefined;
     getValues(revisionsFilter: (id: string, history: Version<Metadata>[]) => (string | null)[]): VersionedData<Value>;
     getMetadata(id: string, revisions: (string | null)[]): VersionedData<Metadata>;
     getChildren(): Promise<FormValuesContainer<Value, Metadata>[]>;
-    getValidationErrors(): Promise<[FieldMetadata, string][]>;
-    setValue(label: string, language: string, data?: Value, id?: string, metadata?: Metadata, changeListenersOverrider?: (fvc: FormValuesContainer<Value, Metadata>) => void): void;
+    getValidationErrors(): Promise<[FieldMetadata, string] | null>[];
+    setValue(label: string, language: string, data?: Value, id?: string, metadata?: Metadata, changeListenersOverrider?: (fvc: FormValuesContainer<Value, Metadata>, changedKeys: string[] | null) => void): void;
     setMetadata(metadata: Metadata, id?: string): void;
     delete(serviceId: string): void;
     addChild(anchorId: string, templateId: string, label: string): Promise<void>;
     removeChild(container: FormValuesContainer<Value, Metadata>): Promise<void>;
-    registerChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void;
-    unregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void;
+    registerChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>, changedKeys: string[] | null, force: boolean) => void): void;
+    unregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>, changedKeys: string[] | null, force: boolean) => void): void;
     synchronise(): FormValuesContainer<Value, Metadata>;
 }
 /**
@@ -83,3 +84,7 @@ export type Suggestion = {
         [lng: string]: string;
     };
 };
+export interface ComputationResult<T> {
+    value: T | undefined;
+    dependencies: string[];
+}

package/generic/model.js.map

@@ -1 +1 @@
-{"version":3,"file":"model.js","sourceRoot":"","sources":["../../tmp/generic/model.ts"],"names":[],"mappings":"","sourcesContent":["import { FieldMetadata, FieldValue } from '../components/model'\n\n/**\n * VersionedData is a structure that contains the values of a form, organized by id and version.\n */\nexport interface VersionedData<T> {\n\t[id: string]: Version<T>[]\n}\n\n/**\n * Version is a structure that contains a value, a revision number and a modification timestamp used to sort the versions.\n */\nexport interface Version<T> {\n\trevision: string | null //null means that the version is not saved yet\n\tmodified?: number\n\tvalue: T\n}\n\nexport type ID = string\n/**\n * FormValuesContainer is a readonly structure that provides and handle the values of a form.\n * It is a tree structure where each node is a FormValuesContainer with the same Value and Metadata types.\n *\n * The following methods are provided and must be implemented by the concrete class:\n * - `compute(formula: string, sandbox?: S): T?` : computes a formula based on the values of the form, inside a provided sandbox. If no sandbox is provided, the default sandbox is used.\n * - `getLabel(): string` : returns the label of the form values container (used to display the title of the form in hierarchical contexts)\n * - `getFormId(): string?` : returns the id of the form values container\n * - `getValues(revisionsFilter: Lambda): VersionedData<Value>` : obtains the values to be displayed in the form, using a filter\n * \t\t\tto select the desired versioned data that are to be displayed in a specific field.\n * - `getMetadata(id: string, revisions: (string | null)[]): VersionedData<Metadata>` : obtains the metadata of a specific value, for the specified revisions.\n * - `getValidationErrors(): [FieldMetadata, string][]`: returns the validation errors of the form values container for the values that are currently stored in it.\n * - `getChildren(): FormValuesContainer<Value, Metadata>[]` : returns the children of the form values container\n * - `setValue(label: string, language: string, data?: Value, id?: string, metadata?: Metadata): FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, ID>` :\n * \t\t\tmodifies the value associated to a field in the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container along with the modified value.\n * - `setMetadata(label: string, metadata: Metadata, id?: string): FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, ID>` :\n * \t\t\tmodifies the metadata associated to a value in the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container along with the modified metadata.\n * - `delete(valueId: string): FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, void>` :\n * \t\t\tdeletes a value from the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container without the deleted value.\n * - `addChild(anchorId: string, templateId: string, label: string): Promise<FormValuesContainerMutation<...>, FormValuesContainer<...>>>`:\n * \t\t\tadds a child to the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container with the added child.\n * - `removeChild(container: FormValuesContainer<Value, Metadata>): Promise<FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, void>>` :\n * \t\t\tremoves a child from the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container without the removed child.\n * - `registerChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void` :\n * \t\t\tregisters a listener that will be called whenever the form values container is modified.\n * - `unregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void` : unregisters a listener that was previously registered.\n *\n */\nexport interface FormValuesContainer<Value, Metadata> {\n\t//information retrieval\n\tcompute<T, S extends { [key: string | symbol]: unknown }>(formula: string, sandbox?: S): Promise<T | undefined>\n\tgetLabel(): string\n\tgetFormId(): string | undefined\n\tgetDefaultValue(label: string): Promise<FieldValue | undefined>\n\tgetValues(revisionsFilter: (id: string, history: Version<Metadata>[]) => (string | null)[]): VersionedData<Value>\n\tgetMetadata(id: string, revisions: (string | null)[]): VersionedData<Metadata>\n\tgetChildren(): Promise<FormValuesContainer<Value, Metadata>[]>\n\tgetValidationErrors(): Promise<[FieldMetadata, string][]>\n\t//modification\n\tsetValue(label: string, language: string, data?: Value, id?: string, metadata?: Metadata, changeListenersOverrider?: (fvc: FormValuesContainer<Value, Metadata>) => void): void\n\tsetMetadata(metadata: Metadata, id?: string): void\n\tdelete(serviceId: string): void\n\t//hierarchy\n\taddChild(anchorId: string, templateId: string, label: string): Promise<void>\n\tremoveChild(container: FormValuesContainer<Value, Metadata>): Promise<void>\n\t//listeners\n\tregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void\n\tunregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void\n\n\tsynchronise(): FormValuesContainer<Value, Metadata>\n}\n\n/**\n * FormValuesContainerMutation is a structure that wraps a new form values container along with the modified value.\n */\nexport interface FormValuesContainerMutation<Value, Metadata, FVC extends FormValuesContainer<Value, Metadata>, Result> {\n\tresult: Result\n\tformValuesContainer: FVC\n}\n\nexport type Suggestion = { id: string; code?: string; text: string; terms: string[]; label: { [lng: string]: string } }\n"]}
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../../tmp/generic/model.ts"],"names":[],"mappings":"","sourcesContent":["import { FieldMetadata, FieldValue } from '../components/model'\n\n/**\n * VersionedData is a structure that contains the values of a form, organized by id and version.\n * Versions are ordered most recent first.\n */\nexport interface VersionedData<T> {\n\t[id: string]: Version<T>[]\n}\n\n/**\n * Version is a structure that contains a value, a revision number and a modification timestamp used to sort the versions.\n */\nexport interface Version<T> {\n\trevision: string | null //null means that the version is not saved yet\n\tmodified?: number\n\tvalue: T\n}\n\nexport type ID = string\n/**\n * FormValuesContainer is a readonly structure that provides and handle the values of a form.\n * It is a tree structure where each node is a FormValuesContainer with the same Value and Metadata types.\n *\n * The following methods are provided and must be implemented by the concrete class:\n * - `compute(formula: string, sandbox?: S): T?` : computes a formula based on the values of the form, inside a provided sandbox. If no sandbox is provided, the default sandbox is used.\n * - `getLabel(): string` : returns the label of the form values container (used to display the title of the form in hierarchical contexts)\n * - `getFormId(): string?` : returns the id of the form values container\n * - `getValues(revisionsFilter: Lambda): VersionedData<Value>` : obtains the values to be displayed in the form, using a filter\n * \t\t\tto select the desired versioned data that are to be displayed in a specific field.\n * - `getMetadata(id: string, revisions: (string | null)[]): VersionedData<Metadata>` : obtains the metadata of a specific value, for the specified revisions.\n * - `getValidationErrors(): [FieldMetadata, string][]`: returns the validation errors of the form values container for the values that are currently stored in it.\n * - `getChildren(): FormValuesContainer<Value, Metadata>[]` : returns the children of the form values container\n * - `setValue(label: string, language: string, data?: Value, id?: string, metadata?: Metadata): FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, ID>` :\n * \t\t\tmodifies the value associated to a field in the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container along with the modified value.\n * - `setMetadata(label: string, metadata: Metadata, id?: string): FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, ID>` :\n * \t\t\tmodifies the metadata associated to a value in the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container along with the modified metadata.\n * - `delete(valueId: string): FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, void>` :\n * \t\t\tdeletes a value from the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container without the deleted value.\n * - `addChild(anchorId: string, templateId: string, label: string): Promise<FormValuesContainerMutation<...>, FormValuesContainer<...>>>`:\n * \t\t\tadds a child to the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container with the added child.\n * - `removeChild(container: FormValuesContainer<Value, Metadata>): Promise<FormValuesContainerMutation<Value, Metadata, FormValuesContainer<Value, Metadata>, void>>` :\n * \t\t\tremoves a child from the form values container. As a form values container is immutable, this method returns a mutation wrapping\n * \t\t\ta new form values container without the removed child.\n * - `registerChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void` :\n * \t\t\tregisters a listener that will be called whenever the form values container is modified.\n * - `unregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>) => void): void` : unregisters a listener that was previously registered.\n *\n */\nexport interface FormValuesContainer<Value, Metadata> {\n\t//information retrieval\n\tcompute<T, S extends { [key: string | symbol]: unknown }>(formula: string, sandbox?: S): Promise<ComputationResult<T>>\n\tgetLabel(): string\n\tgetFormId(): string | undefined\n\tgetDefaultValueProvider(label: string): (() => Promise<FieldValue | undefined>) | undefined\n\tgetValues(revisionsFilter: (id: string, history: Version<Metadata>[]) => (string | null)[]): VersionedData<Value>\n\tgetMetadata(id: string, revisions: (string | null)[]): VersionedData<Metadata>\n\tgetChildren(): Promise<FormValuesContainer<Value, Metadata>[]>\n\tgetValidationErrors(): Promise<[FieldMetadata, string] | null>[]\n\t//modification\n\tsetValue(\n\t\tlabel: string,\n\t\tlanguage: string,\n\t\tdata?: Value,\n\t\tid?: string,\n\t\tmetadata?: Metadata,\n\t\tchangeListenersOverrider?: (fvc: FormValuesContainer<Value, Metadata>, changedKeys: string[] | null) => void,\n\t): void\n\tsetMetadata(metadata: Metadata, id?: string): void\n\tdelete(serviceId: string): void\n\t//hierarchy\n\taddChild(anchorId: string, templateId: string, label: string): Promise<void>\n\tremoveChild(container: FormValuesContainer<Value, Metadata>): Promise<void>\n\t//listeners\n\tregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>, changedKeys: string[] | null, force: boolean) => void): void\n\tunregisterChangeListener(listener: (newValue: FormValuesContainer<Value, Metadata>, changedKeys: string[] | null, force: boolean) => void): void\n\n\tsynchronise(): FormValuesContainer<Value, Metadata>\n}\n\n/**\n * FormValuesContainerMutation is a structure that wraps a new form values container along with the modified value.\n */\nexport interface FormValuesContainerMutation<Value, Metadata, FVC extends FormValuesContainer<Value, Metadata>, Result> {\n\tresult: Result\n\tformValuesContainer: FVC\n}\n\nexport type Suggestion = { id: string; code?: string; text: string; terms: string[]; label: { [lng: string]: string } }\n\nexport interface ComputationResult<T> {\n\tvalue: T | undefined\n\tdependencies: string[]\n}\n"]}

package/icure/form-values-container.d.ts

@@ -1,7 +1,13 @@
 import { Contact, Form, Form as ICureForm, Service } from '@icure/api';
-import { FormValuesContainer, Version, VersionedData } from '../generic';
+import { ComputationResult, FormValuesContainer, Version, VersionedData } from '../generic';
 import { ServiceMetadata } from './model';
 import { FieldMetadata, FieldValue, Validator } from '../components/model';
+interface ComputedValueChange {
+    serviceId: string | undefined;
+    metadata: FieldMetadata;
+    language: string;
+    value: FieldValue | undefined;
+}
 /** This class is a bridge between the ICure API and the generic FormValuesContainer interface.
  * It wraps around a ContactFormValuesContainer and provides a series of services:
  * - It computes dependent values when the form is created
@@ -30,10 +36,12 @@ export declare class BridgedFormValuesContainer implements FormValuesContainer<F
     private language;
     private changeListeners;
     private interpreterContext;
+    private dependenciesCache;
     private contact;
     private contactFormValuesContainer;
     private _id;
     private readonly mutateAndNotify;
+    private dependentValuesComputationIteration?;
     toString(): string;
     /**
      * Creates an instance of BridgedFormValuesContainer.
@@ -47,6 +55,7 @@ export declare class BridgedFormValuesContainer implements FormValuesContainer<F
      * @param language The language in which the values are displayed
      * @param changeListeners The listeners that will be notified when the values change
      * @param interpreterContext A map with keys that are the names of the variables and values that are the functions that return the values of the variables
+     * @param dependenciesCache
      */
     constructor(responsible: string, contactFormValuesContainer: ContactFormValuesContainer, interpreter?: (<T, S extends {
         [key: string | symbol]: unknown;
@@ -61,30 +70,30 @@ export declare class BridgedFormValuesContainer implements FormValuesContainer<F
     }[], validatorsProvider?: (anchorId: string | undefined, templateId: string) => {
         metadata: FieldMetadata;
         validators: Validator[];
-    }[], language?: string, changeListeners?: ((newValue: BridgedFormValuesContainer) => void)[], interpreterContext?: {
+    }[], language?: string, changeListeners?: ((newValue: BridgedFormValuesContainer, changedKeys: string[] | null, force: boolean) => void)[], interpreterContext?: {
         [variable: string]: () => unknown;
+    }, dependenciesCache?: {
+        [formula: string]: string[];
     });
-    init(): Promise<this>;
+    init(changedKeys?: string[] | null, pendingComputationIteration?: Promise<ComputedValueChange[]>): Promise<BridgedFormValuesContainer>;
     getLabel(): string;
     getFormId(): string | undefined;
     getContactFormValuesContainer(): ContactFormValuesContainer;
-    registerChangeListener(listener: (newValue: BridgedFormValuesContainer) => void): void;
-    unregisterChangeListener(listener: (newValue: BridgedFormValuesContainer) => void): void;
-    getDefaultValue(label: string): Promise<FieldValue | undefined>;
+    registerChangeListener(listener: (newValue: BridgedFormValuesContainer, changedKeys: string[] | null, force: boolean) => void): void;
+    unregisterChangeListener(listener: (newValue: BridgedFormValuesContainer, changedKeys: string[] | null, force: boolean) => void): void;
+    getDefaultValueProvider(label: string): (() => Promise<FieldValue | undefined>) | undefined;
     getValues(revisionsFilter: (id: string, history: Version<FieldMetadata>[]) => (string | null)[]): VersionedData<FieldValue>;
     getMetadata(id: string, revisions: (string | null)[]): VersionedData<FieldMetadata>;
     private convertRawValue;
-    private computeInitialValues;
     private computeDependentValues;
+    private quietlyApplyChangesOnContactFormValueContainer;
     setValue(label: string, language: string, fv?: FieldValue, id?: string, metadata?: FieldMetadata): void;
     setMetadata(meta: FieldMetadata, id?: string | undefined): void;
     delete(serviceId: string): void;
     private getVersionedValuesForKey;
-    compute<T, S extends {
-        [key: string | symbol]: unknown;
-    }>(formula: string, sandbox?: S): Promise<T | undefined>;
+    compute<T>(formula: string): Promise<ComputationResult<T>>;
     getChildren(): Promise<FormValuesContainer<FieldValue, FieldMetadata>[]>;
-    getValidationErrors(): Promise<[FieldMetadata, string][]>;
+    getValidationErrors(): Promise<[FieldMetadata, string] | null>[];
     addChild(anchorId: string, templateId: string, label: string): Promise<void>;
     removeChild(container: BridgedFormValuesContainer): Promise<void>;
     synchronise(): this;
@@ -102,11 +111,12 @@ export declare class ContactFormValuesContainer implements FormValuesContainer<S
     currentContact: Contact;
     contactsHistory: Contact[];
     children: ContactFormValuesContainer[];
+    anchorId?: string;
     serviceFactory: (label: string, serviceId?: string) => Service;
     formFactory: (parentId: string, anchorId: string, formTemplateId: string, label: string) => Promise<ICureForm>;
     formRecycler: (formId: string) => Promise<void>;
-    changeListeners: ((newValue: ContactFormValuesContainer) => void)[];
-    private _id;
+    changeListeners: ((newValue: ContactFormValuesContainer, changedKeys: string[] | null, force: boolean) => void)[];
+    _id: string;
     private _initialised;
     private indexedServices;
     toString(): string;
@@ -119,23 +129,24 @@ export declare class ContactFormValuesContainer implements FormValuesContainer<S
      * Returns a contact that combines the content of the contact in this form with the content of all contents stored in the children
      */
     allForms(): Form[];
-    constructor(rootForm: ICureForm, currentContact: Contact, contactsHistory: Contact[], serviceFactory: (label: string, serviceId?: string) => Service, children: ContactFormValuesContainer[], formFactory: (parentId: string, anchorId: string, formTemplateId: string, label: string) => Promise<ICureForm>, formRecycler: (formId: string) => Promise<void>, changeListeners?: ((newValue: ContactFormValuesContainer) => void)[], initialised?: boolean);
+    constructor(rootForm: ICureForm, currentContact: Contact, contactsHistory: Contact[], serviceFactory: (label: string, serviceId?: string) => Service, children: ContactFormValuesContainer[], formFactory: (parentId: string, anchorId: string, formTemplateId: string, label: string) => Promise<ICureForm>, formRecycler: (formId: string) => Promise<void>, changeListeners?: ((newValue: ContactFormValuesContainer, changedKeys: string[] | null, force: boolean) => void)[], anchorId?: string, initialised?: boolean);
     synchronise(): this;
-    registerChildFormValuesContainer(childFormValueContainer: ContactFormValuesContainer): void;
+    registerChildFormValuesContainer(childFormValueContainer: ContactFormValuesContainer, anchorId: string): void;
     static fromFormsHierarchy(rootForm: ICureForm, currentContact: Contact, contactsHistory: Contact[], serviceFactory: (label: string, serviceId?: string) => Service, formChildrenProvider: (parentId: string | undefined) => Promise<ICureForm[]>, formFactory: (parentId: string, anchorId: string, formTemplateId: string, label: string) => Promise<ICureForm>, formRecycler: (formId: string) => Promise<void>, changeListeners?: ((newValue: ContactFormValuesContainer) => void)[]): Promise<ContactFormValuesContainer>;
     getLabel(): string;
     getFormId(): string | undefined;
-    registerChangeListener(listener: (newValue: ContactFormValuesContainer) => void): void;
-    unregisterChangeListener(listener: (newValue: ContactFormValuesContainer) => void): void;
+    registerChangeListener(listener: (newValue: ContactFormValuesContainer, changedKeys: string[] | null, force: boolean) => void): void;
+    unregisterChangeListener(listener: (newValue: ContactFormValuesContainer, changedKeys: string[] | null, force: boolean) => void): void;
     getChildren(): Promise<ContactFormValuesContainer[]>;
-    getValidationErrors(): Promise<[FieldMetadata, string][]>;
-    getDefaultValue(): Promise<FieldValue | undefined>;
+    getValidationErrors(): Promise<[FieldMetadata, string] | null>[];
+    getDefaultValueProvider(): (() => Promise<FieldValue | undefined>) | undefined;
     getValues(revisionsFilter: (id: string, history: Version<ServiceMetadata>[]) => (string | null)[]): VersionedData<Service>;
     getMetadata(id: string, revisions: (string | null)[]): VersionedData<ServiceMetadata>;
     setMetadata(meta: ServiceMetadata, id?: string): void;
-    setValue(label: string, language: string, value?: Service, id?: string, metadata?: ServiceMetadata, changeListenersOverrider?: (fvc: ContactFormValuesContainer) => void): void;
+    setValue(label: string, language: string, value?: Service, id?: string, metadata?: ServiceMetadata, changeListenersOverrider?: (fvc: ContactFormValuesContainer, changedKeys: string[] | null) => void): void;
     delete(serviceId: string): void;
-    compute<T>(): Promise<T | undefined>;
+    toMarkdownTable(): string;
+    compute<T>(): Promise<ComputationResult<T>>;
     /** returns all services in history that match a selector
      *
      * @private
@@ -146,3 +157,4 @@ export declare class ContactFormValuesContainer implements FormValuesContainer<S
     private getServiceInCurrentContact;
     removeChild(container: ContactFormValuesContainer): Promise<void>;
 }
+export {};