@travetto/model 3.0.3 → 3.1.0-rc.0

package/README.md

@@ -381,11 +381,20 @@ The module provides the ability to generate an export of the model structure fro
 ```bash
 $ trv model:export --help
 
-Usage:  model:export [options] [provider] [models...]
+Usage: model:export [options] <provider:string> <models...:string>
 
 Options:
-  -e, --env <env>  Application environment
-  -h, --help       display help for command
+  -e, --env <string>     Application environment
+  -m, --module <string>  Module to run for
+  -h, --help             display help for command
+
+Providers
+--------------------
+  * SQL
+
+Models
+--------------------
+  * samplemodel
 ```
 
 ## CLI - model:install
@@ -395,9 +404,19 @@ The module provides the ability to install all the various [@Model](https://gith
 ```bash
 $ trv model:install --help
 
-Usage:  model:install [options] [provider] [models...]
+Usage: model:install [options] <provider:string> <models...:string>
 
 Options:
-  -e, --env <env>  Application environment
-  -h, --help       display help for command
+  -e, --env <string>     Application environment
+  -m, --module <string>  Module to run for
+  -h, --help             display help for command
+
+Providers
+--------------------
+  * Memory
+  * SQL
+
+Models
+--------------------
+  * samplemodel
 ```

package/package.json

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

package/support/base-command.ts

@@ -0,0 +1,61 @@
+import { ConsoleManager, GlobalEnvConfig } from '@travetto/base';
+import { CliValidationError, CliCommandShape, cliTpl } from '@travetto/cli';
+import { RootRegistry } from '@travetto/registry';
+
+import type { ModelStorageSupport } from '../src/service/storage';
+
+import { ModelCandidateUtil } from './bin/candidate';
+
+/**
+ * CLI Entry point for exporting model schemas
+ */
+export abstract class BaseModelCommand implements CliCommandShape {
+
+  /** Application Environment */
+  env?: string;
+
+  abstract getOp(): keyof ModelStorageSupport;
+
+  envInit(): GlobalEnvConfig {
+    return { debug: false };
+  }
+
+  async help(): Promise<string[]> {
+    await RootRegistry.init();
+
+    const candidates = await ModelCandidateUtil.export(this.getOp());
+    return [
+      cliTpl`${{ title: 'Providers' }}`,
+      '-'.repeat(20),
+      ...candidates.providers.map(p => cliTpl`  * ${{ type: p }}`),
+      '',
+      cliTpl`${{ title: 'Models' }}`,
+      '-'.repeat(20),
+      ...candidates.models.map(p => cliTpl`  * ${{ param: p }}`)
+    ];
+  }
+
+  async validate(provider: string, models: string[]): Promise<CliValidationError | undefined> {
+    ConsoleManager.setDebug(false);
+    await RootRegistry.init();
+
+    const candidates = await ModelCandidateUtil.export(this.getOp());
+    if (!candidates.providers.includes(provider)) {
+      return {
+        message: `${provider} is not a valid provider`,
+        path: 'provider',
+        kind: 'invalid'
+      };
+    }
+    const badModel = models.find(x => x !== '*' && !candidates.models.includes(x));
+    if (badModel) {
+      return {
+        message: `${badModel} is not a valid model`,
+        path: 'models',
+        kind: 'invalid'
+      };
+    }
+  }
+
+  abstract main(...args: unknown[]): ReturnType<CliCommandShape['main']>;
+}

package/support/bin/candidate.ts

@@ -1,24 +1,21 @@
-import { RootIndex } from '@travetto/manifest';
-import { Class, ExecUtil } from '@travetto/base';
-import { GlobalTerminal } from '@travetto/terminal';
-import { ModelRegistry } from '@travetto/model';
+import { Class } from '@travetto/base';
+import { ModelRegistry } from '@travetto/model/src/registry/model';
 import { InjectableConfig, DependencyRegistry } from '@travetto/di';
-import { RootRegistry } from '@travetto/registry';
-
 import { ModelStorageSupportTarget } from '@travetto/model/src/internal/service/common';
 
 import type { ModelStorageSupport } from '../../src/service/storage';
 import type { ModelType } from '../../src/types/model';
 
-type CandidateNames = { providers: string[], models: string[] };
-
 /**
  * Utilities for finding candidates for model operations
  */
 export class ModelCandidateUtil {
 
   static async export(op: keyof ModelStorageSupport): Promise<{ models: string[], providers: string[] }> {
-    return { models: await this.getModelNames(), providers: await this.getProviderNames(op) };
+    return {
+      models: await this.getModelNames(),
+      providers: await this.getProviderNames(op)
+    };
   }
 
   /**
@@ -65,17 +62,6 @@ export class ModelCandidateUtil {
     return DependencyRegistry.getInstance<ModelStorageSupport>(config.class, config.qualifier);
   }
 
-  /**
-   * Get candidates asynchronously
-   * @returns
-   */
-  static async getCandidates(op: keyof ModelStorageSupport): Promise<CandidateNames> {
-    return GlobalTerminal.withWaiting('Resolving', ExecUtil.worker<CandidateNames>(
-      RootIndex.resolveFileImport('@travetto/cli/support/entry.cli'),
-      ['main', '@travetto/model/support/bin/candidate.ts', op]
-    ).message);
-  }
-
   /**
    * Get resolved instances/classes/configs
    * @param provider
@@ -88,12 +74,4 @@ export class ModelCandidateUtil {
       models: await this.#getModels(models)
     };
   }
-}
-
-/**
- * Handles direct invocation
- */
-export async function main(op: keyof ModelStorageSupport): Promise<{ models: string[], providers: string[] }> {
-  await RootRegistry.init();
-  return await ModelCandidateUtil.export(op);
 }

package/support/cli.model_export.ts

@@ -1,33 +1,19 @@
-import { ConsoleManager } from '@travetto/base';
-import { RootRegistry } from '@travetto/registry';
+import { CliCommand } from '@travetto/cli';
 
-import { BaseModelCommand } from './cli.base-command';
+import { BaseModelCommand } from './base-command';
 import { ModelExportUtil } from './bin/export';
+import { ModelCandidateUtil } from './bin/candidate';
 
 /**
- * CLI Entry point for exporting model schemas
+ * Exports model schemas
  */
+@CliCommand({ fields: ['env', 'module'] })
 export class ModelExportCommand extends BaseModelCommand {
-  name = 'model:export';
-  op = 'exportModel' as const;
 
-  async action(provider: string, models: string[]): Promise<void> {
-    try {
-      ConsoleManager.setDebug(false);
-      await RootRegistry.init();
+  getOp(): 'exportModel' { return 'exportModel'; }
 
-      if (!await this.validate(provider, models)) {
-        return this.exit(1);
-      }
-
-      const resolved = await this.resolve(provider, models);
-      await ModelExportUtil.run(resolved.provider, resolved.models);
-    } catch (err) {
-      if (err instanceof Error) {
-        console.error(err.message);
-      } else {
-        console.error((err && err instanceof Error) ? err.message : err);
-      }
-    }
+  async main(provider: string, models: string[]): Promise<void> {
+    const resolved = await ModelCandidateUtil.resolve(provider, models);
+    await ModelExportUtil.run(resolved.provider, resolved.models);
   }
 }

package/support/cli.model_install.ts

@@ -1,31 +1,20 @@
-import { cliTpl } from '@travetto/cli';
-import { ConsoleManager } from '@travetto/base';
-import { RootRegistry } from '@travetto/registry';
+import { CliCommand, cliTpl } from '@travetto/cli';
 
-import { BaseModelCommand } from './cli.base-command';
+import { BaseModelCommand } from './base-command';
 import { ModelInstallUtil } from './bin/install';
+import { ModelCandidateUtil } from './bin/candidate';
 
 /**
- * CLI Entry point for installing models
+ * Installing models
  */
+@CliCommand({ fields: ['env', 'module'] })
 export class ModelInstallCommand extends BaseModelCommand {
-  name = 'model:install';
-  op = 'createModel' as const;
 
-  async action(provider: string, models: string[]): Promise<void> {
-    try {
-      ConsoleManager.setDebug(false);
-      await RootRegistry.init();
+  getOp(): 'createModel' { return 'createModel'; }
 
-      if (!await this.validate(provider, models)) {
-        return this.exit(1);
-      }
-
-      const resolved = await this.resolve(provider, models);
-      await ModelInstallUtil.run(resolved.provider, resolved.models);
-      console.log(cliTpl`${{ success: 'Successfully' }} installed ${{ param: models.length.toString() }} model(s)`);
-    } catch (err) {
-      console.error((err && err instanceof Error) ? err.message : err);
-    }
+  async main(provider: string, models: string[]): Promise<void> {
+    const resolved = await ModelCandidateUtil.resolve(provider, models);
+    await ModelInstallUtil.run(resolved.provider, resolved.models);
+    console.log(cliTpl`${{ success: 'Successfully' }} installed ${{ param: models.length.toString() }} model(s)`);
   }
 }

package/support/cli.base-command.ts

@@ -1,54 +0,0 @@
-import { CliCommand, cliTpl, OptionConfig } from '@travetto/cli';
-import type { ModelStorageSupport } from '@travetto/model/src/service/storage';
-
-import { ModelCandidateUtil } from './bin/candidate';
-
-type Options = {
-  env: OptionConfig<string>;
-};
-
-/**
- * CLI Entry point for exporting model schemas
- */
-export abstract class BaseModelCommand extends CliCommand<Options> {
-
-  restoreEnv?: (err: Error) => unknown;
-
-  op: keyof ModelStorageSupport;
-
-  resolve = ModelCandidateUtil.resolve.bind(ModelCandidateUtil);
-
-  getArgs(): string {
-    return '[provider] [models...]';
-  }
-
-  getOptions(): Options {
-    return { env: this.option({ desc: 'Application environment' }) };
-  }
-
-  usage({ providers, models }: { providers: string[], models: string[] }, err = ''): Promise<void> {
-    return this.showHelp(err, cliTpl`   
-${{ title: 'Providers' }}:
-${providers.map(p => cliTpl`  * ${{ type: p }}`).join('\n')}
-
-${{ title: 'Models' }}:
-${models.map(p => cliTpl`  * ${{ param: p }}`).join('\n')}
-`, false);
-  }
-
-  async validate(provider: string, models: string[]): Promise<true | void> {
-    const candidates = await ModelCandidateUtil.getCandidates(this.op);
-    if (!provider) {
-      return this.usage(candidates);
-    } else {
-      if (!candidates.providers.includes(provider)) {
-        return this.usage(candidates, cliTpl`${{ param: provider }} is not a valid provider`);
-      }
-      const badModel = models.find(x => x !== '*' && !candidates.models.includes(x));
-      if (badModel) {
-        return this.usage(candidates, cliTpl`${{ param: badModel }} is not a valid model`);
-      }
-    }
-    return true;
-  }
-}