@twin.org/core 0.0.1-next.26 → 0.0.1-next.28

package/dist/cjs/index.cjs

@@ -2954,6 +2954,55 @@ class ErrorHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types the extracted data can be coerced to.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const CoerceType = {
+    /**
+     * String.
+     */
+    String: "string",
+    /**
+     * Number.
+     */
+    Number: "number",
+    /**
+     * Integer.
+     */
+    Integer: "integer",
+    /**
+     * Boolean.
+     */
+    Boolean: "boolean",
+    /**
+     * Big Integer.
+     */
+    BigInt: "bigint",
+    /**
+     * Date.
+     */
+    Date: "date",
+    /**
+     * Date Time.
+     */
+    DateTime: "datetime",
+    /**
+     * Time.
+     */
+    Time: "time",
+    /**
+     * Object.
+     */
+    Object: "object",
+    /**
+     * Uint8Array.
+     */
+    Uint8Array: "uint8array"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -3009,6 +3058,18 @@ class Coerce {
             return value.getTime();
         }
     }
+    /**
+     * Coerce the value to an integer.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
+     */
+    static integer(value) {
+        const num = Coerce.number(value);
+        if (!Is.undefined(num)) {
+            return Math.trunc(num);
+        }
+    }
     /**
      * Coerce the value to a bigint.
      * @param value The value to coerce.
@@ -3155,6 +3216,57 @@ class Coerce {
             catch { }
         }
     }
+    /**
+     * Coerce the value to a Uint8Array.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
+     */
+    static uint8Array(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.string(value)) {
+            if (Is.stringHex(value.toLowerCase(), true)) {
+                return Converter.hexToBytes(value.toLowerCase());
+            }
+            if (Is.stringBase64(value)) {
+                return Converter.base64ToBytes(value);
+            }
+        }
+    }
+    /**
+     * Coerces a value based on the coercion type.
+     * @param value The value to coerce.
+     * @param type The coercion type to perform.
+     * @returns The coerced value.
+     */
+    static byType(value, type) {
+        switch (type) {
+            case CoerceType.String:
+                return Coerce.string(value);
+            case CoerceType.Number:
+                return Coerce.number(value);
+            case CoerceType.Integer:
+                return Coerce.integer(value);
+            case CoerceType.BigInt:
+                return Coerce.bigint(value);
+            case CoerceType.Boolean:
+                return Coerce.boolean(value);
+            case CoerceType.Date:
+                return Coerce.date(value);
+            case CoerceType.DateTime:
+                return Coerce.dateTime(value);
+            case CoerceType.Time:
+                return Coerce.time(value);
+            case CoerceType.Object:
+                return Coerce.object(value);
+            case CoerceType.Uint8Array:
+                return Coerce.uint8Array(value);
+            default:
+                return value;
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -4569,6 +4681,7 @@ exports.Base64Url = Base64Url;
 exports.BaseError = BaseError;
 exports.BitString = BitString;
 exports.Coerce = Coerce;
+exports.CoerceType = CoerceType;
 exports.ComponentFactory = ComponentFactory;
 exports.Compression = Compression;
 exports.CompressionType = CompressionType;

package/dist/esm/index.mjs

@@ -2952,6 +2952,55 @@ class ErrorHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types the extracted data can be coerced to.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const CoerceType = {
+    /**
+     * String.
+     */
+    String: "string",
+    /**
+     * Number.
+     */
+    Number: "number",
+    /**
+     * Integer.
+     */
+    Integer: "integer",
+    /**
+     * Boolean.
+     */
+    Boolean: "boolean",
+    /**
+     * Big Integer.
+     */
+    BigInt: "bigint",
+    /**
+     * Date.
+     */
+    Date: "date",
+    /**
+     * Date Time.
+     */
+    DateTime: "datetime",
+    /**
+     * Time.
+     */
+    Time: "time",
+    /**
+     * Object.
+     */
+    Object: "object",
+    /**
+     * Uint8Array.
+     */
+    Uint8Array: "uint8array"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -3007,6 +3056,18 @@ class Coerce {
             return value.getTime();
         }
     }
+    /**
+     * Coerce the value to an integer.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
+     */
+    static integer(value) {
+        const num = Coerce.number(value);
+        if (!Is.undefined(num)) {
+            return Math.trunc(num);
+        }
+    }
     /**
      * Coerce the value to a bigint.
      * @param value The value to coerce.
@@ -3153,6 +3214,57 @@ class Coerce {
             catch { }
         }
     }
+    /**
+     * Coerce the value to a Uint8Array.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
+     */
+    static uint8Array(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.string(value)) {
+            if (Is.stringHex(value.toLowerCase(), true)) {
+                return Converter.hexToBytes(value.toLowerCase());
+            }
+            if (Is.stringBase64(value)) {
+                return Converter.base64ToBytes(value);
+            }
+        }
+    }
+    /**
+     * Coerces a value based on the coercion type.
+     * @param value The value to coerce.
+     * @param type The coercion type to perform.
+     * @returns The coerced value.
+     */
+    static byType(value, type) {
+        switch (type) {
+            case CoerceType.String:
+                return Coerce.string(value);
+            case CoerceType.Number:
+                return Coerce.number(value);
+            case CoerceType.Integer:
+                return Coerce.integer(value);
+            case CoerceType.BigInt:
+                return Coerce.bigint(value);
+            case CoerceType.Boolean:
+                return Coerce.boolean(value);
+            case CoerceType.Date:
+                return Coerce.date(value);
+            case CoerceType.DateTime:
+                return Coerce.dateTime(value);
+            case CoerceType.Time:
+                return Coerce.time(value);
+            case CoerceType.Object:
+                return Coerce.object(value);
+            case CoerceType.Uint8Array:
+                return Coerce.uint8Array(value);
+            default:
+                return value;
+        }
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -4557,4 +4669,4 @@ class Validation {
     }
 }
 
-export { AlreadyExistsError, ArrayHelper, AsyncCache, Base32, Base58, Base64, Base64Url, BaseError, BitString, Coerce, ComponentFactory, Compression, CompressionType, ConflictError, Converter, EnvHelper, ErrorHelper, Factory, FilenameHelper, GeneralError, GuardError, Guards, HexHelper, I18n, Is, JsonHelper, NotFoundError, NotImplementedError, NotSupportedError, ObjectHelper, RandomHelper, StringHelper, UnauthorizedError, UnprocessableError, Url, Urn, Validation, ValidationError };
+export { AlreadyExistsError, ArrayHelper, AsyncCache, Base32, Base58, Base64, Base64Url, BaseError, BitString, Coerce, CoerceType, ComponentFactory, Compression, CompressionType, ConflictError, Converter, EnvHelper, ErrorHelper, Factory, FilenameHelper, GeneralError, GuardError, Guards, HexHelper, I18n, Is, JsonHelper, NotFoundError, NotImplementedError, NotSupportedError, ObjectHelper, RandomHelper, StringHelper, UnauthorizedError, UnprocessableError, Url, Urn, Validation, ValidationError };

package/dist/types/index.d.ts

@@ -24,6 +24,7 @@ export * from "./helpers/jsonHelper";
 export * from "./helpers/objectHelper";
 export * from "./helpers/randomHelper";
 export * from "./helpers/stringHelper";
+export * from "./models/coerceType";
 export * from "./models/compressionType";
 export * from "./models/IComponent";
 export * from "./models/IError";

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

@@ -0,0 +1,49 @@
+/**
+ * The types the extracted data can be coerced to.
+ */
+export declare const CoerceType: {
+    /**
+     * String.
+     */
+    readonly String: "string";
+    /**
+     * Number.
+     */
+    readonly Number: "number";
+    /**
+     * Integer.
+     */
+    readonly Integer: "integer";
+    /**
+     * Boolean.
+     */
+    readonly Boolean: "boolean";
+    /**
+     * Big Integer.
+     */
+    readonly BigInt: "bigint";
+    /**
+     * Date.
+     */
+    readonly Date: "date";
+    /**
+     * Date Time.
+     */
+    readonly DateTime: "datetime";
+    /**
+     * Time.
+     */
+    readonly Time: "time";
+    /**
+     * Object.
+     */
+    readonly Object: "object";
+    /**
+     * Uint8Array.
+     */
+    readonly Uint8Array: "uint8array";
+};
+/**
+ * The types the extracted data can be coerced to.
+ */
+export type CoerceType = (typeof CoerceType)[keyof typeof CoerceType];

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

@@ -1,3 +1,4 @@
+import { CoerceType } from "../models/coerceType";
 /**
  * Coerce an object from one type to another.
  */
@@ -16,6 +17,13 @@ export declare class Coerce {
      * @returns The value if it can be coerced.
      */
     static number(value: unknown): number | undefined;
+    /**
+     * Coerce the value to an integer.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
+     */
+    static integer(value: unknown): number | undefined;
     /**
      * Coerce the value to a bigint.
      * @param value The value to coerce.
@@ -58,4 +66,18 @@ export declare class Coerce {
      * @returns The value if it can be coerced.
      */
     static object<T = unknown>(value: unknown): T | undefined;
+    /**
+     * Coerce the value to a Uint8Array.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
+     */
+    static uint8Array(value: unknown): Uint8Array | undefined;
+    /**
+     * Coerces a value based on the coercion type.
+     * @param value The value to coerce.
+     * @param type The coercion type to perform.
+     * @returns The coerced value.
+     */
+    static byType(value: unknown, type?: CoerceType): unknown;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/core - Changelog
 
-## 0.0.1-next.26
+## 0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/Coerce.md

@@ -66,6 +66,32 @@ TypeError If the value can not be coerced.
 
 ***
 
+### integer()
+
+> `static` **integer**(`value`): `undefined` \| `number`
+
+Coerce the value to an integer.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `number`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
 ### bigint()
 
 > `static` **bigint**(`value`): `undefined` \| `bigint`
@@ -223,3 +249,57 @@ The value if it can be coerced.
 #### Throws
 
 TypeError If the value can not be coerced.
+
+***
+
+### uint8Array()
+
+> `static` **uint8Array**(`value`): `undefined` \| `Uint8Array`
+
+Coerce the value to a Uint8Array.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `Uint8Array`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### byType()
+
+> `static` **byType**(`value`, `type`?): `unknown`
+
+Coerces a value based on the coercion type.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to coerce.
+
+##### type?
+
+[`CoerceType`](../type-aliases/CoerceType.md)
+
+The coercion type to perform.
+
+#### Returns
+
+`unknown`
+
+The coerced value.

package/docs/reference/index.md

@@ -54,9 +54,11 @@
 
 ## Type Aliases
 
+- [CoerceType](type-aliases/CoerceType.md)
 - [CompressionType](type-aliases/CompressionType.md)
 
 ## Variables
 
 - [ComponentFactory](variables/ComponentFactory.md)
+- [CoerceType](variables/CoerceType.md)
 - [CompressionType](variables/CompressionType.md)

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

@@ -0,0 +1,5 @@
+# Type Alias: CoerceType
+
+> **CoerceType**: *typeof* [`CoerceType`](../variables/CoerceType.md)\[keyof *typeof* [`CoerceType`](../variables/CoerceType.md)\]
+
+The types the extracted data can be coerced to.

package/docs/reference/variables/CoerceType.md

@@ -0,0 +1,67 @@
+# Variable: CoerceType
+
+> `const` **CoerceType**: `object`
+
+The types the extracted data can be coerced to.
+
+## 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.
+
+### BigInt
+
+> `readonly` **BigInt**: `"bigint"` = `"bigint"`
+
+Big Integer.
+
+### Date
+
+> `readonly` **Date**: `"date"` = `"date"`
+
+Date.
+
+### DateTime
+
+> `readonly` **DateTime**: `"datetime"` = `"datetime"`
+
+Date Time.
+
+### Time
+
+> `readonly` **Time**: `"time"` = `"time"`
+
+Time.
+
+### Object
+
+> `readonly` **Object**: `"object"` = `"object"`
+
+Object.
+
+### Uint8Array
+
+> `readonly` **Uint8Array**: `"uint8array"` = `"uint8array"`
+
+Uint8Array.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.1-next.26",
+	"version": "0.0.1-next.28",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",