@travetto/web-http 8.0.0-alpha.2 → 8.0.0-alpha.20

package/README.md

@@ -15,8 +15,33 @@ yarn add @travetto/web-http
 
 This module provides basic for running [http](https://nodejs.org/api/http.html). [https](https://nodejs.org/api/https.html)  and [http2](https://nodejs.org/api/http2.html) servers, along with support for tls key generation during development.
 
+## CLI - web:http
+By default, the framework provides a default [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L20) for [WebHttpServer](https://github.com/travetto/travetto/tree/main/module/web-http/src/types.ts#L19) that will follow default behaviors, and spin up the server.
+
+**Terminal: Help for web:http**
+```bash
+$ trv web:http --help
+
+Usage: web:http [options]
+
+Start the configured web HTTP server for a module.
+
+Initializes registry and server bindings, supports restart-aware development
+flags, and can attempt to clear conflicting port owners in local workflows.
+Example Usage:
+	trv web:http -m <MODULE> -p 3000
+
+Options:
+  -p, --port <number>                          Port to run on
+  --kill-conflict, --no-kill-conflict          Kill conflicting port owner (default: true)
+  -m, --module <module>                        Module to run for
+  --profile <string>                           Application profiles
+  --restart-on-change, --no-restart-on-change  Should the invocation automatically restart on source changes (default: true)
+  -d, --debug-ipc                              Should the invocation automatically restart on source changes
+  --help                                       display help for command
+```
+
 ## Running a Server
-By default, the framework provides a default [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L27) for [WebHttpServer](https://github.com/travetto/travetto/tree/main/module/web-http/src/types.ts#L19) that will follow default behaviors, and spin up the server.
 
 **Terminal: Standard application**
 ```bash
@@ -139,8 +164,8 @@ export class WebHttpConfig {
       this.tlsKeys = await WebTlsUtil.generateKeyPair();
     } else {
       if (this.tlsKeys.key.length < 100) { // We have files or resources
-        this.tlsKeys.key = await RuntimeResources.readText(this.tlsKeys.key);
-        this.tlsKeys.cert = await RuntimeResources.readText(this.tlsKeys.cert);
+        this.tlsKeys.key = await RuntimeResources.readUTF8(this.tlsKeys.key);
+        this.tlsKeys.cert = await RuntimeResources.readUTF8(this.tlsKeys.cert);
       }
     }
 
@@ -150,7 +175,7 @@ export class WebHttpConfig {
 ```
 
 ### Creating a Custom CLI Entry Point
-To customize a Web server, you may need to construct an entry point using the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L27) decorator. This could look like:
+To customize a Web server, you may need to construct an entry point using the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L20) decorator. This could look like:
 
 **Code: Application entry point for Web Applications**
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/web-http",
-  "version": "8.0.0-alpha.2",
+  "version": "8.0.0-alpha.20",
   "type": "module",
   "description": "Web HTTP Server Support",
   "keywords": [
@@ -27,11 +27,11 @@
     "directory": "module/web-http"
   },
   "dependencies": {
-    "@travetto/web": "^8.0.0-alpha.2"
+    "@travetto/web": "^8.0.0-alpha.19"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.3",
-    "@travetto/test": "^8.0.0-alpha.2"
+    "@travetto/cli": "^8.0.0-alpha.23",
+    "@travetto/test": "^8.0.0-alpha.17"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/config.ts

@@ -62,8 +62,8 @@ export class WebHttpConfig {
       this.tlsKeys = await WebTlsUtil.generateKeyPair();
     } else {
       if (this.tlsKeys.key.length < 100) { // We have files or resources
-        this.tlsKeys.key = await RuntimeResources.readText(this.tlsKeys.key);
-        this.tlsKeys.cert = await RuntimeResources.readText(this.tlsKeys.cert);
+        this.tlsKeys.key = await RuntimeResources.readUTF8(this.tlsKeys.key);
+        this.tlsKeys.cert = await RuntimeResources.readUTF8(this.tlsKeys.cert);
       }
     }
 

package/support/cli.web_http.ts

@@ -7,7 +7,14 @@ import { Registry } from '@travetto/registry';
 import type { WebHttpServer } from '../src/types.ts';
 
 /**
- * Run a web server
+ * Start the configured web HTTP server for a module.
+ *
+ * Initializes registry and server bindings, supports restart-aware development
+ * flags, and can attempt to clear conflicting port owners in local workflows.
+ *
+ * @example
+ * Starting a web server on port 8000
+ * > trv web:http -m <MODULE> -p 8000
  */
 @CliCommand()
 export class WebHttpCommand implements CliCommandShape {
@@ -25,7 +32,7 @@ export class WebHttpCommand implements CliCommandShape {
   profile: string[];
 
   @CliRestartOnChangeFlag()
-  restartOnChange: boolean = true;
+  restartOnChange: boolean = Runtime.localDevelopment;
 
   @CliDebugIpcFlag()
   debugIpc?: boolean;