@travetto/model 6.0.0-rc.2 → 6.0.1

package/README.md

@@ -15,6 +15,23 @@ yarn add @travetto/model
 
 This module provides a set of contracts/interfaces to data model persistence, modification and retrieval.  This module builds heavily upon the [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding."), which is used for data model validation.
 
+## A Simple Model
+A model can be simply defined by usage of the [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L13) decorator, which opts it into the [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.") contracts, as well as making it available to the [ModelRegistry](https://github.com/travetto/travetto/tree/main/module/model/src/registry/model.ts#L14).
+
+**Code: Basic Structure**
+```typescript
+import { Model } from '@travetto/model';
+
+@Model()
+export class SampleModel {
+  id: string;
+  name: string;
+  age: number;
+}
+```
+
+Once the model is defined, it can be leveraged with any of the services that implement the various model storage contracts.  These contracts allow for persisting and fetching of the associated model object.
+
 ## Contracts
 The module is mainly composed of contracts.  The contracts define the expected interface for various model patterns. The primary contracts are [Basic](https://github.com/travetto/travetto/tree/main/module/model/src/types/basic.ts#L8), [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11), [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/types/indexed.ts#L11), [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10), [Blob](https://github.com/travetto/travetto/tree/main/module/model/src/types/blob.ts#L8) and [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/types/bulk.ts#L64).
 

package/package.json

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

package/src/registry/decorator.ts

@@ -74,6 +74,23 @@ export function PersistValue<T>(handler: (curr: T | undefined) => T, scope: PreP
   };
 }
 
+/**
+ * Prevent a field from being persisted
+ */
+export function Transient<T>() {
+  return function <K extends string, C extends Partial<Record<K, T>>>(tgt: C, prop: K): void {
+    ModelRegistry.registerDataHandlers(asConstructable(tgt).constructor, {
+      prePersist: [{
+        scope: 'all',
+        handler: (inst): void => {
+          const cInst: Record<K, T> = castTo(inst);
+          delete cInst[prop];
+        }
+      }]
+    });
+  };
+}
+
 /**
  * Model class decorator for post-load behavior
  */

package/src/types/model.ts

@@ -16,4 +16,4 @@ export interface ModelType {
   id: string;
 }
 
-export type OptionalId<T extends { id: string }> = Omit<T, 'id'> & { id?: string };
+export type OptionalId<T extends ModelType> = Omit<T, 'id'> & { id?: string };

package/src/util/expiry.ts

@@ -37,7 +37,7 @@ export class ModelExpiryUtil {
       const running = new AbortController();
       const cullInterval = TimeUtil.asMillis(svc.config?.cullRate ?? '10m');
 
-      ShutdownManager.onGracefulShutdown(async () => running.abort(), this);
+      ShutdownManager.onGracefulShutdown(async () => running.abort());
 
       (async (): Promise<void> => {
         await Util.nonBlockingTimeout(1000);

package/src/util/indexed.ts

@@ -39,7 +39,7 @@ export class ModelIndexedUtil {
     cls: Class<T>, idx: IndexConfig<T> | string, item: DeepPartial<T>, opts: ComputeConfig = {}
   ): { fields: IndexFieldPart[], sorted: IndexSortPart | undefined } {
     const cfg = typeof idx === 'string' ? ModelRegistry.getIndex(cls, idx) : idx;
-    const sortField = cfg.type === 'sorted' ? cfg.fields[cfg.fields.length - 1] : undefined;
+    const sortField = cfg.type === 'sorted' ? cfg.fields.at(-1) : undefined;
 
     const fields: IndexFieldPart[] = [];
     let sortDir: number = 0;