@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/base/Person.d.mts

@@ -2,6 +2,11 @@ import { Address } from '../embed/Address.mjs';
 import { Gender } from '../embed/Gender.mjs';
 import { PersonName } from '../embed/PersonName.mjs';
 import { Identifiable } from './Identifiable.mjs';
+/**
+ *
+ *
+ *   Interface for entities that represent a person with personal details and contact information.
+ */
 export interface Person extends Identifiable<string> {
     civility: string | undefined;
     gender: Gender | undefined;

package/model/base/StoredDocument.d.mts

@@ -1,4 +1,10 @@
 import { Versionable } from './Versionable.mjs';
+/**
+ *
+ *
+ *   Interface for entities that are persisted as CouchDB documents and support hard deletion via a
+ *  deletion timestamp.
+ */
 export interface StoredDocument extends Versionable<string> {
     deletionDate: number | undefined;
 }

package/model/base/Versionable.d.mts

@@ -1,4 +1,10 @@
 import { Identifiable } from './Identifiable.mjs';
+/**
+ *
+ *
+ *   @param <T> The type of the entity identity (a String, a UUID, etc.)
+ *  </T>
+ */
 export interface Versionable<T> extends Identifiable<T> {
     rev: string | undefined;
 }

package/model/couchdb/Basic.d.mts

@@ -1,5 +1,19 @@
+/**
+ *
+ *  Data transfer object representing basic authentication credentials for a CouchDB remote
+ *  connection.
+ *  /
+ */
 export declare class Basic {
+    /**
+     *
+     *  The username for authentication.
+     */
     username: string;
+    /**
+     *
+     *  The password for authentication.
+     */
     password: string;
     constructor(partial: Partial<Basic> & Pick<Basic, "username" | "password">);
     toJSON(): object;

package/model/couchdb/Basic.mjs

@@ -1,5 +1,11 @@
 // auto-generated file
 import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Data transfer object representing basic authentication credentials for a CouchDB remote
+ *  connection.
+ *  /
+ */
 export class Basic {
     constructor(partial) {
         this.username = partial.username;

package/model/couchdb/DatabaseInfo.d.mts

@@ -1,13 +1,59 @@
+/**
+ *
+ *  Data transfer object containing information about a CouchDB database, including size metrics and
+ *  cluster configuration.
+ *  /
+ */
 export declare class DatabaseInfo {
+    /**
+     *
+     *  The database identifier.
+     */
     id: string;
+    /**
+     *
+     *  The current update sequence for the database.
+     */
     updateSeq: string | undefined;
+    /**
+     *
+     *  The size of the database file on disk in bytes.
+     */
     fileSize: number | undefined;
+    /**
+     *
+     *  The uncompressed size of the database contents in bytes.
+     */
     externalSize: number | undefined;
+    /**
+     *
+     *  The size of live data in the database in bytes.
+     */
     activeSize: number | undefined;
+    /**
+     *
+     *  The number of documents in the database.
+     */
     docs: number | undefined;
+    /**
+     *
+     *  The number of shards for the database.
+     */
     q: number | undefined;
+    /**
+     *
+     *  The number of replicas of each shard.
+     */
     n: number | undefined;
+    /**
+     *
+     *  The number of copies that must be written before a write is considered successful.
+     */
     w: number | undefined;
+    /**
+     *
+     *  The number of copies that must be read before a read is considered successful.
+     */
     r: number | undefined;
     constructor(partial: Partial<DatabaseInfo>);
     toJSON(): object;

package/model/couchdb/DatabaseInfo.mjs

@@ -1,17 +1,59 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../../utils/Id.mjs';
+/**
+ *
+ *  Data transfer object containing information about a CouchDB database, including size metrics and
+ *  cluster configuration.
+ *  /
+ */
 export class DatabaseInfo {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The current update sequence for the database.
+         */
         this.updateSeq = undefined;
+        /**
+         *
+         *  The size of the database file on disk in bytes.
+         */
         this.fileSize = undefined;
+        /**
+         *
+         *  The uncompressed size of the database contents in bytes.
+         */
         this.externalSize = undefined;
+        /**
+         *
+         *  The size of live data in the database in bytes.
+         */
         this.activeSize = undefined;
+        /**
+         *
+         *  The number of documents in the database.
+         */
         this.docs = undefined;
+        /**
+         *
+         *  The number of shards for the database.
+         */
         this.q = undefined;
+        /**
+         *
+         *  The number of replicas of each shard.
+         */
         this.n = undefined;
+        /**
+         *
+         *  The number of copies that must be written before a write is considered successful.
+         */
         this.w = undefined;
+        /**
+         *
+         *  The number of copies that must be read before a read is considered successful.
+         */
         this.r = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('updateSeq' in partial)

package/model/couchdb/DesignDocument.d.mts

@@ -1,23 +1,66 @@
 import { View } from './View.mjs';
+/**
+ *
+ *
+ *   Data transfer object representing a CouchDB design document, which contains views, lists, shows,
+ *  filters,
+ *   and update handlers used for querying and transforming data.
+ */
 export declare class DesignDocument {
+    /**
+     *
+     *  The identifier of the design document.
+     */
     id: string;
+    /**
+     *
+     *  The current revision of the design document.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  A map of revision history entries.
+     */
     revHistory: {
         [key: string]: string;
     };
+    /**
+     *
+     *  The programming language used for the design document functions.
+     */
     language: string | undefined;
+    /**
+     *
+     *  A map of view names to their definitions.
+     */
     views: {
         [key: string]: View;
     };
+    /**
+     *
+     *  A map of list function names to their source code.
+     */
     lists: {
         [key: string]: string;
     };
+    /**
+     *
+     *  A map of show function names to their source code.
+     */
     shows: {
         [key: string]: string;
     };
+    /**
+     *
+     *  A map of update handler names to their source code.
+     */
     updateHandlers: {
         [key: string]: string;
     } | undefined;
+    /**
+     *
+     *  A map of filter function names to their source code.
+     */
     filters: {
         [key: string]: string;
     };

package/model/couchdb/DesignDocument.mjs

@@ -2,16 +2,55 @@
 import { expectMap, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../../utils/Id.mjs';
 import { View } from './View.mjs';
+/**
+ *
+ *
+ *   Data transfer object representing a CouchDB design document, which contains views, lists, shows,
+ *  filters,
+ *   and update handlers used for querying and transforming data.
+ */
 export class DesignDocument {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The current revision of the design document.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  A map of revision history entries.
+         */
         this.revHistory = {};
+        /**
+         *
+         *  The programming language used for the design document functions.
+         */
         this.language = undefined;
+        /**
+         *
+         *  A map of view names to their definitions.
+         */
         this.views = {};
+        /**
+         *
+         *  A map of list function names to their source code.
+         */
         this.lists = {};
+        /**
+         *
+         *  A map of show function names to their source code.
+         */
         this.shows = {};
+        /**
+         *
+         *  A map of update handler names to their source code.
+         */
         this.updateHandlers = undefined;
+        /**
+         *
+         *  A map of filter function names to their source code.
+         */
         this.filters = {};
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/couchdb/DocIdentifier.d.mts

@@ -1,5 +1,18 @@
+/**
+ *
+ *
+ *   Data transfer object that uniquely identifies a CouchDB document by its id and revision.
+ */
 export declare class DocIdentifier {
+    /**
+     *
+     *  The document identifier.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The document revision.
+     */
     rev: string | undefined;
     constructor(partial: Partial<DocIdentifier>);
     toJSON(): object;

package/model/couchdb/DocIdentifier.mjs

@@ -1,8 +1,21 @@
 // auto-generated file
 import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   Data transfer object that uniquely identifies a CouchDB document by its id and revision.
+ */
 export class DocIdentifier {
     constructor(partial) {
+        /**
+         *
+         *  The document identifier.
+         */
         this.id = undefined;
+        /**
+         *
+         *  The document revision.
+         */
         this.rev = undefined;
         if ('id' in partial)
             this.id = partial.id;

package/model/couchdb/GroupDatabasesInfo.d.mts

@@ -1,7 +1,26 @@
 import { DatabaseInfo } from './DatabaseInfo.mjs';
+/**
+ *
+ *  Data transfer object aggregating database information for all databases belonging to a specific
+ *  group,
+ *  including their storage sizes and GCP storage usage.
+ *  /
+ */
 export declare class GroupDatabasesInfo {
+    /**
+     *
+     *  The identifier of the group.
+     */
     groupId: string;
+    /**
+     *
+     *  The list of database information entries for this group.
+     */
     databasesInfo: Array<DatabaseInfo>;
+    /**
+     *
+     *  The total GCP storage size in bytes used by this group.
+     */
     gcpStorageSize: number;
     constructor(partial: Partial<GroupDatabasesInfo> & Pick<GroupDatabasesInfo, "groupId" | "databasesInfo" | "gcpStorageSize">);
     toJSON(): object;

package/model/couchdb/GroupDatabasesInfo.mjs

@@ -1,6 +1,13 @@
 // auto-generated file
 import { expectArray, expectNumber, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { DatabaseInfo } from './DatabaseInfo.mjs';
+/**
+ *
+ *  Data transfer object aggregating database information for all databases belonging to a specific
+ *  group,
+ *  including their storage sizes and GCP storage usage.
+ *  /
+ */
 export class GroupDatabasesInfo {
     constructor(partial) {
         this.groupId = partial.groupId;

package/model/couchdb/Remote.d.mts

@@ -1,6 +1,20 @@
 import { RemoteAuthentication } from './RemoteAuthentication.mjs';
+/**
+ *
+ *  Data transfer object representing a remote CouchDB endpoint with its URL and optional
+ *  authentication.
+ *  /
+ */
 export declare class Remote {
+    /**
+     *
+     *  The URL of the remote CouchDB instance.
+     */
     url: string;
+    /**
+     *
+     *  The authentication configuration for connecting to the remote instance.
+     */
     auth: RemoteAuthentication | undefined;
     constructor(partial: Partial<Remote> & Pick<Remote, "url">);
     toJSON(): object;

package/model/couchdb/Remote.mjs

@@ -1,8 +1,18 @@
 // auto-generated file
 import { expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { RemoteAuthentication } from './RemoteAuthentication.mjs';
+/**
+ *
+ *  Data transfer object representing a remote CouchDB endpoint with its URL and optional
+ *  authentication.
+ *  /
+ */
 export class Remote {
     constructor(partial) {
+        /**
+         *
+         *  The authentication configuration for connecting to the remote instance.
+         */
         this.auth = undefined;
         this.url = partial.url;
         if ('auth' in partial)

package/model/couchdb/RemoteAuthentication.d.mts

@@ -1,5 +1,14 @@
 import { Basic } from './Basic.mjs';
+/**
+ *
+ *  Data transfer object representing authentication configuration for a remote CouchDB instance.
+ *  /
+ */
 export declare class RemoteAuthentication {
+    /**
+     *
+     *  The basic authentication credentials, if applicable.
+     */
     basic: Basic | undefined;
     constructor(partial: Partial<RemoteAuthentication>);
     toJSON(): object;

package/model/couchdb/RemoteAuthentication.mjs

@@ -1,8 +1,17 @@
 // auto-generated file
 import { expectObject, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { Basic } from './Basic.mjs';
+/**
+ *
+ *  Data transfer object representing authentication configuration for a remote CouchDB instance.
+ *  /
+ */
 export class RemoteAuthentication {
     constructor(partial) {
+        /**
+         *
+         *  The basic authentication credentials, if applicable.
+         */
         this.basic = undefined;
         if ('basic' in partial)
             this.basic = partial.basic;

package/model/couchdb/ReplicationStats.d.mts

@@ -1,12 +1,53 @@
+/**
+ *
+ *  Data transfer object containing statistics about a CouchDB replication process.
+ *  /
+ */
 export declare class ReplicationStats {
+    /**
+     *
+     *  The number of revisions checked during replication.
+     */
     revisionsChecked: number | undefined;
+    /**
+     *
+     *  The number of missing revisions found on the target.
+     */
     missingRevisionsFound: number | undefined;
+    /**
+     *
+     *  The number of documents read from the source.
+     */
     docsRead: number | undefined;
+    /**
+     *
+     *  The number of documents written to the target.
+     */
     docsWritten: number | undefined;
+    /**
+     *
+     *  The number of changes still pending replication.
+     */
     changesPending: number | undefined;
+    /**
+     *
+     *  The number of document write failures on the target.
+     */
     docWriteFailures: number | undefined;
+    /**
+     *
+     *  The last checkpointed source sequence identifier.
+     */
     checkpointedSourceSeq: string | undefined;
+    /**
+     *
+     *  The time when the replication started.
+     */
     startTime: string | undefined;
+    /**
+     *
+     *  An error message if the replication encountered an error.
+     */
     error: string | undefined;
     constructor(partial: Partial<ReplicationStats>);
     toJSON(): object;

package/model/couchdb/ReplicationStats.mjs

@@ -1,15 +1,56 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Data transfer object containing statistics about a CouchDB replication process.
+ *  /
+ */
 export class ReplicationStats {
     constructor(partial) {
+        /**
+         *
+         *  The number of revisions checked during replication.
+         */
         this.revisionsChecked = undefined;
+        /**
+         *
+         *  The number of missing revisions found on the target.
+         */
         this.missingRevisionsFound = undefined;
+        /**
+         *
+         *  The number of documents read from the source.
+         */
         this.docsRead = undefined;
+        /**
+         *
+         *  The number of documents written to the target.
+         */
         this.docsWritten = undefined;
+        /**
+         *
+         *  The number of changes still pending replication.
+         */
         this.changesPending = undefined;
+        /**
+         *
+         *  The number of document write failures on the target.
+         */
         this.docWriteFailures = undefined;
+        /**
+         *
+         *  The last checkpointed source sequence identifier.
+         */
         this.checkpointedSourceSeq = undefined;
+        /**
+         *
+         *  The time when the replication started.
+         */
         this.startTime = undefined;
+        /**
+         *
+         *  An error message if the replication encountered an error.
+         */
         this.error = undefined;
         if ('revisionsChecked' in partial)
             this.revisionsChecked = partial.revisionsChecked;

package/model/couchdb/ReplicatorDocument.d.mts

@@ -1,22 +1,84 @@
 import { Versionable } from '../base/Versionable.mjs';
 import { Remote } from './Remote.mjs';
 import { ReplicationStats } from './ReplicationStats.mjs';
+/**
+ *
+ *  Data transfer object representing a CouchDB replicator document that tracks the state of a
+ *  replication task.
+ *  /
+ */
 export declare class ReplicatorDocument implements Versionable<string> {
+    /**
+     *
+     *  The unique identifier of this replicator document.
+     */
     id: string;
+    /**
+     *
+     *  The current revision of this document.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The source remote endpoint for the replication.
+     */
     source: Remote | undefined;
+    /**
+     *
+     *  The target remote endpoint for the replication.
+     */
     target: Remote | undefined;
+    /**
+     *
+     *  The owner of this replication task.
+     */
     owner: string | undefined;
+    /**
+     *
+     *  Whether to create the target database if it does not exist.
+     */
     create_target: boolean | undefined;
+    /**
+     *
+     *  Whether the replication runs continuously.
+     */
     continuous: boolean | undefined;
+    /**
+     *
+     *  An optional list of document ids to replicate.
+     */
     doc_ids: Array<string> | undefined;
+    /**
+     *
+     *  The current state of the replication (e.g. triggered, completed, error).
+     */
     replicationState: string | undefined;
+    /**
+     *
+     *  The time when the replication state was last updated.
+     */
     replicationStateTime: string | undefined;
+    /**
+     *
+     *  Statistics about the replication process.
+     */
     replicationStats: ReplicationStats | undefined;
+    /**
+     *
+     *  The number of errors encountered during replication.
+     */
     errorCount: number | undefined;
+    /**
+     *
+     *  Information about the document revisions.
+     */
     revsInfo: Array<{
         [key: string]: string;
     }> | undefined;
+    /**
+     *
+     *  A map of the document revision history.
+     */
     revHistory: {
         [key: string]: string;
     } | undefined;