@travetto/model 3.4.5 → 4.0.0-rc.1

package/README.md

@@ -239,7 +239,7 @@ In addition to the provided contracts, the module also provides common utilities
 
 **Code: Memory Service**
 ```typescript
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
 import { StreamUtil, Class, TimeSpan } from '@travetto/base';
 import { DeepPartial } from '@travetto/schema';
 import { Injectable } from '@travetto/di';
@@ -382,7 +382,7 @@ Usage: model:export [options] <provider:string> <models...:string>
 
 Options:
   -e, --env <string>     Application environment
-  -m, --module <string>  Module to run for
+  -m, --module <module>  Module to run for
   -h, --help             display help for command
 
 Providers
@@ -405,7 +405,7 @@ Usage: model:install [options] <provider:string> <models...:string>
 
 Options:
   -e, --env <string>     Application environment
-  -m, --module <string>  Module to run for
+  -m, --module <module>  Module to run for
   -h, --help             display help for command
 
 Providers

package/package.json

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

package/src/internal/service/crud.ts

@@ -1,4 +1,4 @@
-import crypto from 'crypto';
+import crypto from 'node:crypto';
 
 import { Class, ObjectUtil, Util } from '@travetto/base';
 import { SchemaRegistry, SchemaValidator, ValidationError, ValidationResultError } from '@travetto/schema';

package/src/internal/service/expiry.ts

@@ -1,3 +1,5 @@
+import timers from 'node:timers/promises';
+
 import { ShutdownManager, Class, TimeSpan, TimeUtil } from '@travetto/base';
 
 import { ModelRegistry } from '../../registry/model';
@@ -36,16 +38,12 @@ export class ModelExpiryUtil {
       let running = true;
       const cullInterval = TimeUtil.timeToMs(svc.config?.cullRate ?? '10m');
 
-      ShutdownManager.onShutdown(this, {
-        close(cb) {
-          running = false;
-          cb?.();
-        }
-      });
+      ShutdownManager.onGracefulShutdown(async () => { running = false; }, this);
+
       (async (): Promise<void> => {
-        await TimeUtil.wait('1s');  // Wait a second to start culling
+        await timers.setTimeout(1000);  // Wait a second to start culling
         while (running) {
-          await TimeUtil.wait(cullInterval);
+          await timers.setTimeout(cullInterval);
           await Promise.all(cullable.map(cls => svc.deleteExpired(cls)));
         }
       })();

package/src/internal/service/storage.ts

@@ -1,4 +1,4 @@
-import { Class, GlobalEnv } from '@travetto/base';
+import { Class, Env } from '@travetto/base';
 import { SchemaChangeListener } from '@travetto/schema';
 
 import { ModelRegistry } from '../../registry/model';
@@ -13,7 +13,7 @@ export class ModelStorageUtil {
    * Register change listener on startup
    */
   static async registerModelChangeListener(storage: ModelStorageSupport, target?: Class): Promise<void> {
-    if (!GlobalEnv.dynamic || !(storage?.config?.autoCreate ?? GlobalEnv.devMode)) {
+    if (!Env.dynamic || !(storage?.config?.autoCreate ?? !Env.production)) {
       return;
     }
 

package/src/provider/file.ts

@@ -1,11 +1,11 @@
-import fs from 'fs/promises';
-import { createReadStream } from 'fs';
+import fs from 'node:fs/promises';
+import { createReadStream } from 'node:fs';
 
-import os from 'os';
+import os from 'node:os';
 
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
 
-import { path, RootIndex } from '@travetto/manifest';
+import { path, RuntimeContext } from '@travetto/manifest';
 import { StreamUtil, Class, TimeSpan } from '@travetto/base';
 import { Injectable } from '@travetto/di';
 import { Config } from '@travetto/config';
@@ -37,7 +37,7 @@ export class FileModelConfig {
   cullRate?: number | TimeSpan;
 
   async postConstruct(): Promise<void> {
-    this.folder ??= path.resolve(os.tmpdir(), `trv_file_${RootIndex.mainModuleName.replace(/[^a-z]/ig, '_')}`);
+    this.folder ??= path.resolve(os.tmpdir(), `trv_file_${RuntimeContext.main.name.replace(/[^a-z]/ig, '_')}`);
   }
 }
 

package/src/provider/memory.ts

@@ -1,4 +1,4 @@
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
 
 import { StreamUtil, Class, TimeSpan } from '@travetto/base';
 import { DeepPartial } from '@travetto/schema';

package/src/registry/model.ts

@@ -1,4 +1,4 @@
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeIndex } from '@travetto/manifest';
 import { SchemaRegistry } from '@travetto/schema';
 import { MetadataRegistry } from '@travetto/registry';
 import { DependencyRegistry } from '@travetto/di';
@@ -52,7 +52,7 @@ class $ModelRegistry extends MetadataRegistry<ModelOptions<ModelType>> {
   }
 
   createPending(cls: Class): Partial<ModelOptions<ModelType>> {
-    return { class: cls, indices: [], autoCreate: true, baseType: RootIndex.getFunctionMetadata(cls)?.abstract, postLoad: [], prePersist: [] };
+    return { class: cls, indices: [], autoCreate: true, baseType: RuntimeIndex.getFunctionMetadata(cls)?.abstract, postLoad: [], prePersist: [] };
   }
 
   registerDataHandlers(cls: Class, pConfig?: Partial<ModelOptions<ModelType>>): void {

package/src/service/basic.ts

@@ -4,7 +4,7 @@ import { ModelType, OptionalId } from '../types/model';
 /**
  * Interface for basic data interface
  *
- * @concrete ../internal/service/common:ModelBasicSupportTarget
+ * @concrete ../internal/service/common#ModelBasicSupportTarget
  */
 export interface ModelBasicSupport<C = unknown> {
   /**

package/src/service/bulk.ts

@@ -65,7 +65,7 @@ export class BulkProcessError extends AppError {
 /**
  * Determines if model allows for bulk operations
  *
- * @concrete ../internal/service/common:ModelBulkSupportTarget
+ * @concrete ../internal/service/common#ModelBulkSupportTarget
  */
 export interface ModelBulkSupport extends ModelCrudSupport {
   processBulk<T extends ModelType>(cls: Class<T>, operations: BulkOp<T>[]): Promise<BulkResponse>;

package/src/service/crud.ts

@@ -6,7 +6,7 @@ import { ModelBasicSupport } from './basic';
 
 /**
  * Interface for simple CRUD
- * @concrete ../internal/service/common:ModelCrudSupportTarget
+ * @concrete ../internal/service/common#ModelCrudSupportTarget
  */
 export interface ModelCrudSupport extends ModelBasicSupport {
 

package/src/service/expiry.ts

@@ -6,7 +6,7 @@ import { ModelCrudSupport } from './crud';
 /**
  * Support for managing expiration of data
  *
- * @concrete ../internal/service/common:ModelExpirySupportTarget
+ * @concrete ../internal/service/common#ModelExpirySupportTarget
  */
 export interface ModelExpirySupport extends ModelCrudSupport {
   /**

package/src/service/indexed.ts

@@ -7,7 +7,7 @@ import { ModelBasicSupport } from './basic';
 /**
  * Support for simple indexed activity
  *
- * @concrete ../internal/service/common:ModelIndexedSupportTarget
+ * @concrete ../internal/service/common#ModelIndexedSupportTarget
  */
 export interface ModelIndexedSupport extends ModelBasicSupport {
   /**

package/src/service/storage.ts

@@ -10,7 +10,7 @@ import { ModelType } from '../types/model';
  *
  * This is intended to be used during development only for rapid prototyping.
  *
- * @concrete ../internal/service/common:ModelStorageSupportTarget
+ * @concrete ../internal/service/common#ModelStorageSupportTarget
  */
 export interface ModelStorageSupport {
 

package/src/service/stream.ts

@@ -1,4 +1,4 @@
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
 
 export interface StreamMeta {
   /**
@@ -43,7 +43,7 @@ export interface PartialStream {
 /**
  * Support for Streams CRD.  Stream update is not supported.
  *
- * @concrete ../internal/service/common:ModelStreamSupportTarget
+ * @concrete ../internal/service/common#ModelStreamSupportTarget
  */
 export interface ModelStreamSupport {
 

package/support/base-command.ts

@@ -1,4 +1,4 @@
-import { ConsoleManager, defineEnv } from '@travetto/base';
+import { Env } from '@travetto/base';
 import { CliValidationError, CliCommandShape, cliTpl } from '@travetto/cli';
 import { RootRegistry } from '@travetto/registry';
 
@@ -17,7 +17,7 @@ export abstract class BaseModelCommand implements CliCommandShape {
   abstract getOp(): keyof ModelStorageSupport;
 
   preMain(): void {
-    defineEnv({ debug: false });
+    Env.DEBUG.set(false);
   }
 
   async help(): Promise<string[]> {
@@ -36,7 +36,6 @@ export abstract class BaseModelCommand implements CliCommandShape {
   }
 
   async validate(provider: string, models: string[]): Promise<CliValidationError | undefined> {
-    ConsoleManager.setDebug(false);
     await RootRegistry.init();
 
     const candidates = await ModelCandidateUtil.export(this.getOp());

package/support/bin/install.ts

@@ -1,4 +1,4 @@
-import { ShutdownManager, type Class } from '@travetto/base';
+import type { Class } from '@travetto/base';
 import type { ModelStorageSupport } from '@travetto/model/src/service/storage';
 import type { ModelType } from '@travetto/model/src/types/model';
 
@@ -11,6 +11,5 @@ export class ModelInstallUtil {
       console.log('Installing', { name: m.Ⲑid });
       await provider.createModel(m);
     }
-    ShutdownManager.execute(-1); // Release database
   }
 }

package/support/doc.support.tsx

@@ -1,7 +1,7 @@
 /** @jsxImportSource @travetto/doc */
-import { readFileSync } from 'fs';
+import { readFileSync } from 'node:fs';
 
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeIndex } from '@travetto/manifest';
 import { d, c, DocJSXElementByFn, DocJSXElement } from '@travetto/doc';
 import { Config } from '@travetto/config';
 
@@ -16,7 +16,7 @@ export const Links = {
 
 export const ModelTypes = (file: string | Function): DocJSXElement[] => {
   if (typeof file !== 'string') {
-    file = RootIndex.getFunctionMetadata(file)!.source;
+    file = RuntimeIndex.getFunctionMetadata(file)!.source;
   }
   const contents = readFileSync(file, 'utf8');
   const found: DocJSXElementByFn<'CodeLink'>[] = [];

package/support/test/basic.ts

@@ -1,4 +1,4 @@
-import assert from 'assert';
+import assert from 'node:assert';
 
 import { Suite, Test } from '@travetto/test';
 import { ModelCrudSupport, Model, NotFoundError } from '@travetto/model';

package/support/test/bulk.ts

@@ -1,4 +1,4 @@
-import assert from 'assert';
+import assert from 'node:assert';
 
 import { Suite, Test } from '@travetto/test';
 

package/support/test/crud.ts

@@ -1,4 +1,4 @@
-import assert from 'assert';
+import assert from 'node:assert';
 
 import { Suite, Test } from '@travetto/test';
 import { Schema, Text, Precision, } from '@travetto/schema';

package/support/test/expiry.ts

@@ -1,4 +1,5 @@
-import assert from 'assert';
+import assert from 'node:assert';
+import timers from 'node:timers/promises';
 
 import { Suite, Test } from '@travetto/test';
 import { TimeSpan, TimeUnit, TimeUtil } from '@travetto/base';
@@ -22,7 +23,7 @@ export abstract class ModelExpirySuite extends BaseModelSuite<ModelExpirySupport
   delayFactor: number = 1;
 
   async wait(n: number | TimeSpan) {
-    await TimeUtil.wait(TimeUtil.timeToMs(n) * this.delayFactor);
+    await timers.setTimeout(TimeUtil.timeToMs(n) * this.delayFactor);
   }
 
   timeFromNow(v: number | TimeSpan, unit?: TimeUnit) {

package/support/test/indexed.ts

@@ -1,4 +1,4 @@
-import assert from 'assert';
+import assert from 'node:assert';
 
 import { Suite, Test } from '@travetto/test';
 import { Schema } from '@travetto/schema';

package/support/test/polymorphism.ts

@@ -1,5 +1,5 @@
-import assert from 'assert';
-import timers from 'timers/promises';
+import assert from 'node:assert';
+import timers from 'node:timers/promises';
 
 import { Suite, Test } from '@travetto/test';
 import { SubTypeField, Text, TypeMismatchError } from '@travetto/schema';

package/support/test/stream.ts

@@ -1,7 +1,8 @@
-import fs from 'fs/promises';
-import assert from 'assert';
-import crypto from 'crypto';
-import { Readable } from 'stream';
+import fs from 'node:fs/promises';
+import assert from 'node:assert';
+import crypto from 'node:crypto';
+import { Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
 
 import { Suite, Test, TestFixtures } from '@travetto/test';
 import { StreamUtil } from '@travetto/base';
@@ -15,14 +16,9 @@ export abstract class ModelStreamSuite extends BaseModelSuite<ModelStreamSupport
   fixture = new TestFixtures(['@travetto/model']);
 
   async getHash(stream: Readable): Promise<string> {
-    const hash = crypto.createHash('sha1');
-    hash.setEncoding('hex');
-    await new Promise((res, rej) => {
-      stream.on('end', res);
-      stream.on('error', rej);
-      stream.pipe(hash);
-    });
-    return hash.read() as string;
+    const hasher = crypto.createHash('sha1').setEncoding('hex');
+    await pipeline(stream, hasher);
+    return hasher.read().toString();
   }
 
   async getStream(resource: string): Promise<readonly [{ size: number, contentType: string, hash: string, filename: string }, Readable]> {