@icure/cardinal-sdk 2.9.0 → 2.10.0

package/model/embed/Service.mjs

@@ -4,7 +4,7 @@ import { randomUuid } from '../../utils/Id.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
 import { Identifier } from '../base/Identifier.mjs';
 import { LinkQualification } from '../base/LinkQualification.mjs';
-import { Annotation } from './Annotation.mjs';
+import { DecryptedAnnotation, EncryptedAnnotation } from './Annotation.mjs';
 import { DecryptedContent, EncryptedContent } from './Content.mjs';
 import { Delegation } from './Delegation.mjs';
 import { SecurityMetadata } from './SecurityMetadata.mjs';
@@ -316,7 +316,7 @@ export class DecryptedService {
             responsible: expectString(extractEntry(jCpy, 'responsible', false, path), true, [...path, ".responsible"]),
             comment: expectString(extractEntry(jCpy, 'comment', false, path), true, [...path, ".comment"]),
             invoicingCodes: expectArray(extractEntry(jCpy, 'invoicingCodes', false, path), false, [...path, ".invoicingCodes"], (x0, p0) => expectString(x0, false, p0)),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedAnnotation.fromJSON)),
             qualifiedLinks: expectMap(extractEntry(jCpy, 'qualifiedLinks', false, path), false, [...path, ".qualifiedLinks"], (k0, p0) => expectStringEnum(k0, false, p0, LinkQualification, 'LinkQualification'), (v0, p0) => expectMap(v0, false, p0, (k1, p1) => expectString(k1, false, p1), (v1, p1) => expectString(v1, false, p1))),
             codes: expectArray(extractEntry(jCpy, 'codes', false, path), false, [...path, ".codes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
             tags: expectArray(extractEntry(jCpy, 'tags', false, path), false, [...path, ".tags"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
@@ -639,7 +639,7 @@ export class EncryptedService {
             responsible: expectString(extractEntry(jCpy, 'responsible', false, path), true, [...path, ".responsible"]),
             comment: expectString(extractEntry(jCpy, 'comment', false, path), true, [...path, ".comment"]),
             invoicingCodes: expectArray(extractEntry(jCpy, 'invoicingCodes', false, path), false, [...path, ".invoicingCodes"], (x0, p0) => expectString(x0, false, p0)),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedAnnotation.fromJSON)),
             qualifiedLinks: expectMap(extractEntry(jCpy, 'qualifiedLinks', false, path), false, [...path, ".qualifiedLinks"], (k0, p0) => expectStringEnum(k0, false, p0, LinkQualification, 'LinkQualification'), (v0, p0) => expectMap(v0, false, p0, (k1, p1) => expectString(k1, false, p1), (v1, p1) => expectString(v1, false, p1))),
             codes: expectArray(extractEntry(jCpy, 'codes', false, path), false, [...path, ".codes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
             tags: expectArray(extractEntry(jCpy, 'tags', false, path), false, [...path, ".tags"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),

package/options/SdkOptions.d.mts

@@ -66,13 +66,17 @@ export interface SdkOptions {
      */
     readonly jsonPatcher?: JsonPatcher;
     /**
-     * If true the SDK will use lenient deserialization of the entities coming from the backend.
+     * If true, on deserialization of data coming from the backend or from the decrypted content of an entity any
+     * field that is not present in the data model will be ignored.
      *
-     * This could be helpful when developing using the nightly deployments of the backend, as the SDK will ignore minor changes to the data model.
+     * Note that updating an entity where some fields were ignored during deserialization will result in data loss.
      *
-     * This option however could cause loss of data when connecting with incompatible versions of the backend, and should be disabled in production.
+     * If the ignored keys are coming from the encrypted content of an entity you can provide a {@link jsonPatcher}
+     * to specify how the unknown fields should be migrated.
+     *
+     * This behaviour is disabled by default (strict by default).
      */
-    readonly lenientJson?: boolean;
+    readonly ignoreUnknownFields?: boolean;
     /**
      * If not null the SDK will immediately set the data owner scope to the provided value after login.
      */
@@ -98,13 +102,14 @@ export interface BasicSdkOptions {
      */
     readonly groupSelector?: (availableGroups: Array<UserGroup>) => Promise<string>;
     /**
-     * If true the SDK will use lenient deserialization of the entities coming from the backend.
+     * If true, on deserialization of data coming from the backend or from the decrypted content of an entity any
+     * field that is not present in the data model will be ignored.
      *
-     * This could be helpful when developing using the nightly deployments of the backend, as the SDK will ignore minor changes to the data model.
+     * Note that updating an entity where some fields were ignored during deserialization will result in data loss.
      *
-     * This option however could cause loss of data when connecting with incompatible versions of the backend, and should be disabled in production.
+     * This behaviour is disabled by default (strict by default).
      */
-    readonly lenientJson?: boolean;
+    readonly ignoreUnknownFields?: boolean;
     /**
      * If not null the SDK will immediately set the data owner scope to the provided value after login.
      */
@@ -141,13 +146,14 @@ export interface BasicToFullSdkOptions {
 }
 export interface AnonymousSdkOptions {
     /**
-     * If true the SDK will use lenient deserialization of the entities coming from the backend.
+     * If true, on deserialization of data coming from the backend or from the decrypted content of an entity any
+     * field that is not present in the data model will be ignored.
      *
-     * This could be helpful when developing using the nightly deployments of the backend, as the SDK will ignore minor changes to the data model.
+     * Note that updating an entity where some fields were ignored during deserialization will result in data loss.
      *
-     * This option however could cause loss of data when connecting with incompatible versions of the backend, and should be disabled in production.
+     * This behaviour is disabled by default (strict by default).
      */
-    readonly lenientJson?: boolean;
+    readonly ignoreUnknownFields?: boolean;
 }
 export interface EncryptedFieldsConfiguration {
     readonly accessLog?: Array<string>;

package/package.json

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