@pragma-sh/scratchpad-viewer 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,105 @@
+import { ScratchpadBlock, ScratchpadComment } from "@pragma-sh/scratchpad-contract";
+/** Messages the viewer document posts to its native host. */
+type ScratchpadViewerMessage = {
+	type: "ready";
+	height: number;
+} | {
+	type: "height";
+	height: number;
+} | {
+	type: "error";
+	message: string;
+} | {
+	type: "preview";
+	block: ScratchpadBlock | null;
+} | {
+	type: "select";
+	block: ScratchpadBlock;
+} | {
+	type: "promptAgent";
+	requestId: string;
+	text: string;
+} | {
+	type: "requestAgentAttachment";
+	requestId: string;
+} | {
+	type: "getWhiteboardSnapshot";
+	requestId: string;
+	whiteboardId: string;
+	knownVersion?: number;
+	dark?: boolean;
+} | {
+	type: "subscribeAgentProgress";
+	requestId: string;
+	tabIds: string[];
+} | {
+	type: "unsubscribeAgentProgress";
+	requestId: string;
+};
+/** Commands the native host sends into the viewer document. */
+type ScratchpadViewerCommand = {
+	type: "comments";
+	comments: ScratchpadComment[];
+} | {
+	type: "commentMode";
+	active: boolean;
+} | {
+	type: "clearSelection";
+} | {
+	type: "theme";
+	css: string;
+	mode: "light" | "dark";
+} | {
+	type: "response";
+	requestId: string;
+	value?: unknown;
+	error?: string;
+} | {
+	type: "progress";
+	requestId: string;
+	entries: unknown[];
+};
+/** Options for {@link buildScratchpadViewerHtml}. */
+interface ScratchpadViewerHtmlOptions {
+	/** The scratchpad's MDX source, frontmatter included. */
+	source: string;
+	/** Comments to highlight on first paint. */
+	comments?: readonly ScratchpadComment[];
+	/** Which color scheme the host is rendering in. */
+	mode?: "light" | "dark";
+	/**
+	* Host theme overrides as CSS declarations (`--card: oklch(...);`).
+	*
+	* Only overrides belong here. Every `@pragma-sh/scratchpad` rule already carries
+	* a literal fallback after its `var()`, which is what a scratchpad rendered
+	* outside the desktop uses — restating those defaults here would fork the
+	* palette. Build this with {@link scratchpadThemeCss}.
+	*/
+	themeCss?: string;
+}
+/** Turns host theme overrides into the CSS custom-property block the document takes. */
+declare function scratchpadThemeCss(overrides: Readonly<Record<string, string | undefined>>): string;
+/**
+* Builds the whole viewer document: one self-contained HTML string with the
+* runtime, the document source, and the comment layer inlined.
+*
+* Self-contained is the requirement, not a preference — a web view loading this
+* from a string has no origin to resolve relative URLs against, and a phone
+* viewing a scratchpad over a tunnel should not need a second round trip to
+* paint. Nothing here is fetched.
+*/
+declare function buildScratchpadViewerHtml(options: ScratchpadViewerHtmlOptions): string;
+/**
+* Removes frontmatter and import statements from scratchpad MDX before it is
+* evaluated in a web view.
+*
+* Frontmatter is host metadata the MDX compiler would reject without a plugin.
+* Imports are dropped because the document runs with no module resolver: the
+* components they name are supplied to MDX as run-time components instead, so a
+* document that imports from `@pragma-sh/scratchpad/ui` renders exactly as it does
+* on the desktop, and one that imports a worktree file reports the missing
+* component in place rather than failing to render at all.
+*/
+declare function prepareMdxSource(source: string): string;
+import { attachScratchpadAgent, createScratchpadComment, markAllResolved, parseScratchpadComments, parseScratchpadDocument, replaceScratchpadBody, scratchpadCommentsPath, serializeScratchpadComments, unresolvedComments, unresolvedCommentsPrompt, ScratchpadDocument, ScratchpadMetadata } from "@pragma-sh/scratchpad-contract";
+export { unresolvedCommentsPrompt, unresolvedComments, serializeScratchpadComments, scratchpadThemeCss, scratchpadCommentsPath, replaceScratchpadBody, prepareMdxSource, parseScratchpadDocument, parseScratchpadComments, markAllResolved, createScratchpadComment, buildScratchpadViewerHtml, attachScratchpadAgent, ScratchpadViewerMessage, ScratchpadViewerHtmlOptions, ScratchpadViewerCommand, ScratchpadMetadata, ScratchpadDocument, ScratchpadComment, ScratchpadBlock };

package/dist/index.d.ts

@@ -0,0 +1,105 @@
+import { ScratchpadBlock, ScratchpadComment } from "@pragma-sh/scratchpad-contract";
+/** Messages the viewer document posts to its native host. */
+type ScratchpadViewerMessage = {
+	type: "ready";
+	height: number;
+} | {
+	type: "height";
+	height: number;
+} | {
+	type: "error";
+	message: string;
+} | {
+	type: "preview";
+	block: ScratchpadBlock | null;
+} | {
+	type: "select";
+	block: ScratchpadBlock;
+} | {
+	type: "promptAgent";
+	requestId: string;
+	text: string;
+} | {
+	type: "requestAgentAttachment";
+	requestId: string;
+} | {
+	type: "getWhiteboardSnapshot";
+	requestId: string;
+	whiteboardId: string;
+	knownVersion?: number;
+	dark?: boolean;
+} | {
+	type: "subscribeAgentProgress";
+	requestId: string;
+	tabIds: string[];
+} | {
+	type: "unsubscribeAgentProgress";
+	requestId: string;
+};
+/** Commands the native host sends into the viewer document. */
+type ScratchpadViewerCommand = {
+	type: "comments";
+	comments: ScratchpadComment[];
+} | {
+	type: "commentMode";
+	active: boolean;
+} | {
+	type: "clearSelection";
+} | {
+	type: "theme";
+	css: string;
+	mode: "light" | "dark";
+} | {
+	type: "response";
+	requestId: string;
+	value?: unknown;
+	error?: string;
+} | {
+	type: "progress";
+	requestId: string;
+	entries: unknown[];
+};
+/** Options for {@link buildScratchpadViewerHtml}. */
+interface ScratchpadViewerHtmlOptions {
+	/** The scratchpad's MDX source, frontmatter included. */
+	source: string;
+	/** Comments to highlight on first paint. */
+	comments?: readonly ScratchpadComment[];
+	/** Which color scheme the host is rendering in. */
+	mode?: "light" | "dark";
+	/**
+	* Host theme overrides as CSS declarations (`--card: oklch(...);`).
+	*
+	* Only overrides belong here. Every `@pragma-sh/scratchpad` rule already carries
+	* a literal fallback after its `var()`, which is what a scratchpad rendered
+	* outside the desktop uses — restating those defaults here would fork the
+	* palette. Build this with {@link scratchpadThemeCss}.
+	*/
+	themeCss?: string;
+}
+/** Turns host theme overrides into the CSS custom-property block the document takes. */
+declare function scratchpadThemeCss(overrides: Readonly<Record<string, string | undefined>>): string;
+/**
+* Builds the whole viewer document: one self-contained HTML string with the
+* runtime, the document source, and the comment layer inlined.
+*
+* Self-contained is the requirement, not a preference — a web view loading this
+* from a string has no origin to resolve relative URLs against, and a phone
+* viewing a scratchpad over a tunnel should not need a second round trip to
+* paint. Nothing here is fetched.
+*/
+declare function buildScratchpadViewerHtml(options: ScratchpadViewerHtmlOptions): string;
+/**
+* Removes frontmatter and import statements from scratchpad MDX before it is
+* evaluated in a web view.
+*
+* Frontmatter is host metadata the MDX compiler would reject without a plugin.
+* Imports are dropped because the document runs with no module resolver: the
+* components they name are supplied to MDX as run-time components instead, so a
+* document that imports from `@pragma-sh/scratchpad/ui` renders exactly as it does
+* on the desktop, and one that imports a worktree file reports the missing
+* component in place rather than failing to render at all.
+*/
+declare function prepareMdxSource(source: string): string;
+import { attachScratchpadAgent, createScratchpadComment, markAllResolved, parseScratchpadComments, parseScratchpadDocument, replaceScratchpadBody, scratchpadCommentsPath, serializeScratchpadComments, unresolvedComments, unresolvedCommentsPrompt, ScratchpadDocument, ScratchpadMetadata } from "@pragma-sh/scratchpad-contract";
+export { unresolvedCommentsPrompt, unresolvedComments, serializeScratchpadComments, scratchpadThemeCss, scratchpadCommentsPath, replaceScratchpadBody, prepareMdxSource, parseScratchpadDocument, parseScratchpadComments, markAllResolved, createScratchpadComment, buildScratchpadViewerHtml, attachScratchpadAgent, ScratchpadViewerMessage, ScratchpadViewerHtmlOptions, ScratchpadViewerCommand, ScratchpadMetadata, ScratchpadDocument, ScratchpadComment, ScratchpadBlock };