@lytical/app 1.0.10 → 1.0.12

package/README.md

@@ -13,7 +13,7 @@ a typescript api server library built for your express project, with dependency
 install packages:
 
 ```bash
-npm install @lytical/app @lytical/ioc express
+npm install @lytical/app express
 ```
 
 after installing, configure your `tsconfig.json` file to enable decorators.
@@ -22,8 +22,7 @@ after installing, configure your `tsconfig.json` file to enable decorators.
 // tsconfig.json
 {
   "compilerOptions": {
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
+    "experimentalDecorators": true
   }
 }
 ```
@@ -55,6 +54,7 @@ for the above project structure:
 
 ```json
 // tsconfig.json
+
 {
   "compilerOptions": {
     "rootDir": "src",
@@ -67,22 +67,29 @@ for the above project structure:
 
 ```json
 // package.json
+
 {
   "main": "./{index.js,routes/**/*.js}"
 }
 ```
 
-a simple project template / example can be found in github (https://github.com/lytical/ts-app-example)
+**note:** your route handlers can be place anywhere... just make sure you import them before starting the app.\
+(e.g. `import './contact/routes/index'`)
+
+## example app
+a simple project template / example can be found at github\
+ (https://github.com/lytical/ts-app-example)
 
 ## usage
 
 create your injectable service class(es) to implement the business logic.
 
 ```typescript
+// src/services/example-svc.ts
+
 import { ioc_injectable } from '@lytical/ioc';
 
 @ioc_injectable()
-// src/services/example-svc.ts
 export class example_svc {
   async get_message() {
     return 'Hello from example_svc!';
@@ -98,6 +105,7 @@ create your middleware classes
 
 ```typescript
 // src/middleware/example-mw.ts
+
 import type { Request, Response, NextFunction } from 'express';
 
 import { ioc_inject } from '@lytical/ioc';
@@ -127,6 +135,7 @@ create your route handler(s)
 
 ```typescript
 // src/routes/example.ts
+
 import express, {
   type Request,
   type Response,
@@ -145,7 +154,8 @@ import { example_middleware_class } from '../middleware/example-mw';
 
 /**
  * Example route class
- * Use for router class(es) for auto app.use() registration for routes; dependent middleware; and dependency injection
+ * Use for router class(es) to auto app.use() registration for
+ * routes; dependent middleware; and dependency injection
  */
 @app_route({ route: '/example' })
 export class example_route_class {
@@ -173,7 +183,7 @@ export class example_route_class {
     ],
     // you may indicate an error handler middleware at the route level.
     // the default error handler will be used if not indicated here.
-    error_handler: example_error_handler
+    error_handler: example_error_handler,
   })
   post_handler(rqs: Request, rsp: Response, nxt: NextFunction) {
     rsp.json({ body: rqs.body, locals: rsp.locals }).end();
@@ -185,6 +195,7 @@ now just import app and invoke `start()`
 
 ```typescript
 // src/index.ts
+
 import app from '@lytical/app';
 
 app.start();
@@ -194,6 +205,7 @@ app.start();
 
 ```typescript
 // src/index.ts
+
 import app, { app_evt } from './lib/app';
 
 // app events occur in the following order:
@@ -201,42 +213,52 @@ import app, { app_evt } from './lib/app';
 // 2. server_starting
 // 3. server_listening
 
-app.once(app_evt.create_server, (cfg) => {
-  // set the event parameter (evt.server) property to provide the server instance of your choice.
-  //
+app.once(app_evt.create_server, (evt) => {
+  // set the event parameter (evt.server) property to
+  // provide the server instance of your choice.
+
   // e.g.
   //   evt.server = createHttpsServer(evt.express, my_https_options);
-  //
-  // a standard http server instance is created by default, if no server is provided.
-  //
-  // evt.root_route can be modified to change the root route where auto registered routes are mounted.
+
+  // a standard http server instance is created by default,
+  // if no server is provided.
+  
+  // evt.root_route can be modified to change the root route
+  // where auto registered routes are mounted.
+  
   // default is '/api'.
-  //
-  // push async operations (Promise) that fetch encryption keys, ... into the event parameter (evt.wait_for.push(...)).
-  //
-  // add middleware into the pipeline (evt.express.use(...)), before auto registered routes are added.
-  //
-  // this is also the last chance to register dependencies in the ioc collection, before the container is created.
-  console.log(`the root route is (${cfg.root_route})`);
+  
+  // push async operations (Promise) that fetch encryption keys, ...
+  // into the event parameter (evt.wait_for.push(...)).
+  
+  // add middleware into the pipeline (evt.express.use(...)),
+  // before auto registered routes are added.
+  
+  // this is also the last chance to register dependencies
+  // in the ioc collection, before the container is created.
+  console.log(`the root route is (${evt.root_route})`);
 });
 
-app.once(app_evt.server_starting, (cfg) => {
+app.once(app_evt.server_starting, (evt) => {
   // use to modify the server listening configuration before it is started.
-  //
+  
   // all auto registered routes have been added at this point.
-  //
-  // you may add middleware to the app pipeline (evt.express.use(...)), after the auto registered routes.
+  
+  // you may add middleware to the app pipeline (evt.express.use(...)),
+  // after the auto registered routes.
+  
   // for example, to add error handling middleware, ...
-  //
-  // push async operations (Promise) that may fetch data or does some kind of i/o, ... into (evt.wait_for.push(...)).
-  //
+  
+  // push async operations (Promise) that may fetch data or
+  // does some kind of i/o, ... into (evt.wait_for.push(...)).
+  
   // the ioc container is also ready at this point.
-  console.log(`the hostname is (${cfg.hostname})`);
+  console.log(`the hostname is (${evt.hostname})`);
 });
 
 app.once(app_evt.server_listening, () => {
   // emitted when the server is listening
-  //
+  
   // use it to perform operations after the server starts listening.
   // this is the last event from the app, when it's considered started.
 });
@@ -244,10 +266,6 @@ app.once(app_evt.server_listening, () => {
 app.start();
 ```
 
-## documentation
-
-todo: working on this right now...
-
 stay tuned! i have more packages to come.`
 
 _lytical(r) is a registered trademark of lytical, inc. all rights are reserved._

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lytical/app",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "a typescript api server library built for your express project, with dependency injection support and auto router registration",
   "main": "index.js",
   "private": false,