@travetto/scaffold 6.0.0-rc.1 → 6.0.0-rc.2

package/README.md

@@ -24,22 +24,22 @@ $ npx @travetto/scaffold@<version-or-tag>
 
 The generator will ask about enabling the following features:
 
-## Restful Architecture
-The [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") provides the necessary integration for exposing restful apis.  When selecting the `rest` feature, you will need to specify which backend you want to include with your application, the default being [express](https://expressjs.com).  Currently you can select from:
+## Web Application
+The [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative api for Web Applications with support for the dependency injection.") provides the necessary integration for exposing web apis.  When selecting the `web` feature, you will need to specify which backend you want to include with your application, the default being [express](https://expressjs.com).  Currently you can select from:
    *  [express](https://expressjs.com)
    *  [koa](https://koajs.com/)
    *  [fastify](https://www.fastify.io/)
-The code will establish some basic routes, specifically, `GET / ` as the root endpoint.  This will return the contents of your `package.json` as an identification operation.
+The code will establish some basic endpoints, specifically, `GET / ` as the root endpoint.  This will return the contents of your `package.json` as an identification operation.
 
-### Additional Rest Features
-In addition to the core functionality, the `rest` feature has some useful sub-features.  Specifically:
+### Additional Web Features
+In addition to the core functionality, the `web` feature has some useful sub-features.  Specifically:
 
-[OpenAPI Specification](https://github.com/travetto/travetto/tree/main/module/openapi#readme "OpenAPI integration support for the Travetto framework") support for the restful api.  This will automatically expose a `openapi.yml` endpoint, and provide the necessary plumbing to support client generation. 
+[OpenAPI Specification](https://github.com/travetto/travetto/tree/main/module/openapi#readme "OpenAPI integration support for the Travetto framework") support for the web api.  This will automatically expose a `openapi.yml` endpoint, and provide the necessary plumbing to support client generation. 
 
 [Logging](https://github.com/travetto/travetto/tree/main/module/log#readme "Logging framework that integrates at the console.log level.") support for better formatting, [debug](https://www.npmjs.com/package/debug) like support, and colorized output.  This is generally useful for server logs, especially during development.
 
 ## Authentication
-Authentication is also supported on the Restful endpoints by selecting [Rest Auth](https://github.com/travetto/travetto/tree/main/module/auth-rest#readme "Rest authentication integration support for the Travetto framework") during setup.  This will support basic authentication running out of local memory.
+Authentication is also supported on the Web endpoints by selecting [Web Auth](https://github.com/travetto/travetto/tree/main/module/auth-web#readme "Web authentication integration support for the Travetto framework") during setup.  This will support basic authentication running out of local memory.
 
 ## Testing
 [Testing](https://github.com/travetto/travetto/tree/main/module/test#readme "Declarative test framework") can also be configured out of the box to provide simple test cases for the data model.
@@ -68,18 +68,18 @@ export class Todo implements ModelType {
 
 Basic tests are also included for the `model` to verify that database interaction and functionality is working properly.
 
-## Rest + Model
-In the case both `rest` and `model` features are enabled, the code will produce a controller that exposes the [Todo](https://github.com/travetto/travetto/tree/main/module/scaffold/doc/model.ts#L4) model via restful patterns.
+## Web + Model
+In the case both `web` and `model` features are enabled, the code will produce a controller that exposes the [Todo](https://github.com/travetto/travetto/tree/main/module/scaffold/doc/model.ts#L4) model via web patterns.
 
 **Code: Todo controller**
 ```typescript
-import { Controller, Get, Put, Post, Delete } from '@travetto/rest';
+import { Controller, Get, Put, Post, Delete } from '@travetto/web';
 import { NotFoundError } from '@travetto/model';
 import { Inject } from '@travetto/di';
 import { ModelQuery, ModelQueryCrudSupport } from '@travetto/model-query';
 import { Schema } from '@travetto/schema';
 
-import { Todo } from './model';
+import { Todo } from './model.ts';
 
 @Schema()
 class Query {
@@ -147,7 +147,7 @@ export class TodoController {
 ```
 
 ## Running
-Once finished the application will reflect the modules chosen, and will be ready for execution, if you have configured a runnable application.  Currently, this requires the `rest` feature to be selected.
+Once finished the application will reflect the modules chosen, and will be ready for execution, if you have configured a runnable application.  Currently, this requires the `web` feature to be selected.
 
 **Terminal: Starting the App**
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/scaffold",
-  "version": "6.0.0-rc.1",
+  "version": "6.0.0-rc.2",
   "description": "App Scaffold for the Travetto framework",
   "keywords": [
     "generator",
@@ -27,13 +27,13 @@
     "trv-scaffold": "bin/trv-scaffold.js"
   },
   "dependencies": {
-    "@travetto/cli": "^6.0.0-rc.1",
-    "@travetto/runtime": "^6.0.0-rc.1",
+    "@travetto/cli": "^6.0.0-rc.2",
+    "@travetto/runtime": "^6.0.0-rc.2",
     "enquirer": "^2.4.1",
     "mustache": "^4.2.0"
   },
   "devDependencies": {
-    "@travetto/model": "^6.0.0-rc.1",
+    "@travetto/model": "^6.0.0-rc.2",
     "@types/mustache": "^4.2.5"
   },
   "travetto": {

package/resources/templates/todo/listing.json

@@ -15,28 +15,28 @@
       "@travetto/model"
     ]
   },
-  "src/rest/todo.ts": {
+  "src/web/todo.ts": {
     "requires": [
-      "@travetto/rest",
+      "@travetto/web",
       "@travetto/model"
     ]
   },
-  "src/rest/auth.ts": {
+  "src/web/auth.ts": {
     "requires": [
-      "@travetto/rest",
-      "@travetto/auth-rest"
+      "@travetto/web",
+      "@travetto/auth-web"
     ]
   },
-  "src/rest/auth.config.ts": {
+  "src/web/auth.config.ts": {
     "requires": [
-      "@travetto/rest",
+      "@travetto/web",
       "@travetto/model-memory",
-      "@travetto/auth-rest"
+      "@travetto/auth-web"
     ]
   },
-  "src/rest/primary.ts": {
+  "src/web/primary.ts": {
     "requires": [
-      "@travetto/rest"
+      "@travetto/web"
     ]
   },
   "test/model/todo.ts": {

package/resources/templates/todo/package.json.txt

@@ -27,7 +27,7 @@
   "scripts": {
     "watch": "npx trvc watch",
     "build": "npx trvc build",
-    "start": "npx trv run:rest",
+    "start": "npx trv web:http",
     "test": "npx trv test",
     "lint": "npx trv lint"
   },

package/resources/templates/todo/resources/application.yml

@@ -1,9 +1,9 @@
-# {{#modules.rest}}
-rest:
+# {{#modules.web}}
+web:
   ssl:
     active: false
   context:
     active: true
   cors:
     active: true
-# {{/modules.rest}}
+# {{/modules.web}}

package/resources/templates/todo/src/model/todo.ts

@@ -5,7 +5,7 @@ export class Todo implements ModelType {
   id: string;
   text: string;
   completed?: boolean;
-  // {{#modules.auth_rest}}
+  // {{#modules.auth_web}}
   userId?: string;
-  // {{/modules.auth_rest}} 
+  // {{/modules.auth_web}} 
 }

package/resources/templates/todo/src/{rest → web}/auth.ts

@@ -1,5 +1,5 @@
-import { Controller, Get, Post, Redirect } from '@travetto/rest';
-import { Login, Authenticated, Logout } from '@travetto/auth-rest';
+import { Controller, Get, Post, Redirect, ContextParam } from '@travetto/web';
+import { Login, Authenticated, Logout } from '@travetto/auth-web';
 import { Principal } from '@travetto/auth';
 
 import { BasicAuthSymbol } from './auth.config';
@@ -10,6 +10,9 @@ import { BasicAuthSymbol } from './auth.config';
 @Controller('/auth')
 export class ApiController {
 
+  @ContextParam()
+  user: Principal;
+
   @Post('/login')
   @Login(BasicAuthSymbol)
   async getAll(): Promise<Redirect> {
@@ -18,8 +21,8 @@ export class ApiController {
 
   @Get('/self')
   @Authenticated()
-  async getSelf(user: Principal): Promise<Principal> {
-    return user;
+  async getSelf(): Promise<Principal> {
+    return this.user;
   }
 
   @Get('/logout')

package/resources/templates/todo/src/{rest → web}/primary.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, QueryParam } from '@travetto/rest';
+import { Controller, Get, QueryParam } from '@travetto/web';
 
 @Controller('/')
 export class SimpleController {

package/resources/templates/todo/src/{rest → web}/todo.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, Put, Post, Delete } from '@travetto/rest';
+import { Controller, Get, Put, Post, Delete } from '@travetto/web';
 import { NotFoundError } from '@travetto/model';
 import { Inject } from '@travetto/di';
 import { ModelQuery } from '@travetto/model-query';
@@ -6,20 +6,20 @@ import { Schema } from '@travetto/schema';
 // {{#modules.auth}}
 import { AuthContext } from '@travetto/auth';
 // {{/modules.auth}}
-// {{#modules.auth_rest}}
-import { Authenticated } from '@travetto/auth-rest';
-// {{/modules.auth_rest}}
+// {{#modules.auth_web}}
+import { Authenticated } from '@travetto/auth-web';
+// {{/modules.auth_web}}
 // @ts-expect-error
 import { $_modelService_$ } from '$_modelImport_$';
 
-import { Todo } from '../model/todo';
+import { Todo } from '../model/todo.ts';
 
 @Schema()
 class Query {
   q: {
-    // {{#modules.auth_rest}}
+    // {{#modules.auth_web}}
     userId?: string;
-    // {{/modules.auth_rest}}
+    // {{/modules.auth_web}}
   } = {};
 }
 
@@ -27,9 +27,9 @@ class Query {
  * Controller for managing all aspects of the Todo lifecycle
  */
 @Controller('/todo')
-// {{#modules.auth_rest}}
+// {{#modules.auth_web}}
 @Authenticated()
-// {{/modules.auth_rest}}
+// {{/modules.auth_web}}
 export class TodoController {
 
   @Inject()
@@ -46,9 +46,9 @@ export class TodoController {
   @Get('/')
   async getAll(query: Query): Promise<Todo[]> {
     query.q ??= {};
-    // {{#modules.auth_rest}}
+    // {{#modules.auth_web}}
     query.q.userId = this.authContext.principal?.id;
-    // {{/modules.auth_rest}}
+    // {{/modules.auth_web}}
     return this.source.query(Todo, { where: query.q });
   }
 
@@ -58,11 +58,11 @@ export class TodoController {
   @Get('/:id')
   async getOne(id: string): Promise<Todo> {
     const q: ModelQuery<Todo> = { where: { id } };
-    // {{#modules.auth_rest}}
+    // {{#modules.auth_web}}
     if (typeof q.where !== 'string') {
       q.where!.userId = this.authContext.principal?.id;
     }
-    // {{/modules.auth_rest}}
+    // {{/modules.auth_web}}
     return this.source.queryOne(Todo, q);
   }
 
@@ -71,9 +71,9 @@ export class TodoController {
    */
   @Post('/')
   async save(todo: Todo): Promise<Todo> {
-    // {{#modules.auth_rest}}
+    // {{#modules.auth_web}}
     todo.userId = this.authContext.principal?.id;
-    // {{/modules.auth_rest}}
+    // {{/modules.auth_web}}
     return this.source.create(Todo, todo);
   }
 
@@ -82,9 +82,9 @@ export class TodoController {
    */
   @Put('/:id')
   async update(todo: Todo): Promise<Todo> {
-    // {{#modules.auth_rest}}
+    // {{#modules.auth_web}}
     todo.userId = this.authContext.principal?.id;
-    // {{/modules.auth_rest}}
+    // {{/modules.auth_web}}
     return this.source.update(Todo, todo);
   }
 
@@ -94,11 +94,11 @@ export class TodoController {
   @Delete('/:id')
   async remove(id: string): Promise<void> {
     const q: ModelQuery<Todo> = { where: { id } };
-    // {{#modules.auth_rest}}
+    // {{#modules.auth_web}}
     if (typeof q.where !== 'string') {
       q.where!.userId = this.authContext.principal?.id;
     }
-    // {{/modules.auth_rest}}
+    // {{/modules.auth_web}}
     if (await this.source.deleteByQuery(Todo, q) !== 1) {
       throw new NotFoundError(Todo, id);
     }

package/resources/templates/todo/test/model/todo.ts

@@ -2,13 +2,13 @@ import assert from 'node:assert';
 
 import { Suite, Test } from '@travetto/test';
 import { ModelCrudSupport } from '@travetto/model';
-import { BaseModelSuite } from '@travetto/model/support/test/base';
+import { BaseModelSuite } from '@travetto/model/support/test/base.ts';
 import { $_modelConfig_$, $_modelService_$ } from '$_modelImport_$';
 
-import { Todo } from '../../src/model/todo';
+import { Todo } from '../../src/model/todo.ts';
 
 @Suite('Simple CRUD')
-class TestCRUD extends BaseModelSuite<ModelCrudSupport>  {
+class TestCRUD extends BaseModelSuite<ModelCrudSupport> {
 
   serviceClass = $_modelService_$;
   configClass = $_modelConfig_$;

package/support/bin/context.ts

@@ -9,7 +9,7 @@ import { cliTpl } from '@travetto/cli';
 import { NodePackageManager, PackageUtil } from '@travetto/manifest';
 import { Terminal } from '@travetto/terminal';
 
-import { Feature } from './features';
+import { Feature } from './features.ts';
 
 type ListingEntry = { requires?: string[], rename?: string };
 type Listing = Record<string, ListingEntry>;
@@ -122,8 +122,8 @@ export class Context {
       name: this.name,
       modules,
       moduleNames,
-      dependencies: [...new Set(this.#dependencies)].sort((a, b) => a.localeCompare(b)),
-      devDependencies: [...new Set(this.#devDependencies)].sort((a, b) => a.localeCompare(b)),
+      dependencies: [...new Set(this.#dependencies)].toSorted((a, b) => a.localeCompare(b)),
+      devDependencies: [...new Set(this.#devDependencies)].toSorted((a, b) => a.localeCompare(b)),
     }, ...this.#featureContexts);
 
     return context;

package/support/bin/features.ts

@@ -23,15 +23,11 @@ export const FEATURES: Feature[] = [
     default: 'npm'
   },
   {
-    title: 'Rest Framework',
-    package: '@travetto/rest',
+    title: 'Web Framework',
+    package: '@travetto/web',
     choices: [
-      { title: 'Express.js', package: '@travetto/rest-express' },
-      { title: 'Express.js Lambda', package: '@travetto/rest-express-lambda' },
-      { title: 'KOA', package: '@travetto/rest-koa' },
-      { title: 'KOA Lambda', package: '@travetto/rest-koa-lambda' },
-      { title: 'Fastify', package: '@travetto/rest-fastify' },
-      { title: 'Fastify Lambda', package: '@travetto/rest-fastify-lambda' },
+      { title: 'Node', package: '@travetto/web-node' },
+      { title: 'AWS Lambda', package: '@travetto/web-aws-lambda' },
     ],
     addons: [
       { title: 'OpenAPI', package: '@travetto/openapi' },
@@ -42,10 +38,10 @@ export const FEATURES: Feature[] = [
   { title: 'Test Framework', package: '@travetto/test' },
   { title: 'ESLint Support', package: '@travetto/eslint' },
   {
-    title: 'Rest Authentication',
-    package: '@travetto/auth-rest',
+    title: 'Web Authentication',
+    package: '@travetto/auth-web',
     addons: [
-      { title: 'Session Support', package: ['@travetto/auth-session', '@travetto/auth-rest-session', '@travetto/model-memory'] },
+      { title: 'Session Support', package: ['@travetto/auth-session', '@travetto/auth-web-session', '@travetto/model-memory'] },
     ]
   },
   {

package/support/cli.scaffold.ts

@@ -5,8 +5,8 @@ import { prompt } from 'enquirer';
 import { CliCommandShape, CliCommand, cliTpl } from '@travetto/cli';
 import { Terminal } from '@travetto/terminal';
 
-import { Context } from './bin/context';
-import { Feature, FEATURES } from './bin/features';
+import { Context } from './bin/context.ts';
+import { Feature, FEATURES } from './bin/features.ts';
 
 /**
  * Command to run scaffolding
@@ -24,14 +24,14 @@ export class ScaffoldCommand implements CliCommandShape {
 
   async #getName(name?: string): Promise<string> {
     if (!name) {
-      const res = await prompt<{ name: string }>([
+      const response = await prompt<{ name: string }>([
         {
           type: 'input',
           name: 'name',
           message: 'Enter a name for application: '
         }
       ]);
-      name = res.name;
+      name = response.name;
     }
     return name;
   }
@@ -45,8 +45,8 @@ export class ScaffoldCommand implements CliCommandShape {
       choices: feature.choices!.map(x => x.title).filter((x?: string): x is string => !!x),
     };
 
-    const res = await prompt<{ choice: string }>(choice);
-    return feature.choices?.find(x => x.title === res.choice);
+    const response = await prompt<{ choice: string }>(choice);
+    return feature.choices?.find(x => x.title === response.choice);
   }
 
   async * #resolveFeatures(features: Feature[], chosen = false): AsyncGenerator<Feature> {