npm - @rapidrest/service-core - Versions diffs - 1.0.0-rc.9 → 1.0.0 - Mend

@rapidrest/service-core 1.0.0-rc.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (380) hide show

package/docs/reference/classes/ACLUtils.md DELETED Viewed

@@ -1,263 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / ACLUtils
-# Class: ACLUtils
-Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L22)
-Common utility functions for working with `AccessControlList` objects and validating user permissions.
-## Constructors
-### Constructor
-> **new ACLUtils**(): `ACLUtils`
-#### Returns
-`ACLUtils`
-## Properties
-### enabled
-> **enabled**: `boolean` = `true`
-Defined in: [src/security/ACLUtils.ts:24](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L24)
-## Methods
-### checkRequestPerms()
-> **checkRequestPerms**(`uid`, `user`, `req`): `Promise`\<`boolean`\>
-Defined in: [src/security/ACLUtils.ts:90](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L90)
-Validates that the user has permission to perform the request operation against the URL path for the
-provided request. If ACLUtils has not been initialized or the `acl` datastore has not been configured
-then always returns `true`.
-#### Parameters
-##### uid
-`string`
-The uid of the access control list to verify against.
-##### user
-`JWTUser` \| `undefined`
-The user to validate.
-##### req
-[`HttpRequest`](../interfaces/HttpRequest.md)
-The request whose URL path and method will be verified.
-#### Returns
-`Promise`\<`boolean`\>
-***
-### findACL()
-> **findACL**(`entityId`, `parentUids?`, `reqCache?`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
-Defined in: [src/security/ACLUtils.ts:219](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L219)
-Retrieves the access control list with the associated identifier and populates the parent(s).
-#### Parameters
-##### entityId
-`string`
-The unique identifier of the ACL to retrieve.
-##### parentUids?
-`string`[] = `[]`
-The list of already found parent UIDs. This is used to break circular dependencies.
-##### reqCache?
-`Map`\<`string`, [`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
-#### Returns
-`Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
-***
-### getRecord()
-> **getRecord**(`acl`, `user`): [`ACLRecord`](../interfaces/ACLRecord.md) \| `null`
-Defined in: [src/security/ACLUtils.ts:498](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L498)
-Retrieves the first available record in the provided ACL associated with the provided user.
-#### Parameters
-##### acl
-[`AccessControlList`](../interfaces/AccessControlList.md)
-The access control list that will be searched.
-##### user
-`JWTUser` \| `undefined`
-The user to find a record for.
-#### Returns
-[`ACLRecord`](../interfaces/ACLRecord.md) \| `null`
-The ACL record associated with the given user if found, otherwise `undefined`.
-***
-### hasPermission()
-> **hasPermission**(`user`, `acl`, `action`): `Promise`\<`boolean`\>
-Defined in: [src/security/ACLUtils.ts:151](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L151)
-Validates that the user has permission to perform the provided action using the given access control list.
-#### Parameters
-##### user
-`JWTUser` \| `undefined`
-The user to validate permissions of.
-##### acl
-`string` \| [`AccessControlList`](../interfaces/AccessControlList.md)
-The ACL or uid of an ACL to validate permissions against.
-##### action
-[`ACLAction`](../enumerations/ACLAction.md)
-The action that the user desires permission for.
-#### Returns
-`Promise`\<`boolean`\>
-`true` if the user has at least one of the permissions granted for the given entity, otherwise `false`.
-***
-### populateParent()
-> **populateParent**(`acl`, `parentUids?`): `Promise`\<`void`\>
-Defined in: [src/security/ACLUtils.ts:518](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L518)
-Attempts to retrieve the parent access control list for the given ACL object.
-#### Parameters
-##### acl
-[`AccessControlList`](../interfaces/AccessControlList.md)
-The access control list whose parents will be populated.
-##### parentUids?
-`string`[] = `[]`
-The list of already found parent UIDs. This is used to break circular dependencies.
-#### Returns
-`Promise`\<`void`\>
-***
-### removeACL()
-> **removeACL**(`uid`): `Promise`\<`void`\>
-Defined in: [src/security/ACLUtils.ts:284](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L284)
-Deletes the ACL with the given identifier from the database.
-#### Parameters
-##### uid
-`string`
-The unique identifier of the ACL to remove.
-#### Returns
-`Promise`\<`void`\>
-***
-### saveACL()
-> **saveACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
-Defined in: [src/security/ACLUtils.ts:372](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L372)
-Stores the given access control list into the ACL database.
-#### Parameters
-##### acl
-[`AccessControlList`](../interfaces/AccessControlList.md)
-The ACL to store.
-#### Returns
-`Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
-Returns the ACL that was stored in the database.
-***
-### saveDefaultACL()
-> **saveDefaultACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
-Defined in: [src/security/ACLUtils.ts:438](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/security/ACLUtils.ts#L438)
-Stores the given default access control list into the ACL database. A default ACL is a special type of ACL
-that is primarily defined and maintained within the code but allows for user-specific overrides. To accomplish
-this, the provided ACL is split in two. A new record is automatically created with the `uid` of the form
-`default_<uid>` that stores the exact record as provided by code. Then a second ACL record is created
-with the `uid` being that of what is passed as the argument. This second ACL is used to store user-defined
-overrides. As the `default_<uid>` record is always overwritten with the lastest version of the code, any
-user-defined changes made to it are lost on service restart.
-#### Parameters
-##### acl
-[`AccessControlList`](../interfaces/AccessControlList.md)
-#### Returns
-`Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>

package/docs/reference/classes/AdminRoute.md DELETED Viewed

@@ -1,51 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / AdminRoute
-# Class: AdminRoute
-Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/routes/AdminRoute.ts#L50)
-The `AdminRoute` provides a default `/admin` endpoint that gives trusted users the following abilities:
-* Clear cache via `GET /admin/clear-cache`
-* Live tail the service logs via `GET /admin/logs`
-* Retrieve service dependencies via `GET /admin/dependencies`
-* Retrieve service release notes via `GET /admin/release-notes`
-* Restart the service via `GET /admin/restart`
-## Author
-Jean-Philippe Steinmetz
-## Constructors
-### Constructor
-> **new AdminRoute**(`releaseNotes`): `AdminRoute`
-Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/routes/AdminRoute.ts#L82)
-Constructs a new `ReleaseNotesRoute` object with the specified defaults.
-#### Parameters
-##### releaseNotes
-`string`
-The ReleaseNotes specification object to serve.
-#### Returns
-`AdminRoute`
-## Properties
-### cacheClient?
-> `protected` `optional` **cacheClient?**: `Redis`
-Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/routes/AdminRoute.ts#L55)

package/docs/reference/classes/AuthMiddleware.md DELETED Viewed

@@ -1,173 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / AuthMiddleware
-# Class: AuthMiddleware
-Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/auth/AuthMiddleware.ts#L19)
-A set of common utilities for performing authentication using one or more strategies.
-## Author
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-## Constructors
-### Constructor
-> **new AuthMiddleware**(): `AuthMiddleware`
-#### Returns
-`AuthMiddleware`
-## Properties
-### strategies
-> `readonly` **strategies**: `Map`\<`string`, [`AuthStrategy`](../interfaces/AuthStrategy.md)\>
-Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/auth/AuthMiddleware.ts#L30)
-The authentication strategies that have been registered.
-## Methods
-### authenticate()
-> **authenticate**(`strategies`, `req`, `res?`, `required?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
-Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/auth/AuthMiddleware.ts#L54)
-Performs authentication of the given request using one of the provided strategies.
-#### Parameters
-##### strategies
-`string`[]
-The list of strategy names to attempt authentication with.
-##### req
-[`HttpRequest`](../interfaces/HttpRequest.md)
-The request containing data to perform authenticate with.
-##### res?
-[`HttpResponse`](../interfaces/HttpResponse.md)
-The response to use when writing back directly to the client.
-##### required?
-`boolean`
-Set to `true` to if authentication is required to pass, otherwise set to `false`.
-#### Returns
-`Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
-***
-### authenticateSync()
-> **authenticateSync**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
-Defined in: [src/auth/AuthMiddleware.ts:92](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/auth/AuthMiddleware.ts#L92)
-Performs authentication of the given request using one of the provided strategies.
-This is the synchronous version of `authenticate` that performs blocking based authentication.
-#### Parameters
-##### strategies
-`string`[]
-The list of strategy names to attempt authentication with.
-##### req
-[`HttpRequest`](../interfaces/HttpRequest.md)
-The request containing data to perform authenticate with.
-##### res?
-[`HttpResponse`](../interfaces/HttpResponse.md)
-The response to use when writing back directly to the client.
-##### required?
-`boolean`
-Set to `true` to if authentication is required to pass, otherwise set to `false`.
-#### Returns
-[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
-***
-### authWebSocket()
-> **authWebSocket**(`required`): [`RequestHandler`](../type-aliases/RequestHandler.md)
-Defined in: [src/auth/AuthMiddleware.ts:133](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/auth/AuthMiddleware.ts#L133)
-Returns a request handler function that will perform authentication of a websocket connection. Authentication
-can be handled in two ways:
-1. Authorization header
-2. Negotiation via handshake
-This middleware function primarily provides the implementation for item 2 above.
-#### Parameters
-##### required
-`boolean`
-Set to `true` to indicate that auth is required, otherwise `false`.
-#### Returns
-[`RequestHandler`](../type-aliases/RequestHandler.md)
-***
-### register()
-> **register**(`name`, `strategy`): `void`
-Defined in: [src/auth/AuthMiddleware.ts:277](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/auth/AuthMiddleware.ts#L277)
-Registers the provided authentication strategy to be used
-#### Parameters
-##### name
-`string`
-The name of the authentication type to associate the given strategy with
-##### strategy
-[`AuthStrategy`](../interfaces/AuthStrategy.md)
-The strategy to register
-#### Returns
-`void`

package/docs/reference/classes/BackgroundService.md DELETED Viewed

@@ -1,117 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / BackgroundService
-# Abstract Class: BackgroundService
-Defined in: [src/BackgroundService.ts:10](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L10)
-The `BackgroundService` is an abstract base class for defining scheduled background services. A background service
-executes in the background once on startup or on a set schedule (like a cron job) and performs additional processing.
-## Author
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-## Constructors
-### Constructor
-> **new BackgroundService**(`config`, `logger`): `BackgroundService`
-Defined in: [src/BackgroundService.ts:16](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L16)
-#### Parameters
-##### config
-`any`
-##### logger
-`any`
-#### Returns
-`BackgroundService`
-## Properties
-### config
-> `protected` **config**: `any`
-Defined in: [src/BackgroundService.ts:12](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L12)
-The global application configuration that the service can reference.
-***
-### logger
-> `protected` **logger**: `any`
-Defined in: [src/BackgroundService.ts:14](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L14)
-The logging utility to use.
-## Accessors
-### schedule
-#### Get Signature
-> **get** `abstract` **schedule**(): `string` \| `undefined`
-Defined in: [src/BackgroundService.ts:25](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L25)
-Returns the desired execution interval that this service should be scheduled with. If `undefined` is returned
-the service is executed only once.
-##### Returns
-`string` \| `undefined`
-## Methods
-### run()
-> `abstract` **run**(): `void` \| `Promise`\<`void`\>
-Defined in: [src/BackgroundService.ts:30](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L30)
-The processing function to execute at each scheduled interval.
-#### Returns
-`void` \| `Promise`\<`void`\>
-***
-### start()
-> `abstract` **start**(): `void` \| `Promise`\<`void`\>
-Defined in: [src/BackgroundService.ts:35](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L35)
-Initializes the background service with any defaults.
-#### Returns
-`void` \| `Promise`\<`void`\>
-***
-### stop()
-> `abstract` **stop**(): `void` \| `Promise`\<`void`\>
-Defined in: [src/BackgroundService.ts:40](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/BackgroundService.ts#L40)
-Shuts down the background allowing the service to complete any outstanding tasks.
-#### Returns
-`void` \| `Promise`\<`void`\>