@pygmalionjs/pygmalion 0.23.0 → 0.24.0

package/dist-lib/types/workspace/capture/captureMedia.d.ts

@@ -0,0 +1,41 @@
+import { type DocumentAsset } from '../../document/assets.js';
+import { type ScreenImportMedia } from './contracts.js';
+export interface SettleScreenOptions {
+    /** The import controller's stability wait, when the host connected one. */
+    waitForStableDocument?(document: Document): Promise<boolean>;
+}
+export interface SettleScreenReport {
+    finishedAnimations: number;
+    cancelledAnimations: number;
+    stable: boolean | null;
+}
+/** Entrance transitions and image decoding must finish before boxes and opacities are read. */
+export declare function settleScreen(document: Document, options?: SettleScreenOptions): Promise<SettleScreenReport>;
+export interface CollectScreenMediaOptions {
+    signal?: AbortSignal;
+    /** Total time for fetching and rasterizing; media beyond the budget stay placeholders. Default 8000. */
+    budgetMs?: number;
+    /** Fetches encoded bytes for a same-origin or CORS-readable URL; null means unreadable. */
+    fetchBytes?(url: string, signal?: AbortSignal): Promise<Uint8Array | null>;
+    /** Draws an element to PNG bytes at the given CSS size; null means the canvas was tainted or unsupported. */
+    rasterize?(element: Element, size: {
+        width: number;
+        height: number;
+    }): Promise<Uint8Array | null>;
+}
+export interface CollectedScreenMedia {
+    media: Record<string, ScreenImportMedia>;
+    assets: DocumentAsset[];
+    diagnostics: string[];
+    stamped: number;
+}
+/**
+ * Serializes an inline SVG the way the editable importer can read it: computed fill and stroke replace
+ * class-driven styling and `currentColor`, rounded rectangles become cubic paths, and non-presentational attributes drop out.
+ */
+export declare function editableSvgMarkup(element: Element): string;
+/**
+ * Stamps every media element and element with a CSS background image, then gathers the bytes behind them.
+ * The stamps survive the DOM importer as attributes, so the converter can match layers to this media map.
+ */
+export declare function collectScreenMedia(document: Document, options?: CollectScreenMediaOptions): Promise<CollectedScreenMedia>;

package/dist-lib/types/workspace/capture/contracts.d.ts

@@ -1,3 +1,4 @@
+import type { DocumentAsset, ImageScaleMode } from '../../document/assets.js';
 import type { DesignDocument, DocumentDiagnostic } from '../../document/contracts.js';
 import type { ImportedGeometryEntry } from '../../editor/domImport.js';
 import type { NodeJSON, PageModel } from '../../editor/store.js';
@@ -15,7 +16,26 @@ export interface ScreenImportSource {
     geometry: readonly ImportedGeometryEntry[];
     truncated?: boolean;
     importDiagnostics?: readonly string[];
+    /** Media observed on the screen, keyed by the stamp the loader wrote on each element before import. */
+    media?: Readonly<Record<string, ScreenImportMedia>>;
+    /** Image assets the media entries reference; only referenced assets enter the document. */
+    assets?: readonly DocumentAsset[];
 }
+/** The attribute the loader stamps on media elements so their layers can be matched after import. */
+export declare const MEDIA_STAMP_ATTRIBUTE = "data-pygmalion-media";
+export type ScreenImportMedia = {
+    kind: 'svg';
+    markup: string;
+    rasterAssetId?: string;
+} | {
+    kind: 'image';
+    assetId: string;
+    scaleMode: ImageScaleMode;
+} | {
+    kind: 'background';
+    assetId: string;
+    scaleMode: ImageScaleMode;
+};
 export interface ScreenImportResult {
     document: DesignDocument;
     diagnostics: DocumentDiagnostic[];
@@ -43,6 +63,8 @@ export interface CapturedScreenDocumentOptions {
     };
     /** Milliseconds to wait for the screen to load and prepare before giving up. Default 45000. */
     timeoutMs?: number;
+    /** Milliseconds spent collecting images and drawings before the import continues without the rest. Default 8000. */
+    mediaBudgetMs?: number;
     /** Where the offscreen frame mounts; default is the document body of the page running the editor. */
     container?: HTMLElement;
 }

package/dist-lib/types/workspace/configuration.d.ts

@@ -40,7 +40,7 @@ export interface WorkspaceConfiguration extends WorkspaceTargetConfiguration {
     /** Undefined explicitly marks an unsupported screen or source revision. */
     resolveTarget?(target: WorkspaceTarget): WorkspaceTargetConfiguration | undefined;
     /** Open any routed screen the host does not resolve as an imported design document; edits stay drafts until the host connects a source mapping. */
-    capturedScreens?: true | CapturedScreenDocumentOptions;
+    capturedScreens?: boolean | CapturedScreenDocumentOptions;
 }
 export interface WorkspaceTargetResolverOptions {
     /** The host decides whether this screen and revision have usable capabilities. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pygmalionjs/pygmalion",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Code-backed DOM design sandbox and visual QA editor",
   "license": "Apache-2.0",
   "repository": {