@travetto/model 3.1.0-rc.1 → 3.1.0-rc.10

package/README.md

@@ -60,10 +60,9 @@ The [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/servi
 export interface ModelCrudSupport extends ModelBasicSupport {
 
   /**
-   * Generate a uuid
-   * @param value The optional value to generate a uuid around.  Passing the same value multiple times produces the same output.
+   * Uuid Generator
    */
-  uuid(): string;
+  uuid: UuidGenerator;
 
   /**
    * Update an item
@@ -234,8 +233,8 @@ All fields are optional, but the `id` and `type` are important as those field ty
 |[Redis Model Support](https://github.com/travetto/travetto/tree/main/module/model-redis#readme "Redis backing for the travetto model module.")|X|X|X|X| ||
 |[S3 Model Support](https://github.com/travetto/travetto/tree/main/module/model-s3#readme "S3 backing for the travetto model module.")|X|X| |X|X| |
 |[SQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-sql#readme "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.")|X|X|X|X| |X|
-|[MemoryModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/memory.ts#L54)|X|X|X|X|X|X|
-|[FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L51)|X|X| |X|X|X|
+|[MemoryModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/memory.ts#L53)|X|X|X|X|X|X|
+|[FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L50)|X|X| |X|X|X|
 
 ## Custom Model Service
 In addition to the provided contracts, the module also provides common utilities and shared test suites.  The common utilities are useful for repetitive functionality, that is unable to be shared due to not relying upon inheritance (this was an intentional design decision).  This allows for all the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") implementations to completely own the functionality and also to be able to provide additional/unique functionality that goes beyond the interface.
@@ -262,7 +261,6 @@ import { ModelIndexedUtil } from '../internal/service/indexed';
 import { ModelStorageUtil } from '../internal/service/storage';
 import { StreamModel, STREAMS } from '../internal/service/stream';
 import { IndexConfig } from '../registry/types';
-import { ModelUtil } from '../internal/util';
 const STREAM_META = `${STREAMS}_meta`;
 type StoreType = Map<string, Buffer>;
 @Config('model.memory')
@@ -291,11 +289,11 @@ export class MemoryModelService implements ModelCrudSupport, ModelStreamSupport,
     sorted: new Map<string, Map<string, Map<string, number>>>(),
     unsorted: new Map<string, Map<string, Set<string>>>()
   };
+  uuid = ModelCrudUtil.uuidGenerator();
   get client(): Map<string, StoreType>;
   constructor(public readonly config: MemoryModelConfig) { }
   async postConstruct(): Promise<void>;
   // CRUD Support
-  uuid(): string;
   async get<T extends ModelType>(cls: Class<T>, id: string): Promise<T>;
   async create<T extends ModelType>(cls: Class<T>, item: OptionalId<T>): Promise<T>;
   async update<T extends ModelType>(cls: Class<T>, item: T): Promise<T>;

package/__index__.ts

@@ -9,6 +9,7 @@ export * from './src/service/indexed';
 export * from './src/service/expiry';
 export * from './src/service/storage';
 export * from './src/service/stream';
+export * from './src/service/types';
 
 export * from './src/provider/file';
 export * from './src/provider/memory';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model",
-  "version": "3.1.0-rc.1",
+  "version": "3.1.0-rc.10",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -26,14 +26,14 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/config": "^3.1.0-rc.1",
-    "@travetto/di": "^3.1.0-rc.0",
-    "@travetto/registry": "^3.1.0-rc.0",
-    "@travetto/schema": "^3.1.0-rc.1"
+    "@travetto/config": "^3.1.0-rc.8",
+    "@travetto/di": "^3.1.0-rc.5",
+    "@travetto/registry": "^3.1.0-rc.3",
+    "@travetto/schema": "^3.1.0-rc.6"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.1.0-rc.1",
-    "@travetto/test": "^3.1.0-rc.1"
+    "@travetto/cli": "^3.1.0-rc.9",
+    "@travetto/test": "^3.1.0-rc.4"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/internal/service/bulk.ts

@@ -1,6 +1,7 @@
 import { Class } from '@travetto/base';
 
 import { BulkOp } from '../../service/bulk';
+import { ModelUuidGenerator } from '../../service/types';
 import { ModelType } from '../../types/model';
 import { ModelCrudUtil } from './crud';
 
@@ -19,7 +20,7 @@ export class ModelBulkUtil {
    * @param operations
    * @param idSource
    */
-  static async preStore<T extends ModelType>(cls: Class<T>, operations: BulkOp<T>[], idSource: { uuid(): string }): Promise<BulkPreStore<T>> {
+  static async preStore<T extends ModelType>(cls: Class<T>, operations: BulkOp<T>[], idSource: { uuid: ModelUuidGenerator }): Promise<BulkPreStore<T>> {
     const insertedIds = new Map<number, string>();
     const upsertedIds = new Map<number, string>();
     const updatedIds = new Map<number, string>();

package/src/internal/service/crud.ts

@@ -1,19 +1,38 @@
 import crypto from 'crypto';
 
-import { Class, ObjectUtil } from '@travetto/base';
-import { SchemaRegistry, SchemaValidator } from '@travetto/schema';
+import { Class, ObjectUtil, Util } from '@travetto/base';
+import { SchemaRegistry, SchemaValidator, ValidationError, ValidationResultError } from '@travetto/schema';
 
 import { ModelRegistry } from '../../registry/model';
 import { ModelType, OptionalId } from '../../types/model';
 import { NotFoundError } from '../../error/not-found';
 import { ExistsError } from '../../error/exists';
 import { SubTypeNotSupportedError } from '../../error/invalid-sub-type';
+import { ModelUuidGenerator } from '../../service/types';
 
 /**
  * Crud utilities
  */
 export class ModelCrudUtil {
 
+  /**
+   * Build a uuid generator
+   */
+  static uuidGenerator(create: () => string, valid: (id: string) => boolean): ModelUuidGenerator;
+  static uuidGenerator(len?: number): ModelUuidGenerator;
+  static uuidGenerator(lenOrCreate: (() => string) | number = 32, valid?: (id: string) => boolean): ModelUuidGenerator {
+    if (typeof lenOrCreate === 'number') {
+      const len = lenOrCreate;
+      const create = (): string => Util.uuid(len);
+      create.valid = (id: string): boolean => id.length === len && /^[0-9a-f]+$/i.test(id);
+      return create;
+    } else {
+      const create = (): string => lenOrCreate();
+      create.valid = valid!;
+      return create;
+    }
+  }
+
   /**
    * Provide hash value
    * @param value Input value
@@ -61,7 +80,7 @@ export class ModelCrudUtil {
    * @param cls Type to store for
    * @param item Item to store
    */
-  static async preStore<T extends ModelType>(cls: Class<T>, item: Partial<OptionalId<T>>, idSource: { uuid(): string }): Promise<T> {
+  static async preStore<T extends ModelType>(cls: Class<T>, item: Partial<OptionalId<T>>, idSource: { uuid: ModelUuidGenerator }): Promise<T> {
     if (!item.id) {
       item.id = idSource.uuid();
     }
@@ -77,12 +96,26 @@ export class ModelCrudUtil {
       SchemaRegistry.ensureInstanceTypeField(cls, item);
     }
 
-    await SchemaValidator.validate(cls, item);
-
     if (item.prePersist) {
       await item.prePersist();
     }
 
+    let errors: ValidationError[] = [];
+    try {
+      await SchemaValidator.validate(cls, item);
+    } catch (err) {
+      if (err instanceof ValidationResultError) {
+        errors = err.errors;
+      }
+    }
+
+    if (!idSource.uuid.valid(item.id!)) {
+      errors.push({ kind: 'invalid', path: 'id', value: item.id!, type: 'string', message: `${item.id!} is an invalid value for \`id\`` });
+    }
+
+    if (errors.length) {
+      throw new ValidationResultError(errors);
+    }
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return item as T;
   }

package/src/provider/file.ts

@@ -22,7 +22,6 @@ import { ModelExpiryUtil } from '../internal/service/expiry';
 import { NotFoundError } from '../error/not-found';
 import { ExistsError } from '../error/exists';
 import { StreamModel, STREAMS } from '../internal/service/stream';
-import { ModelUtil } from '../internal/util';
 
 type Suffix = '.bin' | '.meta' | '.json' | '.expires';
 
@@ -38,7 +37,7 @@ export class FileModelConfig {
   cullRate?: number | TimeSpan;
 
   async postConstruct(): Promise<void> {
-    this.folder ??= path.resolve(os.tmpdir(), `trv_file_${RootIndex.mainModule.name.replace(/[^a-z]/ig, '_')}`);
+    this.folder ??= path.resolve(os.tmpdir(), `trv_file_${RootIndex.mainModuleName.replace(/[^a-z]/ig, '_')}`);
   }
 }
 
@@ -60,6 +59,8 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     }
   }
 
+  uuid = ModelCrudUtil.uuidGenerator();
+
   get client(): string {
     return this.config.folder;
   }
@@ -105,10 +106,6 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     return item;
   }
 
-  uuid(): string {
-    return ModelUtil.uuid(32);
-  }
-
   async get<T extends ModelType>(cls: Class<T>, id: string): Promise<T> {
     await this.#find(cls, '.json', id);
 

package/src/provider/memory.ts

@@ -20,7 +20,6 @@ import { ModelIndexedUtil } from '../internal/service/indexed';
 import { ModelStorageUtil } from '../internal/service/storage';
 import { StreamModel, STREAMS } from '../internal/service/stream';
 import { IndexConfig } from '../registry/types';
-import { ModelUtil } from '../internal/util';
 
 const STREAM_META = `${STREAMS}_meta`;
 
@@ -58,6 +57,8 @@ export class MemoryModelService implements ModelCrudSupport, ModelStreamSupport,
     sorted: new Map<string, Map<string, Map<string, number>>>(),
     unsorted: new Map<string, Map<string, Set<string>>>()
   };
+
+  uuid = ModelCrudUtil.uuidGenerator();
   get client(): Map<string, StoreType> { return this.#store; }
 
   constructor(public readonly config: MemoryModelConfig) { }
@@ -168,10 +169,6 @@ export class MemoryModelService implements ModelCrudSupport, ModelStreamSupport,
   }
 
   // CRUD Support
-  uuid(): string {
-    return ModelUtil.uuid(32);
-  }
-
   async get<T extends ModelType>(cls: Class<T>, id: string): Promise<T> {
     const store = this.#getStore(cls);
     if (store.has(id)) {

package/src/service/crud.ts

@@ -2,19 +2,18 @@ import { Class } from '@travetto/base';
 
 import { ModelType, OptionalId } from '../types/model';
 import { ModelBasicSupport } from './basic';
+import { UuidGenerator } from './types';
 
 /**
  * Interface for simple CRUD
- *
  * @concrete ../internal/service/common:ModelCrudSupportTarget
  */
 export interface ModelCrudSupport extends ModelBasicSupport {
 
   /**
-   * Generate a uuid
-   * @param value The optional value to generate a uuid around.  Passing the same value multiple times produces the same output.
+   * Uuid Generator
    */
-  uuid(): string;
+  uuid: UuidGenerator;
 
   /**
    * Update an item

package/src/service/types.ts

@@ -0,0 +1,4 @@
+/**
+ * Model UUID Generator
+ */
+export type ModelUuidGenerator = (() => string) & { valid: (id: string) => boolean };

package/src/internal/util.ts

@@ -1,7 +0,0 @@
-import { Util } from '@travetto/base';
-
-export class ModelUtil {
-  static uuid(len: number = 32): string {
-    return Util.uuid(len);
-  }
-}