@travetto/model 7.0.0-rc.2 → 7.0.0-rc.4

package/package.json

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

package/src/error/exists.ts

@@ -5,6 +5,9 @@ import { Class, AppError } from '@travetto/runtime';
  */
 export class ExistsError extends AppError {
   constructor(cls: Class | string, id: string) {
-    super(`${typeof cls === 'string' ? cls : cls.name} with id ${id} already exists`, { category: 'data' });
+    super(`${typeof cls === 'string' ? cls : cls.name} with id ${id} already exists`, {
+      category: 'data',
+      details: { id, type: typeof cls === 'string' ? cls : cls.name }
+    });
   }
 }

package/src/registry/registry-adapter.ts

@@ -12,6 +12,9 @@ function combineClasses(target: ModelConfig, sources: Partial<ModelConfig>[]): M
       prePersist: [...(target.prePersist || []), ...(source.prePersist || [])],
     });
   }
+  if (target.store) {
+    target.store = target.store.toLowerCase().replace(/[^A-Za-z0-9_]+/g, '_');
+  }
   return target;
 }
 
@@ -27,8 +30,8 @@ export class ModelRegistryAdapter implements RegistryAdapter<ModelConfig> {
     const config = this.#config ??= {
       class: this.#cls,
       indices: [],
-      autoCreate: true,
-      store: this.#cls.name.toLowerCase(),
+      autoCreate: 'development',
+      store: this.#cls.name,
       postLoad: [],
       prePersist: []
     };

package/src/registry/registry-index.ts

@@ -1,4 +1,4 @@
-import { ChangeEvent, RegistryIndex, RegistryIndexStore, Registry } from '@travetto/registry';
+import { RegistryIndex, RegistryIndexStore, Registry } from '@travetto/registry';
 import { AppError, castTo, Class } from '@travetto/runtime';
 import { SchemaRegistryIndex } from '@travetto/schema';
 
@@ -58,7 +58,9 @@ export class ModelRegistryIndex implements RegistryIndex {
 
   store = new RegistryIndexStore(ModelRegistryAdapter);
 
-  #addClass(cls: Class): void {
+  /** @private */ constructor(source: unknown) { Registry.validateConstructor(source); }
+
+  onCreate(cls: Class): void {
     const schema = SchemaRegistryIndex.getConfig(cls);
 
     // Don't index on discriminated schemas
@@ -81,22 +83,6 @@ export class ModelRegistryIndex implements RegistryIndex {
     }
   }
 
-  #removeClass(cls: Class): void {
-    const { store } = this.store.get(cls).get();
-    this.#modelNameMapping.get(store)?.delete(cls.Ⲑid);
-  }
-
-  process(events: ChangeEvent<Class>[]): void {
-    for (const event of events) {
-      if ('previous' in event) {
-        this.#removeClass(event.previous);
-      }
-      if ('current' in event) {
-        this.#addClass(event.current);
-      }
-    }
-  }
-
   getConfig(cls: Class): ModelConfig<ModelType> {
     return this.store.get(cls).get();
   }

package/src/registry/types.ts

@@ -41,9 +41,9 @@ export class ModelConfig<T extends ModelType = ModelType> {
    */
   expiresAt?: string;
   /**
-   * Auto create in development mode
+   * Allows auto creation of a model storage backing at runtime
    */
-  autoCreate?: boolean;
+  autoCreate?: 'production' | 'development' | 'off';
   /**
    * Pre-persist handlers
    */

package/src/types/storage.ts

@@ -1,5 +1,4 @@
 import { Class } from '@travetto/runtime';
-import { SchemaChange } from '@travetto/schema';
 
 import { ModelType } from '../types/model.ts';
 
@@ -15,10 +14,10 @@ import { ModelType } from '../types/model.ts';
 export interface ModelStorageSupport {
 
   /**
-   * Should auto-creation be allowed
+   * Should storage modification be allowed
    */
   readonly config?: {
-    autoCreate?: boolean;
+    modifyStorage?: boolean;
   };
 
   /**
@@ -30,29 +29,21 @@ export interface ModelStorageSupport {
    */
   deleteStorage(): Promise<void>;
   /**
-   * Installs model
+   * Creates model
    */
-  createModel?<T extends ModelType>(cls: Class<T>): Promise<void>;
+  upsertModel?<T extends ModelType>(cls: Class<T>): Promise<void>;
   /**
-   * Installs model
+   * Exports model
    */
   exportModel?<T extends ModelType>(cls: Class<T>): Promise<string>;
   /**
-   * Installs model
+   * Deletes model
    */
   deleteModel?<T extends ModelType>(cls: Class<T>): Promise<void>;
   /**
    * Removes all data from a model, but leaving the structure in place
    */
   truncateModel?<T extends ModelType>(cls: Class<T>): Promise<void>;
-  /**
-   * Deals with model internals changing
-   */
-  changeModel?<T extends ModelType>(cls: Class<T>): Promise<void>;
-  /**
-   * An event listener for whenever a model schema is changed
-   */
-  changeSchema?(cls: Class, changes: SchemaChange): Promise<void>;
   /**
    * Truncate blob storage data
    */

package/src/util/crud.ts

@@ -1,4 +1,4 @@
-import { castTo, Class, Util, AppError, hasFunction } from '@travetto/runtime';
+import { castTo, Class, Util, AppError, hasFunction, JSONUtil } from '@travetto/runtime';
 import { DataUtil, SchemaRegistryIndex, SchemaValidator, ValidationError, ValidationResultError } from '@travetto/schema';
 
 import { ModelRegistryIndex } from '../registry/registry-index.ts';
@@ -39,10 +39,8 @@ export class ModelCrudUtil {
    */
   static async load<T extends ModelType>(cls: Class<T>, input: Buffer | string | object, onTypeMismatch: 'notfound' | 'exists' = 'notfound'): Promise<T> {
     let resolvedInput: object;
-    if (typeof input === 'string') {
-      resolvedInput = JSON.parse(input);
-    } else if (input instanceof Buffer) {
-      resolvedInput = JSON.parse(input.toString('utf8'));
+    if (typeof input === 'string' || input instanceof Buffer) {
+      resolvedInput = JSONUtil.parseSafe(input);
     } else {
       resolvedInput = input;
     }

package/src/util/storage.ts

@@ -1,6 +1,5 @@
 import { Class, hasFunction, Runtime } from '@travetto/runtime';
-import { SchemaChangeListener, SchemaRegistryIndex } from '@travetto/schema';
-import { Registry } from '@travetto/registry';
+import { SchemaRegistryIndex } from '@travetto/schema';
 
 import { ModelStorageSupport } from '../types/storage.ts';
 import { ModelRegistryIndex } from '../registry/registry-index.ts';
@@ -16,10 +15,10 @@ export class ModelStorageUtil {
   static isSupported = hasFunction<ModelStorageSupport>('createStorage');
 
   /**
-   * Register change listener on startup
+   * Storage Initialization
    */
-  static async registerModelChangeListener(storage: ModelStorageSupport): Promise<void> {
-    if (!Runtime.dynamic || !(storage?.config?.autoCreate ?? !Runtime.production)) {
+  static async storageInitialization(storage: ModelStorageSupport): Promise<void> {
+    if (storage.config?.modifyStorage === false) {
       return;
     }
 
@@ -27,39 +26,25 @@ export class ModelStorageUtil {
       if (enforceBase && SchemaRegistryIndex.getBaseClass(cls) !== cls) {
         return false;
       }
+
       const { autoCreate } = ModelRegistryIndex.getConfig(cls) ?? {};
-      return autoCreate ?? false;
-    };
 
-    // If listening for model add/removes/updates
-    if (storage.createModel || storage.deleteModel || storage.changeModel) {
-      Registry.onClassChange(event => {
-        switch (event.type) {
-          case 'added': checkType(event.current) ? storage.createModel?.(event.current) : undefined; break;
-          case 'changed': checkType(event.current, false) ? storage.changeModel?.(event.current) : undefined; break;
-          case 'removing': checkType(event.previous) ? storage.deleteModel?.(event.previous) : undefined; break;
-        }
-      }, ModelRegistryIndex);
-    }
+      if (autoCreate === 'off') {
+        return false;
+      }
+
+      return (autoCreate === 'production' || !Runtime.production);
+    };
 
     // Initialize on startup (test manages)
     await storage.createStorage();
 
-    if (storage.createModel) {
+    if (storage.upsertModel) {
       for (const cls of ModelRegistryIndex.getClasses()) {
         if (checkType(cls)) {
-          await storage.createModel(cls);
+          await storage.upsertModel(cls);
         }
       }
     }
-
-    // If listening for model add/removes/updates
-    if (storage.changeSchema) {
-      SchemaChangeListener.onSchemaChange(event => {
-        if (checkType(event.cls)) {
-          storage.changeSchema!(event.cls, event.change);
-        }
-      });
-    }
   }
 }

package/support/bin/install.ts

@@ -3,12 +3,12 @@ import type { ModelStorageSupport, ModelType } from '@travetto/model';
 
 export class ModelInstallUtil {
   static async run(provider: ModelStorageSupport, models: Class<ModelType>[]): Promise<void> {
-    if (!provider.createModel) {
+    if (!provider.upsertModel) {
       throw new Error(`${provider} does not support model installation`);
     }
     for (const cls of models) {
       console.log('Installing', { name: cls.Ⲑid });
-      await provider.createModel(cls);
+      await provider.upsertModel(cls);
     }
   }
 }

package/support/cli.model_install.ts

@@ -10,7 +10,7 @@ import { ModelCandidateUtil } from './bin/candidate.ts';
 @CliCommand({ with: { env: true, module: true } })
 export class ModelInstallCommand extends BaseModelCommand {
 
-  getOperation(): 'createModel' { return 'createModel'; }
+  getOperation(): 'upsertModel' { return 'upsertModel'; }
 
   async main(provider: string, models: string[]): Promise<void> {
     const resolved = await ModelCandidateUtil.resolve(provider, models);

package/support/test/suite.ts

@@ -39,10 +39,10 @@ export function ModelSuite<T extends { configClass: Class<{ autoCreate?: boolean
           const service = await DependencyRegistryIndex.getInstance(this.serviceClass, qualifier);
           if (ModelStorageUtil.isSupported(service)) {
             await service.createStorage();
-            if (service.createModel) {
+            if (service.upsertModel) {
               await Promise.all(ModelRegistryIndex.getClasses()
                 .filter(x => x === SchemaRegistryIndex.getBaseClass(x))
-                .map(m => service.createModel!(m)));
+                .map(m => service.upsertModel!(m)));
             }
           }
         }