@rtrvr-ai/rover 3.0.0 → 4.0.0

package/dist/agentDiscovery.d.ts

@@ -0,0 +1,304 @@
+import type { RoverShortcut } from '@rover/ui';
+import { createRoverAgentDiscoverySnapshot } from '@rover/shared/lib/agent-discovery.js';
+import type { RoverAgentDiscoverySnapshot } from '@rover/shared/lib/types/index.js';
+export declare const DEFAULT_AGENT_CARD_PATH = "/.well-known/agent-card.json";
+export declare const DEFAULT_ROVER_SITE_PATH = "/.well-known/rover-site.json";
+export declare const DEFAULT_LLMS_PATH = "/llms.txt";
+export declare const ROVER_WEBMCP_DISCOVERY_GLOBAL = "__ROVER_WEBMCP_TOOL_DEFS__";
+export declare const ROVER_DISCOVERY_ACTION_SHEET_MAX_ACTIONS = 3;
+type JsonSchema = Record<string, any>;
+export type RoverDiscoveryExecutionPreference = 'auto' | 'browser' | 'cloud';
+export type RoverDiscoverySurfaceMode = 'silent' | 'beacon' | 'integrated' | 'debug';
+export type RoverDiscoverySurfaceBranding = 'site' | 'co' | 'rover';
+export type RoverDiscoveryHostSurface = 'auto' | 'existing-assistant' | 'floating-corner' | 'inline-primary';
+export type RoverDiscoveryActionReveal = 'click' | 'focus' | 'keyboard' | 'agent-handshake';
+export type RoverCapabilityResultMode = 'text' | 'markdown' | 'json' | 'observation' | 'artifacts';
+export type RoverSkillSideEffect = 'none' | 'read' | 'write' | 'transactional';
+export type RoverSkillInterface = 'task' | 'shortcut' | 'client_tool' | 'webmcp';
+export type RoverDiscoverySurfacePolicy = {
+    mode?: RoverDiscoverySurfaceMode;
+    branding?: RoverDiscoverySurfaceBranding;
+    hostSurface?: RoverDiscoveryHostSurface;
+    actionReveal?: RoverDiscoveryActionReveal;
+    beaconLabel?: string;
+    agentModeEntryHints?: string[];
+};
+export type RoverToolAnnotations = {
+    category?: string;
+    tags?: string[];
+    examples?: string[];
+    whenToUse?: string;
+    whyUse?: string;
+    sideEffect?: RoverSkillSideEffect;
+    requiresConfirmation?: boolean;
+    preferredInterface?: RoverSkillInterface;
+    priority?: 'primary' | 'secondary';
+};
+export type RoverAgentDiscoveryToolDefinition = {
+    name: string;
+    title?: string;
+    description?: string;
+    parameters?: Record<string, any>;
+    required?: string[];
+    schema?: JsonSchema;
+    outputSchema?: JsonSchema;
+    llmCallable?: boolean;
+    annotations?: RoverToolAnnotations | Record<string, any>;
+};
+export type RoverPublicSkillDefinition = {
+    id: string;
+    name: string;
+    description: string;
+    tags?: string[];
+    examples?: string[];
+    inputSchema?: JsonSchema;
+    outputSchema?: JsonSchema;
+    sideEffect?: RoverSkillSideEffect;
+    requiresConfirmation?: boolean;
+    preferredInterface?: RoverSkillInterface;
+    category?: 'primary' | 'secondary';
+    rover?: {
+        shortcutId?: string;
+        prompt?: string;
+        routing?: 'auto' | 'act' | 'planner';
+        toolName?: string;
+        task?: {
+            endpoint: string;
+            payload: Record<string, unknown>;
+            preferExecution: RoverDiscoveryExecutionPreference;
+        };
+        deepLink?: string;
+        source?: 'shortcut' | 'client_tool' | 'webmcp' | 'additional';
+    };
+};
+export type RoverCapabilityRecord = {
+    capabilityId: string;
+    version: string;
+    label: string;
+    description: string;
+    inputSchema?: JsonSchema;
+    outputSchema?: JsonSchema;
+    sideEffect?: RoverSkillSideEffect;
+    requiresConfirmation?: boolean;
+    preferredInterface?: RoverSkillInterface;
+    allowedExecutionModes: RoverDiscoveryExecutionPreference[];
+    resultModes: RoverCapabilityResultMode[];
+    pageScope?: string[];
+    analyticsTags?: string[];
+    rover?: RoverPublicSkillDefinition['rover'];
+};
+export type RoverPageDefinition = {
+    pageId: string;
+    route?: string;
+    label?: string;
+    capabilityIds?: string[];
+    entityHints?: string[];
+    formHints?: string[];
+    visibleCueLabel?: string;
+    beaconLabel?: string;
+    discoveryMode?: RoverDiscoverySurfaceMode;
+    hostSurface?: RoverDiscoveryHostSurface;
+    actionReveal?: RoverDiscoveryActionReveal;
+    agentModeEntryHints?: string[];
+    capabilitySummary?: string[];
+};
+export type RoverSiteProfile = {
+    identity: {
+        siteId?: string;
+        name: string;
+        description: string;
+        siteUrl: string;
+        version: string;
+    };
+    actions: RoverCapabilityRecord[];
+    pages: RoverPageDefinition[];
+    policies: {
+        preferredExecution: RoverDiscoveryExecutionPreference;
+        promptLaunchEnabled: boolean;
+        shortcutLaunchEnabled: boolean;
+        cloudBrowserAllowed: boolean;
+        delegatedHandoffs: boolean;
+    };
+    auth: {
+        taskEndpoint: string;
+        workflowEndpoint: string;
+        acceptsHttpMessageSignatures: boolean;
+        supportsUnsignedSelfReportedIdentity: boolean;
+    };
+    analytics: {
+        layer: 'roverbook';
+        taskIdField: 'taskId';
+        workflowIdField: 'workflowId';
+        capabilityIdField: 'capabilityId';
+        pageIdField: 'pageId';
+    };
+    currentPage?: RoverPageDefinition;
+    display: {
+        mode: RoverDiscoverySurfaceMode;
+        branding: RoverDiscoverySurfaceBranding;
+        hostSurface: RoverDiscoveryHostSurface;
+        actionReveal: RoverDiscoveryActionReveal;
+        beaconLabel?: string;
+        agentModeEntryHints: string[];
+        compactActionMaxActions: number;
+    };
+    artifacts: {
+        agentCardUrl: string;
+        roverSiteUrl: string;
+        llmsUrl?: string;
+        siteUrl: string;
+    };
+    interfaces?: RoverAgentCard['interfaces'];
+};
+export type RoverAgentCard = {
+    name: string;
+    description: string;
+    url: string;
+    version: string;
+    defaultInputModes: string[];
+    defaultOutputModes: string[];
+    capabilities: {
+        streaming: boolean;
+        publicTasks: boolean;
+        stateTransitions: boolean;
+        delegatedHandoffs: boolean;
+        webmcp: boolean;
+    };
+    skills: RoverPublicSkillDefinition[];
+    interfaces?: Array<{
+        type: 'task' | 'workflow' | 'site' | 'deep_link' | 'webmcp';
+        url: string;
+        description?: string;
+        available?: boolean;
+    }>;
+    extensions?: {
+        rover: {
+            siteId?: string;
+            siteUrl: string;
+            taskEndpoint: string;
+            workflowEndpoint: string;
+            serviceDescUrl: string;
+            roverSiteUrl: string;
+            llmsUrl?: string;
+            preferredExecution: RoverDiscoveryExecutionPreference;
+            promptLaunchEnabled: boolean;
+            shortcutLaunchEnabled: boolean;
+            cloudBrowserAllowed: boolean;
+            delegatedHandoffs: boolean;
+            instructions: string[];
+            capabilitiesGraph: RoverCapabilityRecord[];
+            pages: RoverPageDefinition[];
+            currentPage?: RoverPageDefinition;
+            discoverySurface: {
+                mode: RoverDiscoverySurfaceMode;
+                branding: RoverDiscoverySurfaceBranding;
+                hostSurface: RoverDiscoveryHostSurface;
+                actionReveal: RoverDiscoveryActionReveal;
+                beaconLabel?: string;
+                agentModeEntryHints: string[];
+                compactActionMaxActions: number;
+            };
+            shortcuts: Array<{
+                id: string;
+                label: string;
+                description?: string;
+                prompt: string;
+                routing?: 'auto' | 'act' | 'planner';
+            }>;
+            webmcp: {
+                available: boolean;
+                tools: string[];
+            };
+        };
+    };
+};
+export type RoverAgentDiscoveryConfig = {
+    enabled?: boolean;
+    siteUrl: string;
+    siteId?: string;
+    apiBase?: string;
+    siteName?: string;
+    description?: string;
+    version?: string;
+    agentCardUrl?: string;
+    roverSiteUrl?: string;
+    llmsUrl?: string;
+    visibleCue?: boolean;
+    discoverySurface?: RoverDiscoverySurfacePolicy;
+    hostSurfaceSelector?: string;
+    preferExecution?: RoverDiscoveryExecutionPreference;
+    shortcuts?: RoverShortcut[];
+    tools?: RoverAgentDiscoveryToolDefinition[];
+    webmcpTools?: RoverAgentDiscoveryToolDefinition[];
+    additionalSkills?: RoverPublicSkillDefinition[];
+    capabilities?: RoverCapabilityRecord[];
+    pages?: RoverPageDefinition[];
+    pageContext?: Omit<RoverPageDefinition, 'capabilityIds'> & {
+        capabilityIds?: string[];
+    };
+    aiAccess?: {
+        enabled?: boolean;
+        allowPromptLaunch?: boolean;
+        allowShortcutLaunch?: boolean;
+        allowCloudBrowser?: boolean;
+        allowDelegatedHandoffs?: boolean;
+    };
+};
+export type RoverAgentDiscoveryRuntimeConfig = Omit<RoverAgentDiscoveryConfig, 'siteUrl'> & {
+    siteUrl?: string;
+};
+export declare function sanitizeRoverAgentDiscoveryRuntimeConfig(raw: unknown): RoverAgentDiscoveryRuntimeConfig | undefined;
+export declare function createRoverAgentCard(config: RoverAgentDiscoveryConfig): RoverAgentCard;
+export declare function createRoverSiteProfile(config: RoverAgentDiscoveryConfig): RoverSiteProfile;
+export declare function buildRoverAgentDiscoveryPayloads(config: RoverAgentDiscoveryConfig): {
+    card: RoverAgentCard;
+    cardJson: string;
+    serviceDescHref: string;
+    roverSite: RoverSiteProfile;
+    roverSiteJson: string;
+    roverSiteHref: string;
+    pageManifest: RoverPageDefinition;
+    pageManifestJson: string;
+    llmsUrl?: string;
+    marker: {
+        task?: string;
+        card: string;
+        roverSite: string;
+        site?: string;
+        workflow?: string;
+        page?: string;
+        preferExecution?: RoverDiscoveryExecutionPreference;
+        discoveryMode?: RoverDiscoverySurfaceMode;
+        hostSurface?: RoverDiscoveryHostSurface;
+        actionReveal?: RoverDiscoveryActionReveal;
+        beaconLabel?: string;
+        skills: Array<{
+            id: string;
+            name: string;
+        }>;
+        capabilities: Array<{
+            capabilityId: string;
+            label: string;
+        }>;
+    };
+    markerJson: string;
+};
+export declare function createRoverAgentCardJson(config: RoverAgentDiscoveryConfig, options?: {
+    pretty?: boolean;
+}): string;
+export declare function createRoverWellKnownAgentCard(config: RoverAgentDiscoveryConfig, options?: {
+    pretty?: boolean;
+}): string;
+export declare function createRoverSiteProfileJson(config: RoverAgentDiscoveryConfig, options?: {
+    pretty?: boolean;
+}): string;
+export declare function createRoverWellKnownSiteProfile(config: RoverAgentDiscoveryConfig, options?: {
+    pretty?: boolean;
+}): string;
+export declare function createRoverServiceDescLinkHeader(config: {
+    agentCardUrl?: string;
+    llmsUrl?: string;
+}): string;
+export declare function createRoverAgentDiscoveryTags(config: RoverAgentDiscoveryConfig): string;
+export { createRoverAgentDiscoverySnapshot };
+export type { RoverAgentDiscoverySnapshot };