@1agh/maude 0.49.2 → 0.50.0

package/apps/studio/canvas-artifacts.ts

@@ -0,0 +1,153 @@
+// The canonical inventory of every on-disk artifact belonging to a canvas,
+// derived from its `rel` path (designRoot-relative, POSIX, e.g. "ui/Foo.tsx").
+// Pure — no `Bun.*` / `node:fs`, so it's fully unit-testable. `deleteCanvas`
+// and `moveCanvas` (api.ts) both consume this instead of hand-listing sidecars,
+// so the DDR-115 runtime-state taxonomy is expressed in exactly one place.
+//
+// Deliberately NOT included: `_photo/` (asset-keyed, not canvas-slug-keyed —
+// see photo-store.ts) and `_draw/<slug>.proof.tsx` (mark-slug-keyed, a
+// different slug namespace). Adding either here would silently relocate/trash
+// something that isn't actually addressed by this canvas's slug.
+
+import path from 'node:path';
+
+import { canvasSlugFromRel } from './canvas-slug.ts';
+import type { Paths } from './context.ts';
+
+export interface CanvasArtifact {
+  /** Absolute on-disk path. */
+  abs: string;
+  /** The primary `.tsx`, a same-basename sibling, or a slug-keyed sidecar. */
+  kind: 'primary' | 'sibling' | 'slug-keyed';
+  /**
+   * True when the artifact's on-disk NAME is derived from the canvas's slug
+   * (so a rename — not just a directory change — requires renaming this
+   * artifact too). False for primary/sibling, whose name tracks the canvas's
+   * own basename and is otherwise untouched by a pure directory move.
+   */
+  rekey: boolean;
+  /** True when the artifact is git-tracked (vs. gitignored runtime state —
+   *  see DDR-115). Informational only; callers don't need to branch on it
+   *  today, but it keeps the taxonomy legible at the one place it's listed. */
+  versioned: boolean;
+}
+
+/**
+ * Every on-disk artifact belonging to the canvas at `rel`. Does not check
+ * existence — callers `stat`/`rename` best-effort, since most canvases don't
+ * have every sidecar (a fresh brief-board has no history, no comments, …).
+ */
+export function canvasArtifacts(input: { rel: string; paths: Paths }): CanvasArtifact[] {
+  const { rel, paths } = input;
+  const dir = path.posix.dirname(rel.replace(/\\/g, '/'));
+  const groupDirAbs = path.join(paths.designRoot, dir === '.' ? '' : dir);
+  const base = path.basename(rel).replace(/\.tsx$/i, '');
+  const slug = canvasSlugFromRel(rel, paths.designRel);
+
+  const out: CanvasArtifact[] = [];
+
+  // Same-dir siblings — same basename, dir tracks the canvas's own dir. Only
+  // the primary `.tsx` is guaranteed to exist; the rest are best-effort.
+  for (const ext of ['.tsx', '.meta.json', '.css', '.registry.json']) {
+    out.push({
+      abs: path.join(groupDirAbs, `${base}${ext}`),
+      kind: ext === '.tsx' ? 'primary' : 'sibling',
+      rekey: false,
+      versioned: true,
+    });
+  }
+
+  // Slug-keyed sidecars.
+  out.push({
+    abs: path.join(paths.historyDir, slug),
+    kind: 'slug-keyed',
+    rekey: true,
+    versioned: false,
+  });
+  out.push({
+    abs: path.join(paths.canvasStateDir, `${slug}.json`),
+    kind: 'slug-keyed',
+    rekey: true,
+    versioned: false,
+  });
+  out.push({
+    // DDR-115 — the per-machine camera view file.
+    abs: path.join(paths.canvasStateDir, `${slug}.view.json`),
+    kind: 'slug-keyed',
+    rekey: true,
+    versioned: false,
+  });
+  out.push({
+    abs: path.join(paths.commentsDir, `${slug}.json`),
+    kind: 'slug-keyed',
+    rekey: true,
+    versioned: false,
+  });
+  out.push({
+    // collab/persistence.ts ydocBinPath — the `.ydoc.bin` cache under `_state/`.
+    abs: path.join(paths.designRoot, '_state', `${slug}.ydoc.bin`),
+    kind: 'slug-keyed',
+    rekey: true,
+    versioned: false,
+  });
+  out.push({
+    // Versioned — a real git rename on move, which is correct and expected.
+    abs: path.join(paths.designRoot, `${slug}.annotations.svg`),
+    kind: 'slug-keyed',
+    rekey: true,
+    versioned: true,
+  });
+  out.push({
+    // Footage EDL (feature-footage-analysis-director) — also versioned.
+    abs: path.join(paths.designRoot, `${slug}.edl.json`),
+    kind: 'slug-keyed',
+    rekey: true,
+    versioned: true,
+  });
+
+  return out;
+}
+
+/**
+ * `_locator.json`'s top-level key for a canvas at `rel` — POSIX,
+ * extension-less, but NOT lowercased or dash-flattened (unlike
+ * `canvasSlugFromRel`). Matches `locator.ts`'s `canvasSlug()`. Kept OUT of
+ * `canvasArtifacts()`'s slug-keyed list on purpose: folding it in would let
+ * the two divergent slug shapes get confused for each other, which the plan
+ * calls out as the single most likely bug in this feature.
+ */
+export function locatorKeyFor(rel: string): string {
+  const p = rel.replace(/\\/g, '/');
+  const dot = p.lastIndexOf('.');
+  return dot > 0 ? p.slice(0, dot) : p;
+}
+
+/**
+ * Where `artifact` lands after the canvas at `fromRel` moves to `toRel`.
+ * Primary/sibling artifacts track the destination's directory + basename;
+ * slug-keyed artifacts stay in their fixed directory but swap the old slug
+ * for the new one in their filename (the `_history/<slug>` dir included —
+ * there the "filename" IS the slug).
+ */
+export function relocatedName(
+  artifact: CanvasArtifact,
+  fromRel: string,
+  toRel: string,
+  paths: Paths
+): string {
+  if (artifact.kind === 'slug-keyed') {
+    const fromSlug = canvasSlugFromRel(fromRel, paths.designRel);
+    const toSlug = canvasSlugFromRel(toRel, paths.designRel);
+    const dir = path.dirname(artifact.abs);
+    const name = path.basename(artifact.abs);
+    if (name === fromSlug) return path.join(dir, toSlug);
+    return path.join(dir, name.replace(fromSlug, toSlug));
+  }
+  const fromBase = path.basename(fromRel).replace(/\.tsx$/i, '');
+  const toBase = path.basename(toRel).replace(/\.tsx$/i, '');
+  const oldName = path.basename(artifact.abs);
+  const suffix = oldName.slice(fromBase.length); // '.tsx' | '.meta.json' | '.css' | '.registry.json'
+  const toDir = path.posix.dirname(toRel.replace(/\\/g, '/'));
+  const newDirAbs = path.join(paths.designRoot, toDir === '.' ? '' : toDir);
+  return path.join(newDirAbs, `${toBase}${suffix}`);
+}

package/apps/studio/canvas-create.ts

@@ -37,6 +37,29 @@ export interface NameValidation {
   error?: string;
 }
 
+/**
+ * Folder names reuse `NAME_RE` — the same path/JSX/JSON-safe allowlist as
+ * canvas names. Folder names never reach JSX or a JSON string interpolation,
+ * but sharing the regex keeps one thing to audit rather than two allowlists
+ * that could drift.
+ */
+export function validateFolderName(raw: unknown): NameValidation {
+  if (typeof raw !== 'string') return { ok: false, error: 'name must be a string' };
+  const name = raw.normalize('NFC').trim().replace(/ +/g, ' ');
+  if (!name) return { ok: false, error: 'name is required' };
+  if (name.length > 60) return { ok: false, error: 'name must be 60 characters or fewer' };
+  if (!NAME_RE.test(name)) {
+    return {
+      ok: false,
+      error: 'name may contain only letters, numbers, spaces, hyphens and underscores',
+    };
+  }
+  if (name.includes('..') || name.includes('/') || name.includes('\\') || name.startsWith('.')) {
+    return { ok: false, error: 'name may not contain path separators or leading dots' };
+  }
+  return { ok: true, name };
+}
+
 export function validateCanvasName(raw: unknown): NameValidation {
   if (typeof raw !== 'string') return { ok: false, error: 'name must be a string' };
   // NFC-normalize so a decomposed (NFD) name and its composed sibling can't hash

package/apps/studio/canvas-slug.ts

@@ -0,0 +1,30 @@
+// Canonical canvas slug derivation. Extracted from api.ts so canvas-artifacts.ts
+// (a pure, dependency-free artifact-inventory module) and api.ts can both depend
+// on it without a cycle between the two. api.ts re-exports this for existing
+// external callers (canvas-list-watch.ts, tests) so their import surface is
+// unchanged.
+
+/**
+ * Canonical canvas slug from a (repo- or design-root-relative) canvas path.
+ * Pure — the `fileSlug` closure inside `createApi` delegates here, and the
+ * external-canvas watcher (`canvas-list-watch.ts`) imports it so both creation
+ * paths derive identical `canvas-list-update` slugs. Strips an optional
+ * `<designRel>/` prefix, then `/`→`-`, whitespace→`_`, drops the `.tsx`/`.html`
+ * extension, and lowercases.
+ */
+export function canvasSlugFromRel(file: string, designRel: string): string {
+  let p = String(file).replace(/^\/+|\/+$/g, '');
+  try {
+    p = decodeURIComponent(p);
+  } catch {
+    /* ignore */
+  }
+  const prefix = `${designRel.replace(/^\/+|\/+$/g, '')}/`;
+  if (p.startsWith(prefix)) p = p.slice(prefix.length);
+  return p
+    .replace(/\//g, '-')
+    .replace(/\s+/g, '_')
+    .replace(/\.(tsx|html)$/i, '')
+    .replace(/^\.+/, '')
+    .toLowerCase();
+}