Caido
GuidesTutorialsReferenceConcepts

@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 ParameterDefault type
T extends BackendEndpoints | BackendSpecRecord<string, never>
E extends BackendEventsRecord<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: FooterSDK

Utilities to interact with the footer.

graphql ​

graphql: GraphqlSDK

Utilities to interact with the GraphQL API.

Queries and mutations return a promise; subscriptions return an AsyncIterable. On success they resolve with the response data or yield it. On failure (network error or any GraphQL errors returned by the server) the promise rejects, or the iterator throws into the for await loop, with the underlying error. Failures can be handled with try/ catch or .catch().

Example ​
ts
try {
  const result = await sdk.graphql.automateEntry({ id: "1" });
  // use result
} catch (err) {
  // err.message, err.graphQLErrors, err.networkError
}
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: MenuSDK

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

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: 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: 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.

websocket ​

websocket: WebsocketSDK

Utilities to interact with the Websocket page.

window ​

window: WindowSDK

Utilities to interact with the active page.

workflows ​

workflows: WorkflowSDK

Utilities to interact with workflows.

API Reference ​