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

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

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

@@ -1,68 +0,0 @@
-[**@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:208](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L208)
-
-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:209](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L209)
-
-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:210](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L210)
-
-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

@@ -1,26 +0,0 @@
-[**@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:242](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L242)
-
-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

@@ -1,26 +0,0 @@
-[**@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:291](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L291)
-
-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

@@ -1,27 +0,0 @@
-[**@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:262](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L262)
-
-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/CollationOptions.md

@@ -1,79 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / CollationOptions
-
-# Interface: CollationOptions
-
-Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L12)
-
-The language-specific rules to use for string comparison in MongoDB collections.
-
-## See
-
-https://www.mongodb.com/docs/v7.0/reference/collation/#std-label-collation
-
-## Properties
-
-### alternate?
-
-> `optional` **alternate?**: `string`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L18)
-
-***
-
-### backwards?
-
-> `optional` **backwards?**: `boolean`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L20)
-
-***
-
-### caseFirst?
-
-> `optional` **caseFirst?**: `string`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:15](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L15)
-
-***
-
-### caseLevel?
-
-> `optional` **caseLevel?**: `boolean`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L14)
-
-***
-
-### locale
-
-> **locale**: `string`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:13](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L13)
-
-***
-
-### maxVariable?
-
-> `optional` **maxVariable?**: `string`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:19](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L19)
-
-***
-
-### numericOrdering?
-
-> `optional` **numericOrdering?**: `boolean`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:17](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L17)
-
-***
-
-### strength?
-
-> `optional` **strength?**: `number`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L16)

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

@@ -1,41 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / ColumnInfo
-
-# Interface: ColumnInfo
-
-Defined in: [src/decorators/PersistenceDecorators.ts:67](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L67)
-
-Describes a single persisted column/property of a model class.
-
-## Properties
-
-### designType?
-
-> `optional` **designType?**: `any`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:71](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L71)
-
-The design type of the property as captured at decoration time.
-
-***
-
-### options
-
-> **options**: [`ColumnOptions`](ColumnOptions.md)
-
-Defined in: [src/decorators/PersistenceDecorators.ts:73](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L73)
-
-The options that the column was declared with.
-
-***
-
-### propertyName
-
-> **propertyName**: `string`
-
-Defined in: [src/decorators/PersistenceDecorators.ts:69](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L69)
-
-The name of the class property.