@twin.org/entity 0.0.1-next.1

package/docs/reference/classes/EntitySorter.md

@@ -0,0 +1,81 @@
+# Class: EntitySorter
+
+Class to perform sort operations on entities.
+
+## Constructors
+
+### new EntitySorter()
+
+> **new EntitySorter**(): [`EntitySorter`](EntitySorter.md)
+
+#### Returns
+
+[`EntitySorter`](EntitySorter.md)
+
+## Methods
+
+### sort()
+
+> `static` **sort**\<`T`\>(`entities`, `entitySorters`?): `T`[]
+
+Sort a list of entities using multiple keys and direction.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **entities**: `T`[]
+
+The list of entities.
+
+• **entitySorters?**: [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
+
+The sort keys to use.
+
+#### Returns
+
+`T`[]
+
+The sorted list.
+
+***
+
+### compare()
+
+> `static` **compare**\<`T`\>(`entity1`, `entity2`, `prop`, `type`, `direction`): `number`
+
+Compare two properties.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **entity1**: `T`
+
+The first entity.
+
+• **entity2**: `T`
+
+The second entity.
+
+• **prop**: keyof `T`
+
+The property to compare.
+
+• **type**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
+
+The type of the property.
+
+• **direction**: [`SortDirection`](../type-aliases/SortDirection.md) = `SortDirection.Ascending`
+
+The direction of the sort.
+
+#### Returns
+
+`number`
+
+The result of the comparison.

package/docs/reference/functions/entity.md

@@ -0,0 +1,17 @@
+# Function: entity()
+
+> **entity**(`options`?): `any`
+
+Decorator to produce schema data for entity.
+
+## Parameters
+
+• **options?**: [`IEntitySchemaOptions`](../interfaces/IEntitySchemaOptions.md)
+
+The options for the entity.
+
+## Returns
+
+`any`
+
+The class decorator.

package/docs/reference/functions/property.md

@@ -0,0 +1,17 @@
+# Function: property()
+
+> **property**(`options`): `any`
+
+Decorator to produce schema property data for entities.
+
+## Parameters
+
+• **options**: `Omit`\<[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`unknown`\>, `"property"`\>
+
+The options for the property.
+
+## Returns
+
+`any`
+
+The property decorator.

package/docs/reference/index.md

@@ -0,0 +1,40 @@
+# @twin.org/entity
+
+## Classes
+
+- [DecoratorHelper](classes/DecoratorHelper.md)
+- [EntityConditions](classes/EntityConditions.md)
+- [EntitySchemaHelper](classes/EntitySchemaHelper.md)
+- [EntitySorter](classes/EntitySorter.md)
+
+## Interfaces
+
+- [IComparator](interfaces/IComparator.md)
+- [IComparatorGroup](interfaces/IComparatorGroup.md)
+- [IEntitySchema](interfaces/IEntitySchema.md)
+- [IEntitySchemaOptions](interfaces/IEntitySchemaOptions.md)
+- [IEntitySchemaProperty](interfaces/IEntitySchemaProperty.md)
+- [IEntitySort](interfaces/IEntitySort.md)
+
+## Type Aliases
+
+- [ComparisonOperator](type-aliases/ComparisonOperator.md)
+- [EntityCondition](type-aliases/EntityCondition.md)
+- [EntitySchemaPropertyFormat](type-aliases/EntitySchemaPropertyFormat.md)
+- [EntitySchemaPropertyType](type-aliases/EntitySchemaPropertyType.md)
+- [LogicalOperator](type-aliases/LogicalOperator.md)
+- [SortDirection](type-aliases/SortDirection.md)
+
+## Variables
+
+- [EntitySchemaFactory](variables/EntitySchemaFactory.md)
+- [ComparisonOperator](variables/ComparisonOperator.md)
+- [EntitySchemaPropertyFormat](variables/EntitySchemaPropertyFormat.md)
+- [EntitySchemaPropertyType](variables/EntitySchemaPropertyType.md)
+- [LogicalOperator](variables/LogicalOperator.md)
+- [SortDirection](variables/SortDirection.md)
+
+## Functions
+
+- [entity](functions/entity.md)
+- [property](functions/property.md)

package/docs/reference/interfaces/IComparator.md

@@ -0,0 +1,27 @@
+# Interface: IComparator
+
+Interface defining comparator operator.
+
+## Properties
+
+### property
+
+> **property**: `string`
+
+The name of the property in the object to check.
+
+***
+
+### value
+
+> **value**: `unknown`
+
+The value of the property to check.
+
+***
+
+### comparison
+
+> **comparison**: [`ComparisonOperator`](../type-aliases/ComparisonOperator.md)
+
+The comparison to perform.

package/docs/reference/interfaces/IComparatorGroup.md

@@ -0,0 +1,23 @@
+# Interface: IComparatorGroup\<T\>
+
+Interface defining condition group operator.
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Properties
+
+### conditions
+
+> **conditions**: [`EntityCondition`](../type-aliases/EntityCondition.md)\<`T`\>[]
+
+The conditions to join in a group.
+
+***
+
+### logicalOperator?
+
+> `optional` **logicalOperator**: [`LogicalOperator`](../type-aliases/LogicalOperator.md)
+
+The logical operator to use.

package/docs/reference/interfaces/IEntitySchema.md

@@ -0,0 +1,31 @@
+# Interface: IEntitySchema\<T\>
+
+Definition for an entity schema.
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Properties
+
+### type
+
+> **type**: `undefined` \| `string`
+
+The type of the entity.
+
+***
+
+### options?
+
+> `optional` **options**: [`IEntitySchemaOptions`](IEntitySchemaOptions.md)
+
+The options for the entity.
+
+***
+
+### properties?
+
+> `optional` **properties**: [`IEntitySchemaProperty`](IEntitySchemaProperty.md)\<`T`\>[]
+
+The properties of the entity.

package/docs/reference/interfaces/IEntitySchemaOptions.md

@@ -0,0 +1,11 @@
+# Interface: IEntitySchemaOptions
+
+Definition for an entity schema options.
+
+## Properties
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the object.

package/docs/reference/interfaces/IEntitySchemaProperty.md

@@ -0,0 +1,95 @@
+# Interface: IEntitySchemaProperty\<T\>
+
+Definition for an entity schema property.
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Properties
+
+### property
+
+> **property**: keyof `T`
+
+The property name from the entity.
+
+***
+
+### type
+
+> **type**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
+
+The type of the property.
+
+***
+
+### format?
+
+> `optional` **format**: [`EntitySchemaPropertyFormat`](../type-aliases/EntitySchemaPropertyFormat.md)
+
+The format of the property.
+
+***
+
+### isPrimary?
+
+> `optional` **isPrimary**: `boolean`
+
+Is this the primary index property.
+
+***
+
+### isSecondary?
+
+> `optional` **isSecondary**: `boolean`
+
+Is this a secondary index property.
+
+***
+
+### sortDirection?
+
+> `optional` **sortDirection**: [`SortDirection`](../type-aliases/SortDirection.md)
+
+Default sort direction for this field, leave empty if not sortable.
+
+***
+
+### optional?
+
+> `optional` **optional**: `boolean`
+
+Is the property optional.
+
+***
+
+### itemType?
+
+> `optional` **itemType**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
+
+The type of the item (only applies when type is `array`).
+
+***
+
+### itemTypeRef?
+
+> `optional` **itemTypeRef**: `string`
+
+The type ref of the item (only applies when type is either `array` or `object`).
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the object.
+
+***
+
+### examples?
+
+> `optional` **examples**: `unknown`[]
+
+Examples of the property values.

package/docs/reference/interfaces/IEntitySort.md

@@ -0,0 +1,31 @@
+# Interface: IEntitySort\<T\>
+
+Definition of an entity property sort details.
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### property
+
+> **property**: keyof `T`
+
+The name of the property.
+
+***
+
+### type
+
+> **type**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
+
+The type of the property.
+
+***
+
+### sortDirection
+
+> **sortDirection**: [`SortDirection`](../type-aliases/SortDirection.md)
+
+Default sort direction for this column, leave empty if not sortable.

package/docs/reference/type-aliases/ComparisonOperator.md

@@ -0,0 +1,5 @@
+# Type Alias: ComparisonOperator
+
+> **ComparisonOperator**: *typeof* [`ComparisonOperator`](../variables/ComparisonOperator.md)\[keyof *typeof* [`ComparisonOperator`](../variables/ComparisonOperator.md)\]
+
+The types of comparisons.

package/docs/reference/type-aliases/EntityCondition.md

@@ -0,0 +1,9 @@
+# Type Alias: EntityCondition\<T\>
+
+> **EntityCondition**\<`T`\>: [`IComparator`](../interfaces/IComparator.md) \| [`IComparatorGroup`](../interfaces/IComparatorGroup.md)\<`T`\>
+
+Type defining condition for entities filtering.
+
+## Type Parameters
+
+• **T**

package/docs/reference/type-aliases/EntitySchemaPropertyFormat.md

@@ -0,0 +1,5 @@
+# Type Alias: EntitySchemaPropertyFormat
+
+> **EntitySchemaPropertyFormat**: *typeof* [`EntitySchemaPropertyFormat`](../variables/EntitySchemaPropertyFormat.md)\[keyof *typeof* [`EntitySchemaPropertyFormat`](../variables/EntitySchemaPropertyFormat.md)\]
+
+Definition of the entity property type's format.

package/docs/reference/type-aliases/EntitySchemaPropertyType.md

@@ -0,0 +1,5 @@
+# Type Alias: EntitySchemaPropertyType
+
+> **EntitySchemaPropertyType**: *typeof* [`EntitySchemaPropertyType`](../variables/EntitySchemaPropertyType.md)\[keyof *typeof* [`EntitySchemaPropertyType`](../variables/EntitySchemaPropertyType.md)\]
+
+Definition of the entity property types.

package/docs/reference/type-aliases/LogicalOperator.md

@@ -0,0 +1,5 @@
+# Type Alias: LogicalOperator
+
+> **LogicalOperator**: *typeof* [`LogicalOperator`](../variables/LogicalOperator.md)\[keyof *typeof* [`LogicalOperator`](../variables/LogicalOperator.md)\]
+
+The logical operators for condition combining.

package/docs/reference/type-aliases/SortDirection.md

@@ -0,0 +1,5 @@
+# Type Alias: SortDirection
+
+> **SortDirection**: *typeof* [`SortDirection`](../variables/SortDirection.md)\[keyof *typeof* [`SortDirection`](../variables/SortDirection.md)\]
+
+The sort directions.

package/docs/reference/variables/ComparisonOperator.md

@@ -0,0 +1,68 @@
+# Variable: ComparisonOperator
+
+> `const` **ComparisonOperator**: `object`
+
+The types of comparisons.
+
+## Type declaration
+
+### Equals
+
+> `readonly` **Equals**: `"equals"` = `"equals"`
+
+Equals.
+
+### NotEquals
+
+> `readonly` **NotEquals**: `"not-equals"` = `"not-equals"`
+
+Not Equals.
+
+### GreaterThan
+
+> `readonly` **GreaterThan**: `"greater-than"` = `"greater-than"`
+
+Greater Than.
+
+### GreaterThanOrEqual
+
+> `readonly` **GreaterThanOrEqual**: `"greater-than-or-equal"` = `"greater-than-or-equal"`
+
+Greater Than Or Equal.
+
+### LessThan
+
+> `readonly` **LessThan**: `"less-than"` = `"less-than"`
+
+Less Than.
+
+### LessThanOrEqual
+
+> `readonly` **LessThanOrEqual**: `"less-than-or-equal"` = `"less-than-or-equal"`
+
+Less Than Or Equal.
+
+### Includes
+
+> `readonly` **Includes**: `"includes"` = `"includes"`
+
+Includes.
+A string in a substring.
+A set contains an element.
+A list contains an element.
+
+### NotIncludes
+
+> `readonly` **NotIncludes**: `"not-includes"` = `"not-includes"`
+
+Not Includes.
+A string not in a substring.
+A set does not contain an element.
+A list does not contain an element.
+
+### In
+
+> `readonly` **In**: `"in"` = `"in"`
+
+In.
+A element is in a set.

package/docs/reference/variables/EntitySchemaFactory.md

@@ -0,0 +1,5 @@
+# Variable: EntitySchemaFactory
+
+> `const` **EntitySchemaFactory**: `Factory`\<[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`unknown`\>\>
+
+Factory for creating entity schemas.

package/docs/reference/variables/EntitySchemaPropertyFormat.md

@@ -0,0 +1,109 @@
+# Variable: EntitySchemaPropertyFormat
+
+> `const` **EntitySchemaPropertyFormat**: `object`
+
+Definition of the entity property format.
+
+## Type declaration
+
+### Uuid
+
+> `readonly` **Uuid**: `"uuid"` = `"uuid"`
+
+UUID.
+
+### Uri
+
+> `readonly` **Uri**: `"uri"` = `"uri"`
+
+URI.
+
+### Email
+
+> `readonly` **Email**: `"email"` = `"email"`
+
+email.
+
+### Int8
+
+> `readonly` **Int8**: `"int8"` = `"int8"`
+
+int8.
+
+### Uint8
+
+> `readonly` **Uint8**: `"uint8"` = `"uint8"`
+
+uint8.
+
+### Int16
+
+> `readonly` **Int16**: `"int16"` = `"int16"`
+
+int16.
+
+### Uint16
+
+> `readonly` **Uint16**: `"uint16"` = `"uint16"`
+
+uint16.
+
+### Int32
+
+> `readonly` **Int32**: `"int32"` = `"int32"`
+
+int32.
+
+### Uint32
+
+> `readonly` **Uint32**: `"uint32"` = `"uint32"`
+
+uint32.
+
+### Float
+
+> `readonly` **Float**: `"float"` = `"float"`
+
+float.
+
+### Double
+
+> `readonly` **Double**: `"double"` = `"double"`
+
+double.
+
+### Int64
+
+> `readonly` **Int64**: `"int64"` = `"int64"`
+
+int64.
+
+### Uint64
+
+> `readonly` **Uint64**: `"uint64"` = `"uint64"`
+
+uint64.
+
+### Date
+
+> `readonly` **Date**: `"date"` = `"date"`
+
+date.
+
+### Time
+
+> `readonly` **Time**: `"time"` = `"time"`
+
+time.
+
+### DateTime
+
+> `readonly` **DateTime**: `"date-time"` = `"date-time"`
+
+date-time.
+
+### Json
+
+> `readonly` **Json**: `"json"` = `"json"`
+
+JSON.

package/docs/reference/variables/EntitySchemaPropertyType.md

@@ -0,0 +1,43 @@
+# Variable: EntitySchemaPropertyType
+
+> `const` **EntitySchemaPropertyType**: `object`
+
+Definition of the entity property types.
+
+## Type declaration
+
+### String
+
+> `readonly` **String**: `"string"` = `"string"`
+
+String.
+
+### Number
+
+> `readonly` **Number**: `"number"` = `"number"`
+
+Number.
+
+### Integer
+
+> `readonly` **Integer**: `"integer"` = `"integer"`
+
+Integer.
+
+### Boolean
+
+> `readonly` **Boolean**: `"boolean"` = `"boolean"`
+
+Boolean.
+
+### Array
+
+> `readonly` **Array**: `"array"` = `"array"`
+
+Array.
+
+### Object
+
+> `readonly` **Object**: `"object"` = `"object"`
+
+Object.

package/docs/reference/variables/LogicalOperator.md

@@ -0,0 +1,19 @@
+# Variable: LogicalOperator
+
+> `const` **LogicalOperator**: `object`
+
+The logical operators for condition combining.
+
+## Type declaration
+
+### And
+
+> `readonly` **And**: `"and"` = `"and"`
+
+Logical operator AND.
+
+### Or
+
+> `readonly` **Or**: `"or"` = `"or"`
+
+Logical operator OR.

package/docs/reference/variables/SortDirection.md

@@ -0,0 +1,19 @@
+# Variable: SortDirection
+
+> `const` **SortDirection**: `object`
+
+The sort directions.
+
+## Type declaration
+
+### Ascending
+
+> `readonly` **Ascending**: `"asc"` = `"asc"`
+
+Ascending.
+
+### Descending
+
+> `readonly` **Descending**: `"desc"` = `"desc"`
+
+Descending.