@icure/cardinal-sdk 2.1.1 → 2.1.2

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

@@ -1,8 +1,30 @@
 import { StructureElement } from './StructureElement.mjs';
+/**
+ *
+ *  Represents a section within a form template layout, containing a set of structure elements
+ *  (fields and groups).
+ *  /
+ */
 export declare class Section {
+    /**
+     *
+     *  The name or identifier of this section.
+     */
     section: string;
+    /**
+     *
+     *  The list of structure elements in this section.
+     */
     fields: Array<StructureElement>;
+    /**
+     *
+     *  A description of this section.
+     */
     description: string | undefined;
+    /**
+     *
+     *  Keywords associated with this section for search purposes.
+     */
     keywords: Array<string> | undefined;
     constructor(partial: Partial<Section> & Pick<Section, "section" | "fields">);
     toJSON(): object;

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

@@ -1,9 +1,23 @@
 // auto-generated file
 import { expectArray, expectObject, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
 import { StructureElement } from './StructureElement.mjs';
+/**
+ *
+ *  Represents a section within a form template layout, containing a set of structure elements
+ *  (fields and groups).
+ *  /
+ */
 export class Section {
     constructor(partial) {
+        /**
+         *
+         *  A description of this section.
+         */
         this.description = undefined;
+        /**
+         *
+         *  Keywords associated with this section for search purposes.
+         */
         this.keywords = undefined;
         this.section = partial.section;
         this.fields = partial.fields;

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

@@ -1,7 +1,24 @@
 import { StateToUpdate } from './StateToUpdate.mjs';
+/**
+ *
+ *
+ *   Represents a state change applied to a form field when an action is triggered.
+ */
 export declare class State {
+    /**
+     *
+     *  The name of the target field.
+     */
     name: string;
+    /**
+     *
+     *  The aspect of the field state to update (value, visibility, readonly, etc.).
+     */
     stateToUpdate: StateToUpdate;
+    /**
+     *
+     *  Whether this state change can trigger additional launchers.
+     */
     canLaunchLauncher: boolean;
     constructor(partial: Partial<State> & Pick<State, "name" | "stateToUpdate">);
     toJSON(): object;

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

@@ -1,8 +1,17 @@
 // auto-generated file
 import { expectBoolean, expectString, expectStringEnum, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
 import { StateToUpdate } from './StateToUpdate.mjs';
+/**
+ *
+ *
+ *   Represents a state change applied to a form field when an action is triggered.
+ */
 export class State {
     constructor(partial) {
+        /**
+         *
+         *  Whether this state change can trigger additional launchers.
+         */
         this.canLaunchLauncher = false;
         this.name = partial.name;
         this.stateToUpdate = partial.stateToUpdate;

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

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the aspects of a form field state that can be updated by an action.
+ */
 export declare enum StateToUpdate {
     Value = "Value",
     Visible = "Visible",

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

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the aspects of a form field state that can be updated by an action.
+ */
 export var StateToUpdate;
 (function (StateToUpdate) {
     StateToUpdate["Value"] = "Value";

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

@@ -1,5 +1,11 @@
 import { Field } from './Field.mjs';
 import { FieldsGroup } from './FieldsGroup.mjs';
+/**
+ *
+ *  Marker interface for elements that can appear in a form template structure, including fields and
+ *  groups.
+ *  /
+ */
 export type StructureElement = FieldsGroup | Field;
 export declare namespace StructureElement {
     function fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): StructureElement;

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

@@ -1,24 +1,97 @@
+/**
+ *
+ *  A text input field in a form template.
+ *  /
+ */
 export declare class TextField {
+    /**
+     *
+     *  The field identifier.
+     */
     field: string;
+    /**
+     *
+     *  A short label for the field.
+     */
     shortLabel: string | undefined;
+    /**
+     *
+     *  The number of rows for display.
+     */
     rows: number | undefined;
+    /**
+     *
+     *  The number of columns for display.
+     */
     columns: number | undefined;
+    /**
+     *
+     *  Whether the field grows dynamically.
+     */
     grows: boolean | undefined;
+    /**
+     *
+     *  Whether the field supports multiline input.
+     */
     multiline: boolean | undefined;
+    /**
+     *
+     *  The schema reference for validation.
+     */
     schema: string | undefined;
+    /**
+     *
+     *  Tags associated with this field.
+     */
     tags: Array<string> | undefined;
+    /**
+     *
+     *  Codification references for this field.
+     */
     codifications: Array<string> | undefined;
+    /**
+     *
+     *  Additional options as key-value pairs.
+     */
     options: {
         [key: string]: string;
     } | undefined;
+    /**
+     *
+     *  Localized labels keyed by language code.
+     */
     labels: {
         [key: string]: string;
     } | undefined;
+    /**
+     *
+     *  The default value.
+     */
     value: string | undefined;
+    /**
+     *
+     *  The unit of measurement.
+     */
     unit: string | undefined;
+    /**
+     *
+     *  Whether the field is required.
+     */
     required: boolean | undefined;
+    /**
+     *
+     *  A condition expression for hiding the field.
+     */
     hideCondition: string | undefined;
+    /**
+     *
+     *  Whether to default to the current date/time.
+     */
     now: boolean | undefined;
+    /**
+     *
+     *  Whether the field value should be translated.
+     */
     translate: boolean | undefined;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.embed.form.template.TextField';
     constructor(partial: Partial<TextField> & Pick<TextField, "field">);

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

@@ -1,22 +1,91 @@
 // auto-generated file
 import { expectArray, expectBoolean, expectMap, expectNumber, expectString, extractEntry } from '../../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A text input field in a form template.
+ *  /
+ */
 export class TextField {
     constructor(partial) {
+        /**
+         *
+         *  A short label for the field.
+         */
         this.shortLabel = undefined;
+        /**
+         *
+         *  The number of rows for display.
+         */
         this.rows = undefined;
+        /**
+         *
+         *  The number of columns for display.
+         */
         this.columns = undefined;
+        /**
+         *
+         *  Whether the field grows dynamically.
+         */
         this.grows = undefined;
+        /**
+         *
+         *  Whether the field supports multiline input.
+         */
         this.multiline = undefined;
+        /**
+         *
+         *  The schema reference for validation.
+         */
         this.schema = undefined;
+        /**
+         *
+         *  Tags associated with this field.
+         */
         this.tags = undefined;
+        /**
+         *
+         *  Codification references for this field.
+         */
         this.codifications = undefined;
+        /**
+         *
+         *  Additional options as key-value pairs.
+         */
         this.options = undefined;
+        /**
+         *
+         *  Localized labels keyed by language code.
+         */
         this.labels = undefined;
+        /**
+         *
+         *  The default value.
+         */
         this.value = undefined;
+        /**
+         *
+         *  The unit of measurement.
+         */
         this.unit = undefined;
+        /**
+         *
+         *  Whether the field is required.
+         */
         this.required = undefined;
+        /**
+         *
+         *  A condition expression for hiding the field.
+         */
         this.hideCondition = undefined;
+        /**
+         *
+         *  Whether to default to the current date/time.
+         */
         this.now = undefined;
+        /**
+         *
+         *  Whether the field value should be translated.
+         */
         this.translate = undefined;
         this.$ktClass = 'com.icure.cardinal.sdk.model.embed.form.template.TextField';
         this.field = partial.field;

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

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

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

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

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

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the trigger events that can activate a launcher in a form template.
+ */
 export declare enum Trigger {
     Init = "Init",
     Change = "Change",

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

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the trigger events that can activate a launcher in a form template.
+ */
 export var Trigger;
 (function (Trigger) {
     Trigger["Init"] = "Init";

package/model/enums/UsersStatus.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Represents the lifecycle status of a user account in the iCure system.
+ */
 export declare enum UsersStatus {
     Active = "Active",
     Disabled = "Disabled",

package/model/enums/UsersStatus.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Represents the lifecycle status of a user account in the iCure system.
+ */
 export var UsersStatus;
 (function (UsersStatus) {
     UsersStatus["Active"] = "Active";

package/model/filter/predicate/AlwaysPredicate.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Predicate that always evaluates to true, matching all elements.
+ */
 export declare class AlwaysPredicate {
     readonly $ktClass: 'com.icure.cardinal.sdk.model.filter.predicate.AlwaysPredicate';
     constructor(partial: Partial<AlwaysPredicate>);

package/model/filter/predicate/AlwaysPredicate.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { extractEntry } from '../../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   Predicate that always evaluates to true, matching all elements.
+ */
 export class AlwaysPredicate {
     constructor(partial) {
         this.$ktClass = 'com.icure.cardinal.sdk.model.filter.predicate.AlwaysPredicate';

package/model/filter/predicate/AndPredicate.d.mts

@@ -1,5 +1,14 @@
 import { Predicate } from './Predicate.mjs';
+/**
+ *
+ *  Predicate that evaluates to true only when all sub-predicates evaluate to true (logical AND).
+ *  /
+ */
 export declare class AndPredicate {
+    /**
+     *
+     *  The list of predicates that must all be satisfied.
+     */
     predicates: Array<Predicate>;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.filter.predicate.AndPredicate';
     constructor(partial: Partial<AndPredicate>);

package/model/filter/predicate/AndPredicate.mjs

@@ -1,8 +1,17 @@
 // auto-generated file
 import { expectArray, expectObject, extractEntry } from '../../../internal/JsonDecodeUtils.mjs';
 import { Predicate } from './Predicate.mjs';
+/**
+ *
+ *  Predicate that evaluates to true only when all sub-predicates evaluate to true (logical AND).
+ *  /
+ */
 export class AndPredicate {
     constructor(partial) {
+        /**
+         *
+         *  The list of predicates that must all be satisfied.
+         */
         this.predicates = [];
         this.$ktClass = 'com.icure.cardinal.sdk.model.filter.predicate.AndPredicate';
         if ('predicates' in partial && partial.predicates !== undefined)

package/model/filter/predicate/KeyValuePredicate.d.mts

@@ -1,7 +1,24 @@
 import { Operator } from './Operator.mjs';
+/**
+ *
+ *  Predicate that evaluates a comparison between an entity property and a value using an operator.
+ *  /
+ */
 export declare class KeyValuePredicate {
+    /**
+     *
+     *  The property key to compare.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The comparison operator.
+     */
     operator: Operator | undefined;
+    /**
+     *
+     *  The value to compare against.
+     */
     value: any | undefined;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.filter.predicate.KeyValuePredicate';
     constructor(partial: Partial<KeyValuePredicate>);

package/model/filter/predicate/KeyValuePredicate.mjs

@@ -1,10 +1,27 @@
 // auto-generated file
 import { expectString, expectStringEnum, extractEntry } from '../../../internal/JsonDecodeUtils.mjs';
 import { Operator } from './Operator.mjs';
+/**
+ *
+ *  Predicate that evaluates a comparison between an entity property and a value using an operator.
+ *  /
+ */
 export class KeyValuePredicate {
     constructor(partial) {
+        /**
+         *
+         *  The property key to compare.
+         */
         this.key = undefined;
+        /**
+         *
+         *  The comparison operator.
+         */
         this.operator = undefined;
+        /**
+         *
+         *  The value to compare against.
+         */
         this.value = undefined;
         this.$ktClass = 'com.icure.cardinal.sdk.model.filter.predicate.KeyValuePredicate';
         if ('key' in partial)

package/model/filter/predicate/NotPredicate.d.mts

@@ -1,5 +1,14 @@
 import { Predicate } from './Predicate.mjs';
+/**
+ *
+ *  Predicate that negates another predicate (logical NOT).
+ *  /
+ */
 export declare class NotPredicate {
+    /**
+     *
+     *  The predicate to negate.
+     */
     predicate: Predicate;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.filter.predicate.NotPredicate';
     constructor(partial: Partial<NotPredicate> & Pick<NotPredicate, "predicate">);

package/model/filter/predicate/NotPredicate.mjs

@@ -1,6 +1,11 @@
 // auto-generated file
 import { expectObject, extractEntry } from '../../../internal/JsonDecodeUtils.mjs';
 import { Predicate } from './Predicate.mjs';
+/**
+ *
+ *  Predicate that negates another predicate (logical NOT).
+ *  /
+ */
 export class NotPredicate {
     constructor(partial) {
         this.$ktClass = 'com.icure.cardinal.sdk.model.filter.predicate.NotPredicate';

package/model/filter/predicate/Operator.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Comparison operators for use in key-value predicates.
+ */
 export declare enum Operator {
     Equal = "Equal",
     Notequal = "Notequal",

package/model/filter/predicate/Operator.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Comparison operators for use in key-value predicates.
+ */
 export var Operator;
 (function (Operator) {
     Operator["Equal"] = "Equal";

package/model/filter/predicate/OrPredicate.d.mts

@@ -1,5 +1,14 @@
 import { Predicate } from './Predicate.mjs';
+/**
+ *
+ *  Predicate that evaluates to true when any sub-predicate evaluates to true (logical OR).
+ *  /
+ */
 export declare class OrPredicate {
+    /**
+     *
+     *  The list of predicates where at least one must be satisfied.
+     */
     predicates: Array<Predicate>;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.filter.predicate.OrPredicate';
     constructor(partial: Partial<OrPredicate>);

package/model/filter/predicate/OrPredicate.mjs

@@ -1,8 +1,17 @@
 // auto-generated file
 import { expectArray, expectObject, extractEntry } from '../../../internal/JsonDecodeUtils.mjs';
 import { Predicate } from './Predicate.mjs';
+/**
+ *
+ *  Predicate that evaluates to true when any sub-predicate evaluates to true (logical OR).
+ *  /
+ */
 export class OrPredicate {
     constructor(partial) {
+        /**
+         *
+         *  The list of predicates where at least one must be satisfied.
+         */
         this.predicates = [];
         this.$ktClass = 'com.icure.cardinal.sdk.model.filter.predicate.OrPredicate';
         if ('predicates' in partial && partial.predicates !== undefined)

package/model/filter/predicate/Predicate.d.mts

@@ -3,6 +3,12 @@ import { AndPredicate } from './AndPredicate.mjs';
 import { KeyValuePredicate } from './KeyValuePredicate.mjs';
 import { NotPredicate } from './NotPredicate.mjs';
 import { OrPredicate } from './OrPredicate.mjs';
+/**
+ *
+ *  Sealed interface for filter predicates that can be used to post-filter results from a filter
+ *  chain.
+ *  /
+ */
 export type Predicate = AndPredicate | NotPredicate | OrPredicate | AlwaysPredicate | KeyValuePredicate;
 export declare namespace Predicate {
     function fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): Predicate;

package/model/requests/RequestedPermission.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Strategy to use for the calculation of permissions for the new [SecureDelegation.permissions]
+ */
 export declare enum RequestedPermission {
     MaxRead = "MaxRead",
     FullRead = "FullRead",

package/model/requests/RequestedPermission.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Strategy to use for the calculation of permissions for the new [SecureDelegation.permissions]
+ */
 export var RequestedPermission;
 (function (RequestedPermission) {
     RequestedPermission["MaxRead"] = "MaxRead";

package/model/security/AlwaysPermissionItem.d.mts

@@ -1,5 +1,15 @@
 import { PermissionType } from './PermissionType.mjs';
+/**
+ *
+ *  A permission item whose predicate always evaluates to true, unconditionally granting or revoking
+ *  the specified permission type.
+ *  /
+ */
 export declare class AlwaysPermissionItem {
+    /**
+     *
+     *  The permission type that is always granted or revoked by this item.
+     */
     type: PermissionType;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.security.AlwaysPermissionItem';
     constructor(partial: Partial<AlwaysPermissionItem> & Pick<AlwaysPermissionItem, "type">);

package/model/security/AlwaysPermissionItem.mjs

@@ -1,6 +1,12 @@
 // auto-generated file
 import { expectStringEnum, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { PermissionType } from './PermissionType.mjs';
+/**
+ *
+ *  A permission item whose predicate always evaluates to true, unconditionally granting or revoking
+ *  the specified permission type.
+ *  /
+ */
 export class AlwaysPermissionItem {
     constructor(partial) {
         this.$ktClass = 'com.icure.cardinal.sdk.model.security.AlwaysPermissionItem';

package/model/security/AuthenticationToken.d.mts

@@ -1,7 +1,30 @@
+/**
+ *
+ *  Represents an authentication token associated with a user, including its creation time and
+ *  validity period.
+ *  The token value is stored in encrypted form.
+ *  /
+ */
 export declare class AuthenticationToken {
+    /**
+     *
+     *  The encrypted token string.
+     */
     token: string | undefined;
+    /**
+     *
+     *  The epoch-millisecond timestamp at which the token became valid.
+     */
     creationTime: number;
+    /**
+     *
+     *  The duration in seconds for which the token remains valid after creation.
+     */
     validity: number;
+    /**
+     *
+     *  The epoch-millisecond timestamp of a hard deletion, if the token has been marked for deletion.
+     */
     deletionDate: number | undefined;
     constructor(partial: Partial<AuthenticationToken> & Pick<AuthenticationToken, "creationTime" | "validity">);
     toJSON(): object;