@spotpatch/runtime 1.13.0 → 1.15.0

package/dist/contextual-ask-panel.d.ts

@@ -0,0 +1,165 @@
+import { SpotTargetContext, PageContext, SpotPatchLocale } from '@spotpatch/shared';
+import { ContextualAskCapability, AskJobSnapshot, AskJobCreateRequest, AskJobEvent, AskJobResultResponse, AskAnswerResult, ErrorCode, AskDraftOrigin, AskSourceReference, AskJobStatus, AskAnswerWarningCode } from '@spotpatch/shared/contextual-ask-browser';
+import { c as FloatingSurfaceProjection } from './motion-extension-contract-B3m26CML.js';
+
+interface SelectionSnapshotTarget extends Omit<SpotTargetContext, "page" | "warnings"> {
+    readonly id: string;
+    readonly page: PageContext;
+}
+
+interface ContextualAskApi {
+    readonly capability: () => Promise<ContextualAskCapability>;
+    readonly cancelJob: (jobId: string) => Promise<AskJobSnapshot>;
+    readonly cancelPending: () => void;
+    readonly createJob: (request: AskJobCreateRequest) => Promise<AskJobSnapshot>;
+    readonly dispose: () => void;
+    readonly events: (jobId: string, afterSequence: number, onEvent: (event: AskJobEvent) => void) => Promise<void>;
+    readonly result: (jobId: string) => Promise<AskJobResultResponse>;
+}
+
+type ClipboardWriter = Readonly<{
+    writeText(value: string): Promise<void>;
+}>;
+
+interface ContextualAskSelectionPreview {
+    readonly contextReady: boolean;
+    readonly targetCount: number;
+    readonly sourceCount: number;
+}
+interface ContextualAskSelectionDraft {
+    readonly locale: SpotPatchLocale;
+    readonly targets: readonly SelectionSnapshotTarget[];
+}
+interface ContextualAskPanel {
+    readonly cancelButton: HTMLButtonElement;
+    readonly consentCheckbox: HTMLInputElement;
+    readonly convertButton: HTMLButtonElement;
+    readonly copyButton: HTMLButtonElement;
+    readonly executorSelect: HTMLSelectElement;
+    readonly newQuestionButton: HTMLButtonElement;
+    readonly questionInput: HTMLTextAreaElement;
+    readonly root: HTMLElement;
+    readonly styles: HTMLStyleElement;
+    readonly submitButton: HTMLButtonElement;
+    readonly clear: () => void;
+    readonly dispose: () => void;
+    readonly focusQuestion: () => void;
+    readonly mode: () => "ask" | "change";
+    readonly notify: (event: "copied" | "copy-failed" | "converted" | "source-open-failed") => void;
+    readonly readConsent: () => boolean;
+    readonly readExecutorId: () => string | undefined;
+    readonly readModel: () => string | undefined;
+    readonly readQuestion: () => string;
+    readonly renderAnswer: (result: AskAnswerResult, stale: boolean) => void;
+    readonly renderCapability: (capability?: ContextualAskCapability) => void;
+    readonly renderError: (code?: ErrorCode) => void;
+    readonly renderEvent: (event: AskJobEvent) => void;
+    readonly renderJob: (snapshot: AskJobSnapshot) => void;
+    readonly selectedSourceId: (target: EventTarget | null) => string | undefined;
+    readonly setBusy: (busy: boolean) => void;
+    readonly setConsent: (granted: boolean) => void;
+    readonly setMode: (mode: "ask" | "change") => void;
+    readonly setOrigin: (origin?: AskDraftOrigin) => void;
+    readonly setSelectionPreview: (preview: ContextualAskSelectionPreview) => void;
+    readonly setSelectionVisible: (visible: boolean) => void;
+    readonly sourceById: (sourceId: string) => AskSourceReference | undefined;
+    readonly answerPlainText: () => string;
+}
+interface ContextualAskWorkflow {
+    readonly beginSelection: () => void;
+    readonly cancelPending: () => void;
+    readonly dispose: () => void;
+    readonly isBusy: () => boolean;
+    readonly mount: () => void;
+    readonly selectionChanged: () => void;
+}
+interface ContextualAskExtension {
+    readonly createPanel: (input: Readonly<{
+        document: Document;
+        locale: () => SpotPatchLocale;
+        subscribeLocale: (listener: () => void) => () => void;
+        changeRoot: HTMLElement;
+        changeActions: HTMLElement;
+        announce: (message: string) => void;
+        onModeChange: (mode: "ask" | "change", title: string, subtitle: string) => void;
+        onExecutionChange: (projection?: FloatingSurfaceProjection) => void;
+        onViewChange: () => void;
+    }>) => ContextualAskPanel;
+    readonly createWorkflow: (input: Readonly<{
+        api?: ContextualAskApi;
+        clipboard?: ClipboardWriter;
+        createId: () => string;
+        fetch: typeof globalThis.fetch;
+        getSelection: () => ContextualAskSelectionDraft | undefined;
+        onConvert: (origin: AskDraftOrigin) => void;
+        onBusyChange: (busy: boolean) => void;
+        onOpenSource: (source: AskSourceReference) => Promise<void>;
+        panel: ContextualAskPanel;
+        sessionToken: string;
+    }>) => ContextualAskWorkflow;
+}
+declare function registerContextualAskExtension(extension: ContextualAskExtension): void;
+declare function getContextualAskExtension(): ContextualAskExtension | undefined;
+
+interface ContextualAskMessages {
+    readonly mode: Readonly<{
+        ask: string;
+        change: string;
+        label: string;
+    }>;
+    readonly title: string;
+    readonly subtitle: string;
+    readonly questionLabel: string;
+    readonly questionPlaceholder: string;
+    readonly suggestionsLabel: string;
+    readonly suggestions: readonly string[];
+    readonly executorLabel: string;
+    readonly modelLabel: string;
+    readonly loadingExecutors: string;
+    readonly noExecutor: string;
+    readonly unavailable: string;
+    readonly consent: string;
+    readonly dataSummary: (targets: number, sources: number) => string;
+    readonly safety: string;
+    readonly submit: string;
+    readonly cancel: string;
+    readonly newQuestion: string;
+    readonly copy: string;
+    readonly convert: string;
+    readonly answerTitle: string;
+    readonly sourcesTitle: string;
+    readonly stale: string;
+    readonly convertedTitle: string;
+    readonly convertedBody: string;
+    readonly status: Readonly<Record<AskJobStatus, string>>;
+    readonly sourceLabel: (path: string, start: number, end: number) => string;
+    readonly readSource: (path: string) => string;
+    readonly readFiles: (bucket: string) => string;
+    readonly copied: string;
+    readonly copyFailed: string;
+    readonly sourceOpenFailed: string;
+    readonly converted: string;
+    readonly error: (code?: ErrorCode) => string;
+    readonly warning: (code: AskAnswerWarningCode) => string;
+}
+declare function contextualAskMessages(locale: SpotPatchLocale): ContextualAskMessages;
+
+interface CreateContextualAskPanelInput {
+    readonly document: Document;
+    readonly locale: Parameters<typeof contextualAskMessages>[0] extends never ? never : () => Parameters<typeof contextualAskMessages>[0];
+    readonly subscribeLocale: (listener: () => void) => () => void;
+    readonly changeRoot: HTMLElement;
+    readonly changeActions: HTMLElement;
+    readonly announce: (message: string) => void;
+    readonly onModeChange: (mode: "ask" | "change", title: string, subtitle: string) => void;
+    readonly onExecutionChange: (projection?: FloatingSurfaceProjection) => void;
+    readonly onViewChange: () => void;
+}
+declare function createContextualAskPanel(input: CreateContextualAskPanelInput): ContextualAskPanel;
+
+type WorkflowInput = Parameters<ContextualAskExtension["createWorkflow"]>[0];
+declare function createContextualAskWorkflow(input: WorkflowInput): ContextualAskWorkflow;
+
+declare function installContextualAskExtension(): void;
+
+export { type ContextualAskExtension, type ContextualAskPanel, type ContextualAskWorkflow, createContextualAskPanel, createContextualAskWorkflow, getContextualAskExtension, installContextualAskExtension, registerContextualAskExtension };