@kontourai/survey 0.4.6 → 0.4.8

package/dist/src/review-workbench/review-workbench.d.ts

@@ -0,0 +1,71 @@
+import { type ReviewQueueSessionState, type ReviewWorkbenchDecision, type ReviewWorkbenchState } from "./review-queue-session.js";
+import { type ReviewCandidate, type ReviewDecision, type ReviewSession, type ReviewSessionEvent } from "../review-resource.js";
+export { buildReviewSessionEvents, buildReviewSessionEvent, buildReviewSessionResource, candidateForDecision, currentReviewItem, currentReviewWorkbenchState, defaultReviewSessionName, deriveQueueRowStatus, initialReviewQueueSessionState, initialReviewWorkbenchState, nextUnresolvedItemName, replayReviewSessionEvents, reviewSessionSummary, reviewWorkbenchSessionStorageKey, selectedCandidateRole, workbenchDecisionDefinitions, type ReviewQueueRowStatus, type ReviewQueueSessionState, type ReviewSessionSummary, type ReviewWorkbenchDecision, type ReviewWorkbenchState, } from "./review-queue-session.js";
+export { buildSurfaceProjectionPreview, type PreviewAuthorityTrace, type PreviewCandidateHistory, type PreviewClaim, type PreviewIntegrityPosture, type PreviewReviewEvent, type PreviewSourceAuthority, type PreviewSourceEvidence, type SurfaceProjectionPreview, } from "./review-surface-preview.js";
+export declare function buildReviewDecision(state: ReviewWorkbenchState): ReviewDecision | undefined;
+export interface ReviewWorkbenchSessionExport {
+    readonly session: ReviewSession;
+    readonly events: readonly ReviewSessionEvent[];
+    readonly decisions: readonly ReviewDecision[];
+    readonly results: readonly ReviewWorkbenchResult[];
+}
+export interface ReviewSessionEventStore {
+    load(session: ReviewQueueSessionState): readonly ReviewSessionEvent[] | undefined;
+    save(session: ReviewQueueSessionState, events: readonly ReviewSessionEvent[]): void;
+}
+export type ReviewSessionPersistenceStatus = "idle" | "saving" | "saved" | "error";
+export interface ReviewSessionPersistenceState {
+    readonly status: ReviewSessionPersistenceStatus;
+    readonly events: readonly ReviewSessionEvent[];
+    readonly error?: unknown;
+}
+export interface ReviewSessionPersistenceRequest {
+    readonly session: ReviewQueueSessionState;
+    readonly events: readonly ReviewSessionEvent[];
+    readonly expectedEventCount: number;
+}
+export interface ReviewSessionPersistenceResult {
+    readonly eventCount?: number;
+}
+export interface PersistentReviewSessionEventStoreOptions {
+    readonly initialEvents?: readonly ReviewSessionEvent[];
+    readonly persist: (request: ReviewSessionPersistenceRequest) => Promise<ReviewSessionPersistenceResult | void>;
+    readonly onStatusChange?: (state: ReviewSessionPersistenceState) => void;
+}
+export interface MountReviewWorkbenchOptions {
+    readonly eventStore?: ReviewSessionEventStore;
+}
+export interface BrowserReviewWorkbenchConfig {
+    readonly startState?: ReviewQueueSessionState | ReviewWorkbenchState;
+}
+export interface ReviewWorkbenchResult {
+    readonly reviewItemName: string;
+    readonly decision: ReviewWorkbenchDecision;
+    readonly selectedCandidate: ReviewCandidate;
+    readonly selectedCandidateId: string;
+    readonly selectedCandidateRole?: ReviewCandidate["role"];
+    readonly selectedValue: unknown;
+    readonly selectedDisplayValue: string;
+    readonly unselectedCandidates: readonly ReviewCandidate[];
+    readonly reviewDecision: ReviewDecision;
+    readonly status: ReviewDecision["spec"]["status"];
+    readonly rationale?: string;
+}
+export declare function buildReviewDecisionsFromSession(session: ReviewQueueSessionState): ReviewDecision[];
+export declare function buildReviewWorkbenchResultsFromSession(session: ReviewQueueSessionState): ReviewWorkbenchResult[];
+export declare function buildReviewWorkbenchSessionExport(session: ReviewQueueSessionState, events?: readonly ReviewSessionEvent[]): ReviewWorkbenchSessionExport;
+export declare function createInMemoryReviewSessionEventStore(initialEvents?: readonly ReviewSessionEvent[]): ReviewSessionEventStore & {
+    events(): readonly ReviewSessionEvent[];
+};
+export declare function createLocalStorageReviewSessionEventStore(storage: Pick<Storage, "getItem" | "setItem">, keyPrefix?: string): ReviewSessionEventStore;
+export declare function createPersistentReviewSessionEventStore(options: PersistentReviewSessionEventStoreOptions): ReviewSessionEventStore & {
+    events(): readonly ReviewSessionEvent[];
+};
+export declare function renderReviewWorkbenchHtml(state: ReviewWorkbenchState | ReviewQueueSessionState, events?: readonly ReviewSessionEvent[]): string;
+export declare function mountReviewWorkbench(root: HTMLElement, startState?: ReviewQueueSessionState | ReviewWorkbenchState, options?: MountReviewWorkbenchOptions): void;
+export declare function browserReviewWorkbenchStartState(): ReviewQueueSessionState | ReviewWorkbenchState | undefined;
+declare global {
+    interface Window {
+        kontourSurveyReviewWorkbench?: BrowserReviewWorkbenchConfig | ReviewQueueSessionState | ReviewWorkbenchState;
+    }
+}