@zackbart/connecta 0.25.0 → 0.26.1

package/dist/artifacts/connector.d.ts

@@ -0,0 +1,55 @@
+import type { Connector } from "../types.js";
+import { type ArtifactOperations } from "./operations.js";
+import { type ArtifactRefreshService } from "./refresh.js";
+import type { ArtifactAllowlist, ArtifactIssue, ArtifactKind, ArtifactLimits } from "./types.js";
+/** What a deployment's render check is handed: exactly what the viewer loads. */
+export interface ArtifactRenderCheckInput {
+    /** The complete frame document, data injected. */
+    document: string;
+    /** The Content-Security-Policy the viewer serves it under. */
+    csp: string;
+    kind: ArtifactKind;
+    /** Aborted when the check's 20-second deadline or the call's own passes. */
+    signal: AbortSignal;
+}
+export type ArtifactRenderCheckResult = {
+    ok: true;
+    warnings?: string[];
+} | {
+    ok: false;
+    errors: string[];
+};
+/**
+ * A real render check — a headless browser, say — run on `validate_artifact`
+ * and on every write that changes what a page renders. It must answer within
+ * 20 seconds; a throw or a timeout fails the write as retryable `unavailable`
+ * and saves nothing.
+ */
+export type ArtifactRenderCheck = (input: ArtifactRenderCheckInput) => Promise<ArtifactRenderCheckResult>;
+type RenderVerdict = {
+    ok: true;
+    warnings: ArtifactIssue[];
+} | {
+    ok: false;
+    errors: ArtifactIssue[];
+} | {
+    ok: false;
+    unavailable: string;
+};
+/** Run a hook under its 20-second deadline and the call's own signal. Never throws. */
+export declare function runRenderCheck(hook: ArtifactRenderCheck, input: {
+    document: string;
+    csp: string;
+    kind: ArtifactKind;
+}, callSignal: AbortSignal | undefined): Promise<RenderVerdict>;
+export interface ArtifactsConnectorOptions {
+    operations: ArtifactOperations;
+    refresh: ArtifactRefreshService;
+    allowlist: ArtifactAllowlist;
+    limits: ArtifactLimits;
+    renderCheck?: ArtifactRenderCheck;
+    /** Where pages are served, when not the deployment's own origin. */
+    origin?: string;
+}
+export declare function artifactsConnector(options: ArtifactsConnectorOptions): Connector;
+export {};