@hyperframes/studio-server 0.8.72 → 0.8.74

package/dist/{mediaProxyPreview-CB-eWiSy.d.ts → mediaProxyPreview-BXtfHq7G.d.ts}

@@ -3,6 +3,99 @@ import { RegistryItem } from '@hyperframes/core';
 import { CanvasResolution } from '@hyperframes/parsers';
 import { MediaCodecProbeCache, HtmlSourceLike } from './helpers/mediaCodecMap.js';
 
+interface HistoryWho {
+    kind: "person" | "agent" | "outside";
+    /** Shown in the History list: "You", the agent's name, "Outside". */
+    name: string;
+}
+/** A file's sha256 before and after; null is "did not exist", so a create or delete undoes like any edit. */
+interface HistoryFileChange {
+    path: string;
+    before: string | null;
+    after: string | null;
+}
+interface HistoryEntry {
+    id: string;
+    who: HistoryWho;
+    label: string;
+    startedAt: number;
+    endedAt: number;
+    files: HistoryFileChange[];
+    /** Set on an undo: the entry it reverted. Redo is undoing the undo. */
+    undoes?: string;
+    /** Set on a restore: the point (an entry id, or START) the files were made equal to. */
+    restoredTo?: string;
+}
+/** The point before the first kept entry. */
+declare const START = "start";
+
+interface ProjectHistoryOptions {
+    projectDir: string;
+    /** Kept outside the project, so nothing tidying the project can take its history with it. */
+    historyRoot: string;
+    now?: () => number;
+    /** Writes with no window open group into one entry until this long without another (default 2 s)... */
+    quietMs?: number;
+    /** ...or this long after the first (default 30 s). */
+    maxGroupMs?: number;
+    /** Past this many stored bytes the oldest unpinned entries are folded away (default 2 GB). */
+    budgetBytes?: number;
+    /** A sweep or commit that a watcher or timer started failed. */
+    onError?: (error: unknown) => void;
+}
+interface HistoryListItem extends HistoryEntry {
+    pinned: boolean;
+    undone: boolean;
+}
+type HistoryResult = {
+    ok: true;
+    entry: HistoryEntry | null;
+} | {
+    ok: false;
+    conflict: {
+        files: string[];
+        newer: string[];
+    };
+};
+interface HistoryWindow {
+    readonly id: string;
+    /** Records everything written since the window opened as one entry (null when nothing changed); after the window
+     * ended by itself or by flush, returns the entry it became. */
+    close(): Promise<HistoryEntry | null>;
+}
+interface ProjectHistory {
+    readonly projectId: string;
+    /**
+     * Writes until close() are this writer's, as one entry whose id is the window's. A window with no write for
+     * `idleMs` (default maxGroupMs) ends by itself. ponytail: overlapping windows give a write to the newest.
+     */
+    beginWindow(who: HistoryWho, label: string, options?: {
+        idleMs?: number;
+    }): Promise<HistoryWindow>;
+    /** A watcher saw `path` change (project-relative or absolute). */
+    noteChange(path: string): void;
+    list(): HistoryListItem[];
+    /** Cmd+Z (back) and Cmd+Shift+Z (forward), whoever made the change. */
+    step(direction: "back" | "forward", who: HistoryWho): Promise<HistoryResult>;
+    /** A conflict (a file changed since) returns the choice; pass `mode` to take one. */
+    undo(id: string, options: {
+        who: HistoryWho;
+        mode?: "just-this" | "back-to-before";
+    }): Promise<HistoryResult>;
+    /** Makes the files equal what they were right after `point` (an entry id, or START). */
+    restore(point: string, who: HistoryWho): Promise<HistoryEntry | null>;
+    /** The files at `point` without writing anything: path to hash, read through readBlob. */
+    peek(point: string): Record<string, string> | null;
+    readBlob(hash: string): Promise<Buffer>;
+    pin(id: string, pinned: boolean): void;
+    onEntry(listener: (entry: HistoryEntry) => void): () => void;
+    /** Takes in every pending write and commits every open window and the outside group. */
+    flush(): Promise<void>;
+    close(): Promise<void>;
+}
+/** Opens a project's history: every write to its files becomes an entry that can be undone or restored. */
+declare function openProjectHistory(options: ProjectHistoryOptions): Promise<ProjectHistory>;
+
 /** Resolved info about a single project. */
 interface ResolvedProject {
     id: string;
@@ -106,6 +199,11 @@ interface StudioApiAdapter {
     listProjects(): Promise<ResolvedProject[]> | ResolvedProject[];
     /** Resolve a project ID (or session ID) to its directory. Returns null if not found. */
     resolveProject(id: string): Promise<ResolvedProject | null> | ResolvedProject | null;
+    /**
+     * Optional: the project's history (openProjectHistory), one per project for the host's lifetime. Without it
+     * the history routes answer 404.
+     */
+    history?: (project: ResolvedProject) => Promise<ProjectHistory | null> | ProjectHistory | null;
     /** Bundle a project directory into a single HTML string. Returns null if unavailable. */
     bundle(projectDir: string): Promise<string | null>;
     /** Optional: cached signature for project files that should invalidate preview frame caches. */
@@ -283,4 +381,4 @@ declare function injectMediaCodecMapIntoHtml(html: string, projectDir: string, h
  */
 declare function injectMediaCodecMap(html: string, adapter: PreviewApiAdapter, projectDir: string, compSrcPath: string, probeCache: MediaCodecProbeCache): Promise<string>;
 
-export { type LintResult as L, type MediaProcessingJobState as M, type PreviewApiAdapter as P, type RenderJobState as R, type StudioApiAdapter as S, type ResolvedProject as a, type StudioSelectionResponse as b, type StudioSelectionSnapshot as c, type StudioSelectionTextField as d, injectMediaCodecMapIntoHtml as e, isAutoProxyEnabled as f, injectMediaCodecMap as i, proxyEtagSalt as p, resolvePreviewMediaCodecProbeCache as r };
+export { type HistoryEntry as H, type LintResult as L, type MediaProcessingJobState as M, type PreviewApiAdapter as P, type RenderJobState as R, type StudioApiAdapter as S, START as a, type HistoryFileChange as b, type HistoryListItem as c, type HistoryResult as d, type HistoryWho as e, type HistoryWindow as f, type ProjectHistory as g, type ProjectHistoryOptions as h, type ResolvedProject as i, type StudioSelectionResponse as j, type StudioSelectionSnapshot as k, type StudioSelectionTextField as l, injectMediaCodecMap as m, injectMediaCodecMapIntoHtml as n, openProjectHistory as o, isAutoProxyEnabled as p, proxyEtagSalt as q, resolvePreviewMediaCodecProbeCache as r };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperframes/studio-server",
-  "version": "0.8.72",
+  "version": "0.8.74",
   "repository": {
     "type": "git",
     "url": "https://github.com/heygen-com/hyperframes",
@@ -64,8 +64,8 @@
     "linkedom": "^0.18.12",
     "postcss": "^8.5.8",
     "postcss-selector-parser": "^7.1.2",
-    "@hyperframes/core": "0.8.72",
-    "@hyperframes/parsers": "0.8.72"
+    "@hyperframes/parsers": "0.8.74",
+    "@hyperframes/core": "0.8.74"
   },
   "devDependencies": {
     "@types/node": "^25.0.10",