@twin.org/core 0.0.2-next.20 → 0.0.2-next.22

package/dist/types/helpers/objectHelper.d.ts

@@ -2,6 +2,10 @@
  * Class to help with objects.
  */
 export declare class ObjectHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Convert an object to bytes.
      * @param obj The object to convert.

package/dist/types/models/IComponent.d.ts

@@ -3,9 +3,11 @@
  */
 export interface IComponent {
     /**
-     * The name of the component.
+     * All methods are optional, so we introduce an index signature to allow
+     * any additional properties or methods, which removes the TypeScript error where
+     * the class has no properties in common with the type.
      */
-    readonly CLASS_NAME: string;
+    [key: string]: any;
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingComponentType The node logging component type.

package/dist/types/models/IValidationFailure.d.ts

@@ -10,10 +10,6 @@ export interface IValidationFailure {
      * The reason the validation failed as an i18 resource error.
      */
     reason: string;
-    /**
-     * The optional human readable name for the field as an i18 resource.
-     */
-    fieldName?: string;
     /**
      * Additional properties for the validation failure.
      */

package/dist/types/types/bitString.d.ts

@@ -2,6 +2,10 @@
  * A class to represent a bit string.
  */
 export declare class BitString {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of BitString.
      * @param numberBits The length of the bit string.

package/dist/types/types/url.d.ts

@@ -4,6 +4,10 @@ import type { IValidationFailure } from "../models/IValidationFailure";
  * Class to help with urls.
  */
 export declare class Url {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of Url.
      * @param url The url string.
@@ -28,9 +32,10 @@ export declare class Url {
      * @param property Throw an exception if the url property is invalid.
      * @param value The url to parse.
      * @param failures The list of failures to add to.
+     * @param fieldNameResource The optional human readable name for the field as an i18 resource.
      * @returns The formatted url.
      */
-    static validate(property: string, value: unknown, failures: IValidationFailure[]): value is Url;
+    static validate(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is Url;
     /**
      * Construct a url from a URL.
      * @param url The url to construct from.

package/dist/types/types/urn.d.ts

@@ -3,6 +3,10 @@ import type { IValidationFailure } from "../models/IValidationFailure";
  * Class to help with urns.
  */
 export declare class Urn {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of Urn.
      * @param namespaceIdentifier The identifier for the namespace.
@@ -53,9 +57,10 @@ export declare class Urn {
      * @param property Throw an exception if the urn property is invalid.
      * @param value The urn to parse.
      * @param failures The list of failures to add to.
+     * @param fieldNameResource The optional human readable name for the field as an i18 resource.
      * @returns The formatted urn.
      */
-    static validate(property: string, value: unknown, failures: IValidationFailure[]): value is string;
+    static validate(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is string;
     /**
      * Get the parts.
      * @param startIndex The index to start from, defaults to 0.

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

@@ -3,6 +3,10 @@ import { CompressionType } from "../models/compressionType";
  * A class to handle compression.
  */
 export declare class Compression {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Compress bytes using GZIP.
      * @param bytes The bytes to compress.

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

@@ -78,4 +78,19 @@ export declare class I18n {
      * @returns True if the key exists.
      */
     static hasMessage(key: string): boolean;
+    /**
+     * Flatten the translation property paths for faster lookup.
+     * @param translation The translation to merge.
+     * @param propertyPath The current root path.
+     * @param mergedKeys The merged keys dictionary to populate.
+     */
+    static flattenTranslationKeys(translation: ILocaleDictionary, propertyPath: string, mergedKeys: {
+        [key: string]: string;
+    }): void;
+    /**
+     * Get a list of the property names from the message.
+     * @param message The message to extract the property names from.
+     * @returns The list of property names.
+     */
+    static getPropertyNames(message: string): string[];
 }

package/docs/changelog.md

@@ -1,5 +1,39 @@
 # @twin.org/core - Changelog
 
+## [0.0.2-next.22](https://github.com/twinfoundation/framework/compare/core-v0.0.2-next.21...core-v0.0.2-next.22) (2025-10-10)
+
+
+### Miscellaneous Chores
+
+* **core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.2-next.21 to 0.0.2-next.22
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.21 to 0.0.2-next.22
+
+## [0.0.2-next.21](https://github.com/twinfoundation/framework/compare/core-v0.0.2-next.20...core-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
+  * 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
+
 ## [0.0.2-next.20](https://github.com/twinfoundation/framework/compare/core-v0.0.2-next.19...core-v0.0.2-next.20) (2025-10-02)
 
 

package/docs/reference/classes/Base32.md

@@ -12,6 +12,14 @@ Class to help with base63 Encoding/Decoding.
 
 `Base32`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### decode()

package/docs/reference/classes/Base58.md

@@ -12,6 +12,14 @@ Class to help with base58 Encoding/Decoding.
 
 `Base58`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### decode()

package/docs/reference/classes/Base64.md

@@ -13,6 +13,14 @@ Sourced from https://github.com/beatgammit/base64-js.
 
 `Base64`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### byteLength()

package/docs/reference/classes/Base64Url.md

@@ -13,6 +13,14 @@ https://www.rfc-editor.org/rfc/rfc4648#section-5.
 
 `Base64Url`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### decode()

package/docs/reference/classes/BitString.md

@@ -22,6 +22,14 @@ The length of the bit string.
 
 `BitString`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### fromBits()

package/docs/reference/classes/Compression.md

@@ -12,6 +12,14 @@ A class to handle compression.
 
 `Compression`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### compress()

package/docs/reference/classes/Factory.md

@@ -8,6 +8,14 @@ Factory for creating implementation of generic types.
 
 `T`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### createFactory()

package/docs/reference/classes/I18n.md

@@ -261,3 +261,55 @@ The key to check for existence.
 `boolean`
 
 True if the key exists.
+
+***
+
+### flattenTranslationKeys()
+
+> `static` **flattenTranslationKeys**(`translation`, `propertyPath`, `mergedKeys`): `void`
+
+Flatten the translation property paths for faster lookup.
+
+#### Parameters
+
+##### translation
+
+[`ILocaleDictionary`](../interfaces/ILocaleDictionary.md)
+
+The translation to merge.
+
+##### propertyPath
+
+`string`
+
+The current root path.
+
+##### mergedKeys
+
+The merged keys dictionary to populate.
+
+#### Returns
+
+`void`
+
+***
+
+### getPropertyNames()
+
+> `static` **getPropertyNames**(`message`): `string`[]
+
+Get a list of the property names from the message.
+
+#### Parameters
+
+##### message
+
+`string`
+
+The message to extract the property names from.
+
+#### Returns
+
+`string`[]
+
+The list of property names.

package/docs/reference/classes/JsonHelper.md

@@ -12,6 +12,14 @@ Helpers methods for JSON objects.
 
 `JsonHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### canonicalize()

package/docs/reference/classes/ObjectHelper.md

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

package/docs/reference/classes/Url.md

@@ -22,6 +22,14 @@ The url string.
 
 `Url`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### tryParseExact()
@@ -84,7 +92,7 @@ GuardError If the value does not match the assertion.
 
 ### validate()
 
-> `static` **validate**(`property`, `value`, `failures`): `value is Url`
+> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Url`
 
 Validate a string as a Url.
 
@@ -108,6 +116,12 @@ The url to parse.
 
 The list of failures to add to.
 
+##### fieldNameResource?
+
+`string`
+
+The optional human readable name for the field as an i18 resource.
+
 #### Returns
 
 `value is Url`

package/docs/reference/classes/Urn.md

@@ -28,6 +28,14 @@ The specific part of the namespace.
 
 `Urn`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### generateRandom()
@@ -184,7 +192,7 @@ GuardError If the value does not match the assertion.
 
 ### validate()
 
-> `static` **validate**(`property`, `value`, `failures`): `value is string`
+> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Validate a string as a Urn.
 
@@ -208,6 +216,12 @@ The urn to parse.
 
 The list of failures to add to.
 
+##### fieldNameResource?
+
+`string`
+
+The optional human readable name for the field as an i18 resource.
+
 #### Returns
 
 `value is string`

package/docs/reference/interfaces/IComponent.md

@@ -2,13 +2,13 @@
 
 Interface describing a component which can be bootstrapped, started and stopped.
 
-## Properties
+## Indexable
 
-### CLASS\_NAME
+\[`key`: `string`\]: `any`
 
-> `readonly` **CLASS\_NAME**: `string`
-
-The name of the component.
+All methods are optional, so we introduce an index signature to allow
+any additional properties or methods, which removes the TypeScript error where
+the class has no properties in common with the type.
 
 ## Methods
 

package/docs/reference/interfaces/IValidationFailure.md

@@ -20,14 +20,6 @@ The reason the validation failed as an i18 resource error.
 
 ***
 
-### fieldName?
-
-> `optional` **fieldName**: `string`
-
-The optional human readable name for the field as an i18 resource.
-
-***
-
 ### properties?
 
 > `optional` **properties**: `object`

package/locales/.validate-ignore

@@ -0,0 +1 @@
+^errorNames.*$

package/locales/en.json

@@ -38,9 +38,7 @@
 			"beUrn": "{fieldName} must be a correctly formatted urn",
 			"beUrl": "{fieldName} must be a correctly formatted url",
 			"beJSON": "{fieldName} must be correctly formatted JSON",
-			"beEmail": "{fieldName} must be a correctly formatted e-mail address",
-			"failed": "Validation failed",
-			"failedObject": "Validation of \"{objectName}\" failed"
+			"beEmail": "{fieldName} must be a correctly formatted e-mail address"
 		},
 		"guard": {
 			"undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
@@ -87,7 +85,7 @@
 			"noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
 		},
 		"bitString": {
-			"outOfRange": "The index should be >= 0 and less than the length of the bit string"
+			"outOfRange": "The index should be >= 0 and less than the length of the bit string, the index is \"{index}\" and the number of bit is \"{numberBits}\""
 		},
 		"base32": {
 			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
@@ -112,7 +110,8 @@
 		"alreadyExistsError": "Already Exists",
 		"notImplementedError": "Not Implemented",
 		"validationError": "Validation",
-		"unprocessableError": "Unprocessable"
+		"unprocessableError": "Unprocessable",
+		"unauthorizedError": "Unauthorized"
 	},
 	"validation": {
 		"defaultFieldName": "The field"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.2-next.20",
+	"version": "0.0.2-next.22",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.2-next.20",
-		"intl-messageformat": "10.7.16",
+		"@twin.org/nameof": "0.0.2-next.22",
+		"intl-messageformat": "10.7.17",
 		"rfc6902": "5.1.2"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -45,5 +45,9 @@
 		"core",
 		"foundation",
 		"utilities"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/framework/issues"
+	},
+	"homepage": "https://twindev.org"
 }