@neta-art/cohub 2.15.0 → 3.0.0

package/README.md

@@ -74,6 +74,62 @@ await session.messages.send({
 });
 ```
 
+## Boards
+
+Use `space.boards` for collection operations and bind an ID with
+`space.board(boardId)` for entity operations:
+
+```ts
+const created = await space.boards.create({
+  path: "boards/plan.board",
+  title: "Plan",
+  nodes: [],
+});
+
+const board = space.board(created.board.id);
+// Equivalent: space.boards.byId(created.board.id)
+
+const snapshot = await board.inspect({
+  include: ["nodes", "effects", "sequences", "clips", "playback"],
+});
+
+await board.apply({
+  txId: crypto.randomUUID(),
+  baseVersion: snapshot.board.version,
+  operations: [
+    { type: "board.patch", payload: { patch: { title: "Updated plan" } } },
+  ],
+});
+```
+
+A bound `BoardClient` injects its `boardId` into validation and transaction
+requests. Realtime subscriptions are also scoped to that Board:
+
+```ts
+const stop = board.subscribe({
+  transaction(event) {
+    console.log("version", event.payload.version);
+  },
+  playback(event) {
+    console.log("playback", event.payload.status);
+  },
+});
+
+stop();
+```
+
+Import timeline compilation and extension registry helpers from the lightweight
+Board entry point:
+
+```ts
+import {
+  clip,
+  compileSequence,
+  createBoardExtensionRegistry,
+  timeline,
+} from "@neta-art/cohub/board";
+```
+
 ## Session subscriptions
 
 ```ts

package/dist/board.d.ts

@@ -0,0 +1,99 @@
+import { C as BoardRenderCost, S as BoardCapability, c as BoardEffect, i as BoardClip, s as BoardDiagnostic, t as BoardAssetRef, v as BoardSequence, x as BoardValidationResult, y as BoardTarget } from "./chunks/board.js";
+//#region src/board.d.ts
+type TimelineClipInput = Omit<BoardClip, "id" | "sequenceId" | "start" | "seed"> & {
+  id?: string;
+  seed?: string;
+};
+type TimelineInput = {
+  type: "clip";
+  clip: TimelineClipInput;
+} | {
+  type: "parallel";
+  children: TimelineInput[];
+} | {
+  type: "sequence";
+  children: TimelineInput[];
+} | {
+  type: "stagger";
+  each: number;
+  children: TimelineInput[];
+} | {
+  type: "delay";
+  duration: number;
+  child: TimelineInput;
+} | {
+  type: "repeat";
+  count: number;
+  child: TimelineInput;
+};
+type CompiledSequence = {
+  sequence: Omit<BoardSequence, "boardId" | "revision">;
+  clips: Array<Omit<BoardClip, "sequenceId">>;
+  assetRefs: BoardAssetRef[];
+};
+type RenderBounds = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+type QualityProfile = "low" | "medium" | "high";
+type BoardExtensionDefinition = BoardCapability & {
+  validate?: (params: Record<string, unknown>) => BoardDiagnostic[];
+  getBounds?: (params: Record<string, unknown>) => RenderBounds | null;
+  getAssetRefs?: (params: Record<string, unknown>) => BoardAssetRef[];
+  estimateCost: (params: Record<string, unknown>, profile: QualityProfile) => Partial<BoardRenderCost>;
+};
+type BoardPresetDefinition = BoardCapability & {
+  kind: "preset";
+  compile: (params: Record<string, unknown>) => TimelineInput;
+};
+declare const DEFAULT_BOARD_LIMITS: BoardRenderCost;
+declare const timeline: {
+  clip(clip: TimelineClipInput): TimelineInput;
+  parallel(...children: TimelineInput[]): TimelineInput;
+  sequence(...children: TimelineInput[]): TimelineInput;
+  stagger(each: number, ...children: TimelineInput[]): TimelineInput;
+  delay(duration: number, child: TimelineInput): TimelineInput;
+  repeat(count: number, child: TimelineInput): TimelineInput;
+};
+declare function clip(input: {
+  kind: string;
+  target: BoardTarget;
+  duration: number;
+  params?: Record<string, unknown>;
+  keyframes?: BoardClip["keyframes"];
+  assetRefs?: BoardAssetRef[];
+  easing?: string;
+  fill?: BoardClip["fill"];
+  layer?: BoardClip["layer"];
+  kindVersion?: number;
+  id?: string;
+  seed?: string;
+  metadata?: Record<string, unknown>;
+}): TimelineInput;
+declare function compileSequence(input: {
+  id: string;
+  name: string;
+  seed: string;
+  timeline: TimelineInput;
+  restPose?: Record<string, unknown>;
+  metadata?: Record<string, unknown>;
+}): CompiledSequence;
+declare class BoardExtensionRegistry {
+  #private;
+  register(definition: BoardExtensionDefinition | BoardPresetDefinition): this;
+  capabilities(): BoardCapability[];
+  compilePreset(id: string, version: number, params: Record<string, unknown>): TimelineInput;
+  validate(input: {
+    clips: Array<Omit<BoardClip, "sequenceId">>;
+    effects?: Array<Omit<BoardEffect, "boardId" | "revision">>;
+    profile?: QualityProfile;
+    limits?: BoardRenderCost;
+  }): BoardValidationResult;
+}
+declare function createBoardExtensionRegistry(input?: {
+  builtins?: boolean;
+}): BoardExtensionRegistry;
+//#endregion
+export { BoardExtensionDefinition, BoardExtensionRegistry, BoardPresetDefinition, CompiledSequence, DEFAULT_BOARD_LIMITS, QualityProfile, RenderBounds, TimelineClipInput, TimelineInput, clip, compileSequence, createBoardExtensionRegistry, timeline };

package/dist/board.js

@@ -0,0 +1,2 @@
+import { a as createBoardExtensionRegistry, i as compileSequence, n as DEFAULT_BOARD_LIMITS, o as timeline, r as clip, t as BoardExtensionRegistry } from "./chunks/board.js";
+export { BoardExtensionRegistry, DEFAULT_BOARD_LIMITS, clip, compileSequence, createBoardExtensionRegistry, timeline };