@pygmalionjs/pygmalion 0.2.10 → 0.2.12

package/vite.d.ts

@@ -1,4 +1,10 @@
 import type { PluginOption } from 'vite';
+import type {
+  QaCaptureRunner,
+  QaCaptureServiceOptions,
+} from './qa';
+
+export * from './qa';
 
 export interface PygmalionInventoryContext {
   sourceRoot: string;
@@ -14,6 +20,11 @@ export interface PygmalionInventoryConfig {
   args?: string[] | ((context: PygmalionInventoryContext) => string[]);
   cwd?: string;
   outputRoot?: string;
+  /**
+   * Generator-owned paths relative to the host application root. The dedicated
+   * mirror restores only these paths before checking for unexpected changes.
+   */
+  outputs?: string[];
   generate?: (context: PygmalionInventoryContext) => void | Promise<void>;
 }
 
@@ -51,6 +62,23 @@ export interface PygmalionPreviewConfig {
   viteBin?: string;
   mirrorPort?: number;
   sessionPort?: number;
+  artifactFile?: string;
+  artifactEndpoint?: string;
+  generateArtifact?: (request: {
+    namespace: string;
+    sourceRevision: string;
+    captureBaseUrl?: string;
+  }) => unknown | Promise<unknown>;
+}
+
+export interface PygmalionQaConfig
+  extends Omit<QaCaptureServiceOptions, 'root' | 'scriptPath'> {
+  /**
+   * Host-owned capture CLI, relative to the application root. Pygmalion owns
+   * orchestration, validation, baseline storage, and pixel comparison.
+   */
+  captureScript?: string;
+  captureRunner?: QaCaptureRunner;
 }
 
 export interface PygmalionProjectConfig {
@@ -77,6 +105,7 @@ export interface PygmalionProjectConfig {
   mirror?: false | PygmalionMirrorConfig;
   sessions?: false | PygmalionSessionConfig;
   preview?: PygmalionPreviewConfig;
+  qa?: false | PygmalionQaConfig;
 }
 
 export interface ResolvedPygmalionProject {
@@ -95,11 +124,14 @@ export interface ResolvedPygmalionProject {
   sessions: false | PygmalionSessionConfig;
   inspect: false | PygmalionInspectConfig;
   preview: PygmalionPreviewConfig;
+  qa: false | PygmalionQaConfig;
   dependencies: PygmalionDependencyConfig;
   inventory?: PygmalionInventoryConfig;
 }
 
-export declare function definePygmalionProject<T extends PygmalionProjectConfig>(config: T): T;
+export declare function definePygmalionProject<
+  T extends PygmalionProjectConfig,
+>(config: T): T;
 export declare function resolvePygmalionProject(
   config: PygmalionProjectConfig,
 ): ResolvedPygmalionProject;
@@ -107,15 +139,44 @@ export declare function createPygmalionVitePlugins(
   config: PygmalionProjectConfig,
 ): PluginOption[];
 
+export declare const PYGMALION_PREVIEW_ARTIFACT_ENDPOINT: string;
+export declare const DEFAULT_PYGMALION_PREVIEW_ARTIFACT_FILE: string;
+export declare function pygmalionPreviewArtifactPlugin(options?: {
+  root?: string;
+  artifactFile?: string;
+  endpoint?: string;
+  disabled?: () => boolean;
+  generateArtifact?: (request: {
+    namespace: string;
+    sourceRevision: string;
+    captureBaseUrl?: string;
+  }) => unknown | Promise<unknown>;
+}): PluginOption;
+export interface PygmalionGitSourceState {
+  commit: string;
+  revision: string;
+  dirty: boolean;
+  fingerprint: string | null;
+}
+export declare function resolveGitSourceState(
+  root?: string,
+): PygmalionGitSourceState;
+
 export declare const PYGMALION_INSPECT_CONTROL: string;
 export declare const PYGMALION_DEV_PREFIX: string;
 export declare const PYGMALION_DEV_CONTROL: string;
 export declare const PYGMALION_SESSION_PREFIX: string;
 export declare const PYGMALION_SESSION_CONTROL: string;
 
-export declare function pygmalionInspectPlugin(options: Record<string, unknown>): PluginOption;
-export declare function pygmalionDevMirrorPlugin(options: Record<string, unknown>): PluginOption;
-export declare function pygmalionDesignSessionPlugin(options: Record<string, unknown>): PluginOption;
+export declare function pygmalionInspectPlugin(
+  options: Record<string, unknown>,
+): PluginOption;
+export declare function pygmalionDevMirrorPlugin(
+  options: Record<string, unknown>,
+): PluginOption;
+export declare function pygmalionDesignSessionPlugin(
+  options: Record<string, unknown>,
+): PluginOption;
 export declare function writeStyleEdit(
   root: string,
   input: unknown,
@@ -181,9 +242,7 @@ export interface PygmalionSourceGraphOptions {
 }
 
 export type PygmalionStoryboardEnvironmentKind =
-  | 'permission'
-  | 'media-devices'
-  | 'storage';
+  'permission' | 'media-devices' | 'storage';
 
 export interface PygmalionStoryboardEnvironmentEvidence {
   id: string;
@@ -333,8 +392,12 @@ export interface PygmalionStoryboardCanonicalManifest {
   };
 }
 
-export declare function normalizeStoryboardSnapshot(snapshot: string): string | null;
-export declare function fingerprintStoryboardSnapshot(snapshot: string): string | null;
+export declare function normalizeStoryboardSnapshot(
+  snapshot: string,
+): string | null;
+export declare function fingerprintStoryboardSnapshot(
+  snapshot: string,
+): string | null;
 export declare function canonicalizeStoryboardExecutions(
   candidates: PygmalionStoryboardEnvironmentManifest['candidates'],
   executions: PygmalionStoryboardCandidateExecution[],
@@ -350,12 +413,10 @@ export declare function executeStoryboardCandidates(
     timeoutMs?: number;
   },
 ): Promise<PygmalionStoryboardCandidateExecution[]>;
-export declare function recommendedStoryboardExecutionConcurrency(
-  capabilities?: {
-    parallelism?: number;
-    totalMemoryBytes?: number;
-  },
-): number;
+export declare function recommendedStoryboardExecutionConcurrency(capabilities?: {
+  parallelism?: number;
+  totalMemoryBytes?: number;
+}): number;
 
 export interface PygmalionRoutePreviewArtifactV1 {
   version: 1;
@@ -404,11 +465,15 @@ export declare const ROUTE_PREVIEW_ARTIFACT_V2_LIMITS: Readonly<
 export declare function isSafeFrozenRoutePreviewSnapshot(
   snapshot: unknown,
 ): snapshot is string;
-export declare function createRoutePreviewArtifactV2(input: {
-  namespace: string;
-  sourceRevision?: string;
-  snapshots: Record<string, string>;
-} | PygmalionRoutePreviewArtifactV1): PygmalionRoutePreviewArtifactV2;
+export declare function createRoutePreviewArtifactV2(
+  input:
+    | {
+        namespace: string;
+        sourceRevision?: string;
+        snapshots: Record<string, string>;
+      }
+    | PygmalionRoutePreviewArtifactV1,
+): PygmalionRoutePreviewArtifactV2;
 export declare function convertRoutePreviewArtifactV1ToV2(
   bundle: PygmalionRoutePreviewArtifactV1,
 ): PygmalionRoutePreviewArtifactV2;
@@ -426,6 +491,23 @@ export declare function reconstructRoutePreviewArtifactSnapshots(
   bundle: PygmalionRoutePreviewArtifactV2,
 ): Record<string, string>;
 
+export {
+  ROUTE_PREVIEW_ARTIFACT_V3_LIMITS,
+  createRoutePreviewArtifactV3,
+  reconstructRoutePreviewArtifactScreenshotV3,
+  reconstructRoutePreviewArtifactSnapshotV3,
+  reconstructRoutePreviewArtifactSnapshotsV3,
+  validateRoutePreviewArtifactBundle,
+  validateRoutePreviewArtifactV3,
+} from './storyboard';
+export type {
+  RoutePreviewArtifactBundleV3,
+  RoutePreviewArtifactV3Capture,
+  StoryboardCaptureDiagnostic,
+  StoryboardCaptureStatus,
+  StoryboardCaptureViewport,
+} from './storyboard';
+
 export declare function scanStoryboardEnvironment(
   root: string,
   options?: PygmalionStoryboardEnvironmentScanOptions,