@travetto/model 3.3.3 → 3.3.4

package/README.md

@@ -216,18 +216,10 @@ export interface ModelType {
    * If not provided, will be computed on create
    */
   id: string;
-  /**
-   * Run before saving
-   */
-  prePersist?(): void | Promise<void>;
-  /**
-   * Run after loading
-   */
-  postLoad?(): void | Promise<void>;
 }
 ```
 
-All fields are optional, but the `id` and `type` are important as those field types are unable to be changed.  This may make using existing data models impossible if types other than strings are required.  Additionally, the type field, is intended to record the base model type and cannot be remapped. This is important to support polymorphism, not only in [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations."), but also in [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.").
+The `id` is the only required field for a model, as this is a hard requirement on naming and type.  This may make using existing data models impossible if types other than strings are required.  Additionally, the `type` field, is intended to record the base model type, but can be remapped. This is important to support polymorphism, not only in [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations."), but also in [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.").
 
 ## Implementations
 |Service|Basic|CRUD|Indexed|Expiry|Stream|Bulk|

package/package.json

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

package/src/internal/service/crud.ts

@@ -8,6 +8,7 @@ import { ModelIdSource, ModelType, OptionalId } from '../../types/model';
 import { NotFoundError } from '../../error/not-found';
 import { ExistsError } from '../../error/exists';
 import { SubTypeNotSupportedError } from '../../error/invalid-sub-type';
+import { DataHandler } from '../../registry/types';
 
 export type ModelCrudProvider = {
   idSource: ModelIdSource;
@@ -62,10 +63,7 @@ export class ModelCrudUtil {
       }
     }
 
-    if (result.postLoad) {
-      await result.postLoad();
-    }
-    return result;
+    return this.postLoad(cls, result);
   }
 
   /**
@@ -90,9 +88,7 @@ export class ModelCrudUtil {
       SchemaRegistry.ensureInstanceTypeField(cls, item);
     }
 
-    if (item.prePersist) {
-      await item.prePersist();
-    }
+    item = await this.prePersist(cls, item);
 
     let errors: ValidationError[] = [];
     try {
@@ -141,9 +137,7 @@ export class ModelCrudUtil {
 
     item = Object.assign(existing, item);
 
-    if (item.prePersist) {
-      await item.prePersist();
-    }
+    item = await this.prePersist(cls, item);
 
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return item as T;
@@ -157,4 +151,34 @@ export class ModelCrudUtil {
       throw new SubTypeNotSupportedError(cls);
     }
   }
+
+  /**
+   * Pre persist behavior
+   */
+  static async prePersist<T>(cls: Class<T>, item: T): Promise<T> {
+    const config = ModelRegistry.get(cls);
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    for (const handler of (config.prePersist ?? []) as unknown as DataHandler<T>[]) {
+      item = await handler(item) ?? item;
+    }
+    if (typeof item === 'object' && item && 'prePersist' in item && typeof item['prePersist'] === 'function') {
+      item = await item.prePersist() ?? item;
+    }
+    return item;
+  }
+
+  /**
+   * Post load behavior
+   */
+  static async postLoad<T>(cls: Class<T>, item: T): Promise<T> {
+    const config = ModelRegistry.get(cls);
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    for (const handler of (config.postLoad ?? []) as unknown as DataHandler<T>[]) {
+      item = await handler(item) ?? item;
+    }
+    if (typeof item === 'object' && item && 'postLoad' in item && typeof item['postLoad'] === 'function') {
+      item = await item.postLoad() ?? item;
+    }
+    return item;
+  }
 }

package/src/registry/decorator.ts

@@ -3,7 +3,7 @@ import { SchemaRegistry } from '@travetto/schema';
 
 import { ModelType } from '../types/model';
 import { ModelRegistry } from './model';
-import { IndexConfig, ModelOptions } from './types';
+import { DataHandler, IndexConfig, ModelOptions } from './types';
 
 /**
  * Model decorator, extends `@Schema`
@@ -40,4 +40,43 @@ export function ExpiresAt() {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     ModelRegistry.register(tgt.constructor as Class<T>, { expiresAt: prop });
   };
+}
+
+/**
+ * Model class decorator for pre-persist behavior
+ */
+export function PrePersist<T>(handler: DataHandler<T>) {
+  return function (tgt: Class<T>): void {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    ModelRegistry.registerDataHandlers(tgt, { prePersist: [handler as DataHandler] });
+  };
+}
+
+/**
+ * Model field decorator for pre-persist value setting
+ */
+export function PersistValue<T>(handler: (curr: T | undefined) => T) {
+  return function <K extends string, C extends Partial<Record<K, T>>>(tgt: C, prop: K): void {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    ModelRegistry.registerDataHandlers(tgt.constructor as Class<C>, {
+      prePersist: [
+        (inst): void => {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+          const cInst = (inst as unknown as Record<K, T>);
+          cInst[prop] = handler(cInst[prop]);
+        }
+      ]
+    });
+  };
+}
+
+
+/**
+ * Model class decorator for post-load behavior
+ */
+export function PostLoad<T>(handler: DataHandler<T>) {
+  return function (tgt: Class<T>): void {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    ModelRegistry.registerDataHandlers(tgt, { postLoad: [handler as DataHandler] });
+  };
 }

package/src/registry/model.ts

@@ -52,7 +52,16 @@ class $ModelRegistry extends MetadataRegistry<ModelOptions<ModelType>> {
   }
 
   createPending(cls: Class): Partial<ModelOptions<ModelType>> {
-    return { class: cls, indices: [], autoCreate: true, baseType: RootIndex.getFunctionMetadata(cls)?.abstract };
+    return { class: cls, indices: [], autoCreate: true, baseType: RootIndex.getFunctionMetadata(cls)?.abstract, postLoad: [], prePersist: [] };
+  }
+
+  registerDataHandlers(cls: Class, pConfig?: Partial<ModelOptions<ModelType>>): void {
+    const cfg = this.getOrCreatePending(cls);
+    this.register(cls, {
+      ...cfg,
+      prePersist: [...cfg.prePersist ?? [], ...pConfig?.prePersist ?? []],
+      postLoad: [...cfg.postLoad ?? [], ...pConfig?.postLoad ?? []],
+    });
   }
 
   onInstallFinalize(cls: Class): ModelOptions<ModelType> {
@@ -66,6 +75,16 @@ class $ModelRegistry extends MetadataRegistry<ModelOptions<ModelType>> {
     if (schema.subTypeField in view && this.getBaseModel(cls) !== cls) {
       config.subType = !!schema.subTypeName; // Copy from schema
       delete view[schema.subTypeField].required; // Allow type to be optional
+      let parent = this.getParentClass(cls);
+      let from = cls;
+      // Merge inherited prepersist/postload
+      while (parent && from !== parent) {
+        const pCfg = this.get(parent);
+        config.prePersist = [...pCfg.prePersist ?? [], ...config.prePersist ?? []];
+        config.postLoad = [...pCfg.postLoad ?? [], ...config.postLoad ?? []];
+        from = parent;
+        parent = this.getParentClass(from);
+      }
     }
     return config;
   }

package/src/registry/types.ts

@@ -21,6 +21,8 @@ type IndexClauseRaw<T> = {
   T[P] extends object ? IndexClauseRaw<RetainFields<T[P]>> : 1 | -1 | true;
 };
 
+export type DataHandler<T = unknown> = (inst: T) => (Promise<T | void> | T | void);
+
 /**
  * Model options
  */
@@ -57,6 +59,14 @@ export class ModelOptions<T extends ModelType = ModelType> {
    * Auto create in development mode
    */
   autoCreate: boolean;
+  /**
+   * Pre-persist handlers
+   */
+  prePersist?: DataHandler<unknown>[];
+  /**
+   * Post-load handlers
+   */
+  postLoad?: DataHandler<unknown>[];
 }
 
 /**

package/src/types/model.ts

@@ -13,14 +13,6 @@ export interface ModelType {
    * If not provided, will be computed on create
    */
   id: string;
-  /**
-   * Run before saving
-   */
-  prePersist?(): void | Promise<void>;
-  /**
-   * Run after loading
-   */
-  postLoad?(): void | Promise<void>;
 }
 
 export type OptionalId<T extends { id: string }> = Omit<T, 'id'> & { id?: string };

package/support/test/crud.ts

@@ -46,6 +46,10 @@ class User2 {
   id: string;
   address?: Address;
   name: string;
+
+  prePersist() {
+    this.name = `${this.name}-suff`;
+  }
 }
 
 @Model()
@@ -175,6 +179,7 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     }));
 
     assert(o.address === undefined);
+    assert(o.name === 'bob-suff');
 
     await service.updatePartial(User2, User2.from({
       id: o.id,

package/support/test/indexed.ts

@@ -48,13 +48,9 @@ class Child {
 @Index({ type: 'sorted', name: 'nameCreated', fields: [{ child: { name: 1 } }, { createdDate: 1 }] })
 class User4 {
   id: string;
-  createdDate?: Date;
+  createdDate?: Date = new Date();
   color: string;
   child: Child;
-
-  prePersist?() {
-    this.createdDate ??= new Date();
-  }
 }
 
 @Suite()
@@ -157,7 +153,7 @@ export abstract class ModelIndexedSuite extends BaseModelSuite<ModelIndexedSuppo
     await service.create(User4, User4.from({ child: { name: 'bob', age: 30 }, createdDate: TimeUtil.timeFromNow('2d'), color: 'red' }));
     await service.create(User4, User4.from({ child: { name: 'bob', age: 50 }, createdDate: TimeUtil.timeFromNow('-1d'), color: 'green' }));
 
-    const arr = await this.toArray(service.listByIndex(User4, 'nameCreated', User4.from({ child: { name: 'bob' } })));
+    const arr = await this.toArray(service.listByIndex(User4, 'nameCreated', { child: { name: 'bob' } }));
 
     assert(arr[0].color === 'green' && arr[0].child.name === 'bob' && arr[0].child.age === 50);
     assert(arr[1].color === 'red' && arr[1].child.name === 'bob' && arr[1].child.age === 30);

package/support/test/polymorphism.ts

@@ -2,10 +2,10 @@ import assert from 'assert';
 import timers from 'timers/promises';
 
 import { Suite, Test } from '@travetto/test';
-import { Text, TypeMismatchError } from '@travetto/schema';
+import { SubTypeField, Text, TypeMismatchError } from '@travetto/schema';
 import {
   ModelIndexedSupport, Index, ModelCrudSupport, Model,
-  NotFoundError, SubTypeNotSupportedError
+  NotFoundError, SubTypeNotSupportedError, PersistValue
 } from '@travetto/model';
 
 import { isIndexedSupported } from '../../src/internal/service/common';
@@ -16,15 +16,14 @@ import { BaseModelSuite } from './base';
 @Model({ baseType: true })
 export class Worker {
   id: string;
-  type: string;
+  @SubTypeField()
+  _type: string;
   @Text()
   name: string;
   age?: number;
-  updatedDate?: Date;
 
-  prePersist() {
-    this.updatedDate = new Date();
-  }
+  @PersistValue(() => new Date())
+  updatedDate?: Date;
 }
 
 @Model()