@travetto/web 7.0.0-rc.5 → 7.0.0-rc.6

package/README.md

@@ -13,9 +13,9 @@ npm install @travetto/web
 yarn add @travetto/web
 ```
 
-The module provides a declarative API for creating and describing a Web application.  Since the framework is declarative, decorators are used to configure almost everything. The general layout of an application is a collection of [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L11)s that employ some combination of [WebInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/types/interceptor.ts#L15)s to help manage which functionality is executed before the [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14) code, within the [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L11). This module will look at:
+The module provides a declarative API for creating and describing a Web application.  Since the framework is declarative, decorators are used to configure almost everything. The general layout of an application is a collection of [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L12)s that employ some combination of [WebInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/types/interceptor.ts#L15)s to help manage which functionality is executed before the [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14) code, within the [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L12). This module will look at:
    *  Request/Response Pattern
-   *  Defining a [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L11)
+   *  Defining a [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L12)
    *  Defining an [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14)
    *  Using a [WebInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/types/interceptor.ts#L15)
    *  Creating a Custom [WebInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/types/interceptor.ts#L15)
@@ -91,7 +91,7 @@ export class WebResponse<B = unknown> extends BaseWebMessage<B, WebResponseConte
 These objects do not represent the underlying sockets provided by various http servers, but in fact are simple wrappers that track the flow through the call stack of the various [WebInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/types/interceptor.ts#L15)s and the [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14) handler.  One of the biggest departures here, is that the response is not an entity that is passed around from call-site to call-site, but is is solely a return-value.  This doesn't mean the return value has to be static and pre-allocated, on the contrary streams are still supported.  The difference here is that the streams/asynchronous values will be consumed until the response is sent back to the user. The [CompressInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/compress.ts#L44) is a good reference for transforming a [WebResponse](https://github.com/travetto/travetto/tree/main/module/web/src/types/response.ts#L3) that can either be a stream or a fixed value.
 
 ## Defining a Controller
-To start, we must define a [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L11), which is only allowed on classes. Controllers can be configured with:
+To start, we must define a [@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L12), which is only allowed on classes. Controllers can be configured with:
    *  `path` - The required context path the controller will operate atop
    *  `title` - The definition of the controller
    *  `description` - High level description fo the controller
@@ -378,7 +378,7 @@ Out of the box, the web framework comes with a few interceptors, and more are co
    1. global - Intended to run outside of the request flow - [AsyncContextInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/context.ts#L13)
    1. terminal - Handles once request and response are finished building - [LoggingInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/logging.ts#L28), [RespondInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/respond.ts#L12)
    1. pre-request - Prepares the request for running - [TrustProxyInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/trust-proxy.ts#L23)
-   1. request - Handles inbound request, validation, and body preparation - [DecompressInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/decompress.ts#L53), [AcceptInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/accept.ts#L33), [BodyInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/body.ts#L58), [CookieInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/cookie.ts#L60) 
+   1. request - Handles inbound request, validation, and body preparation - [DecompressInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/decompress.ts#L53), [AcceptInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/accept.ts#L33), [BodyInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/body.ts#L57), [CookieInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/cookie.ts#L60) 
    1. response - Prepares outbound response - [CompressInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/compress.ts#L44), [CorsInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/cors.ts#L51), [EtagInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/etag.ts#L43), [CacheControlInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/cache-control.ts#L23) 
    1. application - Lives outside of the general request/response behavior, [Web Auth](https://github.com/travetto/travetto/tree/main/module/auth-web#readme "Web authentication integration support for the Travetto framework") uses this for login and logout flows.
 
@@ -504,7 +504,7 @@ export class CookieConfig implements CookieSetOptions {
 ```
 
 #### BodyInterceptor
-[BodyInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/body.ts#L58) handles the inbound request, and converting the body payload into an appropriate format.
+[BodyInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/interceptor/body.ts#L57) handles the inbound request, and converting the body payload into an appropriate format.
 
 **Code: Body Config**
 ```typescript
@@ -675,11 +675,11 @@ export class AlowDenyController {
 ```
 
 The resolution logic is as follows:
-   *  Check the resolved [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14)/[@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L11) overrides to see if an interceptor is explicitly allowed or disallowed
+   *  Check the resolved [Endpoint](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/endpoint.ts#L14)/[@Controller](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/controller.ts#L12) overrides to see if an interceptor is explicitly allowed or disallowed
    *  Default to `applies()` logic for all available interceptors
 
 ## Creating a Custom WebInterceptor
-Additionally it may be desirable to create a custom interceptor.  Interceptors can be registered with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") by implementing the [WebInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/types/interceptor.ts#L15) interface and adding an [@Injectable](https://github.com/travetto/travetto/tree/main/module/di/src/decorator.ts#L15) decorator. A simple logging interceptor:
+Additionally it may be desirable to create a custom interceptor.  Interceptors can be registered with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") by implementing the [WebInterceptor](https://github.com/travetto/travetto/tree/main/module/web/src/types/interceptor.ts#L15) interface and adding an [@Injectable](https://github.com/travetto/travetto/tree/main/module/di/src/decorator.ts#L16) decorator. A simple logging interceptor:
 
 **Code: Defining a new Interceptor**
 ```typescript

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@travetto/web",
-  "version": "7.0.0-rc.5",
+  "version": "7.0.0-rc.6",
+  "type": "module",
   "description": "Declarative support for creating Web Applications",
   "keywords": [
     "web",
@@ -25,18 +26,18 @@
     "directory": "module/web"
   },
   "dependencies": {
-    "@travetto/config": "^7.0.0-rc.4",
-    "@travetto/context": "^7.0.0-rc.4",
-    "@travetto/di": "^7.0.0-rc.4",
-    "@travetto/registry": "^7.0.0-rc.4",
-    "@travetto/runtime": "^7.0.0-rc.4",
-    "@travetto/schema": "^7.0.0-rc.4",
+    "@travetto/config": "^7.0.0-rc.5",
+    "@travetto/context": "^7.0.0-rc.5",
+    "@travetto/di": "^7.0.0-rc.5",
+    "@travetto/registry": "^7.0.0-rc.5",
+    "@travetto/runtime": "^7.0.0-rc.5",
+    "@travetto/schema": "^7.0.0-rc.5",
     "find-my-way": "^9.3.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.0.0-rc.4",
-    "@travetto/test": "^7.0.0-rc.4",
-    "@travetto/transformer": "^7.0.0-rc.3"
+    "@travetto/cli": "^7.0.0-rc.5",
+    "@travetto/test": "^7.0.0-rc.5",
+    "@travetto/transformer": "^7.0.0-rc.4"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/decorator/controller.ts

@@ -6,6 +6,7 @@ import { ControllerRegistryIndex } from '../registry/registry-index.ts';
 /**
  * Decorator to register a new web controller
  * @augments `@travetto/schema:Schema`
+ * @example opt-in
  * @kind decorator
  */
 export function Controller(path: string) {

package/src/interceptor/body.ts

@@ -50,7 +50,6 @@ export class WebBodyConfig {
   _limit: number | undefined;
 }
 
-
 /**
  * Verifies content length, decodes character encodings, and parses body input string via the content type
  */

package/src/interceptor/decompress.ts

@@ -52,7 +52,6 @@ export class DecompressConfig {
 @Injectable()
 export class DecompressInterceptor implements WebInterceptor<DecompressConfig> {
 
-
   static async decompress(headers: WebHeaders, input: Buffer | Readable, config: DecompressConfig): Promise<typeof input> {
     const encoding: WebDecompressEncoding | 'identity' = castTo(headers.getList('Content-Encoding')?.[0]) ?? 'identity';
 

package/src/types/message.ts

@@ -10,7 +10,6 @@ export interface WebMessageInit<B = unknown, C = unknown> {
   body?: B;
 }
 
-
 export interface WebMessage<B = unknown, C = unknown> {
   readonly context: C;
   readonly headers: WebHeaders;

package/src/util/common.ts

@@ -55,7 +55,6 @@ export class WebCommonUtil {
     return edgeMap;
   }
 
-
   /**
    * Build matcher
    */

package/src/util/endpoint.ts

@@ -11,7 +11,6 @@ import { EndpointConfig, ControllerConfig, EndpointParameterConfig, EndpointFunc
 import { ControllerRegistryIndex } from '../registry/registry-index.ts';
 import { WebCommonUtil } from './common.ts';
 
-
 const WebQueryExpandedSymbol = Symbol();
 
 /**
@@ -80,7 +79,6 @@ export class EndpointUtil {
     ]);
   }
 
-
   /**
    * Extract parameter value from request
    * @param request The request
@@ -111,7 +109,7 @@ export class EndpointUtil {
     if (param.extract) {
       return param.extract(request, param);
     } else if (param.location === 'query') {
-      // TODO: Revisit this logic?
+      // TODO: Revisit the prefix logic/structure in general
       const withQuery: typeof request & { [WebQueryExpandedSymbol]?: Record<string, unknown> } = request;
       const query = withQuery[WebQueryExpandedSymbol] ??= BindUtil.expandPaths(request.context.httpQuery ?? {});
       if (param.prefix) { // Has a prefix provided
@@ -225,7 +223,6 @@ export class EndpointUtil {
     return castTo(result);
   }
 
-
   /**
    * Get bound endpoints, honoring the conditional status
    */
@@ -268,7 +265,6 @@ export class EndpointUtil {
       .map(([endpoint,]) => endpoint);
   }
 
-
   /**
    * Order interceptors
    */