UNPKG

@yaakapp/api

Version:

Yaak is a desktop [API client](https://yaak.app/blog/yet-another-api-client) for interacting with REST, GraphQL, Server Sent Events (SSE), WebSocket, and gRPC APIs. It's built using Tauri, Rust, and ReactJS.

36 lines (35 loc) 1.75 kB
import type { AuthenticationPlugin } from './AuthenticationPlugin'; import type { Context } from './Context'; import type { FilterPlugin } from './FilterPlugin'; import type { FolderActionPlugin } from './FolderActionPlugin'; import type { GrpcRequestActionPlugin } from './GrpcRequestActionPlugin'; import type { HttpRequestActionPlugin } from './HttpRequestActionPlugin'; import type { ImporterPlugin } from './ImporterPlugin'; import type { TemplateFunctionPlugin } from './TemplateFunctionPlugin'; import type { ThemePlugin } from './ThemePlugin'; import type { WebsocketRequestActionPlugin } from './WebsocketRequestActionPlugin'; import type { WorkspaceActionPlugin } from './WorkspaceActionPlugin'; export type { Context }; export type { DynamicAuthenticationArg } from './AuthenticationPlugin'; export type { CallPromptFormDynamicArgs, DynamicPromptFormArg } from './Context'; export type { DynamicTemplateFunctionArg } from './TemplateFunctionPlugin'; export type { TemplateFunctionPlugin }; export type { FolderActionPlugin } from './FolderActionPlugin'; export type { WorkspaceActionPlugin } from './WorkspaceActionPlugin'; /** * The global structure of a Yaak plugin */ export type PluginDefinition = { init?: (ctx: Context) => void | Promise<void>; dispose?: () => void | Promise<void>; importer?: ImporterPlugin; themes?: ThemePlugin[]; filter?: FilterPlugin; authentication?: AuthenticationPlugin; httpRequestActions?: HttpRequestActionPlugin[]; websocketRequestActions?: WebsocketRequestActionPlugin[]; workspaceActions?: WorkspaceActionPlugin[]; folderActions?: FolderActionPlugin[]; grpcRequestActions?: GrpcRequestActionPlugin[]; templateFunctions?: TemplateFunctionPlugin[]; };