@travetto/model 3.1.4 → 3.1.6

package/README.md

@@ -79,7 +79,11 @@ export interface ModelCrudSupport extends ModelBasicSupport {
   upsert<T extends ModelType>(cls: Class<T>, item: OptionalId<T>): Promise<T>;
 
   /**
-   * Update Partial
+   * Update partial, respecting only top level keys.
+   *
+   * When invoking this method, any top level keys that are null/undefined are treated as removals/deletes.  Any properties
+   * that point to sub objects/arrays are treated as wholesale replacements.
+   *
    * @param id The document identifier to update
    * @param item The document to partially update.
    * @param view The schema view to validate against

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model",
-  "version": "3.1.4",
+  "version": "3.1.6",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -26,13 +26,13 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/config": "^3.1.1",
+    "@travetto/config": "^3.1.2",
     "@travetto/di": "^3.1.1",
     "@travetto/registry": "^3.1.1",
-    "@travetto/schema": "^3.1.1"
+    "@travetto/schema": "^3.1.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.1.1",
+    "@travetto/cli": "^3.1.2",
     "@travetto/test": "^3.1.1"
   },
   "peerDependenciesMeta": {

package/src/service/crud.ts

@@ -30,7 +30,11 @@ export interface ModelCrudSupport extends ModelBasicSupport {
   upsert<T extends ModelType>(cls: Class<T>, item: OptionalId<T>): Promise<T>;
 
   /**
-   * Update Partial
+   * Update partial, respecting only top level keys.
+   *
+   * When invoking this method, any top level keys that are null/undefined are treated as removals/deletes.  Any properties
+   * that point to sub objects/arrays are treated as wholesale replacements.
+   *
    * @param id The document identifier to update
    * @param item The document to partially update.
    * @param view The schema view to validate against

package/support/test/crud.ts

@@ -127,7 +127,6 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
       gender: 'f',
       address: {
         street1: 'changed\n',
-        street2: undefined
       }
     }));
 
@@ -172,7 +171,7 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
   async testBlankPartialUpdate() {
     const service = await this.service;
     const o = await service.create(User2, User2.from({
-      name: 'bob'
+      name: 'bob',
     }));
 
     assert(o.address === undefined);
@@ -187,7 +186,8 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     const o3 = await service.get(User2, o.id);
 
     assert(o3.address !== undefined);
-    assert(o3.address!.street1 === 'blue');
+    assert(o3.address.street1 === 'blue');
+    assert(o3.address.street2 === undefined);
   }
 
   @Test('verify dates')
@@ -282,4 +282,29 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     assert(o2.age === 20);
     assert(o2.address.street2 === 'roader');
   }
+
+  @Test('Verify nested list in partial update')
+  async testPartialUpdateOnLists() {
+    const service = await this.service;
+    const o = await service.create(SimpleList, {
+      names: ['rob', 'tom'],
+      simples: [
+        { name: 'roger' },
+        { name: 'dodger' }
+      ]
+    });
+    assert(o.names.length === 2);
+    assert(o.simples);
+    assert(o.simples.length === 2);
+
+    const o2 = await service.updatePartial(SimpleList, {
+      id: o.id,
+      names: ['dawn'],
+      simples: [{ name: 'jim' }]
+    });
+
+    assert(o2.names.length === 1);
+    assert(o2.simples);
+    assert(o2.simples.length === 1);
+  }
 }