@travetto/model 3.0.2 → 3.0.3

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Data Modeling Support
+
 ## Datastore abstraction for core operations.
 
 **Install: @travetto/model**
@@ -15,11 +16,10 @@ yarn add @travetto/model
 This module provides a set of contracts/interfaces to data model persistence, modification and retrieval.  This module builds heavily upon the [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding."), which is used for data model validation.
 
 ## Contracts
-
 The module is mainly composed of contracts.  The contracts define the expected interface for various model patterns. The primary contracts are [Basic](https://github.com/travetto/travetto/tree/main/module/model/src/service/basic.ts#L9), [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11), [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/service/indexed.ts#L12), [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11), [Streaming](https://github.com/travetto/travetto/tree/main/module/model/src/service/stream.ts#L3) and [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19).
 
-### [Basic](https://github.com/travetto/travetto/tree/main/module/model/src/service/basic.ts#L9)
-All [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") implementations, must honor the BasicCrud contract to be able to participate in the model ecosystem.  This contract represents the bare minimum for a model service.
+### Basic
+All [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") implementations, must honor the [Basic](https://github.com/travetto/travetto/tree/main/module/model/src/service/basic.ts#L9) contract to be able to participate in the model ecosystem.  This contract represents the bare minimum for a model service.
 
 **Code: Basic Contract**
 ```typescript
@@ -52,8 +52,8 @@ export interface ModelBasicSupport<C = unknown> {
 }
 ```
 
-### [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
-The crud 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.
+### CRUD
+The [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/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.
 
 **Code: Crud Contract**
 ```typescript
@@ -95,9 +95,8 @@ export interface ModelCrudSupport extends ModelBasicSupport {
 }
 ```
 
-### [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/service/indexed.ts#L12)
-Additionally, an implementation may support the ability for basic indexed queries. This is not the full featured query support of [Data Model Querying](https://github.com/travetto/travetto/tree/main/module/model-query#readme "Datastore abstraction for advanced query support."), but
-allowing for indexed lookups.  This does not support listing by index, but may be added at a later date.  
+### Indexed
+Additionally, an implementation may support the ability for basic [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/service/indexed.ts#L12) queries. This is not the full featured query support of [Data Model Querying](https://github.com/travetto/travetto/tree/main/module/model-query#readme "Datastore abstraction for advanced query support."), but allowing for indexed lookups.  This does not support listing by index, but may be added at a later date.
 
 **Code: Indexed Contract**
 ```typescript
@@ -136,9 +135,8 @@ export interface ModelIndexedSupport extends ModelBasicSupport {
 }
 ```
 
-### [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11)
-
-Certain implementations will also provide support for automatic expiry of data at runtime.  This is extremely useful for temporary data as, and is used in the [Caching](https://github.com/travetto/travetto/tree/main/module/cache#readme "Caching functionality with decorators for declarative use.") module for expiring data accordingly.
+### Expiry
+Certain implementations will also provide support for automatic [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11) of data at runtime.  This is extremely useful for temporary data as, and is used in the [Caching](https://github.com/travetto/travetto/tree/main/module/cache#readme "Caching functionality with decorators for declarative use.") module for expiring data accordingly.
 
 **Code: Expiry Contract**
 ```typescript
@@ -152,9 +150,8 @@ export interface ModelExpirySupport extends ModelCrudSupport {
 }
 ```
 
-### [Streaming](https://github.com/travetto/travetto/tree/main/module/model/src/service/stream.ts#L3)
-
-Some implementations also allow for the ability to read/write binary data as a stream.  Given that all implementations can store [Base64](https://en.wikipedia.org/wiki/Base64) encoded data, the key differentiator here, is native support for streaming data, as well as being able to store binary data of significant sizes.  This pattern is currently used by [Asset](https://github.com/travetto/travetto/tree/main/module/asset#readme "Modular library for storing and retrieving binary assets") for reading and writing asset data.
+### Stream
+Some implementations also allow for the ability to read/write binary data as a [Streaming](https://github.com/travetto/travetto/tree/main/module/model/src/service/stream.ts#L3).  Given that all implementations can store [Base64](https://en.wikipedia.org/wiki/Base64) encoded data, the key differentiator here, is native support for streaming data, as well as being able to store binary data of significant sizes.  This pattern is currently used by [Asset](https://github.com/travetto/travetto/tree/main/module/asset#readme "Modular library for storing and retrieving binary assets") for reading and writing asset data.
 
 **Code: Stream Contract**
 ```typescript
@@ -188,9 +185,8 @@ export interface ModelStreamSupport {
 }
 ```
 
-### [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19)
-
-Finally, there is support for bulk operations.  This is not to simply imply issuing many commands at in parallel, but implementation support for an atomic/bulk operation.  This should allow for higher throughput on data ingest, and potentially for atomic support on transactions.  
+### Bulk
+Finally, there is support for [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19) operations.  This is not to simply imply issuing many commands at in parallel, but implementation support for an atomic/bulk operation.  This should allow for higher throughput on data ingest, and potentially for atomic support on transactions.
 
 **Code: Bulk Contract**
 ```typescript
@@ -229,7 +225,6 @@ export interface ModelType {
 All fields are optional, but the `id` and `type` are important as those field types are unable to be changed.  This may make using existing data models impossible if types other than strings are required.  Additionally, the type field, is intended to record the base model type and cannot be remapped. This is important to support polymorphism, not only in [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations."), but also in [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.").
 
 ## Implementations
-
 |Service|Basic|CRUD|Indexed|Expiry|Stream|Bulk|
 |-------|-----|----|-------|------|------|----|
 |[DynamoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-dynamodb#readme "DynamoDB backing for the travetto model module.")|X|X|X|X| | |
@@ -243,8 +238,7 @@ All fields are optional, but the `id` and `type` are important as those field ty
 |[FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L51)|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
-repetitive functionality, that is unable to be shared due to not relying upon inheritance (this was an intentional design decision).  This allows for all the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") implementations to completely own the functionality and also to be able to provide additional/unique functionality that goes beyond the interface.
+In addition to the provided contracts, the module also provides common utilities and shared test suites.  The common utilities are useful for repetitive functionality, that is unable to be shared due to not relying upon inheritance (this was an intentional design decision).  This allows for all the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") implementations to completely own the functionality and also to be able to provide additional/unique functionality that goes beyond the interface.
 
 **Code: Memory Service**
 ```typescript
@@ -381,7 +375,6 @@ 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#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**
@@ -396,7 +389,6 @@ 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#L12)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**

package/package.json

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

package/support/doc.support.tsx

@@ -0,0 +1,46 @@
+/** @jsxImportSource @travetto/doc */
+import { readFileSync } from 'fs';
+
+import { RootIndex } from '@travetto/manifest';
+import { d, c, DocJSXElementByFn, DocJSXElement } from '@travetto/doc';
+import { Config } from '@travetto/config';
+
+export const Links = {
+  Basic: d.codeLink('Basic', '@travetto/model/src/service/basic.ts', /export interface/),
+  Crud: d.codeLink('CRUD', '@travetto/model/src/service/crud.ts', /export interface/),
+  Expiry: d.codeLink('Expiry', '@travetto/model/src/service/expiry.ts', /export interface/),
+  Indexed: d.codeLink('Indexed', '@travetto/model/src/service/indexed.ts', /export interface/),
+  Bulk: d.codeLink('Bulk', '@travetto/model/src/service/bulk.ts', /export interface/),
+  Stream: d.codeLink('Streaming', '@travetto/model/src/service/stream.ts', /export interface/),
+};
+
+export const ModelTypes = (file: string | Function): DocJSXElement[] => {
+  if (typeof file !== 'string') {
+    file = RootIndex.getFunctionMetadata(file)!.source;
+  }
+  const contents = readFileSync(file, 'utf8');
+  const found: DocJSXElementByFn<'CodeLink'>[] = [];
+  const seen = new Set();
+  for (const [, key] of contents.matchAll(/Model(Crud|Expiry|Indexed|Bulk|Stream)Support/g)) {
+    if (!seen.has(key)) {
+      seen.add(key);
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      found.push(Links[key as keyof typeof Links]);
+    }
+  }
+  return found.map(v => <li>{v}</li>);
+};
+
+export const ModelCustomConfig = ({ cfg }: { cfg: Function }): JSXElement => <>
+  Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source
+  or config, you can override and register it with the {d.mod('Di')} module.
+
+  <c.Code title='Wiring up a custom Model Source' src='doc/custom-service.ts' />
+
+  where the {cfg} is defined by:
+
+  <c.Code title={`Structure of ${cfg.name}`} src={cfg} />
+
+  Additionally, you can see that the class is registered with the {Config} annotation, and so these values can be overridden using the
+  standard {d.mod('Config')}resolution paths.
+</>;

package/support/doc.support.ts

@@ -1,46 +0,0 @@
-import { readFileSync } from 'fs';
-
-import { RootIndex } from '@travetto/manifest';
-import { d, mod } from '@travetto/doc';
-import { Config } from '@travetto/config';
-import { AllType, AllTypeMap } from '@travetto/doc/src/nodes';
-
-export const Links = {
-  Basic: d.SnippetLink('Basic', '@travetto/model/src/service/basic.ts', /export interface/),
-  Crud: d.SnippetLink('CRUD', '@travetto/model/src/service/crud.ts', /export interface/),
-  Expiry: d.SnippetLink('Expiry', '@travetto/model/src/service/expiry.ts', /export interface/),
-  Indexed: d.SnippetLink('Indexed', '@travetto/model/src/service/indexed.ts', /export interface/),
-  Bulk: d.SnippetLink('Bulk', '@travetto/model/src/service/bulk.ts', /export interface/),
-  Stream: d.SnippetLink('Streaming', '@travetto/model/src/service/stream.ts', /export interface/),
-};
-
-export const ModelTypes = (file: string | Function): AllTypeMap['SnippetLink'][] => {
-  if (typeof file !== 'string') {
-    file = RootIndex.getFunctionMetadata(file)!.source;
-  }
-  const contents = readFileSync(file, 'utf8');
-  const found: AllTypeMap['SnippetLink'][] = [];
-  const seen = new Set();
-  for (const [, key] of contents.matchAll(/Model(Crud|Expiry|Indexed|Bulk|Stream)Support/g)) {
-    if (!seen.has(key)) {
-      seen.add(key);
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      found.push(Links[key as keyof typeof Links]);
-    }
-  }
-  return found;
-};
-
-export const ModelCustomConfig = (cfg: Function): AllType => d`
-    Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source 
-    or config, you can override and register it with the ${mod.Di} module.
-
-    ${d.Code('Wiring up a custom Model Source', 'doc/custom-service.ts')}
-
-  where the ${cfg} is defined by:
-
-  ${d.Code(`Structure of ${cfg.name}`, cfg)}
-
-  Additionally, you can see that the class is registered with the ${Config} annotation, and so these values can be overridden using the 
-  standard ${mod.Config}resolution paths. 
-  `;