@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/embed/TypedValue.mjs

@@ -1,14 +1,49 @@
 // auto-generated file
 import { expectBoolean, expectNumber, expectString, expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { TypedValuesType } from './TypedValuesType.mjs';
+/**
+ *
+ *  Represents a typed value that can hold one of several primitive types (boolean, integer, double,
+ *  string, or date).
+ *  The actual value is stored in the corresponding typed field based on the [type].
+ *  /
+ */
 export class DecryptedTypedValue {
     constructor(partial) {
+        /**
+         *
+         *  The type of the value stored.
+         */
         this.type = undefined;
+        /**
+         *
+         *  The boolean value, if type is BOOLEAN.
+         */
         this.booleanValue = undefined;
+        /**
+         *
+         *  The integer value, if type is INTEGER.
+         */
         this.integerValue = undefined;
+        /**
+         *
+         *  The double value, if type is DOUBLE.
+         */
         this.doubleValue = undefined;
+        /**
+         *
+         *  The string value, if type is STRING, JSON, or CLOB.
+         */
         this.stringValue = undefined;
+        /**
+         *
+         *  The date value as an Instant, if type is DATE.
+         */
         this.dateValue = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -70,14 +105,49 @@ export class DecryptedTypedValue {
         return res;
     }
 }
+/**
+ *
+ *  Represents a typed value that can hold one of several primitive types (boolean, integer, double,
+ *  string, or date).
+ *  The actual value is stored in the corresponding typed field based on the [type].
+ *  /
+ */
 export class EncryptedTypedValue {
     constructor(partial) {
+        /**
+         *
+         *  The type of the value stored.
+         */
         this.type = undefined;
+        /**
+         *
+         *  The boolean value, if type is BOOLEAN.
+         */
         this.booleanValue = undefined;
+        /**
+         *
+         *  The integer value, if type is INTEGER.
+         */
         this.integerValue = undefined;
+        /**
+         *
+         *  The double value, if type is DOUBLE.
+         */
         this.doubleValue = undefined;
+        /**
+         *
+         *  The string value, if type is STRING, JSON, or CLOB.
+         */
         this.stringValue = undefined;
+        /**
+         *
+         *  The date value as an Instant, if type is DATE.
+         */
         this.dateValue = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/TypedValuesType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible types for a typed value.
+ */
 export declare enum TypedValuesType {
     Boolean = "Boolean",
     Integer = "Integer",

package/model/embed/TypedValuesType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible types for a typed value.
+ */
 export var TypedValuesType;
 (function (TypedValuesType) {
     TypedValuesType["Boolean"] = "Boolean";

package/model/embed/UserAccessLevel.d.mts

@@ -1,3 +1,14 @@
+/**
+ *
+ *
+ *   Specifies the access level of a user that is not necessarily a data owner on an entity. The
+ *  interpretation of the
+ *   entities is the following:
+ *   - Read: the user only has read permissions on the entity.
+ *   - Write: the user has read and write permissions on the entity, but they cannot modify the
+ *  access of users to the entity.
+ *   - Admin: the user has full control over the entity.
+ */
 export declare enum UserAccessLevel {
     Admin = "Admin",
     Read = "Read",

package/model/embed/UserAccessLevel.mjs

@@ -1,4 +1,15 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Specifies the access level of a user that is not necessarily a data owner on an entity. The
+ *  interpretation of the
+ *   entities is the following:
+ *   - Read: the user only has read permissions on the entity.
+ *   - Write: the user has read and write permissions on the entity, but they cannot modify the
+ *  access of users to the entity.
+ *   - Admin: the user has full control over the entity.
+ */
 export var UserAccessLevel;
 (function (UserAccessLevel) {
     UserAccessLevel["Admin"] = "Admin";

package/model/embed/UserType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of users in the system.
+ */
 export declare enum UserType {
     Hcp = "Hcp",
     Patient = "Patient",

package/model/embed/UserType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of users in the system.
+ */
 export var UserType;
 (function (UserType) {
     UserType["Hcp"] = "Hcp";

package/model/embed/ValueWithPrecision.d.mts

@@ -1,5 +1,18 @@
+/**
+ *
+ *  Represents a numeric value paired with its precision (number of significant digits).
+ *  /
+ */
 export declare class ValueWithPrecision {
+    /**
+     *
+     *  The numeric value.
+     */
     value: number;
+    /**
+     *
+     *  The number of significant digits.
+     */
     precision: number;
     constructor(partial: Partial<ValueWithPrecision> & Pick<ValueWithPrecision, "value" | "precision">);
     toJSON(): object;

package/model/embed/ValueWithPrecision.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectNumber, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents a numeric value paired with its precision (number of significant digits).
+ *  /
+ */
 export class ValueWithPrecision {
     constructor(partial) {
         this.value = partial.value;

package/model/embed/Weekday.d.mts

@@ -1,6 +1,19 @@
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a weekday reference used in medication regimens, optionally specifying a week number.
+ *  /
+ */
 export declare class Weekday {
+    /**
+     *
+     *  The coded weekday (CD-WEEKDAY).
+     */
     weekday: CodeStub | undefined;
+    /**
+     *
+     *  The week number within a cycle, or null if not applicable.
+     */
     weekNumber: number | undefined;
     constructor(partial: Partial<Weekday>);
     toJSON(): object;

package/model/embed/Weekday.mjs

@@ -1,9 +1,22 @@
 // auto-generated file
 import { expectNumber, expectObject, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a weekday reference used in medication regimens, optionally specifying a week number.
+ *  /
+ */
 export class Weekday {
     constructor(partial) {
+        /**
+         *
+         *  The coded weekday (CD-WEEKDAY).
+         */
         this.weekday = undefined;
+        /**
+         *
+         *  The week number within a cycle, or null if not applicable.
+         */
         this.weekNumber = undefined;
         if ('weekday' in partial)
             this.weekday = partial.weekday;

package/model/embed/form/template/Action.d.mts

@@ -1,8 +1,26 @@
 import { Launcher } from './Launcher.mjs';
 import { State } from './State.mjs';
+/**
+ *
+ *  Represents an action in a form template, combining launchers, a conditional expression, and
+ *  target states.
+ *  /
+ */
 export declare class Action {
+    /**
+     *
+     *  The list of launchers that can trigger this action.
+     */
     launchers: Array<Launcher> | undefined;
+    /**
+     *
+     *  A conditional expression that determines when this action is executed.
+     */
     expression: string | undefined;
+    /**
+     *
+     *  The list of states to apply when this action is triggered.
+     */
     states: Array<State> | undefined;
     constructor(partial: Partial<Action>);
     toJSON(): object;

package/model/embed/form/template/Action.mjs

@@ -2,10 +2,28 @@
 import { expectArray, expectObject, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
 import { Launcher } from './Launcher.mjs';
 import { State } from './State.mjs';
+/**
+ *
+ *  Represents an action in a form template, combining launchers, a conditional expression, and
+ *  target states.
+ *  /
+ */
 export class Action {
     constructor(partial) {
+        /**
+         *
+         *  The list of launchers that can trigger this action.
+         */
         this.launchers = [];
+        /**
+         *
+         *  A conditional expression that determines when this action is executed.
+         */
         this.expression = undefined;
+        /**
+         *
+         *  The list of states to apply when this action is triggered.
+         */
         this.states = [];
         if ('launchers' in partial)
             this.launchers = partial.launchers;

package/model/embed/form/template/CheckBox.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A checkbox field in a form template.
+ *  /
+ */
 export declare class CheckBox {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/CheckBox.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A checkbox field in a form template.
+ *  /
+ */
 export class CheckBox {
     constructor(partial) {
         this.shortLabel = undefined;

package/model/embed/form/template/DatePicker.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A date picker field in a form template.
+ *  /
+ */
 export declare class DatePicker {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/DatePicker.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A date picker field in a form template.
+ *  /
+ */
 export class DatePicker {
     constructor(partial) {
         this.shortLabel = undefined;

package/model/embed/form/template/DateTimePicker.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A date-time picker field in a form template, combining date and time selection.
+ *  /
+ */
 export declare class DateTimePicker {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/DateTimePicker.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A date-time picker field in a form template, combining date and time selection.
+ *  /
+ */
 export class DateTimePicker {
     constructor(partial) {
         this.shortLabel = undefined;

package/model/embed/form/template/DropdownField.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A dropdown selection field in a form template.
+ *  /
+ */
 export declare class DropdownField {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/DropdownField.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A dropdown selection field in a form template.
+ *  /
+ */
 export class DropdownField {
     constructor(partial) {
         this.shortLabel = undefined;

package/model/embed/form/template/Field.d.mts

@@ -8,4 +8,13 @@ import { NumberField } from './NumberField.mjs';
 import { RadioButton } from './RadioButton.mjs';
 import { TextField } from './TextField.mjs';
 import { TimePicker } from './TimePicker.mjs';
+/**
+ *
+ *  Sealed interface representing a form field within a form template. Concrete implementations
+ *  define
+ *  specific field types (text, number, date picker, etc.). Each field has a name, display
+ *  configuration,
+ *  validation rules, and optional codification and tagging.
+ *  /
+ */
 export type Field = RadioButton | MeasureField | TimePicker | NumberField | TextField | DateTimePicker | CheckBox | DatePicker | DropdownField | MultipleChoice;

package/model/embed/form/template/FieldsGroup.d.mts

@@ -1,6 +1,20 @@
 import { StructureElement } from './StructureElement.mjs';
+/**
+ *
+ *  Represents a group of structure elements within a form template section, used to organize fields
+ *  logically.
+ *  /
+ */
 export declare class FieldsGroup {
+    /**
+     *
+     *  The name or identifier of this group.
+     */
     group: string;
+    /**
+     *
+     *  The list of structure elements (fields or nested groups) in this group.
+     */
     fields: Array<StructureElement> | undefined;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.embed.form.template.FieldsGroup';
     constructor(partial: Partial<FieldsGroup> & Pick<FieldsGroup, "group">);

package/model/embed/form/template/FieldsGroup.mjs

@@ -1,8 +1,18 @@
 // auto-generated file
 import { expectArray, expectObject, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
 import { StructureElement } from './StructureElement.mjs';
+/**
+ *
+ *  Represents a group of structure elements within a form template section, used to organize fields
+ *  logically.
+ *  /
+ */
 export class FieldsGroup {
     constructor(partial) {
+        /**
+         *
+         *  The list of structure elements (fields or nested groups) in this group.
+         */
         this.fields = undefined;
         this.$ktClass = 'com.icure.cardinal.sdk.model.embed.form.template.FieldsGroup';
         this.group = partial.group;

package/model/embed/form/template/FormTemplateLayout.d.mts

@@ -1,10 +1,36 @@
 import { Action } from './Action.mjs';
 import { Section } from './Section.mjs';
+/**
+ *
+ *  Represents the layout of a form template, defining the form name, its actions, sections, and
+ *  metadata.
+ *  /
+ */
 export declare class FormTemplateLayout {
+    /**
+     *
+     *  The name or identifier of the form.
+     */
     form: string;
+    /**
+     *
+     *  The list of actions available in this form template.
+     */
     actions: Array<Action>;
+    /**
+     *
+     *  The list of sections composing this form template.
+     */
     sections: Array<Section>;
+    /**
+     *
+     *  A description of the form template.
+     */
     description: string | undefined;
+    /**
+     *
+     *  Keywords associated with the form template for search purposes.
+     */
     keywords: Array<string> | undefined;
     constructor(partial: Partial<FormTemplateLayout> & Pick<FormTemplateLayout, "form">);
     toJSON(): object;

package/model/embed/form/template/FormTemplateLayout.mjs

@@ -2,11 +2,33 @@
 import { expectArray, expectObject, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
 import { Action } from './Action.mjs';
 import { Section } from './Section.mjs';
+/**
+ *
+ *  Represents the layout of a form template, defining the form name, its actions, sections, and
+ *  metadata.
+ *  /
+ */
 export class FormTemplateLayout {
     constructor(partial) {
+        /**
+         *
+         *  The list of actions available in this form template.
+         */
         this.actions = [];
+        /**
+         *
+         *  The list of sections composing this form template.
+         */
         this.sections = [];
+        /**
+         *
+         *  A description of the form template.
+         */
         this.description = undefined;
+        /**
+         *
+         *  Keywords associated with the form template for search purposes.
+         */
         this.keywords = undefined;
         this.form = partial.form;
         if ('actions' in partial && partial.actions !== undefined)

package/model/embed/form/template/Launcher.d.mts

@@ -1,7 +1,25 @@
 import { Trigger } from './Trigger.mjs';
+/**
+ *
+ *
+ *   Represents a launcher that triggers an action in a form template based on a specific trigger
+ *  event.
+ */
 export declare class Launcher {
+    /**
+     *
+     *  The name of the launcher.
+     */
     name: string;
+    /**
+     *
+     *  The trigger event that activates this launcher.
+     */
     triggerer: Trigger;
+    /**
+     *
+     *  Whether the current field value should be passed when the launcher is triggered.
+     */
     shouldPassValue: boolean;
     constructor(partial: Partial<Launcher> & Pick<Launcher, "name" | "triggerer">);
     toJSON(): object;

package/model/embed/form/template/Launcher.mjs

@@ -1,8 +1,18 @@
 // auto-generated file
 import { expectBoolean, expectString, expectStringEnum, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
 import { Trigger } from './Trigger.mjs';
+/**
+ *
+ *
+ *   Represents a launcher that triggers an action in a form template based on a specific trigger
+ *  event.
+ */
 export class Launcher {
     constructor(partial) {
+        /**
+         *
+         *  Whether the current field value should be passed when the launcher is triggered.
+         */
         this.shouldPassValue = false;
         this.name = partial.name;
         this.triggerer = partial.triggerer;

package/model/embed/form/template/MeasureField.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A measurement input field in a form template, used for capturing numeric values with units.
+ *  /
+ */
 export declare class MeasureField {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/MeasureField.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A measurement input field in a form template, used for capturing numeric values with units.
+ *  /
+ */
 export class MeasureField {
     constructor(partial) {
         this.shortLabel = undefined;

package/model/embed/form/template/MultipleChoice.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A multiple choice field in a form template, allowing selection of multiple options.
+ *  /
+ */
 export declare class MultipleChoice {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/MultipleChoice.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A multiple choice field in a form template, allowing selection of multiple options.
+ *  /
+ */
 export class MultipleChoice {
     constructor(partial) {
         this.shortLabel = undefined;

package/model/embed/form/template/NumberField.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A numeric input field in a form template.
+ *  /
+ */
 export declare class NumberField {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/NumberField.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A numeric input field in a form template.
+ *  /
+ */
 export class NumberField {
     constructor(partial) {
         this.shortLabel = undefined;

package/model/embed/form/template/RadioButton.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  A radio button field in a form template, allowing selection of a single option.
+ *  /
+ */
 export declare class RadioButton {
     field: string;
     shortLabel: string | undefined;

package/model/embed/form/template/RadioButton.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A radio button field in a form template, allowing selection of a single option.
+ *  /
+ */
 export class RadioButton {
     constructor(partial) {
         this.shortLabel = undefined;