@rapidrest/service-core 1.0.0-beta.1

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

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

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

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

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

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

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

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

@@ -0,0 +1,45 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L15)
+
+***
+
+### options
+
+> **options**: `any`
+
+Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L16)
+
+***
+
+### propertyName
+
+> **propertyName**: `string`
+
+Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L14)
+
+***
+
+### target
+
+> **target**: `any`
+
+Defined in: [src/decorators/ModelDecorators.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L13)

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

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

@@ -0,0 +1,25 @@
+[**@rapidrest/service-core**](../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../globals.md) / PersistenceDecorators
+
+# PersistenceDecorators
+
+## Interfaces
+
+- [ColumnInfo](interfaces/ColumnInfo.md)
+- [ColumnOptions](interfaces/ColumnOptions.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

@@ -0,0 +1,25 @@
+[**@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:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L95)
+
+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

@@ -0,0 +1,26 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / Entity
+
+# Function: Entity()
+
+> **Entity**(`name?`): (`target`) => `void`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:198](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L198)
+
+Indicates that the class describes an entity that is persisted to a datastore.
+
+## Parameters
+
+### name?
+
+`string`
+
+The name of the collection (or table) that records will be stored in. Defaults to the snake_case
+form of the class name.
+
+## Returns
+
+(`target`) => `void`

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

@@ -0,0 +1,119 @@
+[**@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:133](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L133)
+
+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:134](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L134)
+
+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:135](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L135)
+
+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

@@ -0,0 +1,25 @@
+[**@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:111](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L111)
+
+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`

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

@@ -0,0 +1,68 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / Unique
+
+# Function: Unique()
+
+## Call Signature
+
+> **Unique**(`name?`): `PropertyDecorator`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:179](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L179)
+
+Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
+applied to a property (single-column constraint) or a class (compound constraint).
+
+### Parameters
+
+#### name?
+
+`string`
+
+### Returns
+
+`PropertyDecorator`
+
+## Call Signature
+
+> **Unique**(`fields`): `ClassDecorator`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:180](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L180)
+
+Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
+applied to a property (single-column constraint) or a class (compound constraint).
+
+### Parameters
+
+#### fields
+
+`string`[]
+
+### Returns
+
+`ClassDecorator`
+
+## Call Signature
+
+> **Unique**(`name`, `fields`): `ClassDecorator`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:181](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L181)
+
+Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
+applied to a property (single-column constraint) or a class (compound constraint).
+
+### Parameters
+
+#### name
+
+`string`
+
+#### fields
+
+`string`[]
+
+### Returns
+
+`ClassDecorator`

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

@@ -0,0 +1,26 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / getColumnMetadata
+
+# Function: getColumnMetadata()
+
+> **getColumnMetadata**(`clazz`): [`ColumnInfo`](../interfaces/ColumnInfo.md)[]
+
+Defined in: [src/decorators/PersistenceDecorators.ts:216](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L216)
+
+Returns the merged list of persisted columns declared across the entire class hierarchy of the given model
+class. Columns declared in subclasses override columns of the same property name declared in parent classes.
+
+## Parameters
+
+### clazz
+
+`any`
+
+The model class to retrieve column metadata for.
+
+## Returns
+
+[`ColumnInfo`](../interfaces/ColumnInfo.md)[]

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

@@ -0,0 +1,26 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / getEntityName
+
+# Function: getEntityName()
+
+> **getEntityName**(`clazz`): `string` \| `undefined`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:261](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L261)
+
+Returns the explicit entity name declared via `@Entity(name)` on the given class or the nearest ancestor that
+declares one, otherwise `undefined`.
+
+## Parameters
+
+### clazz
+
+`any`
+
+The model class to retrieve the entity name for.
+
+## Returns
+
+`string` \| `undefined`

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

@@ -0,0 +1,27 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / getIndexMetadata
+
+# Function: getIndexMetadata()
+
+> **getIndexMetadata**(`clazz`): [`IndexInfo`](../interfaces/IndexInfo.md)[]
+
+Defined in: [src/decorators/PersistenceDecorators.ts:236](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L236)
+
+Returns the merged list of indexes declared across the entire class hierarchy of the given model class,
+including both property-level and class-level (compound) indexes. Indexes declared in subclasses override
+indexes with the same identity (name, or column set when unnamed) declared in parent classes.
+
+## Parameters
+
+### clazz
+
+`any`
+
+The model class to retrieve index metadata for.
+
+## Returns
+
+[`IndexInfo`](../interfaces/IndexInfo.md)[]

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md

@@ -0,0 +1,41 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / ColumnInfo
+
+# Interface: ColumnInfo
+
+Defined in: [src/decorators/PersistenceDecorators.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L38)
+
+Describes a single persisted column/property of a model class.
+
+## Properties
+
+### designType?
+
+> `optional` **designType?**: `any`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:42](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L42)
+
+The design type of the property as captured at decoration time.
+
+***
+
+### options
+
+> **options**: [`ColumnOptions`](ColumnOptions.md)
+
+Defined in: [src/decorators/PersistenceDecorators.ts:44](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L44)
+
+The options that the column was declared with.
+
+***
+
+### propertyName
+
+> **propertyName**: `string`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L40)
+
+The name of the class property.