@spotpatch/dev-server 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,201 @@
+import { applyPreparedAgentChange, executeAgentChange, inspectAgentWorkspace, probeProviderCapability, resolveProviderCredential, revertPreparedAgentChange } from '@spotpatch/agent';
+import { AgentJobEvent, AgentJobSnapshot, AgentJobCreateRequest, AgentCapabilityRequest, AgentCapabilitySnapshot, AgentJobResultResponse, AgentWorkspaceHealthSnapshot, ResolvedAiOptions, SpotPatchEditorPreference, ContextBudget, SpotPatchLocalePreference, AiProviderProtocol, AiProviderAuthentication, AiExecutionOptions, AiOptions, RuntimeAiConfig, SpotPatchRuntimeConfig } from '@spotpatch/shared';
+import { SourceFilterEntry } from '@spotpatch/compiler';
+import { IncomingMessage, ServerResponse } from 'node:http';
+
+type AgentJobEventListener = (event: AgentJobEvent) => void;
+interface AgentJobManager {
+    apply(jobId: string): Promise<AgentJobSnapshot>;
+    cancel(jobId: string): AgentJobSnapshot;
+    close(): Promise<void>;
+    create(request: AgentJobCreateRequest): AgentJobSnapshot;
+    events(jobId: string): readonly AgentJobEvent[];
+    probe(request: AgentCapabilityRequest, signal: AbortSignal): Promise<AgentCapabilitySnapshot>;
+    result(jobId: string): AgentJobResultResponse;
+    revert(jobId: string): Promise<AgentJobSnapshot>;
+    subscribe(jobId: string, listener: AgentJobEventListener): () => void;
+    workspaceHealth(signal: AbortSignal): Promise<AgentWorkspaceHealthSnapshot>;
+}
+interface AgentJobManagerDependencies {
+    readonly applyChange: typeof applyPreparedAgentChange;
+    readonly createJobId: () => string;
+    readonly executeChange: typeof executeAgentChange;
+    readonly inspectWorkspace: typeof inspectAgentWorkspace;
+    readonly now: () => string;
+    readonly probeCapability: typeof probeProviderCapability;
+    readonly resolveCredential: typeof resolveProviderCredential;
+    readonly revertChange: typeof revertPreparedAgentChange;
+}
+interface CreateAgentJobManagerOptions {
+    readonly ai: ResolvedAiOptions;
+    readonly dependencies?: Partial<AgentJobManagerDependencies>;
+    readonly environment?: Readonly<Record<string, string | undefined>>;
+    readonly fetch?: typeof globalThis.fetch;
+    readonly root: string;
+}
+declare function createAgentJobManager(options: CreateAgentJobManagerOptions): AgentJobManager;
+
+type FilterEntry = SourceFilterEntry;
+interface SimpleAiOptions {
+    readonly baseURL: string;
+    readonly model: string;
+    readonly apiKeyEnv?: string;
+    readonly protocol?: AiProviderProtocol;
+    readonly authentication?: AiProviderAuthentication;
+    readonly providerLabel?: string;
+    readonly modelLabel?: string;
+    readonly execution?: AiExecutionOptions;
+}
+type SpotPatchAiOptions = false | SimpleAiOptions | AiOptions;
+interface SpotPatchOptions {
+    readonly enabled?: boolean;
+    readonly include?: readonly FilterEntry[];
+    readonly exclude?: readonly FilterEntry[];
+    readonly editor?: SpotPatchEditorPreference;
+    readonly redact?: boolean;
+    readonly budget?: Partial<ContextBudget>;
+    readonly shortcut?: string;
+    readonly allowLan?: boolean;
+    readonly debug?: boolean;
+    readonly locale?: SpotPatchLocalePreference;
+    readonly maxTargets?: number;
+    readonly ai?: SpotPatchAiOptions;
+}
+interface ResolvedSpotPatchOptions {
+    readonly enabled: boolean;
+    readonly include: readonly FilterEntry[];
+    readonly exclude: readonly FilterEntry[];
+    readonly editor: SpotPatchEditorPreference;
+    readonly redact: boolean;
+    readonly budget: Readonly<ContextBudget>;
+    readonly shortcut: string;
+    readonly allowLan: boolean;
+    readonly debug: boolean;
+    readonly locale: SpotPatchLocalePreference;
+    readonly maxTargets: number;
+    readonly ai: false | ResolvedAiOptions;
+}
+declare const DEFAULT_EXCLUDE: readonly RegExp[];
+declare const DEFAULT_OPTIONS: Readonly<{
+    enabled: true;
+    include: readonly RegExp[];
+    exclude: readonly RegExp[];
+    editor: "auto";
+    redact: true;
+    budget: Readonly<{
+        totalCharacters: number;
+        domCharacters: number;
+        cssCharacters: number;
+        codeCharacters: number;
+        maxCodeLines: number;
+        maxComponentDepth: number;
+    }>;
+    shortcut: string;
+    allowLan: false;
+    debug: false;
+    locale: "auto";
+    maxTargets: number;
+    ai: false;
+}>;
+declare function createRuntimeAiConfig(options: false | ResolvedAiOptions): RuntimeAiConfig;
+declare function resolveOptions(options?: SpotPatchOptions, environmentAi?: false | SimpleAiOptions): ResolvedSpotPatchOptions;
+
+interface EnvironmentAiConfiguration {
+    readonly ai: false | SimpleAiOptions;
+}
+declare function resolveCredentialEnvironment(options: ResolvedSpotPatchOptions, environment: Readonly<Record<string, string | undefined>>): Readonly<Record<string, string>>;
+declare function resolveEnvironmentAiConfiguration(environment: Readonly<Record<string, string | undefined>>): EnvironmentAiConfiguration;
+
+type SourceIdFactory = () => string;
+
+interface SourceRegistry {
+    register(absolutePath: string): string;
+    resolve(fileId: string): string | undefined;
+    clear(): void;
+}
+interface SourceRegistryOptions {
+    readonly createId?: SourceIdFactory;
+}
+declare function createSourceRegistry(options?: SourceRegistryOptions): SourceRegistry;
+
+interface SpotPatchSession {
+    readonly token: string;
+}
+declare function createSession(): SpotPatchSession;
+
+type EditorLauncher = (target: string, editor: SpotPatchEditorPreference) => Promise<SpotPatchEditorPreference>;
+
+interface RuntimeBootstrapOptions {
+    readonly expectedOrigin: string;
+    readonly runtimeConfig: SpotPatchRuntimeConfig;
+}
+interface ResolvedRuntimeBootstrapOptions {
+    readonly expectedOrigin: string;
+    readonly runtimeConfig: SpotPatchRuntimeConfig;
+}
+declare function resolveRuntimeBootstrapOptions(options: RuntimeBootstrapOptions): ResolvedRuntimeBootstrapOptions;
+declare function readRuntimeBootstrap(request: IncomingMessage, options: ResolvedRuntimeBootstrapOptions): Promise<SpotPatchRuntimeConfig>;
+
+type SpotPatchNext = (error?: unknown) => void;
+type SpotPatchMiddleware = (request: IncomingMessage, response: ServerResponse, next: SpotPatchNext) => void;
+interface SpotPatchServerLogger {
+    warn(message: string): void;
+}
+interface CreateMiddlewareOptions {
+    readonly agentManager?: AgentJobManager;
+    readonly bootstrap?: RuntimeBootstrapOptions;
+    readonly editorLauncher?: EditorLauncher;
+    readonly logger?: SpotPatchServerLogger;
+    readonly options: ResolvedSpotPatchOptions;
+    readonly registry: SourceRegistry;
+    readonly root: string;
+    readonly session: SpotPatchSession;
+}
+declare function createSpotPatchMiddleware(options: CreateMiddlewareOptions): SpotPatchMiddleware;
+
+declare function readJsonRequestBody(request: IncomingMessage, maximumBytes?: number): Promise<unknown>;
+
+declare function isLoopbackHostname(hostname: string): boolean;
+
+interface SourceRegistrationServiceOptions {
+    readonly internalSecret: string;
+    readonly options: ResolvedSpotPatchOptions;
+    readonly registry: SourceRegistry;
+    readonly registryEpoch: string;
+    readonly root: string;
+}
+type SourceRegistrationHandler = (request: IncomingMessage, response: ServerResponse) => void;
+interface SourceRegistrationService {
+    readonly handler: SourceRegistrationHandler;
+    readonly root: string;
+}
+declare function createSourceRegistrationService(input: SourceRegistrationServiceOptions): Promise<SourceRegistrationService>;
+
+interface SerializedStringFilter {
+    readonly kind: "string";
+    readonly value: string;
+}
+interface SerializedRegExpFilter {
+    readonly flags: string;
+    readonly kind: "regexp";
+    readonly source: string;
+}
+type SerializedFilterEntry = SerializedRegExpFilter | SerializedStringFilter;
+interface SerializedSpotPatchOptions {
+    readonly ai: false | AiOptions;
+    readonly allowLan: boolean;
+    readonly budget: Readonly<ContextBudget>;
+    readonly debug: boolean;
+    readonly editor: SpotPatchEditorPreference;
+    readonly enabled: boolean;
+    readonly exclude: readonly SerializedFilterEntry[];
+    readonly include: readonly SerializedFilterEntry[];
+    readonly locale: SpotPatchLocalePreference;
+    readonly maxTargets: number;
+    readonly redact: boolean;
+    readonly shortcut: string;
+}
+declare function serializeResolvedSpotPatchOptions(options: ResolvedSpotPatchOptions): SerializedSpotPatchOptions;
+declare function parseSerializedSpotPatchOptions(value: unknown): ResolvedSpotPatchOptions;
+
+export { type AgentJobEventListener, type AgentJobManager, type CreateAgentJobManagerOptions, type CreateMiddlewareOptions, DEFAULT_EXCLUDE, DEFAULT_OPTIONS, type EnvironmentAiConfiguration, type FilterEntry, type ResolvedRuntimeBootstrapOptions, type ResolvedSpotPatchOptions, type RuntimeBootstrapOptions, type SerializedFilterEntry, type SerializedSpotPatchOptions, type SimpleAiOptions, type SourceRegistrationHandler, type SourceRegistrationService, type SourceRegistrationServiceOptions, type SourceRegistry, type SpotPatchAiOptions, type SpotPatchMiddleware, type SpotPatchNext, type SpotPatchOptions, type SpotPatchServerLogger, type SpotPatchSession, createAgentJobManager, createRuntimeAiConfig, createSession, createSourceRegistrationService, createSourceRegistry, createSpotPatchMiddleware, isLoopbackHostname, parseSerializedSpotPatchOptions, readJsonRequestBody, readRuntimeBootstrap, resolveCredentialEnvironment, resolveEnvironmentAiConfiguration, resolveOptions, resolveRuntimeBootstrapOptions, serializeResolvedSpotPatchOptions };