@rapidrest/service-core 1.0.0-beta.1

package/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

package/docs/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+import recommonmark
+from recommonmark.transform import AutoStructify
+
+source_suffix = ['.rst', '.md']
+
+# -- Project information -----------------------------------------------------
+
+project = 'Core Library'
+copyright = 'RapidREST All rights reserved.'
+author = 'RapidREST'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'recommonmark',
+    'sphinx.ext.autodoc',
+]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+master_doc = 'index'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# app setup hook
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'auto_toc_tree_section': 'Contents',
+        'enable_math': False,
+        'enable_inline_math': False,
+        'enable_eval_rst': True,
+        'enable_auto_doc_ref': True,
+    }, True)
+    app.add_transform(AutoStructify)

package/docs/index.rst

@@ -0,0 +1,17 @@
+===============================================================================
+Services Core Library
+===============================================================================
+
+Repository: ``git clone https://github.com/rapidrest/service-core.git``
+
+Provides all core functionality for RapidREST based backend services.
+
+.. toctree::
+   :caption: Project Info
+
+   reference/README
+
+.. toctree::
+   :caption: API Reference
+
+   reference/globals

package/docs/make.bat

@@ -0,0 +1,35 @@
+@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

@@ -0,0 +1,13 @@
+[**@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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,23 @@
+[**@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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,28 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,28 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,57 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L6)
+
+## Properties
+
+### default?
+
+> `optional` **default?**: `any`
+
+Defined in: [src/decorators/DocDecorators.ts:7](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L7)
+
+***
+
+### description?
+
+> `optional` **description?**: `string`
+
+Defined in: [src/decorators/DocDecorators.ts:8](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L8)
+
+***
+
+### example?
+
+> `optional` **example?**: `any`
+
+Defined in: [src/decorators/DocDecorators.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L9)
+
+***
+
+### format?
+
+> `optional` **format?**: `string`
+
+Defined in: [src/decorators/DocDecorators.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L10)
+
+***
+
+### summary?
+
+> `optional` **summary?**: `string`
+
+Defined in: [src/decorators/DocDecorators.ts:11](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L11)
+
+***
+
+### tags?
+
+> `optional` **tags?**: `string`[]
+
+Defined in: [src/decorators/DocDecorators.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L12)

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

@@ -0,0 +1,12 @@
+[**@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

@@ -0,0 +1,17 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,26 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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

@@ -0,0 +1,26 @@
+[**@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

@@ -0,0 +1,25 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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`