@caido/sdk-frontend

This is the reference for the frontend SDK used by frontend plugins. Caido is the main interface that provides access to various services and functionalities.

SDK

Caido

Caido<T, E> = object

Utilities for frontend plugins.

Type Parameters

Type Parameter	Default type
T extends BackendEndpoints	Record<string, never>
E extends BackendEvents	Record<string, never>

Properties

ai

ai: AiSDK

Utilities to interact with AI.

assets

assets: AssetsSDK

Utilities to interact with the plugin's static assets.

automate

automate: AutomateSDK

Utilities to interact with the Automate page.

backend

backend: BackendSDK<T, E>

Utilities to interact with the backend plugin.

commandPalette

commandPalette: CommandPaletteSDK

Utilities to interact with the command palette.

commands

commands: CommandsSDK

Utilities to interact with commands

env

env: EnvironmentSDK

Utilities to interact with the environment.

files

files: FilesSDK

Utilities to interact with the Files page.

filters

filters: FiltersSDK

Utilities to interact with Filters page.

findings

findings: FindingsSDK

Utilities to interact with findings

footer

footer: FooterSDK

Utilities to interact with the footer.

graphql

graphql: GraphqlSDK

Utilities to interact with the GraphQL API.

httpHistory

httpHistory: HTTPHistorySDK

Utilities to interact with the HTTP History page.

intercept

intercept: InterceptSDK

Utilities to interact with the Intercept page.

log

log: LogSDK

Utilities for logging messages to the console.

matchReplace

matchReplace: MatchReplaceSDK

Utilities to interact with Match and Replace page.

menu

menu: MenuSDK

Utilities to insert menu items and context-menus throughout the UI.

navigation

navigation: NavigationSDK

Utilities to interact with navigation.

projects

projects: ProjectsSDK

Utilities to interact with projects.

replay

replay: ReplaySDK

Utilities to interact with the Replay page.

runtime

runtime: RuntimeSDK

Utilities to interact with the runtime.

scopes

scopes: ScopesSDK

Utilities to interact with scopes

search

search: SearchSDK

Utilities to interact with the Search page.

settings

settings: SettingsSDK

Utilities to interact with the settings page.

shortcuts

shortcuts: ShortcutsSDK

Utilities to interact with shortcuts.

sidebar

sidebar: SidebarSDK

Utilities to interact with the sidebar.

sitemap

sitemap: SitemapSDK

Utilities to interact with the Sitemap page.

storage

storage: StorageSDK

Utilities to interact with frontend-plugin storage.

ui

ui: UISDK

Utilities to create UI components.

window

window: WindowSDK

Utilities to interact with the active page.

workflows

workflows: WorkflowSDK

Utilities to interact with workflows.

API Reference

• Backend
• UI
• Scopes
• Findings
• Commands
• Menu
• Navigation
• Window
• Storage
• Shortcuts
• Command Palette
• Sidebar
• Replay
• HTTP History
• Search
• Files
• AI
• Assistant
• Automate
• Backups
• Certificate
• Editor
• Environment
• Exports
• Filter
• Filters
• Footer
• Intercept
• JSON
• Log
• Match and Replace
• Other
• Projects
• Request
• Response
• Runtime
• Settings
• Sitemap
• Slots
• Utils
• Websockets
• Workflows