@travetto/model 3.1.1 → 3.1.3

package/README.md

@@ -60,9 +60,9 @@ The [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/servi
 export interface ModelCrudSupport extends ModelBasicSupport {
 
   /**
-   * Uuid Generator
+   * Id Source
    */
-  uuid: UuidGenerator;
+  idSource: ModelIdSource;
 
   /**
    * Update an item
@@ -195,7 +195,7 @@ export interface ModelBulkSupport extends ModelCrudSupport {
 ```
 
 ## Declaration
-Models are declared via the [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L12) decorator, which allows the system to know that this is a class that is compatible with the module.  The only requirement for a model is the [ModelType](https://github.com/travetto/travetto/tree/main/module/model/src/types/model.ts#L4)
+Models are declared via the [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L12) decorator, which allows the system to know that this is a class that is compatible with the module.  The only requirement for a model is the [ModelType](https://github.com/travetto/travetto/tree/main/module/model/src/types/model.ts#L9)
 
 **Code: ModelType**
 ```typescript
@@ -289,7 +289,7 @@ 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();
+  idSource = ModelCrudUtil.uuidSource();
   get client(): Map<string, StoreType>;
   constructor(public readonly config: MemoryModelConfig) { }
   async postConstruct(): Promise<void>;

package/__index__.ts

@@ -9,7 +9,6 @@ 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.1",
+  "version": "3.1.3",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",

package/src/internal/service/bulk.ts

@@ -1,9 +1,8 @@
 import { Class } from '@travetto/base';
 
 import { BulkOp } from '../../service/bulk';
-import { ModelUuidGenerator } from '../../service/types';
 import { ModelType } from '../../types/model';
-import { ModelCrudUtil } from './crud';
+import { ModelCrudProvider, ModelCrudUtil } from './crud';
 
 export type BulkPreStore<T extends ModelType> = {
   insertedIds: Map<number, string>;
@@ -18,9 +17,9 @@ export class ModelBulkUtil {
    * Prepares bulk ops for storage
    * @param cls
    * @param operations
-   * @param idSource
+   * @param provider
    */
-  static async preStore<T extends ModelType>(cls: Class<T>, operations: BulkOp<T>[], idSource: { uuid: ModelUuidGenerator }): Promise<BulkPreStore<T>> {
+  static async preStore<T extends ModelType>(cls: Class<T>, operations: BulkOp<T>[], provider: ModelCrudProvider): Promise<BulkPreStore<T>> {
     const insertedIds = new Map<number, string>();
     const upsertedIds = new Map<number, string>();
     const updatedIds = new Map<number, string>();
@@ -30,14 +29,14 @@ export class ModelBulkUtil {
     let i = 0;
     for (const op of operations) {
       if ('insert' in op && op.insert) {
-        op.insert = await ModelCrudUtil.preStore(cls, op.insert, idSource);
+        op.insert = await ModelCrudUtil.preStore(cls, op.insert, provider);
         insertedIds.set(i, op.insert.id!);
       } else if ('update' in op && op.update) {
-        op.update = await ModelCrudUtil.preStore(cls, op.update, idSource);
+        op.update = await ModelCrudUtil.preStore(cls, op.update, provider);
         updatedIds.set(i, op.update.id);
       } else if ('upsert' in op && op.upsert) {
         const isNew = !op.upsert.id;
-        op.upsert = await ModelCrudUtil.preStore(cls, op.upsert, idSource);
+        op.upsert = await ModelCrudUtil.preStore(cls, op.upsert, provider);
         if (isNew) {
           upsertedIds.set(i, op.upsert.id!);
         } else {

package/src/internal/service/crud.ts

@@ -4,11 +4,14 @@ 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 { 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 { ModelUuidGenerator } from '../../service/types';
+
+export type ModelCrudProvider = {
+  idSource: ModelIdSource;
+};
 
 /**
  * Crud utilities
@@ -18,19 +21,10 @@ 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;
-    }
+  static uuidSource(len: number = 32): ModelIdSource {
+    const create = (): string => Util.uuid(len);
+    const valid = (id: string): boolean => id.length === len && /^[0-9a-f]+$/i.test(id);
+    return { create, valid };
   }
 
   /**
@@ -80,9 +74,9 @@ 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: ModelUuidGenerator }): Promise<T> {
+  static async preStore<T extends ModelType>(cls: Class<T>, item: Partial<OptionalId<T>>, provider: ModelCrudProvider): Promise<T> {
     if (!item.id) {
-      item.id = idSource.uuid();
+      item.id = provider.idSource.create();
     }
 
     if (ObjectUtil.isPlainObject(item)) {
@@ -109,7 +103,7 @@ export class ModelCrudUtil {
       }
     }
 
-    if (!idSource.uuid.valid(item.id!)) {
+    if (!provider.idSource.valid(item.id!)) {
       errors.push({ kind: 'invalid', path: 'id', value: item.id!, type: 'string', message: `${item.id!} is an invalid value for \`id\`` });
     }
 

package/src/provider/file.ts

@@ -59,7 +59,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     }
   }
 
-  uuid = ModelCrudUtil.uuidGenerator();
+  idSource = ModelCrudUtil.uuidSource();
 
   get client(): string {
     return this.config.folder;
@@ -121,7 +121,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
 
   async create<T extends ModelType>(cls: Class<T>, item: OptionalId<T>): Promise<T> {
     if (!item.id) {
-      item.id = this.uuid();
+      item.id = this.idSource.create();
     }
 
     const file = await this.#resolveName(cls, '.json', item.id);

package/src/provider/memory.ts

@@ -58,7 +58,7 @@ export class MemoryModelService implements ModelCrudSupport, ModelStreamSupport,
     unsorted: new Map<string, Map<string, Set<string>>>()
   };
 
-  uuid = ModelCrudUtil.uuidGenerator();
+  idSource = ModelCrudUtil.uuidSource();
   get client(): Map<string, StoreType> { return this.#store; }
 
   constructor(public readonly config: MemoryModelConfig) { }
@@ -188,7 +188,7 @@ export class MemoryModelService implements ModelCrudSupport, ModelStreamSupport,
 
   async create<T extends ModelType>(cls: Class<T>, item: OptionalId<T>): Promise<T> {
     if (!item.id) {
-      item.id = this.uuid();
+      item.id = this.idSource.create();
     }
     this.#find(cls, item.id, 'data');
     return await this.upsert(cls, item);

package/src/service/crud.ts

@@ -1,8 +1,8 @@
 import { Class } from '@travetto/base';
 
-import { ModelType, OptionalId } from '../types/model';
+import { ModelType, OptionalId, ModelIdSource } from '../types/model';
+
 import { ModelBasicSupport } from './basic';
-import { UuidGenerator } from './types';
 
 /**
  * Interface for simple CRUD
@@ -11,9 +11,9 @@ import { UuidGenerator } from './types';
 export interface ModelCrudSupport extends ModelBasicSupport {
 
   /**
-   * Uuid Generator
+   * Id Source
    */
-  uuid: UuidGenerator;
+  idSource: ModelIdSource;
 
   /**
    * Update an item

package/src/types/model.ts

@@ -1,3 +1,8 @@
+/**
+ * Model Id Source
+ */
+export type ModelIdSource = { create: () => string, valid: (id: string) => boolean };
+
 /**
  * Simple model interface
  */

package/support/test/basic.ts

@@ -21,7 +21,7 @@ export abstract class ModelBasicSuite extends BaseModelSuite<ModelCrudSupport> {
     const service = await this.service;
 
     const person = Person.from({
-      id: service.uuid(),
+      id: service.idSource.create(),
       name: 'Bob',
       age: 25,
       gender: 'm'
@@ -34,7 +34,7 @@ export abstract class ModelBasicSuite extends BaseModelSuite<ModelCrudSupport> {
     assert(single.age === 25);
 
     await assert.rejects(async () => {
-      await service.get(Person, service.uuid());
+      await service.get(Person, service.idSource.create());
     }, NotFoundError);
 
     await service.delete(Person, person.id);
@@ -50,7 +50,7 @@ export abstract class ModelBasicSuite extends BaseModelSuite<ModelCrudSupport> {
     const service = await this.service;
 
     const { id } = await service.create(Person, {
-      id: service.uuid(),
+      id: service.idSource.create(),
       name: 'Bob',
       age: 25,
       gender: 'm'

package/support/test/bulk.ts

@@ -46,7 +46,7 @@ export abstract class ModelBulkSuite extends BaseModelSuite<ModelBulkSupport> {
   @Test()
   async bulkUpdate() {
     const service = await this.service;
-    const users = [0, 1, 2, 4].map(x => User.from({ name: `name-${x}`, id: service.uuid() }));
+    const users = [0, 1, 2, 4].map(x => User.from({ name: `name-${x}`, id: service.idSource.create() }));
 
     const res = await service.processBulk(User, users.map(u => ({ insert: u })));
     assert(res.counts.insert === 4);
@@ -60,7 +60,7 @@ export abstract class ModelBulkSuite extends BaseModelSuite<ModelBulkSupport> {
   @Test()
   async bulkDelete() {
     const service = await this.service;
-    const users = [0, 1, 2, 4].map(x => User.from({ name: `name-${x}`, id: service.uuid() }));
+    const users = [0, 1, 2, 4].map(x => User.from({ name: `name-${x}`, id: service.idSource.create() }));
 
     const res = await service.processBulk(User, users.map(u => ({ insert: u })));
     assert(res.counts.insert === 4);

package/support/test/crud.ts

@@ -62,7 +62,7 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     const service = await this.service;
 
     const people = [1, 2, 3, 8].map(x => Person.from({
-      id: service.uuid(),
+      id: service.idSource.create(),
       name: 'Bob',
       age: 20 + x,
       gender: 'm',
@@ -81,7 +81,7 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     assert(single.age === 23);
 
     await assert.rejects(async () => {
-      await service.get(Person, service.uuid());
+      await service.get(Person, service.idSource.create());
     }, NotFoundError);
   }
 
@@ -203,7 +203,7 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     const service = await this.service;
 
     const people = [1, 2, 3].map(x => Person.from({
-      id: service.uuid(),
+      id: service.idSource.create(),
       name: 'Bob',
       age: 20 + x,
       gender: 'm',

package/src/service/types.ts

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