@twin.org/entity 0.0.1-next.9 → 0.0.1

package/dist/cjs/index.cjs

@@ -61,7 +61,7 @@ function property(options) {
         const entitySchema = DecoratorHelper.getSchema(target);
         entitySchema.properties ??= [];
         const idx = entitySchema.properties.findIndex(p => p.property === propertyKey);
-        if (idx >= 0) {
+        if (idx !== -1) {
             entitySchema.properties[idx] = {
                 ...options,
                 property: propertyKey
@@ -533,6 +533,60 @@ class EntitySchemaHelper {
         }
         return finalSortKeys;
     }
+    /**
+     * Validate the entity against the schema.
+     * @param entity The entity to validate.
+     * @param entitySchema The schema to validate against.
+     * @throws If the entity is invalid.
+     */
+    static validateEntity(entity, entitySchema) {
+        core.Guards.object(EntitySchemaHelper._CLASS_NAME, "entity", entity);
+        core.Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        const properties = entitySchema.properties ?? [];
+        if (properties.length === 0 && core.Is.objectValue(entity)) {
+            throw new core.GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityProperties");
+        }
+        const allKeys = Object.keys(entity);
+        for (const prop of properties) {
+            const idx = allKeys.indexOf(prop.property);
+            if (idx !== -1) {
+                allKeys.splice(idx, 1);
+            }
+            const value = entity[prop.property];
+            if (core.Is.empty(value)) {
+                // If the value is empty but the property is not optional, then it's invalid
+                if (!prop.optional) {
+                    throw new core.GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidOptional", {
+                        property: prop.property,
+                        type: prop.type
+                    });
+                }
+            }
+            else if (prop.type === "integer" && core.Is.integer(value)) ;
+            else if (prop.type === "object" &&
+                (core.Is.object(value) ||
+                    core.Is.array(value) ||
+                    core.Is.string(value) ||
+                    core.Is.number(value) ||
+                    core.Is.boolean(value) ||
+                    core.Is.null(value))) ;
+            else if (prop.type === "array" && core.Is.array(value)) ;
+            else if (prop.type !== typeof value) {
+                // The schema type does not match the value type
+                throw new core.GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityProperty", {
+                    value,
+                    property: prop.property,
+                    type: prop.type
+                });
+            }
+        }
+        if (allKeys.length > 0) {
+            // There are keys in the entity that are not in the schema
+            throw new core.GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityKeys", {
+                keys: allKeys.join(", ")
+            });
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -572,7 +626,9 @@ class EntitySorter {
      */
     static compare(entity1, entity2, prop, type, direction = SortDirection.Ascending) {
         let res = 0;
-        if (!core.Is.empty(entity1[prop]) && !core.Is.empty(entity2[prop])) {
+        const hasProp1 = !core.Is.empty(entity1[prop]);
+        const hasProp2 = !core.Is.empty(entity2[prop]);
+        if (hasProp1 && hasProp2) {
             if (type === "number" || type === "integer") {
                 res = entity1[prop] - entity2[prop];
             }
@@ -593,6 +649,12 @@ class EntitySorter {
                 res = entity1[prop].localeCompare(entity2[prop]);
             }
         }
+        else if (hasProp1) {
+            res = -1;
+        }
+        else {
+            res = 1;
+        }
         return direction === SortDirection.Ascending ? res : res * -1;
     }
 }

package/dist/esm/index.mjs

@@ -59,7 +59,7 @@ function property(options) {
         const entitySchema = DecoratorHelper.getSchema(target);
         entitySchema.properties ??= [];
         const idx = entitySchema.properties.findIndex(p => p.property === propertyKey);
-        if (idx >= 0) {
+        if (idx !== -1) {
             entitySchema.properties[idx] = {
                 ...options,
                 property: propertyKey
@@ -531,6 +531,60 @@ class EntitySchemaHelper {
         }
         return finalSortKeys;
     }
+    /**
+     * Validate the entity against the schema.
+     * @param entity The entity to validate.
+     * @param entitySchema The schema to validate against.
+     * @throws If the entity is invalid.
+     */
+    static validateEntity(entity, entitySchema) {
+        Guards.object(EntitySchemaHelper._CLASS_NAME, "entity", entity);
+        Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        const properties = entitySchema.properties ?? [];
+        if (properties.length === 0 && Is.objectValue(entity)) {
+            throw new GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityProperties");
+        }
+        const allKeys = Object.keys(entity);
+        for (const prop of properties) {
+            const idx = allKeys.indexOf(prop.property);
+            if (idx !== -1) {
+                allKeys.splice(idx, 1);
+            }
+            const value = entity[prop.property];
+            if (Is.empty(value)) {
+                // If the value is empty but the property is not optional, then it's invalid
+                if (!prop.optional) {
+                    throw new GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidOptional", {
+                        property: prop.property,
+                        type: prop.type
+                    });
+                }
+            }
+            else if (prop.type === "integer" && Is.integer(value)) ;
+            else if (prop.type === "object" &&
+                (Is.object(value) ||
+                    Is.array(value) ||
+                    Is.string(value) ||
+                    Is.number(value) ||
+                    Is.boolean(value) ||
+                    Is.null(value))) ;
+            else if (prop.type === "array" && Is.array(value)) ;
+            else if (prop.type !== typeof value) {
+                // The schema type does not match the value type
+                throw new GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityProperty", {
+                    value,
+                    property: prop.property,
+                    type: prop.type
+                });
+            }
+        }
+        if (allKeys.length > 0) {
+            // There are keys in the entity that are not in the schema
+            throw new GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityKeys", {
+                keys: allKeys.join(", ")
+            });
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -570,7 +624,9 @@ class EntitySorter {
      */
     static compare(entity1, entity2, prop, type, direction = SortDirection.Ascending) {
         let res = 0;
-        if (!Is.empty(entity1[prop]) && !Is.empty(entity2[prop])) {
+        const hasProp1 = !Is.empty(entity1[prop]);
+        const hasProp2 = !Is.empty(entity2[prop]);
+        if (hasProp1 && hasProp2) {
             if (type === "number" || type === "integer") {
                 res = entity1[prop] - entity2[prop];
             }
@@ -591,6 +647,12 @@ class EntitySorter {
                 res = entity1[prop].localeCompare(entity2[prop]);
             }
         }
+        else if (hasProp1) {
+            res = -1;
+        }
+        else {
+            res = 1;
+        }
         return direction === SortDirection.Ascending ? res : res * -1;
     }
 }

package/dist/types/utils/entitySchemaHelper.d.ts

@@ -35,4 +35,11 @@ export declare class EntitySchemaHelper {
         property: keyof T;
         sortDirection: SortDirection;
     }[]): IEntitySort<T>[] | undefined;
+    /**
+     * Validate the entity against the schema.
+     * @param entity The entity to validate.
+     * @param entitySchema The schema to validate against.
+     * @throws If the entity is invalid.
+     */
+    static validateEntity<T>(entity: T, entitySchema: IEntitySchema<T>): void;
 }

package/docs/changelog.md

@@ -1,5 +1,335 @@
 # @twin.org/entity - Changelog
 
-## 0.0.1-next.9
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([829d53d](https://github.com/twinfoundation/framework/commit/829d53d3953b1e1b40b0243c04cfdfd3842aac7b))
+* release to production ([5cf3a76](https://github.com/twinfoundation/framework/commit/5cf3a76a09eff2e6414d0cba846c7c37400a11d6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from ^0.0.0 to ^0.0.1
+    * @twin.org/core bumped from ^0.0.0 to ^0.0.1
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from ^0.0.0 to ^0.0.1
+    * @twin.org/nameof-vitest-plugin bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.70](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.69...entity-v0.0.1-next.70) (2025-07-02)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.69 to 0.0.1-next.70
+    * @twin.org/core bumped from 0.0.1-next.69 to 0.0.1-next.70
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.69 to 0.0.1-next.70
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.69 to 0.0.1-next.70
+
+## [0.0.1-next.69](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.68...entity-v0.0.1-next.69) (2025-07-02)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.68 to 0.0.1-next.69
+    * @twin.org/core bumped from 0.0.1-next.68 to 0.0.1-next.69
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.68 to 0.0.1-next.69
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.68 to 0.0.1-next.69
+
+## [0.0.1-next.68](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.67...entity-v0.0.1-next.68) (2025-07-02)
+
+
+### Features
+
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.67 to 0.0.1-next.68
+    * @twin.org/core bumped from 0.0.1-next.67 to 0.0.1-next.68
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.67 to 0.0.1-next.68
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.67 to 0.0.1-next.68
+
+## [0.0.1-next.67](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.66...entity-v0.0.1-next.67) (2025-06-26)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.66 to 0.0.1-next.67
+
+## [0.0.1-next.66](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.65...entity-v0.0.1-next.66) (2025-06-26)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.65 to 0.0.1-next.66
+
+## [0.0.1-next.65](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.64...entity-v0.0.1-next.65) (2025-06-19)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.64 to 0.0.1-next.65
+
+## [0.0.1-next.64](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.63...entity-v0.0.1-next.64) (2025-06-19)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.63 to 0.0.1-next.64
+
+## [0.0.1-next.63](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.62...entity-v0.0.1-next.63) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.62 to 0.0.1-next.63
+
+## [0.0.1-next.62](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.61...entity-v0.0.1-next.62) (2025-06-17)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.61 to 0.0.1-next.62
+
+## [0.0.1-next.61](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.60...entity-v0.0.1-next.61) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.60 to 0.0.1-next.61
+
+## [0.0.1-next.60](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.59...entity-v0.0.1-next.60) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.59 to 0.0.1-next.60
+
+## [0.0.1-next.59](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.58...entity-v0.0.1-next.59) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.58 to 0.0.1-next.59
+
+## [0.0.1-next.58](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.57...entity-v0.0.1-next.58) (2025-06-13)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.57 to 0.0.1-next.58
+
+## [0.0.1-next.57](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.56...entity-v0.0.1-next.57) (2025-06-10)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.56 to 0.0.1-next.57
+
+## [0.0.1-next.56](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.55...entity-v0.0.1-next.56) (2025-05-08)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.55 to 0.0.1-next.56
+
+## [0.0.1-next.55](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.54...entity-v0.0.1-next.55) (2025-05-07)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.54 to 0.0.1-next.55
+
+## [0.0.1-next.54](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.53...entity-v0.0.1-next.54) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.53 to 0.0.1-next.54
+
+## [0.0.1-next.53](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.52...entity-v0.0.1-next.53) (2025-05-01)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.52 to 0.0.1-next.53
+
+## [0.0.1-next.52](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.51...entity-v0.0.1-next.52) (2025-04-17)
+
+
+### Features
+
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
+
+## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.50...entity-v0.0.1-next.51) (2025-03-27)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
+
+## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/entity-v0.0.1-next.49...entity-v0.0.1-next.50) (2025-03-26)
+
+
+### Miscellaneous Chores
+
+* **entity:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
+
+## 0.0.1-next.49
 
 - Initial Release

package/docs/reference/classes/DecoratorHelper.md

@@ -4,13 +4,13 @@ Class to help with decorators.
 
 ## Constructors
 
-### new DecoratorHelper()
+### Constructor
 
-> **new DecoratorHelper**(): [`DecoratorHelper`](DecoratorHelper.md)
+> **new DecoratorHelper**(): `DecoratorHelper`
 
 #### Returns
 
-[`DecoratorHelper`](DecoratorHelper.md)
+`DecoratorHelper`
 
 ## Methods
 
@@ -22,11 +22,15 @@ Get the schema from the reflection metadata.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **target**: `any`
+##### target
+
+`any`
 
 The object to get the schema data from.
 
@@ -46,15 +50,21 @@ Set the schema from the reflection metadata.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **target**: `any`
+##### target
+
+`any`
 
 The object to get the schema data from.
 
-• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+##### entitySchema
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
 
 The schema to set.
 

package/docs/reference/classes/EntityConditions.md

@@ -4,33 +4,39 @@ Class to perform condition checks.
 
 ## Constructors
 
-### new EntityConditions()
+### Constructor
 
-> **new EntityConditions**(): [`EntityConditions`](EntityConditions.md)
+> **new EntityConditions**(): `EntityConditions`
 
 #### Returns
 
-[`EntityConditions`](EntityConditions.md)
+`EntityConditions`
 
 ## Methods
 
 ### check()
 
-> `static` **check**\<`T`\>(`entity`, `condition`?): `boolean`
+> `static` **check**\<`T`\>(`entity`, `condition?`): `boolean`
 
 See if the entity matches the conditions.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to test.
 
-• **condition?**: [`EntityCondition`](../type-aliases/EntityCondition.md)\<`T`\>
+##### condition?
+
+[`EntityCondition`](../type-aliases/EntityCondition.md)\<`T`\>
 
 The conditions to test.
 
@@ -50,15 +56,21 @@ See if the entity matches the conditions.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to test.
 
-• **comparator**: [`IComparator`](../interfaces/IComparator.md)
+##### comparator
+
+[`IComparator`](../interfaces/IComparator.md)
 
 The condition to test.
 

package/docs/reference/classes/EntitySchemaHelper.md

@@ -4,13 +4,13 @@ Class to help with entity schema operations.
 
 ## Constructors
 
-### new EntitySchemaHelper()
+### Constructor
 
-> **new EntitySchemaHelper**(): [`EntitySchemaHelper`](EntitySchemaHelper.md)
+> **new EntitySchemaHelper**(): `EntitySchemaHelper`
 
 #### Returns
 
-[`EntitySchemaHelper`](EntitySchemaHelper.md)
+`EntitySchemaHelper`
 
 ## Methods
 
@@ -22,11 +22,15 @@ Get the schema for the specified object.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **target**: `any`
+##### target
+
+`any`
 
 The object to get the schema data for.
 
@@ -46,11 +50,15 @@ Get the primary key from the entity schema.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+##### entitySchema
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
 
 The entity schema to find the primary key from.
 
@@ -74,11 +82,15 @@ Get the sort properties from the schema.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+##### entitySchema
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
 
 The entity schema to find the primary key from.
 
@@ -92,21 +104,27 @@ The sort keys from the schema or undefined if there are none.
 
 ### buildSortProperties()
 
-> `static` **buildSortProperties**\<`T`\>(`entitySchema`, `overrideSortKeys`?): `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
+> `static` **buildSortProperties**\<`T`\>(`entitySchema`, `overrideSortKeys?`): `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
 
 Build sort properties from the schema and override if necessary.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+##### entitySchema
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
 
 The entity schema to retrieve the default sort keys.
 
-• **overrideSortKeys?**: `object`[]
+##### overrideSortKeys?
+
+`object`[]
 
 The override sort keys.
 
@@ -115,3 +133,39 @@ The override sort keys.
 `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
 
 The finalised sort keys.
+
+***
+
+### validateEntity()
+
+> `static` **validateEntity**\<`T`\>(`entity`, `entitySchema`): `void`
+
+Validate the entity against the schema.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### entity
+
+`T`
+
+The entity to validate.
+
+##### entitySchema
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The schema to validate against.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+If the entity is invalid.

package/docs/reference/classes/EntitySorter.md

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

package/docs/reference/functions/entity.md

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

package/docs/reference/functions/property.md

@@ -6,7 +6,9 @@ Decorator to produce schema property data for entities.
 
 ## Parameters
 
-• **options**: `Omit`\<[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`unknown`\>, `"property"`\>
+### options
+
+`Omit`\<[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md), `"property"`\>
 
 The options for the property.
 

package/docs/reference/interfaces/IComparatorGroup.md

@@ -4,7 +4,9 @@ Interface defining condition group operator.
 
 ## Type Parameters
 
-• **T** = `unknown`
+### T
+
+`T` = `unknown`
 
 ## Properties
 

package/docs/reference/interfaces/IEntitySchema.md

@@ -4,7 +4,9 @@ Definition for an entity schema.
 
 ## Type Parameters
 
-• **T** = `unknown`
+### T
+
+`T` = `unknown`
 
 ## Properties
 

package/docs/reference/interfaces/IEntitySchemaProperty.md

@@ -4,7 +4,9 @@ Definition for an entity schema property.
 
 ## Type Parameters
 
-• **T** = `unknown`
+### T
+
+`T` = `unknown`
 
 ## Properties
 

package/docs/reference/interfaces/IEntitySort.md

@@ -4,7 +4,9 @@ Definition of an entity property sort details.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Properties
 

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

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

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

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

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

@@ -1,5 +1,5 @@
 # Type Alias: EntitySchemaPropertyFormat
 
-> **EntitySchemaPropertyFormat**: *typeof* [`EntitySchemaPropertyFormat`](../variables/EntitySchemaPropertyFormat.md)\[keyof *typeof* [`EntitySchemaPropertyFormat`](../variables/EntitySchemaPropertyFormat.md)\]
+> **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

@@ -1,5 +1,5 @@
 # Type Alias: EntitySchemaPropertyType
 
-> **EntitySchemaPropertyType**: *typeof* [`EntitySchemaPropertyType`](../variables/EntitySchemaPropertyType.md)\[keyof *typeof* [`EntitySchemaPropertyType`](../variables/EntitySchemaPropertyType.md)\]
+> **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

@@ -1,5 +1,5 @@
 # Type Alias: LogicalOperator
 
-> **LogicalOperator**: *typeof* [`LogicalOperator`](../variables/LogicalOperator.md)\[keyof *typeof* [`LogicalOperator`](../variables/LogicalOperator.md)\]
+> **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

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

package/locales/en.json

@@ -2,7 +2,11 @@
 	"error": {
 		"entitySchemaHelper": {
 			"noIsPrimary": "Property \"entitySchema.properties\" must contain a value with isPrimary set",
-			"multipleIsPrimary": "Property \"entitySchema.properties\" contains more than one property with isPrimary set"
+			"multipleIsPrimary": "Property \"entitySchema.properties\" contains more than one property with isPrimary set",
+			"invalidEntityProperties": "The schema has no properties defined, but the entity has properties",
+			"invalidEntityProperty": "The entity value of \"{value}\" does not match the type \"{type}\" for property \"{property}\"",
+			"invalidOptional": "The entity property \"{property}\" of type \"{type}\" is not optional, but no value has been provided",
+			"invalidEntityKeys": "The entity had additional properties that are not in the schema, \"{keys}\""
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity",
-	"version": "0.0.1-next.9",
+	"version": "0.0.1",
 	"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.1-next.9",
-		"@twin.org/nameof": "next",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
 		"reflect-metadata": "0.2.2"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -23,11 +23,11 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",