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

package/dist/cjs/index.cjs

@@ -113,7 +113,12 @@ class Is {
         }
         try {
             const json = JSON.parse(value);
-            return typeof json === "object";
+            return (Is.object(json) ||
+                Is.array(json) ||
+                Is.string(json) ||
+                Is.number(json) ||
+                Is.boolean(json) ||
+                Is.null(json));
         }
         catch {
             return false;
@@ -1534,6 +1539,18 @@ class Guards {
             throw new GuardError(source, "guard.stringEmpty", property, value);
         }
     }
+    /**
+     * Is the property a JSON value.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static json(source, property, value) {
+        if (!Is.json(value)) {
+            throw new GuardError(source, "guard.stringJson", property, value);
+        }
+    }
     /**
      * Is the property a base64 string.
      * @param source The source of the error.
@@ -2504,30 +2521,93 @@ class ObjectHelper {
      * @returns The property.
      */
     static propertyGet(obj, property) {
-        if (property.includes(".")) {
-            const parts = property.split(".");
-            let value = obj;
-            for (const part of parts) {
-                if (Is.object(value)) {
-                    value = value[part];
+        const pathParts = property.split(".");
+        let pathValue = obj;
+        for (const pathPart of pathParts) {
+            // Is the path part numeric i.e. an array index.
+            const arrayMatch = /^(\d+)$/.exec(pathPart);
+            if (arrayMatch) {
+                const arrayIndex = Number.parseInt(arrayMatch[1], 10);
+                if (Is.arrayValue(pathValue) && arrayIndex < pathValue.length) {
+                    // There is no prop name so this is a direct array index on the current object
+                    pathValue = pathValue[arrayIndex];
                 }
                 else {
+                    // Array index for non array object so return
                     return undefined;
                 }
             }
-            return value;
+            else if (Is.object(pathValue)) {
+                // No array part in path so assume object sub property
+                pathValue = pathValue[pathPart];
+            }
+            else {
+                return undefined;
+            }
         }
-        return Is.object(obj) ? obj[property] : undefined;
+        return pathValue;
     }
     /**
      * Set the property of an unknown object.
      * @param obj The object to set the property from.
      * @param property The property to set.
      * @param value The value to set.
+     * @throws GeneralError if the property target is not an object.
      */
     static propertySet(obj, property, value) {
-        if (Is.object(obj)) {
-            obj[property] = value;
+        const pathParts = property.split(".");
+        let pathValue = obj;
+        let parentObj;
+        for (let i = 0; i < pathParts.length; i++) {
+            const pathPart = pathParts[i];
+            // Is the path part numeric i.e. an array index.
+            const arrayMatch = /^(\d+)$/.exec(pathPart);
+            const arrayIndex = arrayMatch ? Number.parseInt(arrayMatch[1], 10) : -1;
+            if (i === pathParts.length - 1) {
+                // Last part of path so set the value
+                if (arrayIndex >= 0) {
+                    if (Is.array(pathValue)) {
+                        pathValue[arrayIndex] = value;
+                    }
+                    else {
+                        throw new GeneralError(ObjectHelper._CLASS_NAME, "cannotSetArrayIndex", {
+                            property,
+                            index: arrayIndex
+                        });
+                    }
+                }
+                else if (Is.object(pathValue)) {
+                    pathValue[pathPart] = value;
+                }
+                else {
+                    throw new GeneralError(ObjectHelper._CLASS_NAME, "cannotSetProperty", { property });
+                }
+            }
+            else {
+                parentObj = pathValue;
+                if (Is.object(pathValue)) {
+                    pathValue = pathValue[pathPart];
+                }
+                else if (Is.array(pathValue)) {
+                    pathValue = pathValue[arrayIndex];
+                }
+                if (Is.empty(pathValue)) {
+                    const nextArrayMatch = /^(\d+)$/.exec(pathParts[i + 1]);
+                    const nextArrayIndex = nextArrayMatch ? Number.parseInt(nextArrayMatch[1], 10) : -1;
+                    if (nextArrayIndex >= 0) {
+                        pathValue = [];
+                    }
+                    else {
+                        pathValue = {};
+                    }
+                    if (Is.object(parentObj)) {
+                        parentObj[pathPart] = pathValue;
+                    }
+                    else if (Is.array(parentObj)) {
+                        parentObj[arrayIndex] = pathValue;
+                    }
+                }
+            }
         }
     }
     /**

package/dist/esm/index.mjs

@@ -111,7 +111,12 @@ class Is {
         }
         try {
             const json = JSON.parse(value);
-            return typeof json === "object";
+            return (Is.object(json) ||
+                Is.array(json) ||
+                Is.string(json) ||
+                Is.number(json) ||
+                Is.boolean(json) ||
+                Is.null(json));
         }
         catch {
             return false;
@@ -1532,6 +1537,18 @@ class Guards {
             throw new GuardError(source, "guard.stringEmpty", property, value);
         }
     }
+    /**
+     * Is the property a JSON value.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static json(source, property, value) {
+        if (!Is.json(value)) {
+            throw new GuardError(source, "guard.stringJson", property, value);
+        }
+    }
     /**
      * Is the property a base64 string.
      * @param source The source of the error.
@@ -2502,30 +2519,93 @@ class ObjectHelper {
      * @returns The property.
      */
     static propertyGet(obj, property) {
-        if (property.includes(".")) {
-            const parts = property.split(".");
-            let value = obj;
-            for (const part of parts) {
-                if (Is.object(value)) {
-                    value = value[part];
+        const pathParts = property.split(".");
+        let pathValue = obj;
+        for (const pathPart of pathParts) {
+            // Is the path part numeric i.e. an array index.
+            const arrayMatch = /^(\d+)$/.exec(pathPart);
+            if (arrayMatch) {
+                const arrayIndex = Number.parseInt(arrayMatch[1], 10);
+                if (Is.arrayValue(pathValue) && arrayIndex < pathValue.length) {
+                    // There is no prop name so this is a direct array index on the current object
+                    pathValue = pathValue[arrayIndex];
                 }
                 else {
+                    // Array index for non array object so return
                     return undefined;
                 }
             }
-            return value;
+            else if (Is.object(pathValue)) {
+                // No array part in path so assume object sub property
+                pathValue = pathValue[pathPart];
+            }
+            else {
+                return undefined;
+            }
         }
-        return Is.object(obj) ? obj[property] : undefined;
+        return pathValue;
     }
     /**
      * Set the property of an unknown object.
      * @param obj The object to set the property from.
      * @param property The property to set.
      * @param value The value to set.
+     * @throws GeneralError if the property target is not an object.
      */
     static propertySet(obj, property, value) {
-        if (Is.object(obj)) {
-            obj[property] = value;
+        const pathParts = property.split(".");
+        let pathValue = obj;
+        let parentObj;
+        for (let i = 0; i < pathParts.length; i++) {
+            const pathPart = pathParts[i];
+            // Is the path part numeric i.e. an array index.
+            const arrayMatch = /^(\d+)$/.exec(pathPart);
+            const arrayIndex = arrayMatch ? Number.parseInt(arrayMatch[1], 10) : -1;
+            if (i === pathParts.length - 1) {
+                // Last part of path so set the value
+                if (arrayIndex >= 0) {
+                    if (Is.array(pathValue)) {
+                        pathValue[arrayIndex] = value;
+                    }
+                    else {
+                        throw new GeneralError(ObjectHelper._CLASS_NAME, "cannotSetArrayIndex", {
+                            property,
+                            index: arrayIndex
+                        });
+                    }
+                }
+                else if (Is.object(pathValue)) {
+                    pathValue[pathPart] = value;
+                }
+                else {
+                    throw new GeneralError(ObjectHelper._CLASS_NAME, "cannotSetProperty", { property });
+                }
+            }
+            else {
+                parentObj = pathValue;
+                if (Is.object(pathValue)) {
+                    pathValue = pathValue[pathPart];
+                }
+                else if (Is.array(pathValue)) {
+                    pathValue = pathValue[arrayIndex];
+                }
+                if (Is.empty(pathValue)) {
+                    const nextArrayMatch = /^(\d+)$/.exec(pathParts[i + 1]);
+                    const nextArrayIndex = nextArrayMatch ? Number.parseInt(nextArrayMatch[1], 10) : -1;
+                    if (nextArrayIndex >= 0) {
+                        pathValue = [];
+                    }
+                    else {
+                        pathValue = {};
+                    }
+                    if (Is.object(parentObj)) {
+                        parentObj[pathPart] = pathValue;
+                    }
+                    else if (Is.array(parentObj)) {
+                        parentObj[arrayIndex] = pathValue;
+                    }
+                }
+            }
         }
     }
     /**

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

@@ -49,6 +49,7 @@ export declare class ObjectHelper {
      * @param obj The object to set the property from.
      * @param property The property to set.
      * @param value The value to set.
+     * @throws GeneralError if the property target is not an object.
      */
     static propertySet(obj: unknown, property: string, value: unknown): void;
     /**

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

@@ -26,6 +26,14 @@ export declare class Guards {
      * @throws GuardError If the value does not match the assertion.
      */
     static stringValue(source: string, property: string, value: unknown): asserts value is string;
+    /**
+     * Is the property a JSON value.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static json(source: string, property: string, value: unknown): asserts value is string;
     /**
      * Is the property a base64 string.
      * @param source The source of the error.

package/docs/changelog.md

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

package/docs/reference/classes/Guards.md

@@ -122,6 +122,42 @@ GuardError If the value does not match the assertion.
 
 ***
 
+### json()
+
+> `static` **json**(`source`, `property`, `value`): `asserts value is string`
+
+Is the property a JSON value.
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+`asserts value is string`
+
+#### Throws
+
+GuardError If the value does not match the assertion.
+
+***
+
 ### stringBase64()
 
 > `static` **stringBase64**(`source`, `property`, `value`): `asserts value is string`

package/docs/reference/classes/ObjectHelper.md

@@ -236,6 +236,10 @@ The value to set.
 
 `void`
 
+#### Throws
+
+GeneralError if the property target is not an object.
+
 ***
 
 ### propertyDelete()

package/locales/en.json

@@ -51,6 +51,7 @@
 			"stringBase58": "Property \"{property}\" must be a base58 encoded string, it is \"{value}\"",
 			"stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
 			"stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
+			"stringJson": "Property \"{property}\" must be a JSON string",
 			"number": "Property \"{property}\" must be a number, it is \"{value}\"",
 			"integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
 			"bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
@@ -71,7 +72,9 @@
 			"email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\""
 		},
 		"objectHelper": {
-			"failedBytesToJSON": "Failed converting bytes to JSON"
+			"failedBytesToJSON": "Failed converting bytes to JSON",
+			"cannotSetArrayIndex": "Cannot set property \"{property}\" using index \"{index}\" as it is not an array",
+			"cannotSetProperty": "Cannot set property \"{property}\" when the target is not an object"
 		},
 		"common": {
 			"notImplementedMethod": "The method \"{method}\" has not been implemented",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.1-next.24",
+	"version": "0.0.1-next.26",
 	"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.12",
+		"intl-messageformat": "10.7.14",
 		"rfc6902": "5.1.2"
 	},
 	"main": "./dist/cjs/index.cjs",