@compilr-dev/sdk 0.38.0 → 0.40.0

package/dist/canvas/scene-ops.d.ts

@@ -48,6 +48,11 @@ export type SceneOp =
     op: 'layers';
     layers: unknown;
 }
+/** Replace the lights (§20.5); `[]` restores the default studio light. */
+ | {
+    op: 'lights';
+    lights: unknown;
+}
 /** Whole-scene replace (scene_create, JSON import). */
  | {
     op: 'replace';
@@ -59,7 +64,7 @@ export type SceneEditSource = {
 } | {
     kind: 'user';
 };
-export type SceneChangeKind = 'moved' | 'resized' | 'rotated' | 'recoloured' | 'renamed' | 'removed' | 'added' | 'edited' | 'camera' | 'layers' | 'replaced';
+export type SceneChangeKind = 'moved' | 'resized' | 'rotated' | 'recoloured' | 'renamed' | 'removed' | 'added' | 'edited' | 'camera' | 'layers' | 'lights' | 'replaced';
 /** One journalled change (the writer stamps `rev`). */
 export interface SceneChange {
     rev: number;

package/dist/canvas/scene-ops.js

@@ -291,6 +291,43 @@ function setLayers(scene, layers) {
         warnings: [],
     };
 }
+/**
+ * Replace the lights.
+ *
+ * `[]` DELETES the field rather than storing an empty list, which is the difference between
+ * "the default studio light" and "no light at all" — an empty array would render a black scene
+ * and read in the JSON as if lighting had been configured.
+ */
+function setLights(scene, lights) {
+    if (!Array.isArray(lights)) {
+        return {
+            error: 'lights must be an array of { type: "sun" | "ambient", … } — or [] to go back to the default studio light.',
+        };
+    }
+    const probe = validateScene({ ...scene, lights: lights.length === 0 ? undefined : lights });
+    if (!probe.ok)
+        return { error: formatValidationErrors(probe.errors) };
+    const before = scene.lights ?? [];
+    const next = { ...scene };
+    if (lights.length === 0)
+        delete next.lights;
+    else
+        next.lights = probe.scene.lights;
+    const summary = lights.length === 0
+        ? 'Lights cleared — back to the default studio light.'
+        : `Lights set: ${lights
+            .map((l) => isRecord(l) && typeof l.type === 'string'
+            ? `${l.type} ${typeof l.intensity === 'number' ? String(l.intensity) : 'default'}`
+            : '?')
+            .join(', ')}.`;
+    return {
+        scene: next,
+        summary,
+        ids: [],
+        changes: [{ id: '', what: 'lights', from: before, to: lights }],
+        warnings: [],
+    };
+}
 function setCamera(scene, camera) {
     if (isRecord(camera) && camera.fit === true) {
         const rest = { ...scene };
@@ -335,6 +372,8 @@ export function applySceneOp(scene, op, opts) {
             return setCamera(scene, op.camera);
         case 'layers':
             return setLayers(scene, op.layers);
+        case 'lights':
+            return setLights(scene, op.lights);
         case 'replace': {
             const v = validateScene(op.scene);
             if (!v.ok)
@@ -431,6 +470,8 @@ function describeChange(c) {
             return 'changed the camera';
         case 'layers':
             return 'changed which layers can be hidden';
+        case 'lights':
+            return 'changed the lighting';
         case 'replaced':
             return 'replaced the whole scene';
         case 'edited':

package/dist/canvas/scene.d.ts

@@ -21,10 +21,26 @@ export declare const SCENE_EXTRUDE_AXES: readonly ExtrudeAxis[];
 export interface SceneMaterial {
     /** 0..1, default 0.78 */
     roughness?: number;
-    /** 0..1, default 0.02 */
+    /**
+     * 0..1, default 0.02.
+     *
+     * ⚠️ Metal is MIRROR, not colour: a metal with nothing to reflect renders near-black. The
+     * viewer lights the scene with a neutral room environment so this means something; without
+     * one, raising it made objects darker, which is why it had looked like a dead knob.
+     */
     metalness?: number;
     /** 0.05..1, default 1 (transparent when < 1) */
     opacity?: number;
+    /**
+     * '#RRGGBB' the object gives off, default '#000000' (none). Emission is NOT light: it
+     * brightens the object itself and casts nothing on its neighbours, so it marks a thing as
+     * live or active — an indicator, a hot path, a selected step — rather than lighting a room.
+     */
+    emissive?: string;
+    /** How strong the emission is. 0..5, default 1. Only means anything with `emissive` set. */
+    emissiveIntensity?: number;
+    /** Draw the edges only. Default false. For the parts of a diagram that are logical, not built. */
+    wireframe?: boolean;
 }
 export interface SceneObjectBase {
     /** Unique in the scene; /^[a-z0-9][a-z0-9_-]{0,47}$/ */
@@ -260,6 +276,8 @@ export declare const SCENE_NEUTRAL_PALETTE: readonly string[];
 /** Accessible names for the palette swatches, same order (Q-10). */
 export declare const SCENE_PALETTE_NAMES: readonly string[];
 export declare const SCENE_DEFAULT_MATERIAL: Readonly<Required<SceneMaterial>>;
+/** `material.emissiveIntensity` range. Above ~5 everything clips to white. */
+export declare const SCENE_EMISSIVE_INTENSITY_MAX = 5;
 /** The reference camera, used for an empty scene. */
 export declare const SCENE_DEFAULT_CAMERA: Readonly<SceneCamera>;
 /** Vertical field of view of the viewer camera, degrees. */

package/dist/canvas/scene.js

@@ -105,7 +105,12 @@ export const SCENE_DEFAULT_MATERIAL = {
     roughness: 0.78,
     metalness: 0.02,
     opacity: 1,
+    emissive: '#000000',
+    emissiveIntensity: 1,
+    wireframe: false,
 };
+/** `material.emissiveIntensity` range. Above ~5 everything clips to white. */
+export const SCENE_EMISSIVE_INTENSITY_MAX = 5;
 /** The reference camera, used for an empty scene. */
 export const SCENE_DEFAULT_CAMERA = {
     position: [7, 5.5, 8],
@@ -216,7 +221,14 @@ const TYPE_SHAPE = {
     group: 'a group is a container: id, name, position, rotation, group, locked, tags only — colour its children',
     label: 'label takes text and optional size (cap height in metres), background, face ("camera" or "fixed"); color is the ink and material is not allowed',
 };
-const MATERIAL_KEYS = new Set(['roughness', 'metalness', 'opacity']);
+const MATERIAL_KEYS = new Set([
+    'roughness',
+    'metalness',
+    'opacity',
+    'emissive',
+    'emissiveIntensity',
+    'wireframe',
+]);
 const HEX_RE = /^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/;
 /** Short, stable number rendering for messages and summaries. */
 export function fmtNum(n) {
@@ -422,7 +434,7 @@ function validateObject(raw, i, errors) {
             const m = raw.material;
             for (const k of Object.keys(m)) {
                 if (!MATERIAL_KEYS.has(k)) {
-                    errors.push(`${label}.material.${k} is not a material field — roughness, metalness, opacity.`);
+                    errors.push(`${label}.material.${k} is not a material field — roughness, metalness, opacity, emissive, emissiveIntensity, wireframe.`);
                 }
             }
             if (m.roughness !== undefined)
@@ -431,6 +443,15 @@ function validateObject(raw, i, errors) {
                 checkNumber(m.metalness, `${label}.material.metalness`, 0, 1, 'metalness is 0–1', errors);
             if (m.opacity !== undefined)
                 checkNumber(m.opacity, `${label}.material.opacity`, SCENE_OPACITY_MIN, 1, `opacity is ${fmtNum(SCENE_OPACITY_MIN)}–1`, errors);
+            if (m.emissive !== undefined &&
+                (typeof m.emissive !== 'string' || !HEX_RE.test(m.emissive))) {
+                errors.push(`${label}.material.emissive = ${show(m.emissive)} — a colour the object gives off, "#RGB" or "#RRGGBB" ("#000000" for none).`);
+            }
+            if (m.emissiveIntensity !== undefined)
+                checkNumber(m.emissiveIntensity, `${label}.material.emissiveIntensity`, 0, SCENE_EMISSIVE_INTENSITY_MAX, `emissiveIntensity is 0–${String(SCENE_EMISSIVE_INTENSITY_MAX)}, and only does anything with emissive set`, errors);
+            if (m.wireframe !== undefined && typeof m.wireframe !== 'boolean') {
+                errors.push(`${label}.material.wireframe = ${show(m.wireframe)} — true or false.`);
+            }
         }
     }
     // Type-specific dimensions.

package/dist/capabilities/packs.js

@@ -280,6 +280,7 @@ export const CAPABILITY_PACKS = {
             'scene_remove_object',
             'scene_set_camera',
             'scene_set_layers',
+            'scene_set_lights',
             'scene_screenshot',
         ],
         readOnly: false,

package/dist/platform/tools/scene-tools.d.ts

@@ -15,7 +15,7 @@
 import type { PlatformContext, PlatformToolsConfig } from '../context.js';
 import { type ISceneWriter } from '../scene-writer.js';
 import { type SceneFile } from '../../canvas/scene.js';
-export declare const SCENE_TOOL_NAMES: readonly ["scene_create", "scene_get", "scene_add_object", "scene_update_object", "scene_remove_object", "scene_set_camera", "scene_set_layers", "scene_screenshot"];
+export declare const SCENE_TOOL_NAMES: readonly ["scene_create", "scene_get", "scene_add_object", "scene_update_object", "scene_remove_object", "scene_set_camera", "scene_set_layers", "scene_set_lights", "scene_screenshot"];
 /**
  * "sofa · box · Sofa" rows, indented under their group parent; `#tag` suffixes when `withTags`.
  *
@@ -103,6 +103,9 @@ export declare function createSceneTools(config: PlatformToolsConfig, options?:
 }> | import("@compilr-dev/agents").Tool<{
     canvas_id: number;
     layers?: unknown;
+}> | import("@compilr-dev/agents").Tool<{
+    canvas_id: number;
+    lights?: unknown;
 }> | import("@compilr-dev/agents").Tool<{
     canvas_id: number;
     width?: number;

package/dist/platform/tools/scene-tools.js

@@ -14,7 +14,7 @@
  */
 import { defineTool, createErrorResult } from '@compilr-dev/agents';
 import { createSceneWriter } from '../scene-writer.js';
-import { SCENE_MAX_BATCH, SCENE_MAX_LAYERS, SCENE_OBJECT_TYPES, SCENE_LABEL_FACES, describeScene, serializeScene, } from '../../canvas/scene.js';
+import { SCENE_MAX_BATCH, SCENE_MAX_LAYERS, SCENE_OBJECT_TYPES, SCENE_MAX_LIGHTS, SCENE_MAX_SHADOW_LIGHTS, SCENE_LIGHT_INTENSITY_MAX, SCENE_LABEL_FACES, describeScene, serializeScene, } from '../../canvas/scene.js';
 import { describeLayers, emptyLayers, undeclaredTags } from '../../canvas/scene-layers.js';
 import { formatUserEditNotice, } from '../../canvas/scene-ops.js';
 export const SCENE_TOOL_NAMES = [
@@ -25,6 +25,7 @@ export const SCENE_TOOL_NAMES = [
     'scene_remove_object',
     'scene_set_camera',
     'scene_set_layers',
+    'scene_set_lights',
     'scene_screenshot',
 ];
 const DEFAULT_SHOT = { width: 1280, height: 800 };
@@ -288,11 +289,36 @@ const OBJECT_PROPERTIES = {
     },
     material: {
         type: 'object',
-        description: '{ roughness 0–1, metalness 0–1, opacity 0.05–1 }. Not on a group.',
+        description: 'Not on a group or a label. { roughness 0–1 (0 = mirror-smooth, 1 = matt) · metalness 0–1 ' +
+            '(metal is MIRROR, not colour: it shows the room, so it reads dark against a plain ' +
+            'background — use it for a few accents, not everything) · opacity 0.05–1 (a pane of glass, ' +
+            'a volume you want to see into) · emissive "#RRGGBB" + emissiveIntensity 0–5 · wireframe }.',
         properties: {
             roughness: { type: 'number' },
             metalness: { type: 'number' },
             opacity: { type: 'number' },
+            emissive: {
+                type: 'string',
+                description: 'A colour the object GIVES OFF, so it reads as live rather than lit: an indicator, an ' +
+                    'active path, the step being explained. ⚠️ It brightens the object only — it casts no ' +
+                    "light on its neighbours and draws no halo. Pair it with the object's own colour, and " +
+                    'use it on a few things: everything glowing is nothing glowing.',
+            },
+            emissiveIntensity: {
+                type: 'number',
+                description: '0–5, default 1. Does nothing without emissive. ⚠️ MEASURED on a real scene: a sphere at ' +
+                    '1.5 loses its shading and reads as a flat disc, and a ring at 2 washes to near-white and ' +
+                    'loses its hue. Emission adds a flat colour OVER the shading, so the bigger or paler the ' +
+                    'object, the sooner it stops looking like a solid. Stay at or below ~0.3 for anything ' +
+                    'larger than a token and save the high end for small accents. Against a bright scene a ' +
+                    'glow reads poorly whatever the number — dim the scene with scene_set_lights rather than ' +
+                    'turning this up.',
+            },
+            wireframe: {
+                type: 'boolean',
+                description: 'Edges only. For the parts of a diagram that are LOGICAL rather than built — a boundary, ' +
+                    'a planned phase, a region — beside solid objects that are real.',
+            },
         },
     },
     locked: {
@@ -664,6 +690,56 @@ export function createSceneTools(config, options) {
         },
     });
     // ---------------------------------------------------------------------------
+    const sceneSetLightsTool = defineTool({
+        name: 'scene_set_lights',
+        description: "Replace a scene's lighting. Until this existed, lights could only be set at creation, so " +
+            'dimming a finished scene meant rebuilding every object in it. ' +
+            'Two kinds: { type: "ambient", intensity } is the overall fill — it also sets how much of ' +
+            'the room glossy and metallic surfaces reflect, so dropping it to 0 makes a genuinely dark ' +
+            'scene — and { type: "sun", position: [x, y, z], intensity, castShadow } is a directional ' +
+            'light that can cast shadows. [] goes back to the default studio light (ambient fill + one ' +
+            'sun from above-right), which is what most scenes want. ' +
+            `Up to ${String(SCENE_MAX_LIGHTS)} lights, ${String(SCENE_MAX_SHADOW_LIGHTS)} of them casting shadows ` +
+            '(each shadow costs a render pass). ⚠️ Lighting a scene darker makes emissive objects stand ' +
+            'out; it also makes everything else harder to read, so change it for a reason.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                canvas_id: { type: 'number', description: 'The scene canvas id.' },
+                lights: {
+                    type: 'array',
+                    maxItems: SCENE_MAX_LIGHTS,
+                    description: '[] restores the default studio light.',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            type: { type: 'string', enum: ['sun', 'ambient'] },
+                            position: { ...VEC3, description: 'sun only: where it shines FROM, in metres.' },
+                            intensity: {
+                                type: 'number',
+                                description: `0–${String(SCENE_LIGHT_INTENSITY_MAX)}. The default studio light is ambient ~1 and sun ~1.6.`,
+                            },
+                            castShadow: { type: 'boolean', description: 'sun only. Default false.' },
+                        },
+                        required: ['type'],
+                    },
+                },
+            },
+            required: ['canvas_id', 'lights'],
+        },
+        execute: async (input) => {
+            try {
+                if (!Array.isArray(input.lights)) {
+                    return createErrorResult('lights must be an array of { type: "sun" | "ambient", … } — or [] to go back to the default studio light.');
+                }
+                return await applyAsAgent(input.canvas_id, [{ op: 'lights', lights: input.lights }], () => null);
+            }
+            catch (error) {
+                return createErrorResult(errorMessage('set lights', error));
+            }
+        },
+    });
+    // ---------------------------------------------------------------------------
     const sceneScreenshotTool = defineTool({
         name: 'scene_screenshot',
         description: 'RENDER a 3D scene and SEE it — check proportions, overlaps, gaps and floating objects after ' +
@@ -717,6 +793,7 @@ export function createSceneTools(config, options) {
         sceneRemoveObjectTool,
         sceneSetCameraTool,
         sceneSetLayersTool,
+        sceneSetLightsTool,
         sceneScreenshotTool,
     ];
 }

package/dist/team/tool-config.js

@@ -315,6 +315,7 @@ export const TOOL_GROUPS = {
             'scene_remove_object',
             'scene_set_camera',
             'scene_set_layers',
+            'scene_set_lights',
             'scene_screenshot',
         ],
         readOnly: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compilr-dev/sdk",
-  "version": "0.38.0",
+  "version": "0.40.0",
   "description": "Universal agent runtime for building AI-powered applications",
   "type": "module",
   "main": "dist/index.js",