@cratis/scene.engine 4.5.0 → 4.6.0

package/editing/inspect.ts

@@ -45,6 +45,16 @@ function toInspectedItems(raw: unknown, local: boolean): InspectedCollectionItem
     });
 }
 
+/**
+ * The value a property takes when nothing configures it. A stored `null` is a real value for a `json` property
+ * (it is valid JSON, and clearing it to the default would hide it), so only that type keeps it; every other
+ * type falls back to its default for `null` and `undefined` alike.
+ */
+function effectiveValueOf(descriptor: PropertyDescriptor, currentValue: unknown): unknown {
+    if (currentValue === null && descriptor.valueType === PropertyValueType.Json) return null;
+    return currentValue ?? descriptor.default;
+}
+
 function inspectProperty(
     descriptor: PropertyDescriptor,
     record: NodeRecord,
@@ -61,7 +71,7 @@ function inspectProperty(
     const inspected: InspectedProperty = {
         descriptor,
         currentValue,
-        effectiveValue: configured ? configured.value : (currentValue ?? descriptor.default),
+        effectiveValue: configured ? configured.value : effectiveValueOf(descriptor, currentValue),
         source: (configured?.source ?? (currentValue === undefined ? ValueSource.Default : ValueSource.Local)) as ValueSource,
         editable: false,
     };

package/editing/validateValue.ts

@@ -65,11 +65,40 @@ export function validateValue(descriptor: PropertyDescriptor, value: unknown): s
         case PropertyValueType.Collection:
             return validateCollection(descriptor, value);
 
+        case PropertyValueType.Json:
+            return isJsonValue(value) ? undefined : 'expected a JSON value';
+
         default:
             return isRecord(value) || Array.isArray(value) ? undefined : 'expected a structured value';
     }
 }
 
+/**
+ * The deepest nesting a JSON value may have. Authored configuration (chart datasets, option lists) is shallow;
+ * the limit turns a runaway or hostile structure into a validation message instead of a stack overflow.
+ */
+const maximumJsonDepth = 64;
+
+/**
+ * Whether a value is JSON: `null`, a string, a boolean, a finite number, or an array or plain object of those.
+ * The value is only inspected, never serialized, so what an editor stores is exactly what was passed in.
+ */
+function isJsonValue(value: unknown, parents = new Set<object>()): boolean {
+    if (value === null || typeof value === 'string' || typeof value === 'boolean') return true;
+    if (typeof value === 'number') return Number.isFinite(value);
+    if (typeof value !== 'object' || parents.has(value) || parents.size >= maximumJsonDepth) return false;
+
+    const isArray = Array.isArray(value);
+    const prototype = Object.getPrototypeOf(value);
+    if (isArray ? prototype !== Array.prototype : prototype !== Object.prototype && prototype !== null) return false;
+
+    parents.add(value);
+    const values = isArray ? Array.from({ length: value.length }, (_, index) => (index in value ? value[index] : undefined)) : Object.values(value);
+    const valid = values.every(candidate => isJsonValue(candidate, parents));
+    parents.delete(value);
+    return valid;
+}
+
 function validateCollection(descriptor: PropertyDescriptor, value: unknown): string | undefined {
     if (!Array.isArray(value)) return 'expected a list';
     const constraints = descriptor.constraints ?? {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.engine",
-    "version": "4.5.0",
+    "version": "4.6.0",
     "description": "The Scene runtime: walks a Scene element tree and drives whichever renderer is plugged in. Does not know React, or any other rendering platform, exists.",
     "keywords": [
         "cratis",
@@ -48,9 +48,9 @@
         "up": "yarn g:up"
     },
     "dependencies": {
-        "@cratis/scene.model": "4.5.0"
+        "@cratis/scene.model": "4.6.0"
     },
     "devDependencies": {
-        "@cratis/scene.model": "4.5.0"
+        "@cratis/scene.model": "4.6.0"
     }
 }