@cratis/scene.react 4.2.1 → 4.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.react",
-    "version": "4.2.1",
+    "version": "4.3.0",
     "description": "The React renderer implementing Scene.Engine's Renderer contract against real React/DOM.",
     "keywords": [
         "cratis",
@@ -51,12 +51,12 @@
         "build-storybook": "storybook build"
     },
     "dependencies": {
-        "@cratis/scene.engine": "4.2.1",
-        "@cratis/scene.model": "4.2.1"
+        "@cratis/scene.engine": "4.3.0",
+        "@cratis/scene.model": "4.3.0"
     },
     "devDependencies": {
-        "@cratis/scene.engine": "4.2.1",
-        "@cratis/scene.model": "4.2.1",
+        "@cratis/scene.engine": "4.3.0",
+        "@cratis/scene.model": "4.3.0",
         "@storybook/addon-links": "^10.6.1",
         "@storybook/react": "^10.6.1",
         "@storybook/react-vite": "^10.6.1",

package/packages/ScenePackageBundle.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Cratis. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-import { DialogTemplate, Layout, ScenePackage, Screen, ScreenTemplate, Theme } from '@cratis/scene.model';
+import { ComponentDescriptor, DialogTemplate, Layout, PropertyValueType, ScenePackage, Screen, ScreenTemplate, Theme } from '@cratis/scene.model';
 import { ComponentRegistry } from '../renderer';
 
 /**
@@ -50,6 +50,14 @@ export interface ScenePackageBundle {
      */
     screens?: Screen[];
 
+    /**
+     * What can be edited on this package's components - one {@link ComponentDescriptor} per component that is
+     * editable at design time. They are data, so Studio reads them without rendering anything, and they travel with
+     * the components they describe rather than in a registry of their own. {@link validatePackageBundle} checks
+     * that every descriptor names a component the manifest declares.
+     */
+    descriptors?: ComponentDescriptor[];
+
     /**
      * The themes this package ships, if any.
      */
@@ -71,7 +79,8 @@ export function componentRegistryKey(packageName: string, componentName: string)
 }
 
 /**
- * Checks that a bundle provides everything its manifest declares, and declares everything it provides.
+ * Checks that a bundle provides everything its manifest declares, and declares everything it provides, and that
+ * every descriptor it ships is for a component it declares and is well formed.
  *
  * A manifest that promises a component the bundle does not register renders as `UnresolvedComponent` at
  * runtime — a blank box, far from where the mistake was made. A component registered but not declared is
@@ -123,6 +132,44 @@ export function validatePackageBundle(bundle: ScenePackageBundle): string[] {
         }
     }
 
+    problems.push(...validateDescriptors(bundle));
+    return problems;
+}
+
+function validateDescriptors(bundle: ScenePackageBundle): string[] {
+    const problems: string[] = [];
+    const declared = new Set(bundle.manifest.components.map((name) => componentRegistryKey(bundle.manifest.name, name)));
+    const described = new Set<string>();
+
+    for (const descriptor of bundle.descriptors ?? []) {
+        if (!declared.has(descriptor.component)) {
+            problems.push(`describes '${descriptor.component}', which the manifest does not declare as a component`);
+        }
+
+        if (described.has(descriptor.component)) {
+            problems.push(`describes '${descriptor.component}' more than once`);
+        }
+
+        described.add(descriptor.component);
+
+        const paths = new Set<string>();
+        for (const property of descriptor.properties) {
+            if (paths.has(property.path)) {
+                problems.push(`'${descriptor.component}' describes the property '${property.path}' more than once`);
+            }
+
+            paths.add(property.path);
+
+            if (property.valueType === PropertyValueType.Collection && property.item === undefined) {
+                problems.push(`'${descriptor.component}' describes the collection '${property.path}' without describing its items`);
+            }
+
+            if (property.valueType === PropertyValueType.Enum && (property.choices ?? []).length === 0) {
+                problems.push(`'${descriptor.component}' describes the enum '${property.path}' without choices`);
+            }
+        }
+    }
+
     return problems;
 }