@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/classes/Server.md

@@ -0,0 +1,408 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / Server
+
+# Class: Server
+
+Defined in: [src/Server.ts:147](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L147)
+
+Provides an HTTP server utilizing uWebSockets.js. The server automatically registers all routes, and
+establishes database connections for all configured data stores. Additionally provides automatic authentication
+handling using JSON Web Token (JWT) directly — no Passport dependency required. When provided an OpenAPI
+specification object the server will also automatically serve this specification via the `GET /openapi.json` route.
+
+Routes are defined by creating any class definition using the various decorators found in `RouteDecorators` and
+saving these files in the `routes` subfolder. Upon server start, the `routes` folder is scanned for any class
+that has been decorated with `@Route` and is automatically loaded and registered. Similarly, if the
+class is decorated with the `@Model` decorator the resulting route object will have the associated data model
+definition object injected into the constructor.
+
+SSL termination is supported by providing an `ssl` configuration block with `key`, `cert`, and optionally
+`ca` and `passphrase` file paths. When `ssl` is present the server uses `uWS.SSLApp()`.
+
+IPv6 is supported by setting `listen_host` to `"::"` in configuration (default `"0.0.0.0"`).
+
+By default all registered endpoints that do not explicitly have an `@Auth` decorator have the `JWT`
+authentication strategy applied. This allows users to be implicitly authenticated without requiring additional
+configuration. Once authenticated, the provided `request` argument will have the `user` property available
+containing information about the authenticated user. If the `user` property is `undefined` then no user has
+been authenticated or the authentication attempt failed.
+
+The following is an example of a simple route class.
+
+```javascript
+import { DefaultBehaviors, RouteDecorators } from "@rapidrest/service-core";
+import { Get, Route } = RouteDecorators;
+
+@Route("/hello")
+class TestRoute extends ModelRoute {
+   constructor(model: any) {
+       super(model);
+   }
+
+   @Get()
+   count(req: any, res: any, next: Function): any {
+       return res.send("Hello World!");
+   }
+}
+
+export default TestRoute;
+```
+
+The following is an example of a route class that is bound to a data model providing basic CRUDS operations.
+
+```javascript
+import { DefaultBehaviors, ModelDecorators, ModelRoute, RouteDecorators } from "@rapidrest/service-core";
+import { After, Before, Delete, Get, Post, Put, Route, Validate } = RouteDecorators;
+import { Model } = ModelDecorators;
+import { marshall } = DefaultBehaviors;
+
+@Model("Item")
+@Route("/items")
+class ItemRoute extends ModelRoute {
+    constructor(model: any) {
+      super(model);
+  }
+
+  @Get()
+  @Before(super.count)
+  @After(marshall)
+  count(req: any, res: any, next: Function): any {
+      return next();
+  }
+
+  @Post()
+  @Before([super.create])
+  @After([this.prepare, marshall])
+  create(req: any, res: any, next: Function): any {
+      return next();
+  }
+
+  @Delete(":id")
+  @Before([super.delete])
+  delete(req: any, res: any, next: Function): any {
+      return next();
+  }
+
+  @Get()
+  @Before([super.findAll])
+  @After(this.prepareAndSend)
+  findAll(req: any, res: any, next: Function): any {
+      return next();
+  }
+
+  @Get(":id")
+  @Before([super.findById])
+  @After([this.prepare, marshall])
+  findById(req: any, res: any, next: Function): any {
+      return next();
+  }
+
+  @Put(":id")
+  @Before([super.update])
+  @After([this.prepare, marshall])
+  update(req: any, res: any, next: Function): any {
+      return next();
+  }
+}
+
+export default ItemRoute;
+```
+
+## Author
+
+Jean-Philippe Steinmetz
+
+## Constructors
+
+### Constructor
+
+> **new Server**(`config`, `basePath?`, `logger?`, `objectFactory?`): `Server`
+
+Defined in: [src/Server.ts:209](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L209)
+
+Creates a new instance of Server with the specified defaults.
+
+#### Parameters
+
+##### config
+
+`any`
+
+The nconf-compatible configuration object to initialize the server with.
+
+##### basePath?
+
+`string` = `"."`
+
+The base file system path that models and routes will be searched from.
+
+##### logger?
+
+`any` = `...`
+
+The logging utility to use for outputing to console/file.
+
+##### objectFactory?
+
+[`ObjectFactory`](ObjectFactory.md)
+
+The object factory to use for automatic dependency injection (IOC).
+
+#### Returns
+
+`Server`
+
+## Properties
+
+### apiSpec?
+
+> `protected` `optional` **apiSpec?**: [`OpenApiSpec`](OpenApiSpec.md)
+
+Defined in: [src/Server.ts:149](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L149)
+
+The OpenAPI specification object to use to construct the server with.
+
+***
+
+### app
+
+> `protected` **app**: `HttpRouter`
+
+Defined in: [src/Server.ts:151](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L151)
+
+The underlying HTTP router (uWS-backed) that provides HTTP processing services.
+
+***
+
+### basePath
+
+> `protected` `readonly` **basePath**: `string`
+
+Defined in: [src/Server.ts:153](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L153)
+
+The base file system path that will be searched for models and routes.
+
+***
+
+### config?
+
+> `protected` `readonly` `optional` **config?**: `any`
+
+Defined in: [src/Server.ts:155](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L155)
+
+The global object containing configuration information to use.
+
+***
+
+### connectionManager?
+
+> `protected` `optional` **connectionManager?**: [`ConnectionManager`](ConnectionManager.md)
+
+Defined in: [src/Server.ts:157](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L157)
+
+The manager for handling database connections.
+
+***
+
+### eventListenerManager?
+
+> `protected` `optional` **eventListenerManager?**: [`EventListenerManager`](EventListenerManager.md)
+
+Defined in: [src/Server.ts:159](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L159)
+
+The manager for handling events.
+
+***
+
+### logger
+
+> `protected` `readonly` **logger**: `any`
+
+Defined in: [src/Server.ts:161](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L161)
+
+The logging utility to use when outputing to console/file.
+
+***
+
+### metricCompletedRequests
+
+> `protected` **metricCompletedRequests**: `Counter`\<`string`\>
+
+Defined in: [src/Server.ts:188](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L188)
+
+***
+
+### metricFailedRequests
+
+> `protected` **metricFailedRequests**: `Counter`\<`string`\>
+
+Defined in: [src/Server.ts:192](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L192)
+
+***
+
+### metricRequestPath
+
+> `protected` **metricRequestPath**: `Counter`\<`string`\>
+
+Defined in: [src/Server.ts:172](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L172)
+
+***
+
+### metricRequestStatus
+
+> `protected` **metricRequestStatus**: `Counter`\<`string`\>
+
+Defined in: [src/Server.ts:177](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L177)
+
+***
+
+### metricRequestTime
+
+> `protected` **metricRequestTime**: `Histogram`\<`string`\>
+
+Defined in: [src/Server.ts:182](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L182)
+
+***
+
+### metricTotalRequests
+
+> `protected` **metricTotalRequests**: `Counter`\<`string`\>
+
+Defined in: [src/Server.ts:196](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L196)
+
+***
+
+### objectFactory
+
+> `protected` `readonly` **objectFactory**: [`ObjectFactory`](ObjectFactory.md)
+
+Defined in: [src/Server.ts:163](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L163)
+
+The object factory to use when injecting dependencies.
+
+***
+
+### port
+
+> `readonly` **port**: `number`
+
+Defined in: [src/Server.ts:165](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L165)
+
+The port that the server is listening on.
+
+***
+
+### routeUtils?
+
+> `protected` `optional` **routeUtils?**: [`RouteUtils`](RouteUtils.md)
+
+Defined in: [src/Server.ts:166](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L166)
+
+***
+
+### serviceManager?
+
+> `protected` `optional` **serviceManager?**: [`BackgroundServiceManager`](BackgroundServiceManager.md)
+
+Defined in: [src/Server.ts:167](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L167)
+
+## Methods
+
+### getApplication()
+
+> **getApplication**(): `HttpRouter`
+
+Defined in: [src/Server.ts:220](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L220)
+
+Returns the HTTP router instance.
+
+#### Returns
+
+`HttpRouter`
+
+***
+
+### isRunning()
+
+> **isRunning**(): `boolean`
+
+Defined in: [src/Server.ts:227](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L227)
+
+Returns `true` if the server is running, otherwise `false`.
+
+#### Returns
+
+`boolean`
+
+***
+
+### postStart()
+
+> `protected` **postStart**(): `void` \| `Promise`\<`void`\>
+
+Defined in: [src/Server.ts:241](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L241)
+
+Override this function to add custom behavior after the server is started.
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### preStart()
+
+> `protected` **preStart**(): `void` \| `Promise`\<`void`\>
+
+Defined in: [src/Server.ts:234](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L234)
+
+Override this function to add custom behavior before the server is started.
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### restart()
+
+> **restart**(): `Promise`\<`void`\>
+
+Defined in: [src/Server.ts:622](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L622)
+
+Restarts the HTTP listen server using the provided configuration and OpenAPI specification.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### start()
+
+> **start**(): `Promise`\<`void`\>
+
+Defined in: [src/Server.ts:248](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L248)
+
+Starts an HTTP listen server based on the provided configuration and OpenAPI specification.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Defined in: [src/Server.ts:594](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L594)
+
+Stops the HTTP listen server.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/classes/SimpleEntity.md

@@ -0,0 +1,48 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / SimpleEntity
+
+# Abstract Class: SimpleEntity
+
+Defined in: [src/models/SimpleEntity.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L15)
+
+Provides a simple base class for all entity's that will be persisted with TypeORM. Unlike `BaseEntity` this class
+does not provide optimistic locking or date created and modified tracking.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Extended by
+
+- [`SimpleMongoEntity`](SimpleMongoEntity.md)
+
+## Constructors
+
+### Constructor
+
+> **new SimpleEntity**(`other?`): `SimpleEntity`
+
+Defined in: [src/models/SimpleEntity.ts:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L26)
+
+#### Parameters
+
+##### other?
+
+`Partial`\<`SimpleEntity`\>
+
+#### Returns
+
+`SimpleEntity`
+
+## Properties
+
+### uid
+
+> **uid**: `string`
+
+Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L24)
+
+The universally unique identifier of the entity.

package/docs/reference/classes/SimpleMongoEntity.md

@@ -0,0 +1,66 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / SimpleMongoEntity
+
+# Abstract Class: SimpleMongoEntity
+
+Defined in: [src/models/SimpleMongoEntity.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L14)
+
+Provides a simple base class for all entity's that will be persisted in a MongoDB database. Unlike
+`BaseMongoEntity` this class does not provide optimistic locking or date created and modified tracking.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Extends
+
+- [`SimpleEntity`](SimpleEntity.md)
+
+## Constructors
+
+### Constructor
+
+> **new SimpleMongoEntity**(`other?`): `SimpleMongoEntity`
+
+Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L21)
+
+#### Parameters
+
+##### other?
+
+`Partial`\<`SimpleMongoEntity`\>
+
+#### Returns
+
+`SimpleMongoEntity`
+
+#### Overrides
+
+[`SimpleEntity`](SimpleEntity.md).[`constructor`](SimpleEntity.md#constructor)
+
+## Properties
+
+### \_id?
+
+> `optional` **\_id?**: `ObjectId`
+
+Defined in: [src/models/SimpleMongoEntity.ts:19](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L19)
+
+The internal unique identifier used by MongoDB.
+
+***
+
+### uid
+
+> **uid**: `string`
+
+Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L24)
+
+The universally unique identifier of the entity.
+
+#### Inherited from
+
+[`SimpleEntity`](SimpleEntity.md).[`uid`](SimpleEntity.md#uid)

package/docs/reference/classes/StatusExtraData.md

@@ -0,0 +1,57 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / StatusExtraData
+
+# Class: StatusExtraData
+
+Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L1)
+
+## Constructors
+
+### Constructor
+
+> **new StatusExtraData**(`other`): `StatusExtraData`
+
+Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L9)
+
+#### Parameters
+
+##### other
+
+`Partial`\<`StatusExtraData`\>
+
+#### Returns
+
+`StatusExtraData`
+
+## Accessors
+
+### data
+
+#### Get Signature
+
+> **get** **data**(): `any`
+
+Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L3)
+
+##### Returns
+
+`any`
+
+#### Set Signature
+
+> **set** **data**(`data`): `void`
+
+Defined in: [src/models/StatusExtraData.ts:6](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L6)
+
+##### Parameters
+
+###### data
+
+`any`
+
+##### Returns
+
+`void`

package/docs/reference/classes/StatusRoute.md

@@ -0,0 +1,26 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / StatusRoute
+
+# Class: StatusRoute
+
+Defined in: [src/routes/StatusRoute.ts:17](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/StatusRoute.ts#L17)
+
+The `StatusRoute` provides a default `/status` endpoint the returns metadata information about the service such as
+name, version.
+
+## Author
+
+Jean-Philippe Steinmetz
+
+## Constructors
+
+### Constructor
+
+> **new StatusRoute**(): `StatusRoute`
+
+#### Returns
+
+`StatusRoute`

package/docs/reference/enumerations/ACLAction.md

@@ -0,0 +1,63 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / ACLAction
+
+# Enumeration: ACLAction
+
+Defined in: [src/security/AccessControlList.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L10)
+
+Describes the various permission actions that can be performed against an entity.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Enumeration Members
+
+### CREATE
+
+> **CREATE**: `"CREATE"`
+
+Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L11)
+
+***
+
+### DELETE
+
+> **DELETE**: `"DELETE"`
+
+Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L12)
+
+***
+
+### FULL
+
+> **FULL**: `"FULL"`
+
+Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L13)
+
+***
+
+### READ
+
+> **READ**: `"READ"`
+
+Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L14)
+
+***
+
+### SPECIAL
+
+> **SPECIAL**: `"SPECIAL"`
+
+Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L15)
+
+***
+
+### UPDATE
+
+> **UPDATE**: `"UPDATE"`
+
+Defined in: [src/security/AccessControlList.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L16)