@icure/cardinal-sdk 2.4.2 → 2.4.3

package/model/Receipt.d.mts

@@ -2,8 +2,11 @@ import { CodeStub } from './base/CodeStub.mjs';
 import { HasEncryptionMetadata } from './base/HasEncryptionMetadata.mjs';
 import { ICureDocument } from './base/ICureDocument.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
+import { DataAttachment } from './embed/DataAttachment.mjs';
 import { Delegation } from './embed/Delegation.mjs';
+import { DeletedAttachment } from './embed/DeletedAttachment.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
+import { ReceiptBlobType } from './embed/ReceiptBlobType.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
 /**
@@ -16,6 +19,17 @@ import { Base64String } from './specializations/Base64String.mjs';
  *  /
  */
 export interface Receipt extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable {
+    /**
+     *
+     *  Map of blob type to attachment id for the receipt.
+     */
+    attachmentIds: {
+        [key in ReceiptBlobType]?: string;
+    };
+    attachmentInfos: {
+        [key in ReceiptBlobType]?: DataAttachment;
+    };
+    deletedAttachments: Array<DeletedAttachment>;
     /**
      *
      *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
@@ -94,6 +108,17 @@ export declare class DecryptedReceipt {
      *  Hard delete (unix epoch in ms) timestamp of the object.
      */
     deletionDate: number | undefined;
+    /**
+     *
+     *  Map of blob type to attachment id for the receipt.
+     */
+    attachmentIds: {
+        [key in ReceiptBlobType]?: string;
+    };
+    attachmentInfos: {
+        [key in ReceiptBlobType]?: DataAttachment;
+    };
+    deletedAttachments: Array<DeletedAttachment>;
     /**
      *
      *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
@@ -210,6 +235,17 @@ export declare class EncryptedReceipt {
      *  Hard delete (unix epoch in ms) timestamp of the object.
      */
     deletionDate: number | undefined;
+    /**
+     *
+     *  Map of blob type to attachment id for the receipt.
+     */
+    attachmentIds: {
+        [key in ReceiptBlobType]?: string;
+    };
+    attachmentInfos: {
+        [key in ReceiptBlobType]?: DataAttachment;
+    };
+    deletedAttachments: Array<DeletedAttachment>;
     /**
      *
      *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).

package/model/Receipt.mjs

@@ -1,8 +1,11 @@
 // auto-generated file
-import { expectArray, expectMap, expectNumber, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+import { expectArray, expectMap, expectNumber, expectObject, expectString, expectStringEnum, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
 import { CodeStub } from './base/CodeStub.mjs';
+import { DataAttachment } from './embed/DataAttachment.mjs';
 import { Delegation } from './embed/Delegation.mjs';
+import { DeletedAttachment } from './embed/DeletedAttachment.mjs';
+import { ReceiptBlobType } from './embed/ReceiptBlobType.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 /**
  *
@@ -56,6 +59,13 @@ export class DecryptedReceipt {
          *  Hard delete (unix epoch in ms) timestamp of the object.
          */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Map of blob type to attachment id for the receipt.
+         */
+        this.attachmentIds = {};
+        this.attachmentInfos = {};
+        this.deletedAttachments = [];
         /**
          *
          *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
@@ -126,6 +136,12 @@ export class DecryptedReceipt {
             this.codes = partial.codes;
         if ('deletionDate' in partial)
             this.deletionDate = partial.deletionDate;
+        if ('attachmentIds' in partial && partial.attachmentIds !== undefined)
+            this.attachmentIds = partial.attachmentIds;
+        if ('attachmentInfos' in partial && partial.attachmentInfos !== undefined)
+            this.attachmentInfos = partial.attachmentInfos;
+        if ('deletedAttachments' in partial && partial.deletedAttachments !== undefined)
+            this.deletedAttachments = partial.deletedAttachments;
         if ('references' in partial && partial.references !== undefined)
             this.references = partial.references;
         if ('documentId' in partial)
@@ -164,6 +180,9 @@ export class DecryptedReceipt {
         res['codes'] = this.codes.map((x0) => x0.toJSON());
         if (this.deletionDate != undefined)
             res['deletionDate'] = this.deletionDate;
+        res['attachmentIds'] = Object.fromEntries(Object.entries(this.attachmentIds).map(([k0, v0]) => [k0, v0]));
+        res['attachmentInfos'] = Object.fromEntries(Object.entries(this.attachmentInfos).map(([k0, v0]) => [k0, v0.toJSON()]));
+        res['deletedAttachments'] = this.deletedAttachments.map((x0) => x0.toJSON());
         res['references'] = this.references.map((x0) => x0);
         if (this.documentId != undefined)
             res['documentId'] = this.documentId;
@@ -198,6 +217,9 @@ export class DecryptedReceipt {
             tags: expectArray(extractEntry(jCpy, 'tags', false, path), false, [...path, ".tags"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
             codes: expectArray(extractEntry(jCpy, 'codes', false, path), false, [...path, ".codes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
             deletionDate: expectNumber(extractEntry(jCpy, 'deletionDate', false, path), true, true, [...path, ".deletionDate"]),
+            attachmentIds: expectMap(extractEntry(jCpy, 'attachmentIds', false, path), false, [...path, ".attachmentIds"], (k0, p0) => expectStringEnum(k0, false, p0, ReceiptBlobType, 'ReceiptBlobType'), (v0, p0) => expectString(v0, false, p0)),
+            attachmentInfos: expectMap(extractEntry(jCpy, 'attachmentInfos', false, path), false, [...path, ".attachmentInfos"], (k0, p0) => expectStringEnum(k0, false, p0, ReceiptBlobType, 'ReceiptBlobType'), (v0, p0) => expectObject(v0, false, ignoreUnknownKeys, p0, DataAttachment.fromJSON)),
+            deletedAttachments: expectArray(extractEntry(jCpy, 'deletedAttachments', false, path), false, [...path, ".deletedAttachments"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DeletedAttachment.fromJSON)),
             references: expectArray(extractEntry(jCpy, 'references', false, path), false, [...path, ".references"], (x0, p0) => expectString(x0, false, p0)),
             documentId: expectString(extractEntry(jCpy, 'documentId', false, path), true, [...path, ".documentId"]),
             category: expectString(extractEntry(jCpy, 'category', false, path), true, [...path, ".category"]),
@@ -269,6 +291,13 @@ export class EncryptedReceipt {
          *  Hard delete (unix epoch in ms) timestamp of the object.
          */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Map of blob type to attachment id for the receipt.
+         */
+        this.attachmentIds = {};
+        this.attachmentInfos = {};
+        this.deletedAttachments = [];
         /**
          *
          *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
@@ -339,6 +368,12 @@ export class EncryptedReceipt {
             this.codes = partial.codes;
         if ('deletionDate' in partial)
             this.deletionDate = partial.deletionDate;
+        if ('attachmentIds' in partial && partial.attachmentIds !== undefined)
+            this.attachmentIds = partial.attachmentIds;
+        if ('attachmentInfos' in partial && partial.attachmentInfos !== undefined)
+            this.attachmentInfos = partial.attachmentInfos;
+        if ('deletedAttachments' in partial && partial.deletedAttachments !== undefined)
+            this.deletedAttachments = partial.deletedAttachments;
         if ('references' in partial && partial.references !== undefined)
             this.references = partial.references;
         if ('documentId' in partial)
@@ -377,6 +412,9 @@ export class EncryptedReceipt {
         res['codes'] = this.codes.map((x0) => x0.toJSON());
         if (this.deletionDate != undefined)
             res['deletionDate'] = this.deletionDate;
+        res['attachmentIds'] = Object.fromEntries(Object.entries(this.attachmentIds).map(([k0, v0]) => [k0, v0]));
+        res['attachmentInfos'] = Object.fromEntries(Object.entries(this.attachmentInfos).map(([k0, v0]) => [k0, v0.toJSON()]));
+        res['deletedAttachments'] = this.deletedAttachments.map((x0) => x0.toJSON());
         res['references'] = this.references.map((x0) => x0);
         if (this.documentId != undefined)
             res['documentId'] = this.documentId;
@@ -411,6 +449,9 @@ export class EncryptedReceipt {
             tags: expectArray(extractEntry(jCpy, 'tags', false, path), false, [...path, ".tags"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
             codes: expectArray(extractEntry(jCpy, 'codes', false, path), false, [...path, ".codes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
             deletionDate: expectNumber(extractEntry(jCpy, 'deletionDate', false, path), true, true, [...path, ".deletionDate"]),
+            attachmentIds: expectMap(extractEntry(jCpy, 'attachmentIds', false, path), false, [...path, ".attachmentIds"], (k0, p0) => expectStringEnum(k0, false, p0, ReceiptBlobType, 'ReceiptBlobType'), (v0, p0) => expectString(v0, false, p0)),
+            attachmentInfos: expectMap(extractEntry(jCpy, 'attachmentInfos', false, path), false, [...path, ".attachmentInfos"], (k0, p0) => expectStringEnum(k0, false, p0, ReceiptBlobType, 'ReceiptBlobType'), (v0, p0) => expectObject(v0, false, ignoreUnknownKeys, p0, DataAttachment.fromJSON)),
+            deletedAttachments: expectArray(extractEntry(jCpy, 'deletedAttachments', false, path), false, [...path, ".deletedAttachments"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DeletedAttachment.fromJSON)),
             references: expectArray(extractEntry(jCpy, 'references', false, path), false, [...path, ".references"], (x0, p0) => expectString(x0, false, p0)),
             documentId: expectString(extractEntry(jCpy, 'documentId', false, path), true, [...path, ".documentId"]),
             category: expectString(extractEntry(jCpy, 'category', false, path), true, [...path, ".category"]),

package/model/embed/DataAttachment.d.mts

@@ -20,6 +20,40 @@ export declare class DataAttachment {
      *  The Uniform Type Identifiers of the attachment, ordered by priority.
      */
     utis: Array<string>;
+    /**
+     *
+     *
+     *   Algorithm used on the CLIENT SIDE to compress the data attachment.
+     *   Null means that the document was not compressed because the tried algorithms could not actually
+     *  compress the data
+     *   (because for example it was an already compressed format) or no algorithms were tried.
+     */
+    compressionAlgorithm: string | undefined;
+    /**
+     *
+     *
+     *   A string used by the SDK to mark which compression algorithms were tried.
+     *   Null means that no compression algorithms were tried.
+     *   If an SDK reads some data that is not compressed, if this value indicates that the data was
+     *  created with an older
+     *   version of the SDK then the SDK may try to use any newly available algorithms to compress the
+     *  data.
+     */
+    triedCompressionAlgorithmsVersion: string | undefined;
+    /**
+     *
+     *
+     *   Value computed by the backend, the actual size of the data stored for the attachment, in bytes.
+     */
+    storedDataSize: number | undefined;
+    /**
+     *
+     *
+     *   Value provided by the client, the real size of the data after it has been decrypted and
+     *  decompressed, in bytes.
+     *   This value is not used or verified by the backend.
+     */
+    realDataSize: number | undefined;
     constructor(partial: Partial<DataAttachment>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DataAttachment;

package/model/embed/DataAttachment.mjs

@@ -1,5 +1,5 @@
 // auto-generated file
-import { expectArray, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+import { expectArray, expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 /**
  *
  *  Represents a data attachment that can be stored either as a CouchDB attachment or via object
@@ -23,12 +23,54 @@ export class DataAttachment {
          *  The Uniform Type Identifiers of the attachment, ordered by priority.
          */
         this.utis = [];
+        /**
+         *
+         *
+         *   Algorithm used on the CLIENT SIDE to compress the data attachment.
+         *   Null means that the document was not compressed because the tried algorithms could not actually
+         *  compress the data
+         *   (because for example it was an already compressed format) or no algorithms were tried.
+         */
+        this.compressionAlgorithm = undefined;
+        /**
+         *
+         *
+         *   A string used by the SDK to mark which compression algorithms were tried.
+         *   Null means that no compression algorithms were tried.
+         *   If an SDK reads some data that is not compressed, if this value indicates that the data was
+         *  created with an older
+         *   version of the SDK then the SDK may try to use any newly available algorithms to compress the
+         *  data.
+         */
+        this.triedCompressionAlgorithmsVersion = undefined;
+        /**
+         *
+         *
+         *   Value computed by the backend, the actual size of the data stored for the attachment, in bytes.
+         */
+        this.storedDataSize = undefined;
+        /**
+         *
+         *
+         *   Value provided by the client, the real size of the data after it has been decrypted and
+         *  decompressed, in bytes.
+         *   This value is not used or verified by the backend.
+         */
+        this.realDataSize = undefined;
         if ('couchDbAttachmentId' in partial)
             this.couchDbAttachmentId = partial.couchDbAttachmentId;
         if ('objectStoreAttachmentId' in partial)
             this.objectStoreAttachmentId = partial.objectStoreAttachmentId;
         if ('utis' in partial && partial.utis !== undefined)
             this.utis = partial.utis;
+        if ('compressionAlgorithm' in partial)
+            this.compressionAlgorithm = partial.compressionAlgorithm;
+        if ('triedCompressionAlgorithmsVersion' in partial)
+            this.triedCompressionAlgorithmsVersion = partial.triedCompressionAlgorithmsVersion;
+        if ('storedDataSize' in partial)
+            this.storedDataSize = partial.storedDataSize;
+        if ('realDataSize' in partial)
+            this.realDataSize = partial.realDataSize;
     }
     toJSON() {
         const res = {};
@@ -37,6 +79,14 @@ export class DataAttachment {
         if (this.objectStoreAttachmentId != undefined)
             res['objectStoreAttachmentId'] = this.objectStoreAttachmentId;
         res['utis'] = this.utis.map((x0) => x0);
+        if (this.compressionAlgorithm != undefined)
+            res['compressionAlgorithm'] = this.compressionAlgorithm;
+        if (this.triedCompressionAlgorithmsVersion != undefined)
+            res['triedCompressionAlgorithmsVersion'] = this.triedCompressionAlgorithmsVersion;
+        if (this.storedDataSize != undefined)
+            res['storedDataSize'] = this.storedDataSize;
+        if (this.realDataSize != undefined)
+            res['realDataSize'] = this.realDataSize;
         return res;
     }
     static fromJSON(json, ignoreUnknownKeys = false, path = ['DataAttachment']) {
@@ -47,6 +97,10 @@ export class DataAttachment {
             couchDbAttachmentId: expectString(extractEntry(jCpy, 'couchDbAttachmentId', false, path), true, [...path, ".couchDbAttachmentId"]),
             objectStoreAttachmentId: expectString(extractEntry(jCpy, 'objectStoreAttachmentId', false, path), true, [...path, ".objectStoreAttachmentId"]),
             utis: expectArray(extractEntry(jCpy, 'utis', false, path), false, [...path, ".utis"], (x0, p0) => expectString(x0, false, p0)),
+            compressionAlgorithm: expectString(extractEntry(jCpy, 'compressionAlgorithm', false, path), true, [...path, ".compressionAlgorithm"]),
+            triedCompressionAlgorithmsVersion: expectString(extractEntry(jCpy, 'triedCompressionAlgorithmsVersion', false, path), true, [...path, ".triedCompressionAlgorithmsVersion"]),
+            storedDataSize: expectNumber(extractEntry(jCpy, 'storedDataSize', false, path), true, true, [...path, ".storedDataSize"]),
+            realDataSize: expectNumber(extractEntry(jCpy, 'realDataSize', false, path), true, true, [...path, ".realDataSize"]),
         });
         if (!ignoreUnknownKeys) {
             const unused = Object.keys(jCpy);

package/model/embed/ReceiptBlobType.d.mts

@@ -0,0 +1,15 @@
+/**
+ *
+ *
+ *   Enumerates the types of blobs that can be stored in a receipt, such as XML signatures, KMEHR
+ *  messages, and SOAP exchanges.
+ */
+export declare enum ReceiptBlobType {
+    Xades = "Xades",
+    KmehrRequest = "KmehrRequest",
+    KmehrResponse = "KmehrResponse",
+    SoapRequest = "SoapRequest",
+    SoapResponse = "SoapResponse",
+    SoapConversation = "SoapConversation",
+    Tack = "Tack"
+}

package/model/embed/ReceiptBlobType.mjs

@@ -0,0 +1,17 @@
+// auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of blobs that can be stored in a receipt, such as XML signatures, KMEHR
+ *  messages, and SOAP exchanges.
+ */
+export var ReceiptBlobType;
+(function (ReceiptBlobType) {
+    ReceiptBlobType["Xades"] = "Xades";
+    ReceiptBlobType["KmehrRequest"] = "KmehrRequest";
+    ReceiptBlobType["KmehrResponse"] = "KmehrResponse";
+    ReceiptBlobType["SoapRequest"] = "SoapRequest";
+    ReceiptBlobType["SoapResponse"] = "SoapResponse";
+    ReceiptBlobType["SoapConversation"] = "SoapConversation";
+    ReceiptBlobType["Tack"] = "Tack";
+})(ReceiptBlobType || (ReceiptBlobType = {}));

package/model.d.mts

@@ -58,6 +58,7 @@ export * from './model/embed/ContractChangeType.mjs';
 export * from './model/embed/ReferenceRange.mjs';
 export * from './model/embed/InvoicingCode.mjs';
 export * from './model/embed/EmbeddedTimeTableHour.mjs';
+export * from './model/embed/ReceiptBlobType.mjs';
 export * from './model/embed/Address.mjs';
 export * from './model/embed/Service.mjs';
 export * from './model/embed/MembershipType.mjs';

package/model.mjs

@@ -58,6 +58,7 @@ export * from './model/embed/ContractChangeType.mjs';
 export * from './model/embed/ReferenceRange.mjs';
 export * from './model/embed/InvoicingCode.mjs';
 export * from './model/embed/EmbeddedTimeTableHour.mjs';
+export * from './model/embed/ReceiptBlobType.mjs';
 export * from './model/embed/Address.mjs';
 export * from './model/embed/Service.mjs';
 export * from './model/embed/MembershipType.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@icure/cardinal-sdk",
-  "version": "2.4.2",
+  "version": "2.4.3",
   "main": "cardinal-sdk-ts.mjs",
   "types": "cardinal-sdk-ts.d.mts",
   "devDependencies": {