@neta-art/cohub-cli 9.1.0 → 9.1.2

package/README.md

@@ -232,8 +232,8 @@ cohub -s <spaceId> spaces activity 365 --json
 
 ## Boards
 
-A Board is one JSON document with three collections — `board` settings, `items`,
-and `animations`. Board targets accept a Board ID or a `.board` path. Every
+A Board is one JSON document with three parts — `board` settings, an `items` map,
+and an `animations` map. Board targets accept a Board ID or a `.board` path. Every
 command supports `-h`, and the global `--json` makes the output machine-readable:
 
 ```bash

package/dist/board-export.d.ts

@@ -1,16 +1,16 @@
 import type { BoardDocument, BoardExportRegion, BoardSceneItem } from "@neta-art/cohub/board";
-import type { BoardHeadlessExportFormat, BoardHeadlessFont, BoardHeadlessRenderer, BoardHeadlessTexture } from "@neta-art/cohub/board/headless";
-export declare function resolveBundledFonts(): BoardHeadlessFont[];
+import type { BoardNodeExportFormat, BoardNodeFont, BoardNodeRenderer, BoardNodeTexture } from "@neta-art/cohub/board/export/node";
+export declare function resolveBundledFonts(): BoardNodeFont[];
 export type BoardExportSource = {
     document: BoardDocument;
     boardId: string;
     title: string | null;
 };
 export declare function loadBoardDocument(spaceId: string, target: string): Promise<BoardExportSource>;
-export declare function loadBoardTextures(headless: BoardHeadlessRenderer, spaceId: string, items: readonly BoardSceneItem[], options?: {
+export declare function loadBoardTextures(renderer: BoardNodeRenderer, spaceId: string, items: readonly BoardSceneItem[], options?: {
     concurrency?: number;
 }): Promise<{
-    textures: Map<string, BoardHeadlessTexture>;
+    textures: Map<string, BoardNodeTexture>;
     failed: string[];
     omitted: string[];
 }>;
@@ -24,7 +24,7 @@ export type BoardExportRunOptions = {
     padding?: number;
     colorScheme: "dark" | "light";
     background: "paper" | "transparent";
-    format: BoardHeadlessExportFormat;
+    format: BoardNodeExportFormat;
     quality?: number;
     withImages: boolean;
 };
@@ -35,7 +35,7 @@ export type BoardExportFrame = {
     height: number;
     scale: number;
     itemCount: number;
-    format: BoardHeadlessExportFormat;
+    format: BoardNodeExportFormat;
 };
 export type BoardExportRunResult = {
     frames: BoardExportFrame[];

package/dist/board-export.js

@@ -7,7 +7,7 @@ import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import { tmpdir } from "node:os";
 const execFile = promisify(execFileCallback);
-import { boardDocumentAt, boardImageKeySource, buildBoardScene, createBoardHeadlessRenderer, createBoardHeadlessSketchHost, exportBoardImageBytes, imageAssetKey, parseBoardDocument, planBoardExport, selectBoardExportAssets, } from "./board-kernel.js";
+import { boardDocumentAt, boardImageKeySource, buildBoardScene, createNodeBoardRenderer, createNodeBoardSketchHost, exportBoardImageBytes, imageAssetKey, parseBoardDocument, planBoardExport, selectBoardExportAssets, } from "./board-kernel.js";
 import { resolveBoardId } from "./board-command-support.js";
 import { BOARD_EXPORT_FONTS } from "./board-fonts.js";
 import { createClient } from "./client.js";
@@ -45,7 +45,7 @@ export async function loadBoardDocument(spaceId, target) {
         throw new Error(`Board ${result.id} could not be read: ${parsed.diagnostics[0]?.path}: ${parsed.diagnostics[0]?.message}`);
     return { document: parsed.document, boardId: result.id, title: result.title };
 }
-export async function loadBoardTextures(headless, spaceId, items, options = {}) {
+export async function loadBoardTextures(renderer, spaceId, items, options = {}) {
     const selection = selectBoardExportAssets([...items], imageAssetKey);
     const textures = new Map();
     const failed = [];
@@ -66,7 +66,7 @@ export async function loadBoardTextures(headless, spaceId, items, options = {})
                 const { bytes, mimeType } = source.kind === "file"
                     ? await readSpaceFileBytes(client, spaceId, source.value)
                     : await downloadPublicImage(source.value);
-                const texture = await headless.decodeImage(bytes, mimeType);
+                const texture = await renderer.decodeImage(bytes, mimeType);
                 textures.set(key, texture);
             }
             catch {
@@ -161,7 +161,7 @@ export async function runBoardExport(options) {
     });
     if (!plan)
         return null;
-    const headless = await createBoardHeadlessRenderer({ fonts: resolveBundledFonts() });
+    const renderer = await createNodeBoardRenderer({ fonts: resolveBundledFonts() });
     let sketchHost = null;
     try {
         const warnings = [];
@@ -169,7 +169,7 @@ export async function runBoardExport(options) {
         let backgroundTexture;
         let omittedKeys = new Set();
         if (options.withImages) {
-            const loaded = await loadBoardTextures(headless, options.spaceId, plan.items);
+            const loaded = await loadBoardTextures(renderer, options.spaceId, plan.items);
             textures = loaded.textures;
             omittedKeys = new Set(loaded.omitted);
             if (loaded.failed.length > 0) {
@@ -186,14 +186,14 @@ export async function runBoardExport(options) {
             declaredBackground.imageUrl) {
             try {
                 const { bytes, mimeType } = await downloadPublicImage(declaredBackground.imageUrl);
-                backgroundTexture = await headless.decodeImage(bytes, mimeType);
+                backgroundTexture = await renderer.decodeImage(bytes, mimeType);
             }
             catch {
                 warnings.push("The board background image could not be loaded; the fallback color was exported.");
             }
         }
         const videoCount = plan.items.filter((item) => item.type === "video").length;
-        sketchHost = createBoardHeadlessSketchHost(headless, {
+        sketchHost = createNodeBoardSketchHost(renderer, {
             readModule: async (src) => {
                 const { bytes } = await readSpaceFileBytes(createClient(), options.spaceId, src);
                 return new TextDecoder().decode(bytes);
@@ -202,7 +202,7 @@ export async function runBoardExport(options) {
         const region = times.length > 1 ? { kind: "rect", rect: plan.world } : options.region;
         const host = sketchHost;
         if (!host)
-            throw new Error("Headless sketch host could not be created.");
+            throw new Error("Node sketch host could not be created.");
         const sketchVariants = new Map();
         for (const time of times) {
             const sketchPlan = planBoardExport({
@@ -220,7 +220,7 @@ export async function runBoardExport(options) {
         }
         await Promise.all([...sketchVariants.values()].map((variant) => host.prepare([variant.item], variant.times, plan.scale)));
         if (videoCount > 0) {
-            warnings.push(`${videoCount} video preview${videoCount === 1 ? " was" : "s were"} drawn as placeholders; headless video decoding is unavailable.`);
+            warnings.push(`${videoCount} video preview${videoCount === 1 ? " was" : "s were"} drawn as placeholders; video decoding is unavailable in Node.`);
         }
         const backgroundImage = backgroundTexture
             ? { texture: backgroundTexture, fit: declaredBackground.fit ?? "cover", position: "center", opacity: declaredBackground.opacity ?? 1 }
@@ -234,7 +234,7 @@ export async function runBoardExport(options) {
         const frames = [];
         const reported = new Set();
         for (const time of times) {
-            const result = exportBoardImageBytes(headless, document, {
+            const result = exportBoardImageBytes(renderer, document, {
                 ...(time === null ? {} : { at: { ...(options.animation ? { animation: options.animation } : {}), time } }),
                 region,
                 scale: options.scale,
@@ -272,7 +272,7 @@ export async function runBoardExport(options) {
     }
     finally {
         sketchHost?.destroy();
-        headless.destroy();
+        renderer.destroy();
     }
 }
 function describeWarning(warning) {

package/dist/board-kernel.d.ts

@@ -1,2 +1,2 @@
 export { boardDocumentAt, boardImageKeySource, buildBoardScene, imageAssetKey, parseBoardDocument, planBoardExport, selectBoardExportAssets, } from "@neta-art/cohub/board";
-export { createBoardHeadlessRenderer, createBoardHeadlessSketchHost, exportBoardImageBytes } from "@neta-art/cohub/board/headless";
+export { createNodeBoardRenderer, createNodeBoardSketchHost, exportBoardImageBytes } from "@neta-art/cohub/board/export/node";