@rapidrest/service-core 1.0.0-rc.2 → 1.0.0-rc.21

package/docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/README.md

@@ -1,13 +0,0 @@
-[**@rapidrest/service-core**](../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../globals.md) / DatabaseDecorators
-
-# DatabaseDecorators
-
-## Functions
-
-- [MongoRepository](functions/MongoRepository.md)
-- [RedisConnection](functions/RedisConnection.md)
-- [Repository](functions/Repository.md)

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / MongoRepository
-
-# Function: MongoRepository()
-
-> **MongoRepository**(`type`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DatabaseDecorators.ts:10](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DatabaseDecorators.ts#L10)
-
-Apply this to a property to have the TypeORM `MongoRepository` for the given entity type injected at instantiation.
-
-## Parameters
-
-### type
-
-`any`
-
-The entity type whose repository will be injected.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / RedisConnection
-
-# Function: RedisConnection()
-
-> **RedisConnection**(`name`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DatabaseDecorators.ts:44](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DatabaseDecorators.ts#L44)
-
-Apply this to a property to have the `Redis` connection injected at instantiation.
-
-## Parameters
-
-### name
-
-`string`
-
-The name of the database connection to inject.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / Repository
-
-# Function: Repository()
-
-> **Repository**(`type`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DatabaseDecorators.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DatabaseDecorators.ts#L27)
-
-Apply this to a property to have the TypeORM `Repository` for the given entity type injected at instantiation.
-
-## Parameters
-
-### type
-
-`any`
-
-The entity type whose repository will be injected.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/README.md

@@ -1,23 +0,0 @@
-[**@rapidrest/service-core**](../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../globals.md) / DocDecorators
-
-# DocDecorators
-
-## Interfaces
-
-- [DocumentsData](interfaces/DocumentsData.md)
-
-## Functions
-
-- [Default](functions/Default.md)
-- [Description](functions/Description.md)
-- [Document](functions/Document.md)
-- [Example](functions/Example.md)
-- [Format](functions/Format.md)
-- [Returns](functions/Returns.md)
-- [Summary](functions/Summary.md)
-- [Tags](functions/Tags.md)
-- [TypeInfo](functions/TypeInfo.md)

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Default
-
-# Function: Default()
-
-> **Default**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L40)
-
-Provides a default value for property of a class.
-
-## Parameters
-
-### value
-
-`string`
-
-The default value.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Description
-
-# Function: Description()
-
-> **Description**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:51](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L51)
-
-Provides a detailed describing the class, property or function.
-
-## Parameters
-
-### value
-
-`string`
-
-The description of the class, property or function.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Document
-
-# Function: Document()
-
-> **Document**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L20)
-
-Provides a set of documentation data for a given class, property or function.
-
-## Parameters
-
-### value
-
-[`DocumentsData`](../interfaces/DocumentsData.md)
-
-The default value.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Example
-
-# Function: Example()
-
-> **Example**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:62](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L62)
-
-Provides a example representation of the property or function return value.
-
-## Parameters
-
-### value
-
-`any`
-
-The example value.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Format
-
-# Function: Format()
-
-> **Format**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:73](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L73)
-
-Describes the underlying format of a class's property.
-
-## Parameters
-
-### value
-
-`string`
-
-The format of the property's property.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md

@@ -1,28 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Returns
-
-# Function: Returns()
-
-> **Returns**(`types?`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:109](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L109)
-
-Stores runtime metadata about the typing information of a function's return value.
-
-## Parameters
-
-### types?
-
-`any`
-
-The optional return type(s) of the function. Can represent a single type (e.g. `MyClass`) or a union
-of types (e.g. `string | number | null`). When describing a generic type such as a collection this
-should be encoded as an array with the templated type as additional elements (e.g. `Array<MyClass>`
-becomes `[[Array, MyClass]]`).
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Summary
-
-# Function: Summary()
-
-> **Summary**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:84](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L84)
-
-Provides a brief summary about the class, property or function.
-
-## Parameters
-
-### value
-
-`string`
-
-The summary of the class, property or function.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Tags
-
-# Function: Tags()
-
-> **Tags**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:95](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L95)
-
-Provides a list of searchable tags associated with the property or function.
-
-## Parameters
-
-### value
-
-`string`[]
-
-The list of searchable tags.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md

@@ -1,28 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / TypeInfo
-
-# Function: TypeInfo()
-
-> **TypeInfo**(`types?`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:128](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L128)
-
-Stores runtime metadata about the typing information of a class property.
-
-## Parameters
-
-### types?
-
-`any`
-
-The optional primary type(s) of the property. Can represent a single type (e.g. `MyClass`) or a union
-of types (e.g. `string | number | null`). When describing a generic type such as a collection this
-should be encoded as an array with the templated type as additional elements (e.g. `Array<MyClass>`
-becomes `[[Array, MyClass]]`).
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md

@@ -1,57 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / DocumentsData
-
-# Interface: DocumentsData
-
-Defined in: [src/decorators/DocDecorators.ts:6](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L6)
-
-## Properties
-
-### default?
-
-> `optional` **default?**: `any`
-
-Defined in: [src/decorators/DocDecorators.ts:7](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L7)
-
-***
-
-### description?
-
-> `optional` **description?**: `string`
-
-Defined in: [src/decorators/DocDecorators.ts:8](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L8)
-
-***
-
-### example?
-
-> `optional` **example?**: `any`
-
-Defined in: [src/decorators/DocDecorators.ts:9](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L9)
-
-***
-
-### format?
-
-> `optional` **format?**: `string`
-
-Defined in: [src/decorators/DocDecorators.ts:10](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L10)
-
-***
-
-### summary?
-
-> `optional` **summary?**: `string`
-
-Defined in: [src/decorators/DocDecorators.ts:11](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L11)
-
-***
-
-### tags?
-
-> `optional` **tags?**: `string`[]
-
-Defined in: [src/decorators/DocDecorators.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L12)

package/docs/reference/@rapidrest/namespaces/EventDecorators/README.md

@@ -1,12 +0,0 @@
-[**@rapidrest/service-core**](../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../globals.md) / EventDecorators
-
-# EventDecorators
-
-## Functions
-
-- [EventListener](functions/EventListener.md)
-- [OnEvent](functions/OnEvent.md)

package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md

@@ -1,17 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [EventDecorators](../README.md) / EventListener
-
-# Function: EventListener()
-
-> **EventListener**(): (`target`) => `void`
-
-Defined in: [src/decorators/EventDecorators.ts:21](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/EventDecorators.ts#L21)
-
-Apply this optionally to a abitary class, that has a no argument constructor, to auto register it as an event listener. Will still require add `@OnEvent` to methods
-
-## Returns
-
-(`target`) => `void`

package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md

@@ -1,26 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [EventDecorators](../README.md) / OnEvent
-
-# Function: OnEvent()
-
-> **OnEvent**(`type?`): (`target`, `propertyKey`, `descriptor`) => `void`
-
-Defined in: [src/decorators/EventDecorators.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/EventDecorators.ts#L12)
-
-Apply this to a function that will be called when events arrive for the specified type(s). If no event type is
-specified, then the function will be called upon each event that arrives.
-
-## Parameters
-
-### type?
-
-`string` \| `string`[]
-
-The name or list of names corresponding to events that the function will handle.
-
-## Returns
-
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/ModelDecorators/README.md

@@ -1,26 +0,0 @@
-[**@rapidrest/service-core**](../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../globals.md) / ModelDecorators
-
-# ModelDecorators
-
-## Interfaces
-
-- [PendingTypeOrmColumn](interfaces/PendingTypeOrmColumn.md)
-
-## Variables
-
-- [pendingTypeOrmColumns](variables/pendingTypeOrmColumns.md)
-
-## Functions
-
-- [Cache](functions/Cache.md)
-- [ChildEntity](functions/ChildEntity.md)
-- [DataStore](functions/DataStore.md)
-- [Identifier](functions/Identifier.md)
-- [Protect](functions/Protect.md)
-- [Reference](functions/Reference.md)
-- [Shard](functions/Shard.md)
-- [TrackChanges](functions/TrackChanges.md)

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / Cache
-
-# Function: Cache()
-
-> **Cache**(`ttl?`): (`target`) => `void`
-
-Defined in: [src/decorators/ModelDecorators.ts:30](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L30)
-
-Indicates that the class is cacheable with the specified TTL.
-
-## Parameters
-
-### ttl?
-
-`number` = `30`
-
-The time, in seconds, that an object will be cached before being invalidated.
-
-## Returns
-
-(`target`) => `void`

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md

@@ -1,18 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / ChildEntity
-
-# Function: ChildEntity()
-
-> **ChildEntity**(): \<`T`\>(`constructor`) => \{(...`args`): `child`\<`T`\>; `prototype`: `child`\<`any`\>; \} & `T`
-
-Defined in: [src/decorators/ModelDecorators.ts:45](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L45)
-
-Indicates that a class is a child entity to some parent. Child entities will inherit all datastore configuration
-of the parent, including cache settings.
-
-## Returns
-
-\<`T`\>(`constructor`) => \{(...`args`): `child`\<`T`\>; `prototype`: `child`\<`any`\>; \} & `T`

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / DataStore
-
-# Function: DataStore()
-
-> **DataStore**(`datastore`): (`target`) => `void`
-
-Defined in: [src/decorators/ModelDecorators.ts:73](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L73)
-
-Indicates that the class describes an entity that will be persisted in the datastore with the given name.
-
-## Parameters
-
-### datastore
-
-`string`
-
-The name of the datastore to store records of the decorated class.
-
-## Returns
-
-(`target`) => `void`

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md

@@ -1,27 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / Identifier
-
-# Function: Identifier()
-
-> **Identifier**(`target`, `propertyKey`): `void`
-
-Defined in: [src/decorators/ModelDecorators.ts:87](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L87)
-
-Apply this to a property that is considered a unique identifier.
-
-## Parameters
-
-### target
-
-`any`
-
-### propertyKey
-
-`string` \| `symbol`
-
-## Returns
-
-`void`

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md

@@ -1,35 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / Protect
-
-# Function: Protect()
-
-> **Protect**(`classACL?`, `recordACL?`): (`target`) => `void`
-
-Defined in: [src/decorators/ModelDecorators.ts:109](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L109)
-
-Apply this to a model class to indicate that it should be protected by the AccessControlList security system.
-The `classACL` parameter specifies the default ACL governing access to general operations against the model class
-(e.g. create, truncate, find). The `recordACL` parameter indicates whether or not per-record ACLs should be created
-for this type in order to govern access to individual record operations (e.g. delete, update, find).
-
-## Parameters
-
-### classACL?
-
-`PartialACL` = `...`
-
-The default access control list to limit access to general class operations.
-
-### recordACL?
-
-`boolean` = `false`
-
-Set to `true` to create an ACL for each new record of the given type, otherwise set to false. Default
-is `false`.
-
-## Returns
-
-(`target`) => `void`