@opencraw/studio 0.0.6 → 0.0.8

package/dist/src/studio-server/inspect-page.handler.d.ts

@@ -0,0 +1,18 @@
+import type { InspectPageCommand, InspectView } from '../studio-api/index.js';
+import type { StudioState } from './workspace.store.js';
+/**
+ * Handles `inspect-page`: the Inspect panel's DOM tree and data-in-the-page
+ * findings, off the same cached snapshot `take-snapshot`/`infer-selector`
+ * already use (`page-inspector`, issue #93). `domTree` reads the cached,
+ * rewritten snapshot (the same markup the content pane's iframe shows, so a
+ * tree row's `nodeId` lines up with it exactly); `pageData` reads the raw
+ * capture (`SnapshotResult.rawHtml`), since the display snapshot has had its
+ * `<script>` tags stripped for the sandboxed iframe.
+ *
+ * @param state - The server state.
+ * @param command - The command; `command.path` must already have a cached snapshot (call `take-snapshot` first).
+ * @returns The tree and the data-in-the-page findings.
+ * @throws Error when no workspace is open, or `command.path` has no cached snapshot yet.
+ */
+export declare function handleInspectPage(state: StudioState, command: InspectPageCommand): InspectView;
+//# sourceMappingURL=inspect-page.handler.d.ts.map

package/dist/src/studio-server/pdf-bytes.handler.d.ts

@@ -0,0 +1,17 @@
+import type { StudioState } from './workspace.store.js';
+/**
+ * Handles `GET /api/pdf-bytes`: the raw bytes of a cached PDF snapshot, for
+ * the PDF canvas's `pdf.js` to render in the browser (studio plan §3.4,
+ * issue #94's 5b). Not a `studio-api` command — the other commands all
+ * answer JSON, and pdf.js wants the file itself — so this is its own route,
+ * read directly by `studio-http.use-case.ts` (mirrors `static-file.handler.ts`'s
+ * own reach outside the command dispatch).
+ *
+ * @param state - The server state.
+ * @param recipeId - The recipe.
+ * @param path - The step path; must already have a cached PDF snapshot (call `take-snapshot` first).
+ * @returns The raw PDF bytes.
+ * @throws Error when `path` has no cached snapshot yet, or the snapshot's document is not a PDF.
+ */
+export declare function handlePdfBytes(state: StudioState, recipeId: string, path: string): Promise<Uint8Array>;
+//# sourceMappingURL=pdf-bytes.handler.d.ts.map

package/dist/src/studio-server/pdf-view.handler.d.ts

@@ -0,0 +1,14 @@
+import type { PdfDocumentView, PdfViewCommand } from '../studio-api/index.js';
+import type { StudioState } from './workspace.store.js';
+/**
+ * Handles `pdf-view`: the PDF canvas's cells and rows (`document-view`'s
+ * `pdf-view.mapper.ts`, studio plan §3.4, issue #94's 5b), off the same
+ * cached snapshot `take-snapshot`/`document-tree` already use.
+ *
+ * @param state - The server state.
+ * @param command - The command; `command.path` must already have a cached snapshot (call `take-snapshot` first).
+ * @returns The document's view.
+ * @throws Error when no workspace is open, `command.path` has no cached snapshot yet, or the snapshot's document is not a read PDF.
+ */
+export declare function handlePdfView(state: StudioState, command: PdfViewCommand): PdfDocumentView;
+//# sourceMappingURL=pdf-view.handler.d.ts.map

package/dist/src/studio-server/recording.handler.d.ts

@@ -0,0 +1,33 @@
+import type { StartRecordingCommand, StopRecordingCommand } from '../studio-api/index.js';
+import type { StudioState } from './workspace.store.js';
+/**
+ * Handles `start-recording`: opens the studio's own headed browser window
+ * on the named recipe's start point (issue #95, phase 6) and streams
+ * `recording-card`/`recording-note` events as the person drives it. One
+ * recording at a time, like one sample run at a time: a second
+ * `start-recording` stops whatever was already open first.
+ *
+ * @param state - The server state: `folder` must already be set, `recorderProfileDir` names the studio's own recorder profile (never a crawl's own, never the person's default browser).
+ * @param command - The command.
+ * @returns `{ started: true }` once the window is open.
+ * @throws Error when no workspace is open, or the recipe cannot be found or loaded.
+ */
+export declare function handleStartRecording(state: StudioState, command: StartRecordingCommand): Promise<{
+    started: true;
+}>;
+/**
+ * Handles `stop-recording`: closes the recording window, if one is open,
+ * and answers with every step recorded, in order — enough for the caller to
+ * build "make this the login" (`session.bootstrap`) or "keep as steps"
+ * without asking the server again. Also broadcasts `recording-stopped`, so
+ * every connected client (not only the one that asked) knows the window
+ * closed.
+ *
+ * @param state - The server state holding the active recording, if any.
+ * @param _command - The command (carries nothing beyond its type).
+ * @returns Every step recorded, in order; empty when nothing was recording.
+ */
+export declare function handleStopRecording(state: StudioState, _command: StopRecordingCommand): Promise<{
+    steps: Record<string, unknown>[];
+}>;
+//# sourceMappingURL=recording.handler.d.ts.map

package/dist/src/studio-server/responses-seen.handler.d.ts

@@ -0,0 +1,16 @@
+import type { ResponsesSeenCommand, ResponsesSeenView } from '../studio-api/index.js';
+import type { StudioState } from './workspace.store.js';
+/**
+ * Handles `responses-seen`: the JSON responses observed while a recipe's
+ * start page rendered (`page-inspector`'s `responses-seen.use-case.ts`,
+ * issue #93), for the Inspect panel's "responses seen" list — picking one
+ * is the seam the UI uses to switch the recipe to api mode (issue #93's
+ * acceptance; the JSON tree canvas that follows is phase 5's).
+ *
+ * @param state - The server state: `folder` must already be set.
+ * @param command - The command.
+ * @returns The observed responses.
+ * @throws Error when no workspace is open, or the recipe cannot be found or loaded.
+ */
+export declare function handleResponsesSeen(state: StudioState, command: ResponsesSeenCommand): Promise<ResponsesSeenView>;
+//# sourceMappingURL=responses-seen.handler.d.ts.map

package/dist/src/studio-server/studio-http.use-case.d.ts

@@ -12,8 +12,10 @@ export interface StudioServerOptions {
      * the folder reaches it through the URL's `folder` query param).
      */
     initialFolder?: string;
-    /** Browser launch settings every web-mode command shares (`take-snapshot`, `verify-selector`, `run-sample`); an executable path override (e.g. `OPENCRAW_CHROMIUM`, read by the caller — the server itself has no opinion on env vars) for a sandbox with no full Playwright install. Default: Playwright's own bundled browser. */
+    /** Browser launch settings every web-mode command shares (`take-snapshot`, `verify-selector`, `run-sample`, `start-recording`); an executable path override (e.g. `OPENCRAW_CHROMIUM`, read by the caller — the server itself has no opinion on env vars) for a sandbox with no full Playwright install. Default: Playwright's own bundled browser. `start-recording` always forces `headless: false` regardless of what this sets. */
     browser?: BrowserSessionConfig;
+    /** Where the studio's own recorder profile lives (issue #95); default: a fixed directory under the OS temp folder, never a crawl's own profile directory, never the person's default browser. */
+    recorderProfileDir?: string;
 }
 /** The running server: its URL (token included, ready to open), the token alone, and how to stop it. */
 export interface StudioServer {

package/dist/src/studio-server/table-preview.handler.d.ts

@@ -0,0 +1,16 @@
+import type { TablePreviewCommand, TablePreviewView } from '../studio-api/index.js';
+import type { StudioState } from './workspace.store.js';
+/**
+ * Handles `table-preview`: the PDF canvas's live preview of a `table`
+ * extract's options (`document-view`'s `table-preview.use-case.ts`, studio
+ * plan §3.4, issue #94's 5b), off the same cached snapshot `take-snapshot`
+ * already captured — a pure computation over it, so this answers instantly
+ * on every option change, no re-fetch or re-parse.
+ *
+ * @param state - The server state.
+ * @param command - The command; `command.path` must already have a cached snapshot (call `take-snapshot` first).
+ * @returns The matches, or `error` when an option's pattern does not compile.
+ * @throws Error when no workspace is open, or `command.path` has no cached snapshot yet.
+ */
+export declare function handleTablePreview(state: StudioState, command: TablePreviewCommand): TablePreviewView;
+//# sourceMappingURL=table-preview.handler.d.ts.map

package/dist/src/studio-server/workspace.store.d.ts

@@ -1,18 +1,23 @@
 import type { BrowserSessionConfig } from '@opencraw/core';
+import type { RecorderSessionHandle } from '../flow-recording/index.js';
 import type { SnapshotCache } from '../page-snapshot/index.js';
-import type { SampleRunHandle } from '../sample-run/index.js';
+import type { LastRunCache, SampleRunHandle } from '../sample-run/index.js';
 import type { StudioEvent } from '../studio-api/index.js';
 import type { WsConnection } from './websocket.client.js';
-/** The server's mutable state: the opened folder, the run in progress (if any), the connected event sockets, the per-recipe snapshot cache `take-snapshot`/`verify-selector`/`infer-selector` share, and the browser launch settings every web-mode command (`take-snapshot`, `verify-selector`, `run-sample`) shares. */
+/** The server's mutable state: the opened folder, the run in progress (if any), the recording in progress (if any, issue #95), the connected event sockets, the per-recipe snapshot cache `take-snapshot`/`verify-selector`/`infer-selector` share, each recipe's last finished sample run (`explain-why`, issue #92), the browser launch settings every web-mode command (`take-snapshot`, `verify-selector`, `run-sample`, `start-recording`) shares, and where the studio's own recorder profile lives. */
 export interface StudioState {
     folder?: string;
     activeRun?: SampleRunHandle;
+    activeRecording?: RecorderSessionHandle;
     sockets: Set<WsConnection>;
     snapshots: SnapshotCache;
+    lastRuns: LastRunCache;
     /** Set once at server start (`StudioServerOptions.browser`); every web-mode command reads it from here rather than each accepting its own. */
     browser?: BrowserSessionConfig;
+    /** Set once at server start (`StudioServerOptions.recorderProfileDir`), else `defaultRecorderProfileDir()`. */
+    recorderProfileDir: string;
 }
-/** @returns Fresh state for a new server instance: no workspace open, no run, no sockets, an empty snapshot cache, Playwright's own default browser. */
+/** @returns Fresh state for a new server instance: no workspace open, no run, no recording, no sockets, an empty snapshot cache, no last runs, Playwright's own default browser, the default recorder profile directory. */
 export declare function createStudioState(): StudioState;
 /**
  * Sends one event to every connected client. A socket that errors while