@lupinum/board-core 1.0.0-beta.4 → 1.0.0-beta.6

package/dist/agent/pages/docs/reference/events-and-errors.md

@@ -15,8 +15,285 @@ source: "ginko-content"
 
 Events tell you what happened. Subscribables tell you what state looks like now. Use events to react to discrete actions, use subscribables to keep your UI in sync.
 
-> Component omitted: `event-logger`.
-> This page contains an interactive or site-specific block that has no agent markdown serializer yet.
+## Live example source
+
+Use the installation guide to register @lupinum/nuxt-board. These are the actual documentation demo files. Keep their paths under app/. The module auto-imports Board components; install the optional packages named in imports. For the local content components, use components: [{ path: "~/components/content", pathPrefix: false }, "~/components"] in nuxt.config.ts, as this site does, or import them explicitly. createDemoDocument is a local helper, not a package export. DocsLab and the inspector components provide presentation only.
+
+### app/components/demos/EventLogger.vue
+
+````vue
+<script setup lang="ts">
+import { onBeforeUnmount, onMounted, ref } from 'vue'
+import { createBoardEngine } from '@lupinum/board-core'
+import { createDemoDocument } from '../../utils/demoDocument'
+
+const engine = createBoardEngine({
+  grid: { size: 20, majorEvery: 5, snap: true, pattern: 'dot' },
+})
+
+const entries = ref<string[]>([])
+const unsubscribes: Array<() => void> = []
+
+function push(message: string) {
+  entries.value = [
+    `${new Date().toLocaleTimeString([], { hour: '2-digit', minute: '2-digit', second: '2-digit' })}  ${message}`,
+    ...entries.value,
+  ].slice(0, 18)
+}
+
+function seed() {
+  engine.loadDocument(
+    createDemoDocument({
+      camera: { x: 0, y: 0, z: 1 },
+      grid: engine.getGridSettings(),
+      nodes: [
+        {
+          id: 'event-a',
+          type: 'text',
+          x: 70,
+          y: 80,
+          width: 220,
+          height: 100,
+          text: 'Node',
+          zIndex: 1,
+          locked: false,
+          visible: true,
+        },
+        {
+          id: 'event-b',
+          type: 'text',
+          x: 360,
+          y: 200,
+          width: 220,
+          height: 100,
+          text: 'Node',
+          zIndex: 2,
+          locked: false,
+          visible: true,
+        },
+      ],
+      selection: [],
+      nextZIndex: 3,
+    }),
+    { mode: 'replace' },
+  )
+}
+
+function addNode() {
+  const index = engine.getState().nodes.size - 2
+  engine.createNode({
+    type: 'text',
+    x: 120 + (index % 3) * 140,
+    y: 80 + (index % 2) * 120,
+    width: 220,
+    height: 110,
+    text: `Observed command ${index + 1}`,
+  })
+}
+
+function deleteSelected() {
+  engine.deleteSelected()
+}
+
+async function reset() {
+  entries.value = []
+  seed()
+  push('ready')
+  await engine.zoomToFit(60, false)
+}
+
+onMounted(() => {
+  unsubscribes.push(
+    engine.on('node:created', (node) => push(`node:created ${node.id}`)),
+    engine.on('node:updated', (node) => push(`node:updated ${node.id}`)),
+    engine.on('node:deleted', (id) => push(`node:deleted ${id}`)),
+    engine.on('selection:change', (selected) =>
+      push(`selection:change [${selected.join(', ') || 'none'}]`),
+    ),
+    engine.on('interaction:start', (state) =>
+      push(`interaction:start ${state.mode}`),
+    ),
+    engine.on('interaction:end', (state) =>
+      push(`interaction:end ${state.mode}`),
+    ),
+    engine.on('command:after', (name) => push(`command:after ${name}`)),
+  )
+  void reset()
+})
+
+onBeforeUnmount(() => {
+  for (const unsubscribe of unsubscribes) {
+    unsubscribe()
+  }
+})
+</script>
+
+<template>
+  <div class="demo-frame">
+    <div class="demo-toolbar">
+      <button class="demo-danger" @click="reset">Reset</button>
+      <button class="demo-primary" @click="addNode">Add node</button>
+      <button @click="deleteSelected">Delete selected</button>
+    </div>
+
+    <div class="grid gap-0 lg:grid-cols-[minmax(0,1fr)_340px]">
+      <BoardRoot :engine="engine" style="height: 360px" />
+
+      <div
+        class="border-t border-default bg-inverted p-4 font-mono text-xs text-primary lg:border-t-0 lg:border-l"
+      >
+        <p
+          class="text-[0.7rem] font-semibold uppercase tracking-[0.28em] text-primary"
+        >
+          Live event stream
+        </p>
+        <ul class="mt-3 space-y-2 leading-6">
+          <li
+            v-for="entry in entries"
+            :key="entry"
+            class="rounded-md bg-elevated/10 px-3 py-2"
+          >
+            {{ entry }}
+          </li>
+          <li
+            v-if="entries.length === 0"
+            class="rounded-md border border-dashed border-white/10 px-3 py-4 text-dimmed"
+          >
+            No events yet.
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+</template>
+````
+
+### app/utils/demoDocument.ts
+
+````ts
+import type {
+  BoardNode,
+  BoardNodeMetadata,
+  Camera,
+  GridSettings,
+  JsonCanvasDocument,
+  JsonCanvasNode,
+  NodeId,
+} from '@lupinum/board-core'
+
+type DemoNode = Omit<
+  Pick<
+    BoardNode,
+    | 'id'
+    | 'type'
+    | 'x'
+    | 'y'
+    | 'width'
+    | 'height'
+    | 'color'
+    | 'text'
+    | 'file'
+    | 'subpath'
+    | 'url'
+    | 'label'
+    | 'background'
+    | 'backgroundStyle'
+    | 'zIndex'
+    | 'locked'
+    | 'visible'
+    | 'parentId'
+  >,
+  'id' | 'parentId'
+> & {
+  id: NodeId | string
+  parentId?: NodeId | string
+}
+
+export interface DemoDocumentInput {
+  nodes: readonly DemoNode[]
+  camera?: Camera
+  grid?: GridSettings
+  selection?: readonly (NodeId | string)[]
+  nextZIndex?: number
+}
+
+function toJsonCanvasNode(node: DemoNode): JsonCanvasNode {
+  const base = {
+    id: node.id as NodeId,
+    type: node.type,
+    x: node.x,
+    y: node.y,
+    width: node.width,
+    height: node.height,
+    ...(node.color ? { color: node.color } : {}),
+  }
+
+  switch (node.type) {
+    case 'file':
+      return {
+        ...base,
+        type: 'file',
+        file: node.file ?? '',
+        ...(node.subpath ? { subpath: node.subpath } : {}),
+      }
+    case 'link':
+      return {
+        ...base,
+        type: 'link',
+        url: node.url ?? '',
+      }
+    case 'group':
+      return {
+        ...base,
+        type: 'group',
+        ...((node.label ?? node.text)
+          ? { label: node.label ?? node.text }
+          : {}),
+        ...(node.background ? { background: node.background } : {}),
+        ...(node.backgroundStyle
+          ? { backgroundStyle: node.backgroundStyle }
+          : {}),
+      }
+    case 'text':
+    default:
+      return {
+        ...base,
+        type: 'text',
+        text: node.text ?? '',
+      }
+  }
+}
+
+function toNodeMetadata(node: DemoNode): BoardNodeMetadata {
+  return {
+    zIndex: node.zIndex,
+    locked: node.locked,
+    visible: node.visible,
+    ...(node.parentId ? { parentId: node.parentId as NodeId } : {}),
+  }
+}
+
+export function createDemoDocument(
+  input: DemoDocumentInput,
+): JsonCanvasDocument {
+  return {
+    nodes: input.nodes.map(toJsonCanvasNode),
+    'x-lupinum-board': {
+      ...(input.camera ? { camera: input.camera } : {}),
+      ...(input.grid ? { grid: input.grid } : {}),
+      ...(input.selection
+        ? { selection: input.selection.map((id) => id as NodeId) }
+        : {}),
+      nextZIndex:
+        input.nextZIndex ??
+        input.nodes.reduce((max, node) => Math.max(max, node.zIndex), 0) + 1,
+      nodes: Object.fromEntries(
+        input.nodes.map((node) => [node.id, toNodeMetadata(node)]),
+      ),
+    },
+  }
+}
+````
 
 ## Events
 

package/dist/agent/pages/docs/reference/package-overview.md

@@ -39,8 +39,8 @@ your application directory; for example, resolve
 local pages from its index. The snapshot matches the installed package version.
 Resolve it again after an upgrade or rollback. This export is not a JavaScript module.
 
-Use the [installation prompt](/raw/docs/start-building/installation.md#use-a-coding-agent)
-to start an agent task. Existing project instructions remain authoritative.
+Follow [Set up your coding agent](/raw/docs/start-building/installation.md#set-up-your-coding-agent)
+to point your agent at these pages. Existing project instructions remain authoritative.
 
 ## Runtime export index