@visuallyjs/browser-ui-svelte 1.0.0

package/SurfaceComponent.svelte

@@ -0,0 +1,270 @@
+<script lang="ts">
+    import { onMount, type Snippet } from "svelte";
+    import {
+        BrowserUISvelteModel, internal_createDiagramContext,
+        newInstance,
+        type SurfaceComponentProps
+    } from "./index";
+    import {
+        isNode,
+        isGroup,
+        renderSurface,
+        uuid,
+        EVENT_RENDER_END,
+        CLASS_DEFAULT_GROUP,
+        CLASS_DEFAULT_NODE, Surface,
+		type BrowserElement,
+		type ObjectData,
+		Vertex,
+		partition,
+		type VertexUpdatedParams,
+        extend, EVENT_GRAPH_CLEARED, EVENT_NODE_UPDATED, EVENT_GROUP_UPDATED,
+		type NodeRemovedParams, EVENT_NODE_REMOVED,
+        type GroupRemovedParams, EVENT_GROUP_REMOVED,
+        type SurfaceOptions
+    } from "@visuallyjs/browser-ui";
+    import { internal_getSurfaceContext } from "./surface-store";
+
+    import DefaultNodeComponent from './DefaultNodeComponent.svelte'
+    import DefaultGroupComponent from './DefaultGroupComponent.svelte'
+    import WrapperComponent from "./WrapperComponent.svelte";
+
+    let container:HTMLElement;
+
+    let {
+        className,
+        renderOptions,
+        viewOptions,
+        modelOptions,
+        model,
+        data,
+        url,
+        shapeLibrary,
+        injector,
+		children
+    }:SurfaceComponentProps = $props();
+
+    const surfaceContext = internal_getSurfaceContext(false);
+
+    let surface:Surface;
+
+    export function getSurface() {
+        return surface
+	}
+
+    export function getModel() {
+        return surface?.model
+    }
+
+    type ComponentHolder = {
+        component:any,
+        props:any,
+        vertex:Vertex,
+		def:any,
+		id:string
+    }
+
+    const componentMap:Map<string, ComponentHolder> = new Map();
+    const id = uuid();
+
+    // list of vertices to render
+	let _vertices:Array<ComponentHolder> = []
+
+	// state wrapper around the vertex list
+    let vertexState = $state({
+		vertices:_vertices
+	})
+
+	// manages updating the vertex state cleanly.
+    function _updateVertexState() {
+        vertexState.vertices.length = 0
+		vertexState.vertices.push(..._vertices.slice())
+    }
+
+    function render ( id:string,  data:ObjectData, model:BrowserUISvelteModel, type:string,
+                      surface:Surface, def:any, modelObject:Vertex, eventInfo:any) {
+
+        const hasComponent = def.component != null
+        let component;
+        if (!hasComponent) {
+            if (isNode(modelObject)) {
+                component = DefaultNodeComponent;
+            } else if (isGroup(modelObject)) {
+                component = DefaultGroupComponent;
+            }
+        } else {
+            component = def.component;
+        }
+
+        if (component) {
+            let propsToSet:Record<string, any> = {
+                data: modelObject.data,
+                model,
+                surface,
+                componentId: modelObject.getFullId(),
+                vertex: modelObject,
+                eventInfo,
+				className:hasComponent ? null : (isGroup(modelObject) ? CLASS_DEFAULT_GROUP : CLASS_DEFAULT_NODE)
+            }
+
+            if (injector != null) {
+                const injectedProps = injector(modelObject);
+                if (injectedProps != null) {
+                    for (let key in injectedProps) {
+                        propsToSet[key] = injectedProps[key];
+                    }
+                }
+            }
+
+            const props = $state(propsToSet)
+            const componentHolder:ComponentHolder = {
+                component, props, vertex:modelObject, def, id:modelObject.id
+            }
+
+			_vertices.push(componentHolder)
+			_updateVertexState()
+        }
+
+    }
+
+    function cleanupVertex(objId:string, el:BrowserElement) {
+        el.parentNode && el.parentNode.removeChild(el);
+    }
+
+    onMount(async () => {
+        model = model || newInstance(modelOptions || {});
+
+        const templateRenderer = {
+            asynchronous: true,
+            reactive: true,
+			usesWrapperElement:true,
+            update: (el:BrowserElement, data:Object, vertex:Vertex) => {
+                const component = componentMap.get(vertex.id);
+                if (component) {
+                    component.props.data = vertex.data
+                }
+            },
+            render,
+            cleanupVertex,
+            cleanupPort: (objId:string, el:BrowserElement) => {},
+            rerender: (
+                id:string,
+                data:ObjectData,
+                model:BrowserUISvelteModel,
+                type:string,
+                surface:Surface,
+                def:any,
+                modelObject:Vertex,
+                eventInfo:any,
+                originalElement:BrowserElement
+            ) => {
+
+                // split into vertices we want to keep and the one we want to discard
+                const p = partition(_vertices, (v) => v.vertex !== modelObject)
+				// assign the ones we want to keep, update state
+                _vertices = p.left
+                _updateVertexState()
+
+				// remove the old DOM element
+                if (p.right.length > 0) {
+                    cleanupVertex(modelObject.id, originalElement)
+				}
+
+                // on next tick, render again. it's important to wait for the next tick or the
+				// vertices state array gets messed up
+                setTimeout(() => {
+                    render(id, data, model, type, surface, def, modelObject, eventInfo)
+				})
+            }
+        };
+
+        const params = (renderOptions || {}) as SurfaceOptions;
+        params.view = viewOptions || {};
+        params.id = id;
+
+        if (shapeLibrary != null) {
+            params.shapes = {
+                library: shapeLibrary,
+            };
+        }
+
+        surface = renderSurface(model, container, templateRenderer, params);
+
+        // with continuous anchors it's necessary to do this, for
+        // asynchronous-y reasons. $redrawEveryConnection only redraws
+        // edges and does not update element positions so it's
+        // reasonably quick.
+        surface.bind(EVENT_RENDER_END, () => setTimeout(() => surface.router.$redrawEveryConnection()))
+
+        if (surfaceContext != null) {
+            surfaceContext.set(surface);
+        }
+
+        const updateVertex = (vertexId: string, eventPayload: VertexUpdatedParams) => {
+
+            let mergeData = () => {
+                let data = {}
+                if (eventPayload.originalData || eventPayload.updates) {
+                    data = extend(eventPayload.originalData, eventPayload.updates)
+                }
+                return data
+            };
+
+            const entry = _vertices.find((v) => v.vertex.id === vertexId);
+            if (entry != null) {
+                entry.props.data = mergeData()
+                _updateVertexState()
+            }
+        }
+
+        const removeVertex = (id: string) => {
+            _vertices = _vertices.filter(n => n.vertex.id !== id)
+            _updateVertexState()
+        }
+
+        model.bind<VertexUpdatedParams>(EVENT_NODE_UPDATED, (p: VertexUpdatedParams) => {
+            updateVertex(p.vertex.getFullId(), p)
+        });
+
+        model.bind<VertexUpdatedParams>(EVENT_GROUP_UPDATED, (p: VertexUpdatedParams) => {
+            updateVertex(p.vertex.getFullId(), p)
+        });
+		//
+        model.bind<NodeRemovedParams>(EVENT_NODE_REMOVED, (p: NodeRemovedParams) => {
+            removeVertex(p.node.id)
+        });
+		//
+        model.bind<GroupRemovedParams>(EVENT_GROUP_REMOVED, (p: GroupRemovedParams) => {
+            removeVertex(p.group.id)
+        });
+
+
+        model.bind(EVENT_GRAPH_CLEARED, () => {
+            _vertices = []
+            _updateVertexState()
+            // TODO svelte overlays
+            // _overlays = []
+            // _updateOverlayState()
+        })
+
+        if (url != null) {
+            model.load({ url });
+        } else if (data != null) {
+            model.load({ data });
+        }
+    });
+
+</script>
+
+<div class={className} bind:this={container}>
+	{#each vertexState.vertices as vertex (vertex.id)}
+		<WrapperComponent component={vertex.component}
+						  data={vertex.props.data}
+						  surface={surface}
+						  def={vertex.def}
+						  vertex={vertex.vertex}
+						  className={vertex.props.className}/>
+
+	{/each}
+	{@render children?.()}
+</div>

package/SurfaceProvider.svelte

@@ -0,0 +1,9 @@
+<script>
+
+	import { internal_getSurfaceContext } from "./surface-store"
+
+    internal_getSurfaceContext(false)
+
+</script>
+
+<slot />

package/WrapperComponent.svelte

@@ -0,0 +1,27 @@
+<script lang="ts">
+
+
+    // This is a placeholder component that the surface uses to render each vertex.
+
+	import {onMount} from "svelte";
+    import {type BrowserElement} from "@visuallyjs/browser-ui";
+
+    let {component, vertex, surface, def, data, className} = $props()
+	let el:BrowserElement
+
+	// svelte wants uppercase here. So we just assign to an uppercase var, which we use in the
+	// template
+	const ComponentToRender = component
+
+	const _surface = $state.raw(surface)
+
+	onMount(async () => {
+		surface.$vertexRendered(vertex, el, def)
+	})
+
+
+</script>
+
+<div bind:this={el} class={className}>
+	<ComponentToRender this={component} data={data} surface={_surface} vertex={vertex} model={_surface.model}/>
+</div>

package/XYChartComponent.svelte

@@ -0,0 +1,32 @@
+<script lang="ts">
+
+	import { onMount  } from "svelte";
+
+	import { CategoryValueChart } from "@visuallyjs/browser-ui"
+    import {type XYChartComponentProps} from "./definitions";
+
+    let container:HTMLElement;
+
+	// XYChartOptions
+	let {options, className = "", data, url }:XYChartComponentProps = $props()
+
+	let chart:CategoryValueChart<any>
+
+	export function getChart() {
+	    return chart;
+    }
+
+	onMount(async () => {
+
+		chart = new CategoryValueChart(container, options)
+
+		if (url != null) {
+			chart.load({url});
+		} else if (data != null) {
+			chart.load({data});
+		}
+	})
+
+</script>
+
+<div class={className} bind:this={container}></div>

package/components.d.ts

@@ -0,0 +1,29 @@
+/**
+ * list of exported Svelte components.
+ */
+export { default as SurfaceComponent } from "./SurfaceComponent.svelte";
+export { default as DiagramComponent } from "./DiagramComponent.svelte";
+export { default as ControlsComponent } from "./ControlsComponent.svelte";
+export { default as ExportControlsComponent } from "./ExportControlsComponent.svelte";
+export { default as MiniviewComponent } from "./MiniviewComponent.svelte";
+export { default as PaletteComponent } from "./PaletteComponent.svelte";
+export { default as DecoratorComponent } from "./DecoratorComponent.svelte";
+export { default as InspectorComponent } from "./InspectorComponent.svelte";
+export { default as ShapePaletteComponent } from "./ShapePaletteComponent.svelte";
+export { default as DiagramPaletteComponent } from "./DiagramPaletteComponent.svelte";
+export { default as ShapeComponent } from "./ShapeComponent.svelte";
+export { default as EdgeTypePickerComponent } from "./EdgeTypePickerComponent.svelte";
+export { default as ColorPickerComponent } from "./ColorPickerComponent.svelte";
+export { default as ColumnChartComponent } from "./ColumnChartComponent.svelte";
+export { default as BarChartComponent } from "./BarChartComponent.svelte";
+export { default as XYChartComponent } from "./XYChartComponent.svelte";
+export { default as LineChartComponent } from "./LineChartComponent.svelte";
+export { default as AreaChartComponent } from "./AreaChartComponent.svelte";
+export { default as PieChartComponent } from "./PieChartComponent.svelte";
+export { default as ScatterChartComponent } from "./ScatterChartComponent.svelte";
+export { default as BubbleChartComponent } from "./BubbleChartComponent.svelte";
+export { default as GaugeChartComponent } from "./GaugeChartComponent.svelte";
+export { default as SankeyChartComponent } from "./SankeyChartComponent.svelte";
+export { default as WrapperComponent } from "./WrapperComponent.svelte";
+export { default as DiagramProvider } from "./DiagramProvider.svelte";
+export { default as SurfaceProvider } from "./SurfaceProvider.svelte";

package/components.js

@@ -0,0 +1,29 @@
+/**
+ * list of exported Svelte components.
+ */
+export { default as SurfaceComponent } from "./SurfaceComponent.svelte";
+export { default as DiagramComponent } from "./DiagramComponent.svelte";
+export { default as ControlsComponent } from "./ControlsComponent.svelte";
+export { default as ExportControlsComponent } from "./ExportControlsComponent.svelte";
+export { default as MiniviewComponent } from "./MiniviewComponent.svelte";
+export { default as PaletteComponent } from "./PaletteComponent.svelte";
+export { default as DecoratorComponent } from "./DecoratorComponent.svelte";
+export { default as InspectorComponent } from "./InspectorComponent.svelte";
+export { default as ShapePaletteComponent } from "./ShapePaletteComponent.svelte";
+export { default as DiagramPaletteComponent } from "./DiagramPaletteComponent.svelte";
+export { default as ShapeComponent } from "./ShapeComponent.svelte";
+export { default as EdgeTypePickerComponent } from "./EdgeTypePickerComponent.svelte";
+export { default as ColorPickerComponent } from "./ColorPickerComponent.svelte";
+export { default as ColumnChartComponent } from "./ColumnChartComponent.svelte";
+export { default as BarChartComponent } from "./BarChartComponent.svelte";
+export { default as XYChartComponent } from "./XYChartComponent.svelte";
+export { default as LineChartComponent } from "./LineChartComponent.svelte";
+export { default as AreaChartComponent } from "./AreaChartComponent.svelte";
+export { default as PieChartComponent } from "./PieChartComponent.svelte";
+export { default as ScatterChartComponent } from "./ScatterChartComponent.svelte";
+export { default as BubbleChartComponent } from "./BubbleChartComponent.svelte";
+export { default as GaugeChartComponent } from "./GaugeChartComponent.svelte";
+export { default as SankeyChartComponent } from "./SankeyChartComponent.svelte";
+export { default as WrapperComponent } from "./WrapperComponent.svelte";
+export { default as DiagramProvider } from "./DiagramProvider.svelte";
+export { default as SurfaceProvider } from "./SurfaceProvider.svelte";