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

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

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

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / Reference
-
-# Function: Reference()
-
-> **Reference**(`clazz`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/ModelDecorators.ts:160](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L160)
-
-Apply this to a property to indicate that the value is a reference to another stored entity.
-
-## Parameters
-
-### clazz
-
-`any`
-
-The class type of the referenced object.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

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

@@ -1,27 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / Shard
-
-# Function: Shard()
-
-> **Shard**(`config?`): (`target`) => `void`
-
-Defined in: [src/decorators/ModelDecorators.ts:173](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L173)
-
-Indicates that the class describes an entity that will be persisted in a sharded database collection.
-
-Note: Only supported by MongoDB.
-
-## Parameters
-
-### config?
-
-`any` = `...`
-
-The sharding configuration to pass to the database server. Default value is `{ key: { uid: 1 }, unique: false, options: {} }`.
-
-## Returns
-
-(`target`) => `void`

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

@@ -1,26 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / TrackChanges
-
-# Function: TrackChanges()
-
-> **TrackChanges**(`versions?`): (`target`) => `void`
-
-Defined in: [src/decorators/ModelDecorators.ts:190](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L190)
-
-Indicates that the class will track changes for each document update limited to the specified number of versions.
-
-## Parameters
-
-### versions?
-
-`number` = `-1`
-
-The number of versions that will be tracked for each document change. Set to `-1` to store all
-versions. Default value is `-1`.
-
-## Returns
-
-(`target`) => `void`

package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md

@@ -1,45 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / PendingTypeOrmColumn
-
-# Interface: PendingTypeOrmColumn
-
-Defined in: [src/decorators/ModelDecorators.ts:12](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L12)
-
-Describes a column registration that must be bridged into TypeORM's metadata storage when (and only when) a SQL
-connection is established. Entries are queued here by decorators so that this module does not depend on the
-optional `typeorm` package.
-
-## Properties
-
-### mode
-
-> **mode**: `"regular"`
-
-Defined in: [src/decorators/ModelDecorators.ts:15](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L15)
-
-***
-
-### options
-
-> **options**: `any`
-
-Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L16)
-
-***
-
-### propertyName
-
-> **propertyName**: `string`
-
-Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L14)
-
-***
-
-### target
-
-> **target**: `any`
-
-Defined in: [src/decorators/ModelDecorators.ts:13](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L13)

package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md

@@ -1,14 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [ModelDecorators](../README.md) / pendingTypeOrmColumns
-
-# Variable: pendingTypeOrmColumns
-
-> `const` **pendingTypeOrmColumns**: [`PendingTypeOrmColumn`](../interfaces/PendingTypeOrmColumn.md)[] = `[]`
-
-Defined in: [src/decorators/ModelDecorators.ts:23](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/ModelDecorators.ts#L23)
-
-The list of column registrations waiting to be bridged into TypeORM's metadata storage. This list is drained by
-the TypeORM support module when a SQL connection is created.

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

@@ -1,27 +0,0 @@
-[**@rapidrest/service-core**](../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../globals.md) / PersistenceDecorators
-
-# PersistenceDecorators
-
-## Interfaces
-
-- [CollationOptions](interfaces/CollationOptions.md)
-- [ColumnInfo](interfaces/ColumnInfo.md)
-- [ColumnOptions](interfaces/ColumnOptions.md)
-- [EntityOptions](interfaces/EntityOptions.md)
-- [IndexInfo](interfaces/IndexInfo.md)
-- [IndexOptions](interfaces/IndexOptions.md)
-
-## Functions
-
-- [Column](functions/Column.md)
-- [Entity](functions/Entity.md)
-- [getColumnMetadata](functions/getColumnMetadata.md)
-- [getEntityName](functions/getEntityName.md)
-- [getIndexMetadata](functions/getIndexMetadata.md)
-- [Index](functions/Index.md)
-- [PrimaryColumn](functions/PrimaryColumn.md)
-- [Unique](functions/Unique.md)

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / Column
-
-# Function: Column()
-
-> **Column**(`options?`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:124](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L124)
-
-Indicates that the decorated property will be persisted as a column/property in the datastore.
-
-## Parameters
-
-### options?
-
-[`ColumnOptions`](../interfaces/ColumnOptions.md) = `{}`
-
-The options describing the column.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / Entity
-
-# Function: Entity()
-
-> **Entity**(`options?`): (`target`) => `void`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:226](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L226)
-
-Indicates that the class describes an entity that is persisted to a datastore.
-
-## Parameters
-
-### options?
-
-[`EntityOptions`](../interfaces/EntityOptions.md)
-
-The options to set.
-
-## Returns
-
-(`target`) => `void`

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md

@@ -1,119 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / Index
-
-# Function: Index()
-
-## Call Signature
-
-> **Index**(`nameOrOptions?`, `options?`): `PropertyDecorator`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:162](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L162)
-
-Declares a database index.
-
-When applied to a property, creates an index on that single property:
-```
-@Index()                            // unnamed index
-@Index("myName")                    // named index
-@Index({ unique: true })            // unnamed unique index
-@Index("myName", { unique: true })  // named unique index
-```
-
-When applied to a class, creates a compound index across the given properties:
-```
-@Index(["firstName", "lastName"])
-@Index("fullName", ["firstName", "lastName"], { unique: true })
-```
-
-### Parameters
-
-#### nameOrOptions?
-
-`string` \| [`IndexOptions`](../interfaces/IndexOptions.md)
-
-#### options?
-
-[`IndexOptions`](../interfaces/IndexOptions.md)
-
-### Returns
-
-`PropertyDecorator`
-
-## Call Signature
-
-> **Index**(`fields`, `options?`): `ClassDecorator`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:163](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L163)
-
-Declares a database index.
-
-When applied to a property, creates an index on that single property:
-```
-@Index()                            // unnamed index
-@Index("myName")                    // named index
-@Index({ unique: true })            // unnamed unique index
-@Index("myName", { unique: true })  // named unique index
-```
-
-When applied to a class, creates a compound index across the given properties:
-```
-@Index(["firstName", "lastName"])
-@Index("fullName", ["firstName", "lastName"], { unique: true })
-```
-
-### Parameters
-
-#### fields
-
-`string`[]
-
-#### options?
-
-[`IndexOptions`](../interfaces/IndexOptions.md)
-
-### Returns
-
-`ClassDecorator`
-
-## Call Signature
-
-> **Index**(`name`, `fields`, `options?`): `ClassDecorator`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:164](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L164)
-
-Declares a database index.
-
-When applied to a property, creates an index on that single property:
-```
-@Index()                            // unnamed index
-@Index("myName")                    // named index
-@Index({ unique: true })            // unnamed unique index
-@Index("myName", { unique: true })  // named unique index
-```
-
-When applied to a class, creates a compound index across the given properties:
-```
-@Index(["firstName", "lastName"])
-@Index("fullName", ["firstName", "lastName"], { unique: true })
-```
-
-### Parameters
-
-#### name
-
-`string`
-
-#### fields
-
-`string`[]
-
-#### options?
-
-[`IndexOptions`](../interfaces/IndexOptions.md)
-
-### Returns
-
-`ClassDecorator`

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / PrimaryColumn
-
-# Function: PrimaryColumn()
-
-> **PrimaryColumn**(`options?`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:140](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/PersistenceDecorators.ts#L140)
-
-Indicates that the decorated property is a primary key column in the datastore.
-
-## Parameters
-
-### options?
-
-[`ColumnOptions`](../interfaces/ColumnOptions.md) = `{}`
-
-The options describing the column.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`