@twin.org/core 0.0.1-next.47 → 0.0.1-next.49

package/dist/cjs/index.cjs

@@ -2353,12 +2353,15 @@ class Converter {
     }
 }
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
 /**
  * Helpers methods for JSON objects.
  */
 class JsonHelper {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "JsonHelper";
     /**
      * Serializes in canonical format.
      * Based on https://www.rfc-editor.org/rfc/rfc8785.
@@ -2417,9 +2420,17 @@ class JsonHelper {
      * @param object The object to patch.
      * @param patches The second object.
      * @returns The updated object.
+     * @throws GeneralError if the patch fails.
      */
     static patch(object, patches) {
-        return rfc6902.applyPatch(object, patches);
+        const clone = ObjectHelper.clone(object);
+        const result = rfc6902.applyPatch(clone, patches);
+        for (let i = 0; i < result.length; i++) {
+            if (!Is.empty(result[i])) {
+                throw new GeneralError(JsonHelper._CLASS_NAME, "failedPatch", { index: i }, result[i]);
+            }
+        }
+        return clone;
     }
     /**
      * Stringify the JSON with support for extended data types date/bigint/uint8array.

package/dist/esm/index.mjs

@@ -2351,12 +2351,15 @@ class Converter {
     }
 }
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
 /**
  * Helpers methods for JSON objects.
  */
 class JsonHelper {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "JsonHelper";
     /**
      * Serializes in canonical format.
      * Based on https://www.rfc-editor.org/rfc/rfc8785.
@@ -2415,9 +2418,17 @@ class JsonHelper {
      * @param object The object to patch.
      * @param patches The second object.
      * @returns The updated object.
+     * @throws GeneralError if the patch fails.
      */
     static patch(object, patches) {
-        return applyPatch(object, patches);
+        const clone = ObjectHelper.clone(object);
+        const result = applyPatch(clone, patches);
+        for (let i = 0; i < result.length; i++) {
+            if (!Is.empty(result[i])) {
+                throw new GeneralError(JsonHelper._CLASS_NAME, "failedPatch", { index: i }, result[i]);
+            }
+        }
+        return clone;
     }
     /**
      * Stringify the JSON with support for extended data types date/bigint/uint8array.

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

@@ -24,6 +24,7 @@ export declare class JsonHelper {
      * @param object The object to patch.
      * @param patches The second object.
      * @returns The updated object.
+     * @throws GeneralError if the patch fails.
      */
     static patch<T = unknown>(object: T, patches: IPatchOperation[]): T;
     /**

package/docs/changelog.md

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

package/docs/reference/classes/Coerce.md

@@ -254,7 +254,7 @@ TypeError If the value can not be coerced.
 
 ### uint8Array()
 
-> `static` **uint8Array**(`value`): `undefined` \| `Uint8Array`
+> `static` **uint8Array**(`value`): `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
 
 Coerce the value to a Uint8Array.
 
@@ -268,7 +268,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Uint8Array`
+`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
 
 The value if it can be coerced.
 

package/docs/reference/classes/Compression.md

@@ -16,7 +16,7 @@ A class to handle compression.
 
 ### compress()
 
-> `static` **compress**(`bytes`, `type`): `Promise`\<`Uint8Array`\>
+> `static` **compress**(`bytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 Compress bytes using GZIP.
 
@@ -36,7 +36,7 @@ The type of compression to use.
 
 #### Returns
 
-`Promise`\<`Uint8Array`\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 The compressed bytes.
 
@@ -44,7 +44,7 @@ The compressed bytes.
 
 ### decompress()
 
-> `static` **decompress**(`compressedBytes`, `type`): `Promise`\<`Uint8Array`\>
+> `static` **decompress**(`compressedBytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 Decompress a gzipped compressed byte array.
 
@@ -64,6 +64,6 @@ The type of compression to use.
 
 #### Returns
 
-`Promise`\<`Uint8Array`\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 The decompressed bytes.

package/docs/reference/classes/Guards.md

@@ -816,7 +816,7 @@ GuardError If the value does not match the assertion.
 
 ### uint8Array()
 
-> `static` **uint8Array**(`source`, `property`, `value`): `asserts value is Uint8Array`
+> `static` **uint8Array**(`source`, `property`, `value`): `asserts value is Uint8Array<ArrayBufferLike>`
 
 Is the property a Uint8Array.
 
@@ -842,7 +842,7 @@ The value to test.
 
 #### Returns
 
-`asserts value is Uint8Array`
+`asserts value is Uint8Array<ArrayBufferLike>`
 
 #### Throws
 

package/docs/reference/classes/Is.md

@@ -676,7 +676,7 @@ True if the value is an element from the options array.
 
 ### uint8Array()
 
-> `static` **uint8Array**(`value`): `value is Uint8Array`
+> `static` **uint8Array**(`value`): `value is Uint8Array<ArrayBufferLike>`
 
 Is the value a Uint8Array.
 
@@ -690,7 +690,7 @@ The value to test.
 
 #### Returns
 
-`value is Uint8Array`
+`value is Uint8Array<ArrayBufferLike>`
 
 True if the value is a Uint8Array.
 
@@ -698,7 +698,7 @@ True if the value is a Uint8Array.
 
 ### typedArray()
 
-> `static` **typedArray**(`value`): value is Int8Array \| Uint8Array \| Int16Array \| Uint16Array \| Int32Array \| Uint32Array \| Float32Array \| Float64Array
+> `static` **typedArray**(`value`): value is Int8Array\<ArrayBufferLike\> \| Uint8Array\<ArrayBufferLike\> \| Int16Array\<ArrayBufferLike\> \| Uint16Array\<ArrayBufferLike\> \| Int32Array\<ArrayBufferLike\> \| Uint32Array\<ArrayBufferLike\> \| Float32Array\<ArrayBufferLike\> \| Float64Array\<ArrayBufferLike\>
 
 Is the value a TypedArray.
 
@@ -712,7 +712,7 @@ The value to test.
 
 #### Returns
 
-value is Int8Array \| Uint8Array \| Int16Array \| Uint16Array \| Int32Array \| Uint32Array \| Float32Array \| Float64Array
+value is Int8Array\<ArrayBufferLike\> \| Uint8Array\<ArrayBufferLike\> \| Int16Array\<ArrayBufferLike\> \| Uint16Array\<ArrayBufferLike\> \| Int32Array\<ArrayBufferLike\> \| Uint32Array\<ArrayBufferLike\> \| Float32Array\<ArrayBufferLike\> \| Float64Array\<ArrayBufferLike\>
 
 True if the value is a TypedArray.
 

package/docs/reference/classes/JsonHelper.md

@@ -101,6 +101,10 @@ The second object.
 
 The updated object.
 
+#### Throws
+
+GeneralError if the patch fails.
+
 ***
 
 ### stringifyEx()

package/docs/reference/classes/ObjectHelper.md

@@ -62,7 +62,7 @@ Convert a bytes to an object.
 
 The bytes to convert to an object.
 
-`undefined` | `null` | `Uint8Array`
+`undefined` | `null` | `Uint8Array`\<`ArrayBufferLike`\>
 
 #### Returns
 
@@ -436,13 +436,13 @@ The object to remove the empty properties from.
 
 The options for the removal.
 
-###### removeUndefined
+###### removeUndefined?
 
 `boolean`
 
 Remove undefined properties, defaults to true.
 
-###### removeNull
+###### removeNull?
 
 `boolean`
 

package/docs/reference/classes/Uint8ArrayHelper.md

@@ -24,7 +24,7 @@ Concatenate multiple arrays.
 
 ##### arrays
 
-`Uint8Array`[]
+`Uint8Array`\<`ArrayBufferLike`\>[]
 
 The array to concatenate.
 

package/docs/reference/classes/Validation.md

@@ -130,19 +130,19 @@ Optional i18n resource of the field name to display in the message.
 
 Additional options for the validation.
 
-###### format
+###### format?
 
 `RegExp` \| `"base64"` \| `"base58"` \| `"hex"`
 
 Specific format to check.
 
-###### minLength
+###### minLength?
 
 `number`
 
 The minimum length of the string.
 
-###### maxLength
+###### maxLength?
 
 `number`
 
@@ -192,13 +192,13 @@ Optional i18n resource of the field name to display in the message.
 
 Additional options for the validation.
 
-###### minLength
+###### minLength?
 
 `number`
 
 The minimum length of the string.
 
-###### maxLength
+###### maxLength?
 
 `number`
 
@@ -248,13 +248,13 @@ Optional i18n resource of the field name to display in the message.
 
 Additional options for the validation.
 
-###### minValue
+###### minValue?
 
 `number`
 
 The minimum value of the number.
 
-###### maxValue
+###### maxValue?
 
 `number`
 
@@ -304,13 +304,13 @@ Optional i18n resource of the field name to display in the message.
 
 Additional options for the validation.
 
-###### minValue
+###### minValue?
 
 `number`
 
 The minimum value of the integer.
 
-###### maxValue
+###### maxValue?
 
 `number`
 
@@ -360,13 +360,13 @@ Optional i18n resource of the field name to display in the message.
 
 Additional options for the validation.
 
-###### minValue
+###### minValue?
 
 `bigint`
 
 The minimum value of the bigint.
 
-###### maxValue
+###### maxValue?
 
 `bigint`
 
@@ -844,7 +844,7 @@ True if the value is one of the items in the options.
 
 ### uint8Array()
 
-> `static` **uint8Array**(`property`, `value`, `failures`, `fieldNameResource`?): `value is Uint8Array`
+> `static` **uint8Array**(`property`, `value`, `failures`, `fieldNameResource`?): `value is Uint8Array<ArrayBufferLike>`
 
 Is the property a Uint8Array.
 
@@ -876,7 +876,7 @@ Optional i18n resource of the field name to display in the message.
 
 #### Returns
 
-`value is Uint8Array`
+`value is Uint8Array<ArrayBufferLike>`
 
 True if the value is a Uint8Array.
 

package/locales/en.json

@@ -95,6 +95,9 @@
 		},
 		"base58": {
 			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+		},
+		"jsonHelper": {
+			"failedPatch": "Failed to patch the JSON object, patch index \"{index}\" failed"
 		}
 	},
 	"errorNames": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.1-next.47",
+	"version": "0.0.1-next.49",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/nameof": "next",
-		"intl-messageformat": "10.7.14",
+		"intl-messageformat": "10.7.15",
 		"rfc6902": "5.1.2"
 	},
 	"main": "./dist/cjs/index.cjs",