@guideshot/core 0.1.1 → 0.3.0

package/README.md

@@ -13,3 +13,5 @@ const recipe = parseRecipe(source, { file: 'example.shot.json' });
 ```
 
 Browser drivers and annotation renderers are injected through `defineConfig`. Requires Node.js 20 or newer and is licensed under the MIT License.
+
+Scenario definitions remain isolated per job by default. Deterministic, read-only adapters may set `reusePreparedState: true`; shared mutable adapters should use `concurrencyKey` instead.

package/dist/index.d.ts

@@ -73,6 +73,8 @@ interface ScenarioResult {
 interface ScenarioDefinition<TInput extends JsonObject = JsonObject> extends ExtensionInfo {
     schema: object;
     datasetRevision?: string;
+    concurrencyKey?: string;
+    reusePreparedState?: boolean;
     prepare(context: ScenarioContext, input: TInput): ScenarioResult | Promise<ScenarioResult>;
 }
 interface TranslationContext {
@@ -91,11 +93,15 @@ interface ServerConfig {
 interface SafetyConfig {
     allowedOrigins?: readonly string[];
 }
+interface CaptureConfig {
+    concurrency?: number;
+}
 interface GuideShotConfig {
     recipes: readonly string[];
     outputDir: string;
     cacheDir: string;
     server: ServerConfig;
+    capture?: CaptureConfig;
     safety?: SafetyConfig;
     targetAttribute?: `data-${string}`;
     profiles: Readonly<Record<string, CaptureProfile>>;
@@ -142,6 +148,7 @@ interface BrowserDriver extends ExtensionInfo {
 }
 interface BrowserRun {
     capture(request: CaptureRequest): Promise<CaptureResult>;
+    captureMany?(requests: readonly CaptureRequest[]): Promise<readonly CaptureResult[]>;
     close(): Promise<void>;
 }
 interface Rect {
@@ -405,4 +412,4 @@ declare function validateConfig(config: GuideShotConfig): void;
 declare function validateRecipeSemantics(source: RecipeSource, config: GuideShotConfig): void;
 declare function defaultProfileName(config: GuideShotConfig): string;
 
-export { type AnnotationRenderer, type BrowserCookie, type BrowserDriver, type BrowserEnvironment, type BrowserRun, type BrowserStatePatch, type CaptureIntent, type CaptureProfile, type CaptureRequest, type CaptureResult, type CapturedScene, type CompositionIntent, type CompositionOutput, type CompositionRequest, DIAGNOSTIC_CODES, type Diagnostic, type DiagnosticCode, type DiagnosticLocation, type DiagnosticSeverity, type DimensionDefinition, type DimensionResolveContext, type DriverRunOptions, type ExtensionInfo, type GuideShotConfig, GuideShotError, type GuideShotErrorOptions, type InterpolationContext, type LocalStorageState, type ManifestAssetInput, type MatrixDefinition, type ParseRecipeOptions, type Plan, type PlanOptions, type PlannedJob, type RecipeSource, type Rect, type RenderedAsset, type RendererRun, type ResolveJobOptions, type ResolveTextContext, type ResolvedAnnotation, type ResolvedCaptureJob, type ResolvedJob, type SafeProjectPaths, type SafetyConfig, type ScenarioContext, type ScenarioDefinition, type ScenarioResult, type SceneBackground, type SceneTarget, type SceneViewport, type ServerConfig, type TranslationContext, type TranslationProvider, type VariantRow, type Viewport, assertAllowedOrigin, assertUniqueRecipeIds, buildPublicManifest, canonicalSerialize, createAssetPath, createCaptureHash, createCompositionHash, createJobCompositionHash, createVariantKey, defaultProfileName, defineConfig, defineDimension, defineScenario, diagnosticFromUnknown, discoverRecipes, expandMatrix, hashCanonical, interpolate, interpolateString, isGuideShotError, matchesVariantFilter, mergeBrowserState, parseRecipe, planProject, planRecipes, resolveArtifactPath, resolveJob, resolveLocalizedText, resolvePageUrl, resolveRecipeText, resolveSafeProjectPaths, resolvedAlt, resolvedAnnotations, sanitizeFileSegment, sha256, validateConfig, validateManifest, validateRecipe, validateRecipeSemantics };
+export { type AnnotationRenderer, type BrowserCookie, type BrowserDriver, type BrowserEnvironment, type BrowserRun, type BrowserStatePatch, type CaptureConfig, type CaptureIntent, type CaptureProfile, type CaptureRequest, type CaptureResult, type CapturedScene, type CompositionIntent, type CompositionOutput, type CompositionRequest, DIAGNOSTIC_CODES, type Diagnostic, type DiagnosticCode, type DiagnosticLocation, type DiagnosticSeverity, type DimensionDefinition, type DimensionResolveContext, type DriverRunOptions, type ExtensionInfo, type GuideShotConfig, GuideShotError, type GuideShotErrorOptions, type InterpolationContext, type LocalStorageState, type ManifestAssetInput, type MatrixDefinition, type ParseRecipeOptions, type Plan, type PlanOptions, type PlannedJob, type RecipeSource, type Rect, type RenderedAsset, type RendererRun, type ResolveJobOptions, type ResolveTextContext, type ResolvedAnnotation, type ResolvedCaptureJob, type ResolvedJob, type SafeProjectPaths, type SafetyConfig, type ScenarioContext, type ScenarioDefinition, type ScenarioResult, type SceneBackground, type SceneTarget, type SceneViewport, type ServerConfig, type TranslationContext, type TranslationProvider, type VariantRow, type Viewport, assertAllowedOrigin, assertUniqueRecipeIds, buildPublicManifest, canonicalSerialize, createAssetPath, createCaptureHash, createCompositionHash, createJobCompositionHash, createVariantKey, defaultProfileName, defineConfig, defineDimension, defineScenario, diagnosticFromUnknown, discoverRecipes, expandMatrix, hashCanonical, interpolate, interpolateString, isGuideShotError, matchesVariantFilter, mergeBrowserState, parseRecipe, planProject, planRecipes, resolveArtifactPath, resolveJob, resolveLocalizedText, resolvePageUrl, resolveRecipeText, resolveSafeProjectPaths, resolvedAlt, resolvedAnnotations, sanitizeFileSegment, sha256, validateConfig, validateManifest, validateRecipe, validateRecipeSemantics };

package/dist/index.js

@@ -246,6 +246,26 @@ function validateConfig(config) {
       "Configuration must register at least one capture profile."
     );
   }
+  if (config.capture?.concurrency !== void 0 && (!Number.isInteger(config.capture.concurrency) || config.capture.concurrency < 1)) {
+    throw new GuideShotError(
+      "RECIPE_SCHEMA_INVALID",
+      "Capture concurrency must be a positive integer."
+    );
+  }
+  for (const scenario of Object.values(config.scenarios ?? {})) {
+    if (scenario.concurrencyKey !== void 0 && scenario.concurrencyKey.trim() === "") {
+      throw new GuideShotError(
+        "RECIPE_SCHEMA_INVALID",
+        "Scenario concurrency keys cannot be empty."
+      );
+    }
+    if (scenario.reusePreparedState !== void 0 && typeof scenario.reusePreparedState !== "boolean") {
+      throw new GuideShotError(
+        "RECIPE_SCHEMA_INVALID",
+        "Scenario prepared-state reuse must be a boolean."
+      );
+    }
+  }
   for (const [name, profile] of Object.entries(config.profiles)) {
     if (!Number.isInteger(profile.viewport.width) || profile.viewport.width <= 0 || !Number.isInteger(profile.viewport.height) || profile.viewport.height <= 0) {
       throw new GuideShotError(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guideshot/core",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Portable compiler and contracts for GuideShot.",
   "license": "MIT",
   "keywords": [