@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/Document.mjs

@@ -8,36 +8,155 @@ import { DeletedAttachment } from './embed/DeletedAttachment.mjs';
 import { DocumentStatus } from './embed/DocumentStatus.mjs';
 import { DocumentType } from './embed/DocumentType.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents a document entity stored in CouchDB. Documents can have main and secondary data
+ *  attachments,
+ *  and support various storage backends (CouchDB attachments, object storage).
+ *  /
+ */
 export class DecryptedDocument {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the document in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this entity.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this document.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this document.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the document as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular document.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The type of document (e.g., admission, clinical path, document report, invoice).
+         */
         this.documentType = undefined;
+        /**
+         *
+         *  The status of the document development (e.g., Draft, finalized, reviewed, signed).
+         */
         this.documentStatus = undefined;
+        /**
+         *
+         *  When the document is stored externally, the URI of the document in that repository.
+         */
         this.externalUri = undefined;
+        /**
+         *
+         *  The name of the document.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The document version.
+         */
         this.version = undefined;
+        /**
+         *
+         *  The size of the document file.
+         */
         this.size = undefined;
+        /**
+         *
+         *  The hashed version of the document.
+         */
         this.hash = undefined;
+        /**
+         *
+         *  The id of the contact during which the document was created.
+         */
         this.openingContactId = undefined;
+        /**
+         *
+         *  The id of the main attachment stored as a CouchDB attachment.
+         */
         this.attachmentId = undefined;
+        /**
+         *
+         *  The id of the main attachment in the object storage service.
+         */
         this.objectStoreReference = undefined;
+        /**
+         *
+         *  The main Uniform Type Identifier of the main attachment.
+         */
         this.mainUti = undefined;
+        /**
+         *
+         *  Extra Uniform Type Identifiers for the main attachment.
+         */
         this.otherUtis = [];
+        /**
+         *
+         *  Secondary attachments for this document.
+         */
         this.secondaryAttachments = {};
+        /**
+         *
+         *  Information on past attachments for this document.
+         */
         this.deletedAttachments = [];
+        /**
+         *
+         *  The secret foreign keys, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this document.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this entity, for access control.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -198,36 +317,155 @@ export class DecryptedDocument {
         return res;
     }
 }
+/**
+ *
+ *  Represents a document entity stored in CouchDB. Documents can have main and secondary data
+ *  attachments,
+ *  and support various storage backends (CouchDB attachments, object storage).
+ *  /
+ */
 export class EncryptedDocument {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the document in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this entity.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this document.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this document.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the document as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular document.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The type of document (e.g., admission, clinical path, document report, invoice).
+         */
         this.documentType = undefined;
+        /**
+         *
+         *  The status of the document development (e.g., Draft, finalized, reviewed, signed).
+         */
         this.documentStatus = undefined;
+        /**
+         *
+         *  When the document is stored externally, the URI of the document in that repository.
+         */
         this.externalUri = undefined;
+        /**
+         *
+         *  The name of the document.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The document version.
+         */
         this.version = undefined;
+        /**
+         *
+         *  The size of the document file.
+         */
         this.size = undefined;
+        /**
+         *
+         *  The hashed version of the document.
+         */
         this.hash = undefined;
+        /**
+         *
+         *  The id of the contact during which the document was created.
+         */
         this.openingContactId = undefined;
+        /**
+         *
+         *  The id of the main attachment stored as a CouchDB attachment.
+         */
         this.attachmentId = undefined;
+        /**
+         *
+         *  The id of the main attachment in the object storage service.
+         */
         this.objectStoreReference = undefined;
+        /**
+         *
+         *  The main Uniform Type Identifier of the main attachment.
+         */
         this.mainUti = undefined;
+        /**
+         *
+         *  Extra Uniform Type Identifiers for the main attachment.
+         */
         this.otherUtis = [];
+        /**
+         *
+         *  Secondary attachments for this document.
+         */
         this.secondaryAttachments = {};
+        /**
+         *
+         *  Information on past attachments for this document.
+         */
         this.deletedAttachments = [];
+        /**
+         *
+         *  The secret foreign keys, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this document.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this entity, for access control.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/EntityReferenceInGroup.d.mts

@@ -1,3 +1,26 @@
+/**
+ *
+ *  A reference to an entity in a group.
+ *
+ *  The entity group id can be null, which means the entity is in the same group as the user currently logged in to the
+ *  SDK.
+ *
+ *  When providing input to any SDK method you can use references with the group of the logged user or null
+ *  interchangeably.
+ *
+ *  However, some SDK methods that return [EntityReferenceInGroup] consistently fill the [groupId] of the logged user
+ *  while others consistently leave it null.
+ *  The general rule is that the methods from `inGroup` apis always fill all [groupId] values, even when the group
+ *  matches the current user's group. Methods that always act on the logged user's group instead always leave null
+ *  [groupId] when it would match the logged user's group.
+ *
+ *  Note that `equals` methods can't take in consideration the group of the current user, therefore
+ *  `EntityReferenceInGroup(x, userGroup) != EntityReferenceInGroup(x, null)`, even though the SDK for a user in
+ *  userGroup treats them the same.
+ *
+ *  @param entityId the id of the entity
+ *  @param groupId the id of the entity's group. If null it should be interpreted as the same group of the logged user.
+ */
 export declare class EntityReferenceInGroup {
     entityId: string;
     groupId: string | undefined;

package/model/EntityReferenceInGroup.mjs

@@ -1,5 +1,28 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  A reference to an entity in a group.
+ *
+ *  The entity group id can be null, which means the entity is in the same group as the user currently logged in to the
+ *  SDK.
+ *
+ *  When providing input to any SDK method you can use references with the group of the logged user or null
+ *  interchangeably.
+ *
+ *  However, some SDK methods that return [EntityReferenceInGroup] consistently fill the [groupId] of the logged user
+ *  while others consistently leave it null.
+ *  The general rule is that the methods from `inGroup` apis always fill all [groupId] values, even when the group
+ *  matches the current user's group. Methods that always act on the logged user's group instead always leave null
+ *  [groupId] when it would match the logged user's group.
+ *
+ *  Note that `equals` methods can't take in consideration the group of the current user, therefore
+ *  `EntityReferenceInGroup(x, userGroup) != EntityReferenceInGroup(x, null)`, even though the SDK for a user in
+ *  userGroup treats them the same.
+ *
+ *  @param entityId the id of the entity
+ *  @param groupId the id of the entity's group. If null it should be interpreted as the same group of the logged user.
+ */
 export class EntityReferenceInGroup {
     constructor(partial) {
         this.groupId = undefined;

package/model/FrontEndMigration.d.mts

@@ -1,19 +1,79 @@
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { FrontEndMigrationStatus } from './embed/FrontEndMigrationStatus.mjs';
+/**
+ *
+ *  Represents a front-end migration task. A front-end migration tracks the progress of data
+ *  migration operations
+ *  initiated from the front-end application.
+ *  /
+ */
 export declare class FrontEndMigration implements StoredDocument {
+    /**
+     *
+     *  The unique identifier of the front-end migration.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the front-end migration in the database, used for conflict management /
+     *  optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The name of the migration.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The start date (unix epoch in ms) of the migration.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date (unix epoch in ms) of the migration.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The current status of the migration.
+     */
     status: FrontEndMigrationStatus | undefined;
+    /**
+     *
+     *  Logs produced during the migration process.
+     */
     logs: string | undefined;
+    /**
+     *
+     *  The id of the user that initiated the migration.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The start key used for pagination during migration.
+     */
     startKey: string | undefined;
+    /**
+     *
+     *  The start key document id used for pagination during migration.
+     */
     startKeyDocId: string | undefined;
+    /**
+     *
+     *  The number of items processed during the migration.
+     */
     processCount: number | undefined;
+    /**
+     *
+     *  Extra properties for the front-end migration. Those properties are typed (see class Property).
+     */
     properties: Array<DecryptedPropertyStub>;
     constructor(partial: Partial<FrontEndMigration>);
     toJSON(): object;

package/model/FrontEndMigration.mjs

@@ -3,20 +3,76 @@ import { expectArray, expectNumber, expectObject, expectString, expectStringEnum
 import { randomUuid } from '../utils/Id.mjs';
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
 import { FrontEndMigrationStatus } from './embed/FrontEndMigrationStatus.mjs';
+/**
+ *
+ *  Represents a front-end migration task. A front-end migration tracks the progress of data
+ *  migration operations
+ *  initiated from the front-end application.
+ *  /
+ */
 export class FrontEndMigration {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the front-end migration in the database, used for conflict management /
+         *  optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The name of the migration.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The start date (unix epoch in ms) of the migration.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The end date (unix epoch in ms) of the migration.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  The current status of the migration.
+         */
         this.status = undefined;
+        /**
+         *
+         *  Logs produced during the migration process.
+         */
         this.logs = undefined;
+        /**
+         *
+         *  The id of the user that initiated the migration.
+         */
         this.userId = undefined;
+        /**
+         *
+         *  The start key used for pagination during migration.
+         */
         this.startKey = undefined;
+        /**
+         *
+         *  The start key document id used for pagination during migration.
+         */
         this.startKeyDocId = undefined;
+        /**
+         *
+         *  The number of items processed during the migration.
+         */
         this.processCount = undefined;
+        /**
+         *
+         *  Extra properties for the front-end migration. Those properties are typed (see class Property).
+         */
         this.properties = [];
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/Group.d.mts

@@ -6,32 +6,111 @@ import { AuthenticationClass } from './embed/AuthenticationClass.mjs';
 import { UserType } from './embed/UserType.mjs';
 import { ExternalJwtConfig } from './security/ExternalJwtConfig.mjs';
 import { OperationToken } from './security/OperationToken.mjs';
+/**
+ *
+ *  Represents a group in the iCure platform. A group corresponds to a practice, hospital, or
+ *  organization
+ *  that contains its own set of databases and users.
+ *  /
+ */
 export declare class Group implements StoredDocument, HasTags {
+    /**
+     *
+     *  The id of the group. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the group in the database, used for conflict management / optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  Tags that qualify the group as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Tags that are publicly visible for the group.
+     */
     publicTags: Array<CodeStub>;
+    /**
+     *
+     *  Username for the group.
+     */
     name: string | undefined;
+    /**
+     *
+     *  Password for the group access.
+     */
     password: string | undefined;
+    /**
+     *
+     *  List of servers accessible to the group.
+     */
     servers: Array<string> | undefined;
+    /**
+     *
+     *  Whether the group has a super admin permission.
+     */
     superAdmin: boolean;
+    /**
+     *
+     *  Extra properties for the group. Those properties are typed (see class Property).
+     */
     properties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  The default roles for each user type, if not otherwise specified on the user.
+     */
     defaultUserRoles: {
         [key in UserType]?: Array<string>;
     };
+    /**
+     *
+     *  Single-used token to perform specific operations.
+     */
     operationTokens: {
         [key: string]: OperationToken;
     };
+    /**
+     *
+     *  List of entities that have to be collected from a shared database.
+     */
     sharedEntities: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Minimum version of Kraken required to access API.
+     */
     minimumKrakenVersion: string | undefined;
+    /**
+     *
+     *  Verified public keys that can be used to allow log in with external JWTs.
+     */
     externalJwtConfig: {
         [key: string]: ExternalJwtConfig;
     };
+    /**
+     *
+     *  The minimum authentication class required for elevated privileges.
+     */
     minimumAuthenticationClassForElevatedPrivileges: AuthenticationClass;
+    /**
+     *
+     *  The id of the parent super group, if any.
+     */
     superGroup: string | undefined;
+    /**
+     *
+     *  A user-chosen identifier for the applications for which this group holds data.
+     */
     projectId: string | undefined;
     templates: Group.TemplatesConfiguration | undefined;
     constructor(partial: Partial<Group> & Pick<Group, "minimumAuthenticationClassForElevatedPrivileges">);