@twin.org/entity 0.0.3-next.22 → 0.0.3-next.23

package/README.md

@@ -1,10 +1,6 @@
 # TWIN Entity
 
-This package contains helper methods and classes for working with entities.
-
-- Defining
-- Sorting
-- Comparing
+This package is part of the framework workspace and provides helpers for defining and working with entities to support consistent development workflows across the ecosystem.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,23 @@
-# @twin.org/entity - Changelog
+# Changelog
+
+## [0.0.3-next.23](https://github.com/twinfoundation/framework/compare/entity-v0.0.3-next.22...entity-v0.0.3-next.23) (2026-03-17)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/core bumped from 0.0.3-next.22 to 0.0.3-next.23
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/validate-locales bumped from 0.0.3-next.22 to 0.0.3-next.23
 
 ## [0.0.3-next.22](https://github.com/twinfoundation/framework/compare/entity-v0.0.3-next.21...entity-v0.0.3-next.22) (2026-02-26)
 

package/docs/examples.md

@@ -1 +1,70 @@
-# @twin.org/entity - Examples
+# Entity Examples
+
+Use these snippets to build schemas, compose conditions and order data for query-style workflows.
+
+## EntitySchemaHelper
+
+```typescript
+import { EntitySchemaHelper } from '@twin.org/entity';
+
+class Product {
+  public id!: string;
+  public sku!: string;
+  public price!: number;
+}
+
+const schema = EntitySchemaHelper.getSchema(Product);
+EntitySchemaHelper.getPrimaryKey(schema); // 'id'
+EntitySchemaHelper.getSortProperties(schema); // ['sku', 'price']
+```
+
+## EntityConditions
+
+```typescript
+import { EntityConditions } from '@twin.org/entity';
+
+const product = {
+  sku: 'A-100',
+  price: 49.99,
+  active: true
+};
+
+EntityConditions.compare('eq', product.sku, 'A-100'); // true
+EntityConditions.check(product, [{ property: 'price', comparison: 'gt', value: 10 }]); // true
+```
+
+## EntitySorter
+
+```typescript
+import { EntitySorter } from '@twin.org/entity';
+
+const records = [
+  { sku: 'A-300', price: 15 },
+  { sku: 'A-100', price: 20 },
+  { sku: 'A-200', price: 10 }
+];
+
+EntitySorter.sort(records, [{ property: 'sku', sortDirection: 'ascending' }]);
+```
+
+## DecoratorHelper
+
+```typescript
+import { DecoratorHelper } from '@twin.org/entity';
+
+class Customer {
+  public id!: string;
+}
+
+DecoratorHelper.setSchema(Customer, {
+  primaryKey: 'id',
+  type: 'customer',
+  properties: {
+    id: {
+      type: 'string'
+    }
+  }
+});
+
+DecoratorHelper.getSchema(Customer)?.primaryKey; // 'id'
+```

package/docs/reference/classes/DecoratorHelper.md

@@ -14,7 +14,7 @@ Class to help with decorators.
 
 ## Methods
 
-### getSchema()
+### getSchema() {#getschema}
 
 > `static` **getSchema**\<`T`\>(`target`): [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
 
@@ -42,7 +42,7 @@ The schema from the metadata if it can be found.
 
 ***
 
-### setSchema()
+### setSchema() {#setschema}
 
 > `static` **setSchema**\<`T`\>(`target`, `entitySchema`): `void`
 

package/docs/reference/classes/EntityConditions.md

@@ -14,7 +14,7 @@ Class to perform condition checks.
 
 ## Methods
 
-### check()
+### check() {#check}
 
 > `static` **check**\<`T`\>(`entity`, `condition?`): `boolean`
 
@@ -48,7 +48,7 @@ True if the entity matches.
 
 ***
 
-### compare()
+### compare() {#compare}
 
 > `static` **compare**\<`T`\>(`entity`, `comparator`): `boolean`
 

package/docs/reference/classes/EntitySchemaHelper.md

@@ -14,7 +14,7 @@ Class to help with entity schema operations.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### getSchema()
+### getSchema() {#getschema}
 
 > `static` **getSchema**\<`T`\>(`target`): [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
 
@@ -50,7 +50,7 @@ The schema for the object if it can be found.
 
 ***
 
-### getPrimaryKey()
+### getPrimaryKey() {#getprimarykey}
 
 > `static` **getPrimaryKey**\<`T`\>(`entitySchema`): [`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`T`\>
 
@@ -82,7 +82,7 @@ If no primary key was found, or more than one.
 
 ***
 
-### getSortProperties()
+### getSortProperties() {#getsortproperties}
 
 > `static` **getSortProperties**\<`T`\>(`entitySchema`): [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[] \| `undefined`
 
@@ -110,7 +110,7 @@ The sort keys from the schema or undefined if there are none.
 
 ***
 
-### buildSortProperties()
+### buildSortProperties() {#buildsortproperties}
 
 > `static` **buildSortProperties**\<`T`\>(`entitySchema`, `overrideSortKeys?`): [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[] \| `undefined`
 
@@ -144,7 +144,7 @@ The finalised sort keys.
 
 ***
 
-### validateEntity()
+### validateEntity() {#validateentity}
 
 > `static` **validateEntity**\<`T`\>(`entity`, `entitySchema`): `void`
 

package/docs/reference/classes/EntitySorter.md

@@ -14,7 +14,7 @@ Class to perform sort operations on entities.
 
 ## Methods
 
-### sort()
+### sort() {#sort}
 
 > `static` **sort**\<`T`\>(`entities`, `entitySorters?`): `T`[]
 
@@ -48,9 +48,9 @@ The sorted list.
 
 ***
 
-### compare()
+### compare() {#compare}
 
-> `static` **compare**\<`T`\>(`entity1`, `entity2`, `prop`, `type`, `direction`): `number`
+> `static` **compare**\<`T`\>(`entity1`, `entity2`, `prop`, `type`, `direction?`): `number`
 
 Compare two properties.
 
@@ -86,7 +86,7 @@ The property to compare.
 
 The type of the property.
 
-##### direction
+##### direction?
 
 [`SortDirection`](../type-aliases/SortDirection.md) = `SortDirection.Ascending`
 

package/docs/reference/interfaces/IComparator.md

@@ -4,7 +4,7 @@ Interface defining comparator operator.
 
 ## Properties
 
-### property
+### property {#property}
 
 > **property**: `string`
 
@@ -12,7 +12,7 @@ The name of the property in the object to check.
 
 ***
 
-### value
+### value {#value}
 
 > **value**: `unknown`
 
@@ -20,7 +20,7 @@ The value of the property to check.
 
 ***
 
-### comparison
+### comparison {#comparison}
 
 > **comparison**: [`ComparisonOperator`](../type-aliases/ComparisonOperator.md)
 

package/docs/reference/interfaces/IComparatorGroup.md

@@ -10,7 +10,7 @@ Interface defining condition group operator.
 
 ## Properties
 
-### conditions
+### conditions {#conditions}
 
 > **conditions**: [`EntityCondition`](../type-aliases/EntityCondition.md)\<`T`\>[]
 
@@ -18,7 +18,7 @@ The conditions to join in a group.
 
 ***
 
-### logicalOperator?
+### logicalOperator? {#logicaloperator}
 
 > `optional` **logicalOperator**: [`LogicalOperator`](../type-aliases/LogicalOperator.md)
 

package/docs/reference/interfaces/IEntitySchema.md

@@ -10,7 +10,7 @@ Definition for an entity schema.
 
 ## Properties
 
-### type
+### type {#type}
 
 > **type**: `string` \| `undefined`
 
@@ -18,7 +18,7 @@ The type of the entity.
 
 ***
 
-### options?
+### options? {#options}
 
 > `optional` **options**: [`IEntitySchemaOptions`](IEntitySchemaOptions.md)
 
@@ -26,7 +26,7 @@ The options for the entity.
 
 ***
 
-### properties?
+### properties? {#properties}
 
 > `optional` **properties**: [`IEntitySchemaProperty`](IEntitySchemaProperty.md)\<`T`\>[]
 

package/docs/reference/interfaces/IEntitySchemaOptions.md

@@ -4,7 +4,7 @@ Definition for an entity schema options.
 
 ## Properties
 
-### description?
+### description? {#description}
 
 > `optional` **description**: `string`
 

package/docs/reference/interfaces/IEntitySchemaProperty.md

@@ -10,7 +10,7 @@ Definition for an entity schema property.
 
 ## Properties
 
-### property
+### property {#property}
 
 > **property**: keyof `T`
 
@@ -18,7 +18,7 @@ The property name from the entity.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
 
@@ -26,7 +26,7 @@ The type of the property.
 
 ***
 
-### format?
+### format? {#format}
 
 > `optional` **format**: [`EntitySchemaPropertyFormat`](../type-aliases/EntitySchemaPropertyFormat.md)
 
@@ -34,7 +34,7 @@ The format of the property.
 
 ***
 
-### isPrimary?
+### isPrimary? {#isprimary}
 
 > `optional` **isPrimary**: `boolean`
 
@@ -42,7 +42,7 @@ Is this the primary index property.
 
 ***
 
-### isSecondary?
+### isSecondary? {#issecondary}
 
 > `optional` **isSecondary**: `boolean`
 
@@ -50,7 +50,7 @@ Is this a secondary index property.
 
 ***
 
-### sortDirection?
+### sortDirection? {#sortdirection}
 
 > `optional` **sortDirection**: [`SortDirection`](../type-aliases/SortDirection.md)
 
@@ -58,7 +58,7 @@ Default sort direction for this field, leave empty if not sortable.
 
 ***
 
-### optional?
+### optional? {#optional}
 
 > `optional` **optional**: `boolean`
 
@@ -66,7 +66,7 @@ Is the property optional.
 
 ***
 
-### itemType?
+### itemType? {#itemtype}
 
 > `optional` **itemType**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
 
@@ -74,7 +74,7 @@ The type of the item (only applies when type is `array`).
 
 ***
 
-### itemTypeRef?
+### itemTypeRef? {#itemtyperef}
 
 > `optional` **itemTypeRef**: `string`
 
@@ -82,7 +82,7 @@ The type ref of the item (only applies when type is either `array` or `object`).
 
 ***
 
-### description?
+### description? {#description}
 
 > `optional` **description**: `string`
 
@@ -90,7 +90,7 @@ Description of the object.
 
 ***
 
-### examples?
+### examples? {#examples}
 
 > `optional` **examples**: `unknown`[]
 

package/docs/reference/interfaces/IEntitySort.md

@@ -10,7 +10,7 @@ Definition of an entity property sort details.
 
 ## Properties
 
-### property
+### property {#property}
 
 > **property**: keyof `T`
 
@@ -18,7 +18,7 @@ The name of the property.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: [`EntitySchemaPropertyType`](../type-aliases/EntitySchemaPropertyType.md)
 
@@ -26,7 +26,7 @@ The type of the property.
 
 ***
 
-### sortDirection
+### sortDirection {#sortdirection}
 
 > **sortDirection**: [`SortDirection`](../type-aliases/SortDirection.md)
 

package/docs/reference/variables/ComparisonOperator.md

@@ -6,43 +6,43 @@ The types of comparisons.
 
 ## Type Declaration
 
-### Equals
+### Equals {#equals}
 
 > `readonly` **Equals**: `"equals"` = `"equals"`
 
 Equals.
 
-### NotEquals
+### NotEquals {#notequals}
 
 > `readonly` **NotEquals**: `"not-equals"` = `"not-equals"`
 
 Not Equals.
 
-### GreaterThan
+### GreaterThan {#greaterthan}
 
 > `readonly` **GreaterThan**: `"greater-than"` = `"greater-than"`
 
 Greater Than.
 
-### GreaterThanOrEqual
+### GreaterThanOrEqual {#greaterthanorequal}
 
 > `readonly` **GreaterThanOrEqual**: `"greater-than-or-equal"` = `"greater-than-or-equal"`
 
 Greater Than Or Equal.
 
-### LessThan
+### LessThan {#lessthan}
 
 > `readonly` **LessThan**: `"less-than"` = `"less-than"`
 
 Less Than.
 
-### LessThanOrEqual
+### LessThanOrEqual {#lessthanorequal}
 
 > `readonly` **LessThanOrEqual**: `"less-than-or-equal"` = `"less-than-or-equal"`
 
 Less Than Or Equal.
 
-### Includes
+### Includes {#includes}
 
 > `readonly` **Includes**: `"includes"` = `"includes"`
 
@@ -51,7 +51,7 @@ A string in a substring.
 A set contains an element.
 A list contains an element.
 
-### NotIncludes
+### NotIncludes {#notincludes}
 
 > `readonly` **NotIncludes**: `"not-includes"` = `"not-includes"`
 
@@ -60,7 +60,7 @@ A string not in a substring.
 A set does not contain an element.
 A list does not contain an element.
 
-### In
+### In {#in}
 
 > `readonly` **In**: `"in"` = `"in"`
 

package/docs/reference/variables/EntitySchemaPropertyFormat.md

@@ -6,103 +6,103 @@ Definition of the entity property format.
 
 ## Type Declaration
 
-### Uuid
+### Uuid {#uuid}
 
 > `readonly` **Uuid**: `"uuid"` = `"uuid"`
 
 UUID.
 
-### Uri
+### Uri {#uri}
 
 > `readonly` **Uri**: `"uri"` = `"uri"`
 
 URI.
 
-### Email
+### Email {#email}
 
 > `readonly` **Email**: `"email"` = `"email"`
 
 email.
 
-### Int8
+### Int8 {#int8}
 
 > `readonly` **Int8**: `"int8"` = `"int8"`
 
 int8.
 
-### Uint8
+### Uint8 {#uint8}
 
 > `readonly` **Uint8**: `"uint8"` = `"uint8"`
 
 uint8.
 
-### Int16
+### Int16 {#int16}
 
 > `readonly` **Int16**: `"int16"` = `"int16"`
 
 int16.
 
-### Uint16
+### Uint16 {#uint16}
 
 > `readonly` **Uint16**: `"uint16"` = `"uint16"`
 
 uint16.
 
-### Int32
+### Int32 {#int32}
 
 > `readonly` **Int32**: `"int32"` = `"int32"`
 
 int32.
 
-### Uint32
+### Uint32 {#uint32}
 
 > `readonly` **Uint32**: `"uint32"` = `"uint32"`
 
 uint32.
 
-### Float
+### Float {#float}
 
 > `readonly` **Float**: `"float"` = `"float"`
 
 float.
 
-### Double
+### Double {#double}
 
 > `readonly` **Double**: `"double"` = `"double"`
 
 double.
 
-### Int64
+### Int64 {#int64}
 
 > `readonly` **Int64**: `"int64"` = `"int64"`
 
 int64.
 
-### Uint64
+### Uint64 {#uint64}
 
 > `readonly` **Uint64**: `"uint64"` = `"uint64"`
 
 uint64.
 
-### Date
+### Date {#date}
 
 > `readonly` **Date**: `"date"` = `"date"`
 
 date.
 
-### Time
+### Time {#time}
 
 > `readonly` **Time**: `"time"` = `"time"`
 
 time.
 
-### DateTime
+### DateTime {#datetime}
 
 > `readonly` **DateTime**: `"date-time"` = `"date-time"`
 
 date-time.
 
-### Json
+### Json {#json}
 
 > `readonly` **Json**: `"json"` = `"json"`
 

package/docs/reference/variables/EntitySchemaPropertyType.md

@@ -6,37 +6,37 @@ Definition of the entity property types.
 
 ## Type Declaration
 
-### String
+### String {#string}
 
 > `readonly` **String**: `"string"` = `"string"`
 
 String.
 
-### Number
+### Number {#number}
 
 > `readonly` **Number**: `"number"` = `"number"`
 
 Number.
 
-### Integer
+### Integer {#integer}
 
 > `readonly` **Integer**: `"integer"` = `"integer"`
 
 Integer.
 
-### Boolean
+### Boolean {#boolean}
 
 > `readonly` **Boolean**: `"boolean"` = `"boolean"`
 
 Boolean.
 
-### Array
+### Array {#array}
 
 > `readonly` **Array**: `"array"` = `"array"`
 
 Array.
 
-### Object
+### Object {#object}
 
 > `readonly` **Object**: `"object"` = `"object"`
 

package/docs/reference/variables/LogicalOperator.md

@@ -6,13 +6,13 @@ The logical operators for condition combining.
 
 ## Type Declaration
 
-### And
+### And {#and}
 
 > `readonly` **And**: `"and"` = `"and"`
 
 Logical operator AND.
 
-### Or
+### Or {#or}
 
 > `readonly` **Or**: `"or"` = `"or"`
 

package/docs/reference/variables/SortDirection.md

@@ -6,13 +6,13 @@ The sort directions.
 
 ## Type Declaration
 
-### Ascending
+### Ascending {#ascending}
 
 > `readonly` **Ascending**: `"asc"` = `"asc"`
 
 Ascending.
 
-### Descending
+### Descending {#descending}
 
 > `readonly` **Descending**: `"desc"` = `"desc"`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity",
-	"version": "0.0.3-next.22",
+	"version": "0.0.3-next.23",
 	"description": "Helpers for defining and working with entities",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.3-next.22",
-		"@twin.org/nameof": "0.0.3-next.22",
+		"@twin.org/core": "0.0.3-next.23",
+		"@twin.org/nameof": "0.0.3-next.23",
 		"reflect-metadata": "0.2.2"
 	},
 	"main": "./dist/es/index.js",