@travetto/model 5.0.0 → 5.0.2

package/package.json

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

package/src/internal/service/common.ts

@@ -1,10 +1,11 @@
-import { ClassInstance } from '@travetto/runtime';
+import { hasFunction } from '@travetto/runtime';
+
 import type { ModelBulkSupport } from '../../service/bulk';
-import { ModelCrudSupport } from '../../service/crud';
+import type { ModelCrudSupport } from '../../service/crud';
 import type { ModelExpirySupport } from '../../service/expiry';
-import { ModelIndexedSupport } from '../../service/indexed';
+import type { ModelIndexedSupport } from '../../service/indexed';
 import type { ModelStorageSupport } from '../../service/storage';
-import { ModelBlobSupport } from '../../service/blob';
+import type { ModelBlobSupport } from '../../service/blob';
 
 export class ModelBasicSupportTarget { }
 export class ModelCrudSupportTarget { }
@@ -16,57 +17,35 @@ export class ModelIndexedSupportTarget { }
 
 /**
  * Type guard for determining if service supports basic operations
- * @param o
  */
-export function isBasicSupported(o: ClassInstance): o is ModelBulkSupport {
-  return !!o && 'create' in o;
-}
+export const isBasicSupported = hasFunction<ModelBulkSupport>('create');
 
 /**
  * Type guard for determining if service supports crud operations
- * @param o
  */
-export function isCrudSupported(o: ClassInstance): o is ModelCrudSupport {
-  return !!o && 'upsert' in o;
-}
+export const isCrudSupported = hasFunction<ModelCrudSupport>('upsert');
 
 /**
  * Type guard for determining if model supports expiry
- * @param o
  */
-export function isExpirySupported(o: ClassInstance): o is ModelExpirySupport {
-  return !!o && 'deleteExpired' in o;
-}
+export const isExpirySupported = hasFunction<ModelExpirySupport>('deleteExpired');
 
 /**
  * Type guard for determining if service supports streaming operation
- * @param o
  */
-export function isBlobSupported(o: ClassInstance): o is ModelBlobSupport {
-  return !!o && 'getBlob' in o;
-}
+export const isBlobSupported = hasFunction<ModelBlobSupport>('getBlob');
 
 /**
  * Type guard for determining if service supports storage operation
- * @param o
  */
-export function isStorageSupported(o: ClassInstance): o is ModelStorageSupport {
-  return !!o && 'createStorage' in o;
-}
+export const isStorageSupported = hasFunction<ModelStorageSupport>('createStorage');
 
 /**
  * Type guard for determining if service supports streaming operation
- * @param o
  */
-export function isBulkSupported(o: ClassInstance): o is ModelBulkSupport {
-  return !!o && 'processBulk' in o;
-}
+export const isBulkSupported = hasFunction<ModelBulkSupport>('processBulk');
 
 /**
  * Type guard for determining if service supports indexed operation
- * @param o
  */
-export function isIndexedSupported(o: ClassInstance): o is ModelIndexedSupport {
-  return !!o && 'getByIndex' in o;
-}
-
+export const isIndexedSupported = hasFunction<ModelIndexedSupport>('getByIndex');

package/src/internal/service/crud.ts

@@ -1,6 +1,4 @@
-import crypto from 'node:crypto';
-
-import { castTo, Class, asFull, Util, asConstructable } from '@travetto/runtime';
+import { castTo, Class, Util, asConstructable, AppError } from '@travetto/runtime';
 import { DataUtil, SchemaRegistry, SchemaValidator, ValidationError, ValidationResultError } from '@travetto/schema';
 
 import { ModelRegistry } from '../../registry/model';
@@ -28,18 +26,6 @@ export class ModelCrudUtil {
     return { create, valid };
   }
 
-  /**
-   * Provide hash value
-   * @param value Input value
-   * @param length Number of characters to produce
-   */
-  static hashValue(value: string, length = 32): string {
-    if (value.length < 32) {
-      value = value.padEnd(32, ' ');
-    }
-    return crypto.createHash('sha1').update(value).digest('hex').substring(0, length);
-  }
-
   /**
    * Load model
    * @param cls Class to load model for
@@ -109,36 +95,6 @@ export class ModelCrudUtil {
     return castTo(item);
   }
 
-  /**
-   * Performs a naive partial update by fetching, patching, and then storing
-   * @param cls Type to store for
-   * @param item The object to use for a partial update
-   * @param view The schema view to validate against
-   * @param getExisting How to fetch an existing item
-   */
-  static async naivePartialUpdate<T extends ModelType>(cls: Class<T>, item: Partial<T>, view: undefined | string, getExisting: () => Promise<T>): Promise<T> {
-    if (DataUtil.isPlainObject(item)) {
-      item = cls.from(castTo(item));
-    }
-
-    const config = ModelRegistry.get(asConstructable(item).constructor);
-    if (config.subType) { // Sub-typing, assign type
-      SchemaRegistry.ensureInstanceTypeField(cls, item);
-    }
-
-    if (view) {
-      await SchemaValidator.validate(cls, item, view);
-    }
-
-    const existing = await getExisting();
-
-    item = Object.assign(existing, item);
-
-    item = await this.prePersist(cls, item, 'partial');
-
-    return asFull(item);
-  }
-
   /**
    * Ensure subtype is not supported
    */
@@ -178,4 +134,25 @@ export class ModelCrudUtil {
     }
     return item;
   }
+
+  /**
+   * Ensure everything is correct for a partial update
+   */
+  static async prePartialUpdate<T extends ModelType>(cls: Class<T>, item: Partial<T>, view?: string): Promise<Partial<T>> {
+    if (!DataUtil.isPlainObject(item)) {
+      throw new AppError(`A partial update requires a plain object, not an instance of ${castTo<Function>(item).constructor.name}`, 'data');
+    }
+    const res = await this.prePersist(cls, castTo(item), 'partial');
+    await SchemaValidator.validatePartial(cls, item, view);
+    return res;
+  }
+
+  /**
+   * Ensure everything is correct for a partial update
+   */
+  static async naivePartialUpdate<T extends ModelType>(cls: Class<T>, get: () => Promise<T>, item: Partial<T>, view?: string): Promise<T> {
+    const prepared = await this.prePartialUpdate(cls, item, view);
+    const full = await get();
+    return cls.from(castTo({ ...full, ...prepared }));
+  }
 }

package/support/test/crud.ts

@@ -125,22 +125,22 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     assert(o.id);
     assert(o.name === 'bob');
 
-    const o2 = await service.updatePartial(Person, Person.from({
+    const o2 = await service.updatePartial(Person, {
       id: o.id,
       name: 'oscar'
-    }));
+    });
 
     assert(o2.name === 'oscar');
     assert(o2.age === 20);
     assert(o2.address.street2 === 'roader');
 
-    await service.updatePartial(Person, Person.from({
+    await service.updatePartial(Person, {
       id: o2.id,
       gender: 'f',
       address: {
         street1: 'changed\n',
       }
-    }));
+    });
 
     const o3 = await service.get(Person, o.id);
 
@@ -175,11 +175,11 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
       ]
     }));
 
-    const o2 = await service.updatePartial(SimpleList, SimpleList.from({
+    const o2 = await service.updatePartial(SimpleList, {
       id: o.id,
       names: ['a', 'd'],
       simples: [{ name: 'd' }]
-    }));
+    });
 
     assert.deepStrictEqual(o2.names, ['a', 'd']);
     assert.deepStrictEqual(o2.simples, [SimpleItem.from({ name: 'd' })]);
@@ -195,12 +195,12 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     assert(o.address === undefined);
     assert(o.name === 'bob-suffix');
 
-    await service.updatePartial(User2, User2.from({
+    await service.updatePartial(User2, {
       id: o.id,
       address: {
         street1: 'blue'
       }
-    }));
+    });
 
     const o3 = await service.get(User2, o.id);
 

package/support/test/polymorphism.ts

@@ -2,6 +2,7 @@ import assert from 'node:assert';
 import timers from 'node:timers/promises';
 
 import { Suite, Test } from '@travetto/test';
+import { castTo } from '@travetto/runtime';
 import { SubTypeField, Text, TypeMismatchError } from '@travetto/schema';
 import {
   ModelIndexedSupport, Index, ModelCrudSupport, Model,
@@ -12,7 +13,6 @@ import { isIndexedSupported } from '../../src/internal/service/common';
 import { ExistsError } from '../../src/error/exists';
 
 import { BaseModelSuite } from './base';
-import { castTo } from '@travetto/runtime';
 
 @Model({ baseType: true })
 export class Worker {
@@ -133,6 +133,9 @@ export abstract class ModelPolymorphismSuite extends BaseModelSuite<ModelCrudSup
       name: 'bob2'
     }));
 
+    const all2 = await collect(service.list(Worker));
+    assert(all2.length === 4);
+
     const engineers2 = await collect(service.list(Engineer));
     assert(engineers2.length === 2);
   }