@travetto/model 2.0.2 → 2.1.1

package/README.md

@@ -196,7 +196,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#L13) 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#L4)
 
 **Code: ModelType**
 ```typescript
@@ -236,7 +236,7 @@ All fields are optional, but the `id` and `type` are important as those field ty
 |[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#L50)|X|X|X|X|X|X|
-|[FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L48)|X|X| |X|X|X|
+|[FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L47)|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
@@ -375,7 +375,7 @@ export class MemoryPolymorphicSuite extends ModelPolymorphismSuite {
 
 ## CLI - model:export
 
-The module provides the ability to generate an export of the model structure from all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L13)s within the application.  This is useful for being able to generate the appropriate files to manually create the data schemas in production.
+The module provides the ability to generate an export of the model structure from all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L12)s within the application.  This is useful for being able to generate the appropriate files to manually create the data schemas in production.
 
 **Terminal: Running model export**
 ```bash
@@ -390,7 +390,7 @@ Options:
 
 ## CLI - model:install
 
-The module provides the ability to install all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L13)s within the application given the current configuration being targetted.  This is useful for being able to prepare the datastore manually.
+The module provides the ability to install all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L12)s within the application given the current configuration being targetted.  This is useful for being able to prepare the datastore manually.
 
 **Terminal: Running model install**
 ```bash

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/model",
   "displayName": "Data Modeling Support",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -28,13 +28,13 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/di": "^2.0.2",
-    "@travetto/config": "^2.0.2",
-    "@travetto/registry": "^2.0.2",
-    "@travetto/schema": "^2.0.3"
+    "@travetto/di": "^2.1.1",
+    "@travetto/config": "^2.1.1",
+    "@travetto/registry": "^2.1.1",
+    "@travetto/schema": "^2.1.1"
   },
   "optionalPeerDependencies": {
-    "@travetto/cli": "^2.0.2"
+    "@travetto/cli": "^2.1.1"
   },
   "publishConfig": {
     "access": "public"

package/src/internal/service/crud.ts

@@ -1,12 +1,13 @@
 import * as crypto from 'crypto';
 
 import { Class, Util } from '@travetto/base';
-import { SchemaValidator } from '@travetto/schema';
+import { SchemaRegistry, SchemaValidator } 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';
 
 /**
  * Crud utilities
@@ -39,7 +40,7 @@ export class ModelCrudUtil {
 
     const result = ModelRegistry.getBaseModel(cls).from(input as object) as T;
 
-    if (!(result instanceof cls)) {
+    if (!(result instanceof cls || result.constructor.ᚕid === cls.ᚕid)) {
       if (onTypeMismatch === 'notfound') {
         throw new NotFoundError(cls, result.id);
       } else {
@@ -70,7 +71,7 @@ export class ModelCrudUtil {
 
     const config = ModelRegistry.get(item.constructor as Class<T>);
     if (config.subType) { // Subtyping, assign type
-      item.type = config.subType;
+      SchemaRegistry.ensureInstanceTypeField(cls, item);
     }
 
     await SchemaValidator.validate(cls, item);
@@ -96,7 +97,7 @@ export class ModelCrudUtil {
 
     const config = ModelRegistry.get(item.constructor as Class<T>);
     if (config.subType) { // Subtyping, assign type
-      item.type = config.subType;
+      SchemaRegistry.ensureInstanceTypeField(cls, item);
     }
 
     if (view) {
@@ -113,4 +114,13 @@ export class ModelCrudUtil {
 
     return item as T;
   }
+
+  /**
+   * Ensure subtype is not supported
+   */
+  static ensureNotSubType(cls: Class) {
+    if (ModelRegistry.get(cls).subType) {
+      throw new SubTypeNotSupportedError(cls);
+    }
+  }
 }

package/src/provider/file.ts

@@ -1,4 +1,5 @@
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
+import { createReadStream } from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 
@@ -18,7 +19,6 @@ import { ModelCrudUtil } from '../internal/service/crud';
 import { ModelExpiryUtil } from '../internal/service/expiry';
 import { NotFoundError } from '../error/not-found';
 import { ExistsError } from '../error/exists';
-import { SubTypeNotSupportedError } from '../error/invalid-sub-type';
 import { StreamModel, STREAMS } from '../internal/service/stream';
 
 type Suffix = '.bin' | '.meta' | '.json' | '.expires';
@@ -48,8 +48,8 @@ export class FileModelConfig {
 export class FileModelService implements ModelCrudSupport, ModelStreamSupport, ModelExpirySupport, ModelStorageSupport {
 
   private static async * scanFolder(folder: string, suffix: string) {
-    for (const sub of await fs.promises.readdir(folder)) {
-      for (const file of await fs.promises.readdir(PathUtil.resolveUnix(folder, sub))) {
+    for (const sub of await fs.readdir(folder)) {
+      for (const file of await fs.readdir(PathUtil.resolveUnix(folder, sub))) {
         if (file.endsWith(suffix)) {
           yield [file.replace(suffix, ''), PathUtil.resolveUnix(folder, sub, file)] as [id: string, file: string];
         }
@@ -80,7 +80,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
       dir = path.dirname(resolved);
     }
     if (!await FsUtil.exists(dir)) {
-      await fs.promises.mkdir(dir, { recursive: true });
+      await fs.mkdir(dir, { recursive: true });
     }
     return resolved;
   }
@@ -115,7 +115,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(cls, '.json', id);
 
     if (await FsUtil.exists(file)) {
-      const content = await StreamUtil.streamToBuffer(fs.createReadStream(file));
+      const content = await StreamUtil.streamToBuffer(createReadStream(file));
       return this.checkExpiry(cls, await ModelCrudUtil.load(cls, content));
     }
 
@@ -130,7 +130,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(cls, '.json', item.id);
 
     if (await FsUtil.exists(file)) {
-      throw new ExistsError(cls, item.id);
+      throw new ExistsError(cls, item.id!);
     }
 
     return await this.upsert(cls, item);
@@ -142,32 +142,28 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
   }
 
   async upsert<T extends ModelType>(cls: Class<T>, item: OptionalId<T>) {
-    if (ModelRegistry.get(cls).subType) {
-      throw new SubTypeNotSupportedError(cls);
-    }
+    ModelCrudUtil.ensureNotSubType(cls);
     const prepped = await ModelCrudUtil.preStore(cls, item, this);
 
     const file = await this.#resolveName(cls, '.json', item.id);
-    await fs.promises.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
+    await fs.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
 
     return prepped;
   }
 
   async updatePartial<T extends ModelType>(cls: Class<T>, item: Partial<T> & { id: string }, view?: string) {
-    if (ModelRegistry.get(cls).subType) {
-      throw new SubTypeNotSupportedError(cls);
-    }
+    ModelCrudUtil.ensureNotSubType(cls);
     const id = item.id;
     item = await ModelCrudUtil.naivePartialUpdate(cls, item, view, () => this.get(cls, id));
     const file = await this.#resolveName(cls, '.json', item.id);
-    await fs.promises.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
+    await fs.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
 
     return item as T;
   }
 
   async delete<T extends ModelType>(cls: Class<T>, id: string) {
     const file = await this.#find(cls, '.json', id);
-    await fs.promises.unlink(file);
+    await fs.unlink(file);
   }
 
   async * list<T extends ModelType>(cls: Class<T>) {
@@ -187,18 +183,18 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(STREAMS, BIN, location);
     await Promise.all([
       StreamUtil.writeToFile(input, file),
-      fs.promises.writeFile(file.replace(BIN, META), JSON.stringify(meta), 'utf8')
+      fs.writeFile(file.replace(BIN, META), JSON.stringify(meta), 'utf8')
     ]);
   }
 
   async getStream(location: string) {
     const file = await this.#find(STREAMS, BIN, location);
-    return fs.createReadStream(file);
+    return createReadStream(file);
   }
 
   async describeStream(location: string) {
     const file = await this.#find(STREAMS, META, location);
-    const content = await StreamUtil.streamToBuffer(fs.createReadStream(file));
+    const content = await StreamUtil.streamToBuffer(createReadStream(file));
     const text = JSON.parse(content.toString('utf8'));
     return text as StreamMeta;
   }
@@ -207,8 +203,8 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(STREAMS, BIN, location);
     if (await FsUtil.exists(file)) {
       await Promise.all([
-        fs.promises.unlink(file),
-        fs.promises.unlink(file.replace('.bin', META))
+        fs.unlink(file),
+        fs.unlink(file.replace('.bin', META))
       ]);
     } else {
       throw new NotFoundError('Stream', location);
@@ -229,7 +225,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
   // Storage mgmt
   async createStorage() {
     const dir = PathUtil.resolveUnix(this.config.folder, this.config.namespace);
-    await fs.promises.mkdir(dir, { recursive: true });
+    await fs.mkdir(dir, { recursive: true });
   }
 
   async deleteStorage() {

package/src/registry/decorator.ts

@@ -1,5 +1,4 @@
 import { Class } from '@travetto/base';
-import { SchemaRegistry } from '@travetto/schema';
 
 import { ModelType } from '../types/model';
 import { ModelRegistry } from './model';
@@ -15,39 +14,11 @@ export function Model(conf: Partial<ModelOptions<ModelType>> | string = {}) {
     if (typeof conf === 'string') {
       conf = { store: conf };
     }
-
-    // Force registry first, and update with extra information after computing
-    ModelRegistry.register(target, conf);
-
-    const baseModel = ModelRegistry.getBaseModel(target);
-    if (baseModel !== target) { // Subtyping if base isn't self
-      if (conf.subType) {
-        SchemaRegistry.registerSubTypes(target, conf.subType);
-      } else {
-        conf.subType = SchemaRegistry.getSubTypeName(target);
-      }
-    }
     ModelRegistry.register(target, conf);
     return target;
   };
 }
 
-
-/**
- * Base Model decorator, extends `@Schema`
- *
- * @augments `@trv:schema/Schema`
- */
-export function BaseModel(conf: Partial<ModelOptions<ModelType>> | string = {}) {
-  return function <T extends ModelType & { type: string }, U extends Class<T>>(target: U): U {
-    ModelRegistry.register(target, {
-      baseType: true,
-      ...(typeof conf === 'string' ? { store: conf } : conf)
-    });
-    return target;
-  };
-}
-
 /**
  * Defines an index on a model
  */

package/src/registry/model.ts

@@ -51,12 +51,20 @@ class $ModelRegistry extends MetadataRegistry<ModelOptions<ModelType>> {
   }
 
   createPending(cls: Class): Partial<ModelOptions<ModelType>> {
-    return { class: cls, indices: [], autoCreate: true };
+    return { class: cls, indices: [], autoCreate: true, baseType: cls.ᚕabstract };
   }
 
   onInstallFinalize(cls: Class) {
     const config = this.pending.get(cls.ᚕid)! as ModelOptions<ModelType>;
-    delete SchemaRegistry.get(cls).views[AllViewⲐ].schema.id.required; // Allow ids to be optional
+
+    const schema = SchemaRegistry.get(cls);
+    const view = schema.views[AllViewⲐ].schema;
+    delete view.id.required; // Allow ids to be optional
+
+    if ('type' in view && this.getBaseModel(cls) !== cls) {
+      config.subType = schema.subType; // Copy from schema
+      delete view.type.required; // Allow type to be optional
+    }
     return config;
   }
 
@@ -128,7 +136,6 @@ class $ModelRegistry extends MetadataRegistry<ModelOptions<ModelType>> {
         return this.getStore(this.getBaseModel(cls));
       }
 
-
       const name = config.store ?? cls.name.toLowerCase();
 
       const candidates = this.getInitialNameMapping().get(name) || [];

package/src/registry/types.ts

@@ -35,9 +35,9 @@ export class ModelOptions<T extends ModelType = ModelType> {
    */
   store?: string;
   /**
-   * If a sub type, identifier type
+   * If a sub type
    */
-  subType?: string;
+  subType?: boolean;
   /**
    * Is a base type?
    */

package/test-support/polymorphism.ts

@@ -10,9 +10,8 @@ import {
 } from '..';
 import { isIndexedSupported } from '../src/internal/service/common';
 import { ExistsError } from '../src/error/exists';
-import { BaseModel } from '../src/registry/decorator';
 
-@BaseModel()
+@Model({ baseType: true })
 export class Worker {
   id: string;
   type: string;
@@ -41,7 +40,7 @@ export class Engineer extends Worker {
   major: string;
 }
 
-@BaseModel()
+@Model({ baseType: true })
 @Index({
   name: 'worker-name',
   type: 'sorted',

package/test-support/stream.ts

@@ -1,5 +1,6 @@
 import * as assert from 'assert';
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
+import { createReadStream } from 'fs';
 import * as crypto from 'crypto';
 
 import { PathUtil } from '@travetto/boot';
@@ -25,12 +26,12 @@ export abstract class ModelStreamSuite extends BaseModelSuite<ModelStreamSupport
 
   async getStream(resource: string) {
     const file = await ResourceManager.findAbsolute(resource);
-    const stat = await fs.promises.stat(file);
-    const hash = await this.getHash(fs.createReadStream(file));
+    const stat = await fs.stat(file);
+    const hash = await this.getHash(createReadStream(file));
 
     return [
       { size: stat.size, contentType: '', hash, filename: resource },
-      fs.createReadStream(file)
+      createReadStream(file)
     ] as const;
   }