@travetto/model 8.0.0-alpha.15 → 8.0.0-alpha.17

package/README.md

@@ -76,7 +76,7 @@ export interface ModelBasicSupport<C = unknown> {
 ```
 
 ### CRUD
-The [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11) contract, builds upon the basic contract, and is built around the idea of simple data retrieval and storage, to create a foundation for other services that need only basic support.  The model extension in [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework"), is an example of a module that only needs create, read and delete, and so any implementation of [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") that honors this contract, can be used with the [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework") model extension.
+The [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11) contract, builds upon the basic contract, and is built around the idea of simple data retrieval and storage, to create a foundation for other services that need only basic support.  The model extension in [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication support for the Travetto framework"), is an example of a module that only needs create, read and delete, and so any implementation of [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") that honors this contract, can be used with the [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication support for the Travetto framework") model extension.
 
 **Code: Crud Contract**
 ```typescript
@@ -312,12 +312,18 @@ export abstract class BaseModelSuite<T> {
 ## 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#L14)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**
+**Terminal: Help for model:export**
 ```bash
 $ trv model:export --help
 
 Usage: model:export [options] <provider:string> <models...:string>
 
+Export model definitions for a selected provider and model set.
+
+The command resolves candidate models and delegates to provider-specific
+export logic to produce schema/install artifacts.
+Example Usage:
+
 Options:
   -p, --profile <string>  Application profiles
   -m, --module <module>   Module to run for
@@ -335,12 +341,18 @@ Models
 ## 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#L14)s within the application given the current configuration being targeted.  This is useful for being able to prepare the datastore manually.
 
-**Terminal: Running model install**
+**Terminal: Help for model:install**
 ```bash
 $ trv model:install --help
 
 Usage: model:install [options] <provider:string> <models...:string>
 
+Install or update model definitions for a selected provider.
+
+The command resolves candidate models and applies provider install/upsert
+operations so backing stores are prepared for runtime usage.
+Example Usage:
+
 Options:
   -p, --profile <string>  Application profiles
   -m, --module <module>   Module to run for

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model",
-  "version": "8.0.0-alpha.15",
+  "version": "8.0.0-alpha.17",
   "type": "module",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
@@ -27,14 +27,14 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/config": "^8.0.0-alpha.15",
-    "@travetto/di": "^8.0.0-alpha.14",
-    "@travetto/registry": "^8.0.0-alpha.14",
-    "@travetto/schema": "^8.0.0-alpha.15"
+    "@travetto/config": "^8.0.0-alpha.17",
+    "@travetto/di": "^8.0.0-alpha.16",
+    "@travetto/registry": "^8.0.0-alpha.16",
+    "@travetto/schema": "^8.0.0-alpha.17"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.20",
-    "@travetto/test": "^8.0.0-alpha.14"
+    "@travetto/cli": "^8.0.0-alpha.22",
+    "@travetto/test": "^8.0.0-alpha.16"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/types/basic.ts

@@ -1,5 +1,5 @@
 import type { Class } from '@travetto/runtime';
-import type { ModelIdSource, ModelType, OptionalId } from '../types/model.ts';
+import type { ModelIdSource, ModelType, OptionalId } from './model.ts';
 
 /**
  * Interface for basic data interface

package/src/types/bulk.ts

@@ -2,7 +2,7 @@ import { type Class, RuntimeError } from '@travetto/runtime';
 import type { ValidationError, ValidationResultError } from '@travetto/schema';
 
 import type { ModelCrudSupport } from './crud.ts';
-import type { ModelType, OptionalId } from '../types/model.ts';
+import type { ModelType, OptionalId } from './model.ts';
 
 /**
  * Bulk operation. Each operation has a single action and payload

package/src/types/crud.ts

@@ -1,6 +1,6 @@
 import type { Class } from '@travetto/runtime';
 
-import type { ModelListOptions, ModelType, OptionalId } from '../types/model.ts';
+import type { ModelListOptions, ModelType, OptionalId } from './model.ts';
 
 import type { ModelBasicSupport } from './basic.ts';
 

package/src/types/expiry.ts

@@ -1,6 +1,6 @@
 import type { Class } from '@travetto/runtime';
 
-import type { ModelType } from '../types/model.ts';
+import type { ModelType } from './model.ts';
 import type { ModelCrudSupport } from './crud.ts';
 
 /**

package/src/types/storage.ts

@@ -1,6 +1,6 @@
 import type { Class } from '@travetto/runtime';
 
-import type { ModelType } from '../types/model.ts';
+import type { ModelType } from './model.ts';
 
 /**
  * This interface defines the behavior for dealing with the

package/support/cli.model_export.ts

@@ -6,7 +6,10 @@ import { ModelExportUtil } from './bin/export.ts';
 import { ModelCandidateUtil } from './bin/candidate.ts';
 
 /**
- * Exports model schemas
+ * Export model definitions for a selected provider and model set.
+ *
+ * The command resolves candidate models and delegates to provider-specific
+ * export logic to produce schema/install artifacts.
  */
 @CliCommand()
 export class ModelExportCommand extends BaseModelCommand {

package/support/cli.model_install.ts

@@ -6,7 +6,10 @@ import { ModelInstallUtil } from './bin/install.ts';
 import { ModelCandidateUtil } from './bin/candidate.ts';
 
 /**
- * Installing models
+ * Install or update model definitions for a selected provider.
+ *
+ * The command resolves candidate models and applies provider install/upsert
+ * operations so backing stores are prepared for runtime usage.
  */
 @CliCommand()
 export class ModelInstallCommand extends BaseModelCommand {