@twin.org/entity 0.0.2-next.20 → 0.0.2-next.21

package/dist/cjs/index.cjs

@@ -300,7 +300,7 @@ class EntityConditions {
         }
         if ("conditions" in condition) {
             // It's a group of comparisons, so check the individual items and combine with the logical operator
-            const results = condition.conditions.map(c => this.check(entity, c));
+            const results = condition.conditions.map(c => EntityConditions.check(entity, c));
             if ((condition.logicalOperator ?? LogicalOperator.And) === LogicalOperator.And) {
                 return results.every(Boolean);
             }
@@ -461,9 +461,8 @@ class EntityConditions {
 class EntitySchemaHelper {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "EntitySchemaHelper";
+    static CLASS_NAME = "EntitySchemaHelper";
     /**
      * Get the schema for the specified object.
      * @param target The object to get the schema data for.
@@ -480,13 +479,13 @@ class EntitySchemaHelper {
      * @throws If no primary key was found, or more than one.
      */
     static getPrimaryKey(entitySchema) {
-        core.Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        core.Guards.object(EntitySchemaHelper.CLASS_NAME, "entitySchema", entitySchema);
         const primaryKeys = (entitySchema.properties ?? [])?.filter(p => p.isPrimary);
         if (primaryKeys.length === 0) {
-            throw new core.GeneralError(EntitySchemaHelper._CLASS_NAME, "noIsPrimary");
+            throw new core.GeneralError(EntitySchemaHelper.CLASS_NAME, "noIsPrimary");
         }
         if (primaryKeys.length > 1) {
-            throw new core.GeneralError(EntitySchemaHelper._CLASS_NAME, "multipleIsPrimary");
+            throw new core.GeneralError(EntitySchemaHelper.CLASS_NAME, "multipleIsPrimary");
         }
         return primaryKeys[0];
     }
@@ -496,7 +495,7 @@ class EntitySchemaHelper {
      * @returns The sort keys from the schema or undefined if there are none.
      */
     static getSortProperties(entitySchema) {
-        core.Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        core.Guards.object(EntitySchemaHelper.CLASS_NAME, "entitySchema", entitySchema);
         const sortFields = (entitySchema.properties ?? []).filter(p => !core.Is.undefined(p.sortDirection));
         return sortFields.length > 0
             ? sortFields.map(p => ({
@@ -513,7 +512,7 @@ class EntitySchemaHelper {
      * @returns The finalised sort keys.
      */
     static buildSortProperties(entitySchema, overrideSortKeys) {
-        core.Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        core.Guards.object(EntitySchemaHelper.CLASS_NAME, "entitySchema", entitySchema);
         let finalSortKeys;
         if (core.Is.arrayValue(overrideSortKeys)) {
             finalSortKeys = [];
@@ -540,11 +539,11 @@ class EntitySchemaHelper {
      * @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);
+        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");
+            throw new core.GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidEntityProperties");
         }
         const allKeys = Object.keys(entity);
         for (const prop of properties) {
@@ -556,7 +555,7 @@ class EntitySchemaHelper {
             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", {
+                    throw new core.GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidOptional", {
                         property: prop.property,
                         type: prop.type
                     });
@@ -573,7 +572,7 @@ class EntitySchemaHelper {
             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", {
+                throw new core.GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidEntityProperty", {
                     value,
                     property: prop.property,
                     type: prop.type
@@ -582,7 +581,7 @@ class EntitySchemaHelper {
         }
         if (allKeys.length > 0) {
             // There are keys in the entity that are not in the schema
-            throw new core.GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityKeys", {
+            throw new core.GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidEntityKeys", {
                 keys: allKeys.join(", ")
             });
         }

package/dist/esm/index.mjs

@@ -298,7 +298,7 @@ class EntityConditions {
         }
         if ("conditions" in condition) {
             // It's a group of comparisons, so check the individual items and combine with the logical operator
-            const results = condition.conditions.map(c => this.check(entity, c));
+            const results = condition.conditions.map(c => EntityConditions.check(entity, c));
             if ((condition.logicalOperator ?? LogicalOperator.And) === LogicalOperator.And) {
                 return results.every(Boolean);
             }
@@ -459,9 +459,8 @@ class EntityConditions {
 class EntitySchemaHelper {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "EntitySchemaHelper";
+    static CLASS_NAME = "EntitySchemaHelper";
     /**
      * Get the schema for the specified object.
      * @param target The object to get the schema data for.
@@ -478,13 +477,13 @@ class EntitySchemaHelper {
      * @throws If no primary key was found, or more than one.
      */
     static getPrimaryKey(entitySchema) {
-        Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        Guards.object(EntitySchemaHelper.CLASS_NAME, "entitySchema", entitySchema);
         const primaryKeys = (entitySchema.properties ?? [])?.filter(p => p.isPrimary);
         if (primaryKeys.length === 0) {
-            throw new GeneralError(EntitySchemaHelper._CLASS_NAME, "noIsPrimary");
+            throw new GeneralError(EntitySchemaHelper.CLASS_NAME, "noIsPrimary");
         }
         if (primaryKeys.length > 1) {
-            throw new GeneralError(EntitySchemaHelper._CLASS_NAME, "multipleIsPrimary");
+            throw new GeneralError(EntitySchemaHelper.CLASS_NAME, "multipleIsPrimary");
         }
         return primaryKeys[0];
     }
@@ -494,7 +493,7 @@ class EntitySchemaHelper {
      * @returns The sort keys from the schema or undefined if there are none.
      */
     static getSortProperties(entitySchema) {
-        Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        Guards.object(EntitySchemaHelper.CLASS_NAME, "entitySchema", entitySchema);
         const sortFields = (entitySchema.properties ?? []).filter(p => !Is.undefined(p.sortDirection));
         return sortFields.length > 0
             ? sortFields.map(p => ({
@@ -511,7 +510,7 @@ class EntitySchemaHelper {
      * @returns The finalised sort keys.
      */
     static buildSortProperties(entitySchema, overrideSortKeys) {
-        Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", entitySchema);
+        Guards.object(EntitySchemaHelper.CLASS_NAME, "entitySchema", entitySchema);
         let finalSortKeys;
         if (Is.arrayValue(overrideSortKeys)) {
             finalSortKeys = [];
@@ -538,11 +537,11 @@ class EntitySchemaHelper {
      * @throws If the entity is invalid.
      */
     static validateEntity(entity, entitySchema) {
-        Guards.object(EntitySchemaHelper._CLASS_NAME, "entity", entity);
-        Guards.object(EntitySchemaHelper._CLASS_NAME, "entitySchema", 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");
+            throw new GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidEntityProperties");
         }
         const allKeys = Object.keys(entity);
         for (const prop of properties) {
@@ -554,7 +553,7 @@ class EntitySchemaHelper {
             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", {
+                    throw new GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidOptional", {
                         property: prop.property,
                         type: prop.type
                     });
@@ -571,7 +570,7 @@ class EntitySchemaHelper {
             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", {
+                throw new GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidEntityProperty", {
                     value,
                     property: prop.property,
                     type: prop.type
@@ -580,7 +579,7 @@ class EntitySchemaHelper {
         }
         if (allKeys.length > 0) {
             // There are keys in the entity that are not in the schema
-            throw new GeneralError(EntitySchemaHelper._CLASS_NAME, "invalidEntityKeys", {
+            throw new GeneralError(EntitySchemaHelper.CLASS_NAME, "invalidEntityKeys", {
                 keys: allKeys.join(", ")
             });
         }

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

@@ -6,6 +6,10 @@ import type { SortDirection } from "../models/sortDirection";
  * Class to help with entity schema operations.
  */
 export declare class EntitySchemaHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Get the schema for the specified object.
      * @param target The object to get the schema data for.

package/docs/changelog.md

@@ -1,5 +1,24 @@
 # @twin.org/entity - Changelog
 
+## [0.0.2-next.21](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.20...entity-v0.0.2-next.21) (2025-10-09)
+
+
+### Features
+
+* locales validation ([#197](https://github.com/twinfoundation/framework/issues/197)) ([55fdadb](https://github.com/twinfoundation/framework/commit/55fdadb13595ce0047f787bd1d4135d429a99f12))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/core bumped from 0.0.2-next.20 to 0.0.2-next.21
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/validate-locales bumped from 0.0.2-next.20 to 0.0.2-next.21
+
 ## [0.0.2-next.20](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.19...entity-v0.0.2-next.20) (2025-10-02)
 
 

package/docs/reference/classes/EntitySchemaHelper.md

@@ -12,6 +12,14 @@ Class to help with entity schema operations.
 
 `EntitySchemaHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### getSchema()

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity",
-	"version": "0.0.2-next.20",
+	"version": "0.0.2-next.21",
 	"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.2-next.20",
-		"@twin.org/nameof": "0.0.2-next.20",
+		"@twin.org/core": "0.0.2-next.21",
+		"@twin.org/nameof": "0.0.2-next.21",
 		"reflect-metadata": "0.2.2"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -42,5 +42,9 @@
 		"iota",
 		"framework",
 		"blockchain"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/framework/issues"
+	},
+	"homepage": "https://twindev.org"
 }