selva-shared 0.8.1

package/dist/contexts/FOOTER_USAGE.md

@@ -0,0 +1,164 @@
+# Dynamic Footer System
+
+The footer now supports a dynamic, context-based approach for adding page-specific content without prop drilling.
+
+## How It Works
+
+1. **FooterContext** manages a store of footer items
+2. **PageContainer** initializes the context
+3. **PageFooter** renders items from the context, plus error/warning messages
+4. Pages can register items using `useFooterItem()` hook
+
+## Usage Example
+
+### Basic Usage
+
+In any page component that's wrapped by `PageContainer`:
+
+```svelte
+<script lang="ts">
+	import { useFooterItem } from 'selva-shared';
+
+	let currentStep = $state(1);
+
+	// Define your footer item as a snippet
+	const stepIndicator = {
+		render: () => `Step ${currentStep} of 5`
+	};
+
+	// Register it with the footer
+	useFooterItem('step-indicator', stepIndicator, 'left', 1);
+</script>
+
+<!-- Your page content here -->
+```
+
+### Advanced: Dynamic Footer Items
+
+Register multiple items and update them reactively:
+
+```svelte
+<script lang="ts">
+	import { useFooterItem } from 'selva-shared';
+
+	let solveCount = $state(0);
+	let lastSolveTime = $state<string | null>(null);
+
+	// Define snippet for solve info
+	const solveInfo = {
+		render: () => `Solves: ${solveCount} ${lastSolveTime ? `at ${lastSolveTime}` : ''}`
+	};
+
+	// Register with right position to appear on the right side
+	useFooterItem('solve-info', solveInfo, 'right', 10);
+</script>
+```
+
+### Using Inside Templates
+
+Since snippets are defined in the template in Svelte 5, you can also register them directly:
+
+```svelte
+<script lang="ts">
+	import { useFooter } from 'selva-shared';
+
+	const footer = useFooter();
+
+	// You can call register/unregister manually if needed
+	onMount(() => {
+		footer.register('my-item', mySnippet, 'left', 5);
+		return () => {
+			footer.unregister('my-item');
+		};
+	});
+
+	const mySnippet = { /* ... */ };
+</script>
+```
+
+## API Reference
+
+### `useFooterItem(id, content, position?, priority?)`
+
+Helper hook that automatically registers and cleans up footer items.
+
+- **id** (string): Unique identifier for this footer item
+- **content** (Snippet): Svelte snippet to render
+- **position** ('left' | 'right'): Where to display, defaults to 'left'
+- **priority** (number): Higher values render first within position, defaults to 0
+
+Returns cleanup function (called automatically on unmount).
+
+### `useFooter()`
+
+Direct access to the footer store for manual management.
+
+```typescript
+const footer = useFooter();
+
+// Register an item
+footer.register('item-id', content, 'left', 5);
+
+// Unregister an item
+footer.unregister('item-id');
+
+// Get items by position
+const leftItems = footer.getItemsByPosition('left');
+```
+
+## Positioning
+
+### Left Position
+Items appear to the left side of the footer, before error/warning messages:
+- Custom left items (sorted by priority, highest first)
+- Error/warning indicator
+- Legacy footerChildren snippet (if provided)
+
+### Right Position
+Items appear on the right side of the footer:
+- Custom right items (sorted by priority, highest first)
+- Copyright notice
+
+## Priority
+
+Priority determines render order within each position. Higher values render first:
+
+```
+Priority 10 → renders first
+Priority 5  → renders second
+Priority 0  → renders third (default)
+Priority -1 → renders last
+```
+
+## Benefits
+
+✅ **No prop drilling** - Add footer content from any child component
+✅ **Automatic cleanup** - Items unregister when component unmounts
+✅ **Reactive** - Footer updates automatically when reactive values change
+✅ **Flexible positioning** - Place items on left or right
+✅ **Backwards compatible** - Legacy `footerChildren` prop still works
+
+## Migration from Props
+
+### Before (Prop-based)
+```svelte
+<!-- Page level -->
+<PageContainer errors={errors} warnings={warnings} let:footerChildren>
+	<!-- Child components have no way to add footer content -->
+</PageContainer>
+```
+
+### After (Context-based)
+```svelte
+<!-- Page level - no changes needed -->
+<PageContainer errors={errors} warnings={warnings}>
+	<!-- Anywhere in this tree -->
+	<ChildComponent />
+</PageContainer>
+
+<!-- Child component can now add footer items -->
+<script lang="ts">
+	import { useFooterItem } from 'selva-shared';
+	useFooterItem('my-item', mySnippet);
+</script>
+```

package/dist/contexts/footerContext.svelte.d.ts

@@ -0,0 +1,17 @@
+import { SvelteMap } from 'svelte/reactivity';
+export interface FooterItem {
+    id: string;
+    component: any;
+    /** Called on every render — return reactive state to keep footer in sync */
+    getProps: () => Record<string, any>;
+    position: 'left' | 'right';
+    priority: number;
+    onClick?: () => void;
+}
+export interface FooterStore {
+    items: SvelteMap<string, FooterItem>;
+    register(id: string, component: any, getProps: () => Record<string, any>, position?: 'left' | 'right', priority?: number, onClick?: () => void): void;
+    unregister(id: string): void;
+}
+export declare function initializeFooterContext(): FooterStore;
+export declare function useFooter(): FooterStore;

package/dist/contexts/footerContext.svelte.js

@@ -0,0 +1,24 @@
+import { getContext, setContext } from 'svelte';
+import { SvelteMap } from 'svelte/reactivity';
+const FOOTER_CONTEXT_KEY = Symbol('footer-context');
+export function initializeFooterContext() {
+    const items = new SvelteMap();
+    const store = {
+        items,
+        register(id, component, getProps, position = 'left', priority = 0, onClick) {
+            items.set(id, { id, component, getProps, position, priority, onClick });
+        },
+        unregister(id) {
+            items.delete(id);
+        }
+    };
+    setContext(FOOTER_CONTEXT_KEY, store);
+    return store;
+}
+export function useFooter() {
+    const store = getContext(FOOTER_CONTEXT_KEY);
+    if (!store) {
+        throw new Error('useFooter must be called within a component that is a descendant of the root layout');
+    }
+    return store;
+}

package/dist/dummy-output-values.d.ts

@@ -0,0 +1,3 @@
+import * as THREE from 'three';
+export declare const cubeMesh: THREE.Mesh<THREE.BoxGeometry, THREE.MeshStandardMaterial, THREE.Object3DEventMap>;
+export declare const dummyOutputValues: Record<string, unknown>;

package/dist/dummy-output-values.js

@@ -0,0 +1,53 @@
+import * as THREE from 'three';
+import chart from './dummy-surface-chart.json';
+// ─── 3D mesh ────────────────────────────────────────────────────────────────
+export const cubeMesh = new THREE.Mesh(new THREE.BoxGeometry(1, 1, 1, 4, 4, 4), new THREE.MeshStandardMaterial({ color: 0x4a90d9, metalness: 0.3, roughness: 0.4 }));
+// ─── Plotly figures — add/edit charts here ──────────────────────────────────
+// Paste fig.to_json() output directly as a template literal — no cleanup needed.
+const contourPlot = `{"data":[{"z":[[10,10.625,12.5,15.625,20],[5.625,6.25,8.125,11.25,15.625],[2.5,3.125,5.0,8.125,12.5],[0.625,1.25,3.125,6.25,10.625],[0,0.625,2.5,5.625,10]],"type":"contour","colorscale":"Viridis","contours":{"coloring":"heatmap"},"showscale":true}],"layout":{"title":{"text":"Basic Contour Plot"}}}`;
+// ─── All output values ───────────────────────────────────────────────────────
+export const dummyOutputValues = {
+    'output-001': 'Computation completed successfully. All 12 parameters are within bounds.',
+    'output-002': 4827.63,
+    'output-003': [
+        {
+            fileName: 'result_geometry_SZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ',
+            fileType: '.obj',
+            data: btoa('# Wavefront OBJ\nv 0.0 0.0 0.0\nv 1.0 0.0 0.0\nv 0.0 1.0 0.0\nf 1 2 3'),
+            isBase64Encoded: true
+        }
+    ],
+    'output-004': '[INFO]  Step 1: Parameter validation ............. OK\n[INFO]  Step 2: Mesh generation .................. OK\n[INFO]  Step 3: Geometry export .................. OK\n[WARN]  High vertex count detected (12 480 faces).',
+    'output-005': 892,
+    'output-006': [
+        {
+            fileName: 'panel_A',
+            fileType: '.3dm',
+            subFolder: 'panels',
+            data: btoa('3dm-binary-content-panel-A'),
+            isBase64Encoded: true
+        },
+        {
+            fileName: 'panel_B',
+            fileType: '.3dm',
+            subFolder: 'panels',
+            data: btoa('3dm-binary-content-panel-B'),
+            isBase64Encoded: true
+        },
+        {
+            fileName: 'main_frame',
+            fileType: '.3dm',
+            subFolder: 'structure',
+            data: btoa('3dm-binary-content-frame'),
+            isBase64Encoded: true
+        },
+        {
+            fileName: 'metadata',
+            fileType: '.json',
+            data: btoa(JSON.stringify({ version: '1.0', panelCount: 2, generatedAt: '2026-03-10' })),
+            isBase64Encoded: true
+        }
+    ],
+    'output-007': JSON.stringify(chart),
+    'output-008': contourPlot
+};

package/dist/dummy-surface-chart.json

@@ -0,0 +1,13 @@
+{
+	"data": [
+		{
+			"type": "bar",
+			"x": ["Alpha", "Beta", "Gamma", "Delta", "Epsilon", "Zeta", "Eta", "Theta", "Iota", "Kappa"],
+			"y": [3.0, 7.0, 2.0, 9.0, 5.0, 6.0, 1.0, 8.0, 4.0, 10.0],
+			"orientation": "v",
+			"marker": {}
+		}
+	],
+	"layout": {},
+	"config": { "toImageButtonOptions": { "format": "png" } }
+}

package/dist/example-schema-left-only.json

@@ -0,0 +1,367 @@
+{
+	"id": "left-only-schema-001",
+	"name": "Left Panel Only",
+	"description": "Test schema with all tabs positioned on the left panel",
+	"projectFileName": "left_only_test.gh",
+	"documentId": "b1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6",
+	"pluginVersion": "0.7.0.0",
+	"tags": ["test", "left-only"],
+	"category": "Testing",
+	"author": "Test Suite",
+	"organization": "Selva",
+	"schemaVersion": "2.1.0",
+	"minPluginVersion": "0.5.0.0",
+	"created": "2026-03-06T10:00:00.0000000Z",
+	"lastModified": "2026-03-06T10:00:00.0000000Z",
+	"viewerOptions": {
+		"enableLocal": false,
+		"enableRemote": false,
+		"backgroundColor": "#f5f5f5"
+	},
+	"instanceSolve": false,
+	"inputs": [
+		{
+			"id": "input-001",
+			"nickname": "Width",
+			"paramType": "number",
+			"description": "Width parameter"
+		},
+		{
+			"id": "input-002",
+			"nickname": "Height",
+			"paramType": "number",
+			"description": "Height parameter"
+		},
+		{
+			"id": "input-003",
+			"nickname": "Depth",
+			"paramType": "number",
+			"description": "Depth parameter"
+		},
+		{
+			"id": "input-004",
+			"nickname": "Project Name",
+			"paramType": "text",
+			"description": "Name of the project"
+		},
+		{
+			"id": "input-005",
+			"nickname": "Notes",
+			"paramType": "text",
+			"description": "Additional notes"
+		},
+		{
+			"id": "input-006",
+			"nickname": "Material",
+			"paramType": "generic",
+			"description": "Material selection"
+		},
+		{
+			"id": "input-007",
+			"nickname": "Enable Mirror",
+			"paramType": "boolean",
+			"description": "Toggle mirror mode"
+		},
+		{
+			"id": "input-008",
+			"nickname": "Mirror Axis",
+			"paramType": "generic",
+			"description": "Axis for mirroring"
+		},
+		{
+			"id": "input-009",
+			"nickname": "Quality",
+			"paramType": "integer",
+			"description": "Quality level"
+		},
+		{
+			"id": "input-010",
+			"nickname": "Rotation",
+			"paramType": "number",
+			"description": "Rotation angle"
+		}
+	],
+	"outputs": [
+		{
+			"id": "output-001",
+			"nickname": "Status",
+			"description": "Processing status",
+			"type": "text"
+		},
+		{
+			"id": "output-002",
+			"nickname": "Volume",
+			"description": "Calculated volume",
+			"type": "number"
+		}
+	],
+	"layout": {
+		"type": "tabbed",
+		"gap": 16,
+		"tabs": [
+			{
+				"id": "tab-geometry",
+				"label": "Geometry",
+				"icon": "solar:box-bold",
+				"order": 0,
+				"position": "left",
+				"groups": [
+					{
+						"id": "group-dimensions",
+						"label": "Dimensions",
+						"description": "Basic geometry dimensions",
+						"order": 0,
+						"collapsed": false,
+						"columns": 1,
+						"items": [
+							{
+								"type": "input",
+								"widgetType": "number",
+								"id": "item-001",
+								"paramId": "input-001",
+								"displayName": "Width",
+								"description": "Object width",
+								"order": 0,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"minimum": 0.1,
+									"maximum": 100.0,
+									"stepSize": 0.5,
+									"renderAsSlider": true
+								}
+							},
+							{
+								"type": "input",
+								"widgetType": "number",
+								"id": "item-002",
+								"paramId": "input-002",
+								"displayName": "Height",
+								"description": "Object height",
+								"order": 1,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"minimum": 0.1,
+									"maximum": 100.0,
+									"stepSize": 0.5,
+									"renderAsSlider": true
+								}
+							},
+							{
+								"type": "input",
+								"widgetType": "number",
+								"id": "item-003",
+								"paramId": "input-003",
+								"displayName": "Depth",
+								"description": "Object depth",
+								"order": 2,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"minimum": 0.1,
+									"maximum": 100.0,
+									"stepSize": 0.5,
+									"renderAsSlider": true
+								}
+							}
+						]
+					},
+					{
+						"id": "group-transform",
+						"label": "Transform",
+						"description": "Transformation options",
+						"order": 1,
+						"collapsed": false,
+						"columns": 2,
+						"items": [
+							{
+								"type": "input",
+								"widgetType": "number",
+								"id": "item-010",
+								"paramId": "input-010",
+								"displayName": "Rotation",
+								"description": "Rotation in degrees",
+								"order": 0,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"minimum": 0.0,
+									"maximum": 360.0,
+									"stepSize": 5.0,
+									"renderAsSlider": true
+								}
+							},
+							{
+								"type": "input",
+								"widgetType": "number",
+								"id": "item-009",
+								"paramId": "input-009",
+								"displayName": "Quality",
+								"description": "Mesh quality 1-10",
+								"order": 1,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"minimum": 1.0,
+									"maximum": 10.0,
+									"stepSize": 1.0,
+									"renderAsSlider": true
+								}
+							},
+							{
+								"type": "input",
+								"widgetType": "checkbox",
+								"id": "item-007",
+								"paramId": "input-007",
+								"displayName": "Enable Mirror",
+								"description": "Toggle mirroring",
+								"order": 2,
+								"span": 1,
+								"visible": true
+							},
+							{
+								"type": "input",
+								"widgetType": "dropdown",
+								"id": "item-008",
+								"paramId": "input-008",
+								"displayName": "Mirror Axis",
+								"description": "Shown when mirror enabled",
+								"order": 3,
+								"span": 1,
+								"visible": true,
+								"visibilityCondition": {
+									"mode": "all",
+									"rules": [
+										{
+											"paramId": "input-007",
+											"operator": "equals",
+											"value": true
+										}
+									],
+									"action": "show"
+								},
+								"config": {
+									"options": {
+										"x": "X Axis",
+										"y": "Y Axis",
+										"z": "Z Axis"
+									}
+								}
+							}
+						]
+					}
+				]
+			},
+			{
+				"id": "tab-settings",
+				"label": "Settings",
+				"icon": "solar:settings-bold",
+				"order": 1,
+				"position": "left",
+				"groups": [
+					{
+						"id": "group-project",
+						"label": "Project Info",
+						"description": "Project metadata",
+						"order": 0,
+						"collapsed": false,
+						"columns": 1,
+						"items": [
+							{
+								"type": "input",
+								"widgetType": "text",
+								"id": "item-004",
+								"paramId": "input-004",
+								"displayName": "Project Name",
+								"description": "Name of the project",
+								"order": 0,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"placeholder": "Enter project name",
+									"required": true,
+									"maxLength": 100
+								}
+							},
+							{
+								"type": "input",
+								"widgetType": "text",
+								"id": "item-005",
+								"paramId": "input-005",
+								"displayName": "Notes",
+								"description": "Additional notes",
+								"order": 1,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"placeholder": "Optional notes",
+									"maxLength": 500
+								}
+							}
+						]
+					},
+					{
+						"id": "group-material",
+						"label": "Material",
+						"description": "Material selection",
+						"order": 1,
+						"collapsed": false,
+						"columns": 1,
+						"items": [
+							{
+								"type": "input",
+								"widgetType": "dropdown",
+								"id": "item-006",
+								"paramId": "input-006",
+								"displayName": "Material",
+								"description": "Choose material",
+								"order": 0,
+								"span": 1,
+								"visible": true,
+								"config": {
+									"options": {
+										"wood": "Wood",
+										"steel": "Steel",
+										"concrete": "Concrete",
+										"glass": "Glass"
+									}
+								}
+							}
+						]
+					},
+					{
+						"id": "group-outputs",
+						"label": "Results",
+						"description": "Output values",
+						"order": 2,
+						"collapsed": false,
+						"columns": 1,
+						"items": [
+							{
+								"type": "output",
+								"widgetType": "text",
+								"id": "item-out-001",
+								"paramId": "output-001",
+								"displayName": "Status",
+								"order": 0,
+								"span": 1,
+								"visible": true
+							},
+							{
+								"type": "output",
+								"widgetType": "number",
+								"id": "item-out-002",
+								"paramId": "output-002",
+								"displayName": "Volume",
+								"order": 1,
+								"span": 1,
+								"visible": true
+							}
+						]
+					}
+				]
+			}
+		]
+	}
+}