@yaakapp/api 0.6.6 → 0.8.0

package/README.md

@@ -17,7 +17,7 @@ npx @yaakapp/cli generate
 ```
 
 For more details on creating plugins, check out
-the [Quick Start Guide](https://feedback.yaak.app/help/articles/6911763-plugins-quick-start)
+the [Quick Start Guide](https://yaak.app/docs/plugin-development/plugins-quick-start)
 
 ## Installation
 

package/lib/bindings/gen_events.d.ts

@@ -1,12 +1,25 @@
-import type { Environment, Folder, GrpcRequest, HttpRequest, HttpResponse, WebsocketRequest, Workspace } from "./gen_models.js";
-import type { JsonValue } from "./serde_json/JsonValue.js";
+import type { AnyModel, Environment, Folder, GrpcRequest, HttpRequest, HttpResponse, WebsocketRequest, Workspace } from "./gen_models";
+import type { JsonValue } from "./serde_json/JsonValue";
 export type BootRequest = {
     dir: string;
     watch: boolean;
 };
-export type BootResponse = {
-    name: string;
-    version: string;
+export type CallFolderActionArgs = {
+    folder: Folder;
+};
+export type CallFolderActionRequest = {
+    index: number;
+    pluginRefId: string;
+    args: CallFolderActionArgs;
+};
+export type CallGrpcRequestActionArgs = {
+    grpcRequest: GrpcRequest;
+    protoFiles: Array<string>;
+};
+export type CallGrpcRequestActionRequest = {
+    index: number;
+    pluginRefId: string;
+    args: CallGrpcRequestActionArgs;
 };
 export type CallHttpAuthenticationActionArgs = {
     contextId: string;
@@ -33,7 +46,12 @@ export type CallHttpAuthenticationResponse = {
      * HTTP headers to add to the request. Existing headers will be replaced, while
      * new headers will be added.
      */
-    setHeaders: Array<HttpHeader>;
+    setHeaders?: Array<HttpHeader>;
+    /**
+     * Query parameters to add to the request. Existing params will be replaced, while
+     * new params will be added.
+     */
+    setQueryParameters?: Array<HttpHeader>;
 };
 export type CallHttpRequestActionArgs = {
     httpRequest: HttpRequest;
@@ -46,7 +64,7 @@ export type CallHttpRequestActionRequest = {
 export type CallTemplateFunctionArgs = {
     purpose: RenderPurpose;
     values: {
-        [key in string]?: JsonValue;
+        [key in string]?: JsonPrimitive;
     };
 };
 export type CallTemplateFunctionRequest = {
@@ -55,6 +73,23 @@ export type CallTemplateFunctionRequest = {
 };
 export type CallTemplateFunctionResponse = {
     value: string | null;
+    error?: string;
+};
+export type CallWebsocketRequestActionArgs = {
+    websocketRequest: WebsocketRequest;
+};
+export type CallWebsocketRequestActionRequest = {
+    index: number;
+    pluginRefId: string;
+    args: CallWebsocketRequestActionArgs;
+};
+export type CallWorkspaceActionArgs = {
+    workspace: Workspace;
+};
+export type CallWorkspaceActionRequest = {
+    index: number;
+    pluginRefId: string;
+    args: CallWorkspaceActionArgs;
 };
 export type CloseWindowRequest = {
     label: string;
@@ -77,6 +112,13 @@ export type DeleteKeyValueRequest = {
 export type DeleteKeyValueResponse = {
     deleted: boolean;
 };
+export type DeleteModelRequest = {
+    model: string;
+    id: string;
+};
+export type DeleteModelResponse = {
+    model: AnyModel;
+};
 export type EditorLanguage = "text" | "javascript" | "json" | "html" | "xml" | "graphql" | "markdown";
 export type EmptyPayload = {};
 export type ErrorResponse = {
@@ -101,6 +143,7 @@ export type FilterRequest = {
 };
 export type FilterResponse = {
     content: string;
+    error?: string;
 };
 export type FindHttpResponsesRequest = {
     requestId: string;
@@ -109,6 +152,10 @@ export type FindHttpResponsesRequest = {
 export type FindHttpResponsesResponse = {
     httpResponses: Array<HttpResponse>;
 };
+export type FolderAction = {
+    label: string;
+    icon?: Icon;
+};
 export type FormInput = {
     "type": "text";
 } & FormInputText | {
@@ -124,10 +171,14 @@ export type FormInput = {
 } & FormInputHttpRequest | {
     "type": "accordion";
 } & FormInputAccordion | {
+    "type": "h_stack";
+} & FormInputHStack | {
     "type": "banner";
 } & FormInputBanner | {
     "type": "markdown";
-} & FormInputMarkdown;
+} & FormInputMarkdown | {
+    "type": "key_value";
+} & FormInputKeyValue;
 export type FormInputAccordion = {
     label: string;
     inputs?: Array<FormInput>;
@@ -291,6 +342,10 @@ export type FormInputFile = {
      */
     description?: string;
 };
+export type FormInputHStack = {
+    inputs?: Array<FormInput>;
+    hidden?: boolean;
+};
 export type FormInputHttpRequest = {
     /**
      * The name of the input. The value will be stored at this object attribute in the resulting data
@@ -323,6 +378,38 @@ export type FormInputHttpRequest = {
      */
     description?: string;
 };
+export type FormInputKeyValue = {
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
+    name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
+    /**
+     * Whether the user must fill in the argument
+     */
+    optional?: boolean;
+    /**
+     * The label of the input
+     */
+    label?: string;
+    /**
+     * Visually hide the label of the input
+     */
+    hideLabel?: boolean;
+    /**
+     * The default value
+     */
+    defaultValue?: string;
+    disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
+};
 export type FormInputMarkdown = {
     content: string;
     hidden?: boolean;
@@ -425,6 +512,14 @@ export type GetCookieValueRequest = {
 export type GetCookieValueResponse = {
     value: string | null;
 };
+export type GetFolderActionsResponse = {
+    actions: Array<FolderAction>;
+    pluginRefId: string;
+};
+export type GetGrpcRequestActionsResponse = {
+    actions: Array<GrpcRequestAction>;
+    pluginRefId: string;
+};
 export type GetHttpAuthenticationConfigRequest = {
     contextId: string;
     values: {
@@ -441,7 +536,6 @@ export type GetHttpAuthenticationSummaryResponse = {
     label: string;
     shortLabel: string;
 };
-export type GetHttpRequestActionsRequest = Record<string, never>;
 export type GetHttpRequestActionsResponse = {
     actions: Array<HttpRequestAction>;
     pluginRefId: string;
@@ -458,7 +552,18 @@ export type GetKeyValueRequest = {
 export type GetKeyValueResponse = {
     value?: string;
 };
-export type GetTemplateFunctionsResponse = {
+export type GetTemplateFunctionConfigRequest = {
+    contextId: string;
+    name: string;
+    values: {
+        [key in string]?: JsonPrimitive;
+    };
+};
+export type GetTemplateFunctionConfigResponse = {
+    function: TemplateFunction;
+    pluginRefId: string;
+};
+export type GetTemplateFunctionSummaryResponse = {
     functions: Array<TemplateFunction>;
     pluginRefId: string;
 };
@@ -466,6 +571,18 @@ export type GetThemesRequest = Record<string, never>;
 export type GetThemesResponse = {
     themes: Array<Theme>;
 };
+export type GetWebsocketRequestActionsResponse = {
+    actions: Array<WebsocketRequestAction>;
+    pluginRefId: string;
+};
+export type GetWorkspaceActionsResponse = {
+    actions: Array<WorkspaceAction>;
+    pluginRefId: string;
+};
+export type GrpcRequestAction = {
+    label: string;
+    icon?: Icon;
+};
 export type HttpAuthenticationAction = {
     label: string;
     icon?: Icon;
@@ -498,18 +615,16 @@ export type InternalEvent = {
     pluginRefId: string;
     pluginName: string;
     replyId: string | null;
-    windowContext: PluginWindowContext;
+    context: PluginContext;
     payload: InternalEventPayload;
 };
 export type InternalEventPayload = {
     "type": "boot_request";
 } & BootRequest | {
     "type": "boot_response";
-} & BootResponse | {
-    "type": "reload_request";
-} & EmptyPayload | {
+} | {
     "type": "reload_response";
-} & BootResponse | {
+} & ReloadResponse | {
     "type": "terminate_request";
 } | {
     "type": "terminate_response";
@@ -544,10 +659,38 @@ export type InternalEventPayload = {
 } & GetHttpRequestActionsResponse | {
     "type": "call_http_request_action_request";
 } & CallHttpRequestActionRequest | {
-    "type": "get_template_functions_request";
-} | {
-    "type": "get_template_functions_response";
-} & GetTemplateFunctionsResponse | {
+    "type": "get_websocket_request_actions_request";
+} & EmptyPayload | {
+    "type": "get_websocket_request_actions_response";
+} & GetWebsocketRequestActionsResponse | {
+    "type": "call_websocket_request_action_request";
+} & CallWebsocketRequestActionRequest | {
+    "type": "get_workspace_actions_request";
+} & EmptyPayload | {
+    "type": "get_workspace_actions_response";
+} & GetWorkspaceActionsResponse | {
+    "type": "call_workspace_action_request";
+} & CallWorkspaceActionRequest | {
+    "type": "get_folder_actions_request";
+} & EmptyPayload | {
+    "type": "get_folder_actions_response";
+} & GetFolderActionsResponse | {
+    "type": "call_folder_action_request";
+} & CallFolderActionRequest | {
+    "type": "get_grpc_request_actions_request";
+} & EmptyPayload | {
+    "type": "get_grpc_request_actions_response";
+} & GetGrpcRequestActionsResponse | {
+    "type": "call_grpc_request_action_request";
+} & CallGrpcRequestActionRequest | {
+    "type": "get_template_function_summary_request";
+} & EmptyPayload | {
+    "type": "get_template_function_summary_response";
+} & GetTemplateFunctionSummaryResponse | {
+    "type": "get_template_function_config_request";
+} & GetTemplateFunctionConfigRequest | {
+    "type": "get_template_function_config_response";
+} & GetTemplateFunctionConfigResponse | {
     "type": "call_template_function_request";
 } & CallTemplateFunctionRequest | {
     "type": "call_template_function_response";
@@ -576,6 +719,14 @@ export type InternalEventPayload = {
 } & RenderHttpRequestRequest | {
     "type": "render_http_request_response";
 } & RenderHttpRequestResponse | {
+    "type": "render_grpc_request_request";
+} & RenderGrpcRequestRequest | {
+    "type": "render_grpc_request_response";
+} & RenderGrpcRequestResponse | {
+    "type": "template_render_request";
+} & TemplateRenderRequest | {
+    "type": "template_render_response";
+} & TemplateRenderResponse | {
     "type": "get_key_value_request";
 } & GetKeyValueRequest | {
     "type": "get_key_value_response";
@@ -596,10 +747,10 @@ export type InternalEventPayload = {
 } | {
     "type": "close_window_request";
 } & CloseWindowRequest | {
-    "type": "template_render_request";
-} & TemplateRenderRequest | {
-    "type": "template_render_response";
-} & TemplateRenderResponse | {
+    "type": "open_external_url_request";
+} & OpenExternalUrlRequest | {
+    "type": "open_external_url_response";
+} & EmptyPayload | {
     "type": "show_toast_request";
 } & ShowToastRequest | {
     "type": "show_toast_response";
@@ -608,6 +759,18 @@ export type InternalEventPayload = {
 } & PromptTextRequest | {
     "type": "prompt_text_response";
 } & PromptTextResponse | {
+    "type": "prompt_form_request";
+} & PromptFormRequest | {
+    "type": "prompt_form_response";
+} & PromptFormResponse | {
+    "type": "window_info_request";
+} & WindowInfoRequest | {
+    "type": "window_info_response";
+} & WindowInfoResponse | {
+    "type": "list_workspaces_request";
+} & ListWorkspacesRequest | {
+    "type": "list_workspaces_response";
+} & ListWorkspacesResponse | {
     "type": "get_http_request_by_id_request";
 } & GetHttpRequestByIdRequest | {
     "type": "get_http_request_by_id_response";
@@ -616,6 +779,22 @@ export type InternalEventPayload = {
 } & FindHttpResponsesRequest | {
     "type": "find_http_responses_response";
 } & FindHttpResponsesResponse | {
+    "type": "list_http_requests_request";
+} & ListHttpRequestsRequest | {
+    "type": "list_http_requests_response";
+} & ListHttpRequestsResponse | {
+    "type": "list_folders_request";
+} & ListFoldersRequest | {
+    "type": "list_folders_response";
+} & ListFoldersResponse | {
+    "type": "upsert_model_request";
+} & UpsertModelRequest | {
+    "type": "upsert_model_response";
+} & UpsertModelResponse | {
+    "type": "delete_model_request";
+} & DeleteModelRequest | {
+    "type": "delete_model_response";
+} & DeleteModelResponse | {
     "type": "get_themes_request";
 } & GetThemesRequest | {
     "type": "get_themes_response";
@@ -629,6 +808,23 @@ export type ListCookieNamesRequest = {};
 export type ListCookieNamesResponse = {
     names: Array<string>;
 };
+export type ListFoldersRequest = {};
+export type ListFoldersResponse = {
+    folders: Array<Folder>;
+};
+export type ListHttpRequestsRequest = {
+    folderId?: string;
+};
+export type ListHttpRequestsResponse = {
+    httpRequests: Array<HttpRequest>;
+};
+export type ListWorkspacesRequest = Record<string, never>;
+export type ListWorkspacesResponse = {
+    workspaces: Array<WorkspaceInfo>;
+};
+export type OpenExternalUrlRequest = {
+    url: string;
+};
 export type OpenWindowRequest = {
     url: string;
     /**
@@ -639,12 +835,23 @@ export type OpenWindowRequest = {
     size?: WindowSize;
     dataDirKey?: string;
 };
-export type PluginWindowContext = {
-    "type": "none";
-} | {
-    "type": "label";
-    label: string;
-    workspace_id: string | null;
+export type PluginContext = {
+    id: string;
+    label: string | null;
+    workspaceId: string | null;
+};
+export type PromptFormRequest = {
+    id: string;
+    title: string;
+    description?: string;
+    inputs: Array<FormInput>;
+    confirmText?: string;
+    cancelText?: string;
+};
+export type PromptFormResponse = {
+    values: {
+        [key in string]?: JsonPrimitive;
+    } | null;
 };
 export type PromptTextRequest = {
     id: string;
@@ -657,6 +864,7 @@ export type PromptTextRequest = {
      * Text to add to the confirmation button
      */
     confirmText?: string;
+    password?: boolean;
     /**
      * Text to add to the cancel button
      */
@@ -669,6 +877,16 @@ export type PromptTextRequest = {
 export type PromptTextResponse = {
     value: string | null;
 };
+export type ReloadResponse = {
+    silent: boolean;
+};
+export type RenderGrpcRequestRequest = {
+    grpcRequest: GrpcRequest;
+    purpose: RenderPurpose;
+};
+export type RenderGrpcRequestResponse = {
+    grpcRequest: GrpcRequest;
+};
 export type RenderHttpRequestRequest = {
     httpRequest: HttpRequest;
     purpose: RenderPurpose;
@@ -692,9 +910,11 @@ export type ShowToastRequest = {
     message: string;
     color?: Color;
     icon?: Icon;
+    timeout?: number;
 };
 export type TemplateFunction = {
     name: string;
+    previewType?: TemplateFunctionPreviewType;
     description?: string;
     /**
      * Also support alternative names. This is useful for not breaking existing
@@ -702,11 +922,16 @@ export type TemplateFunction = {
      */
     aliases?: Array<string>;
     args: Array<TemplateFunctionArg>;
+    /**
+     * A list of arg names to show in the inline preview. If not provided, none will be shown (for privacy reasons).
+     */
+    previewArgs?: Array<string>;
 };
 /**
  * Similar to FormInput, but contains
  */
 export type TemplateFunctionArg = FormInput;
+export type TemplateFunctionPreviewType = "live" | "click" | "none";
 export type TemplateRenderRequest = {
     data: JsonValue;
     purpose: RenderPurpose;
@@ -771,6 +996,25 @@ export type ThemeComponents = {
     editor?: ThemeComponentColors;
     input?: ThemeComponentColors;
 };
+export type UpsertModelRequest = {
+    model: AnyModel;
+};
+export type UpsertModelResponse = {
+    model: AnyModel;
+};
+export type WebsocketRequestAction = {
+    label: string;
+    icon?: Icon;
+};
+export type WindowInfoRequest = {
+    label: string;
+};
+export type WindowInfoResponse = {
+    requestId: string | null;
+    environmentId: string | null;
+    workspaceId: string | null;
+    label: string;
+};
 export type WindowNavigateEvent = {
     url: string;
 };
@@ -778,3 +1022,11 @@ export type WindowSize = {
     width: number;
     height: number;
 };
+export type WorkspaceAction = {
+    label: string;
+    icon?: Icon;
+};
+export type WorkspaceInfo = {
+    id: string;
+    name: string;
+};

package/lib/bindings/gen_models.d.ts

@@ -1,3 +1,46 @@
+export type AnyModel = CookieJar | Environment | Folder | GraphQlIntrospection | GrpcConnection | GrpcEvent | GrpcRequest | HttpRequest | HttpResponse | HttpResponseEvent | KeyValue | Plugin | Settings | SyncState | WebsocketConnection | WebsocketEvent | WebsocketRequest | Workspace | WorkspaceMeta;
+export type ClientCertificate = {
+    host: string;
+    port: number | null;
+    crtFile: string | null;
+    keyFile: string | null;
+    pfxFile: string | null;
+    passphrase: string | null;
+    enabled?: boolean;
+};
+export type Cookie = {
+    raw_cookie: string;
+    domain: CookieDomain;
+    expires: CookieExpires;
+    path: [string, boolean];
+};
+export type CookieDomain = {
+    "HostOnly": string;
+} | {
+    "Suffix": string;
+} | "NotPresent" | "Empty";
+export type CookieExpires = {
+    "AtUtc": string;
+} | "SessionEnd";
+export type CookieJar = {
+    model: "cookie_jar";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    workspaceId: string;
+    cookies: Array<Cookie>;
+    name: string;
+};
+export type DnsOverride = {
+    hostname: string;
+    ipv4: Array<string>;
+    ipv6: Array<string>;
+    enabled?: boolean;
+};
+export type EditorKeymap = "default" | "vim" | "vscode" | "emacs";
+export type EncryptedKey = {
+    encryptedKey: string;
+};
 export type Environment = {
     model: "environment";
     id: string;
@@ -6,9 +49,11 @@ export type Environment = {
     updatedAt: string;
     name: string;
     public: boolean;
-    base: boolean;
+    parentModel: string;
+    parentId: string | null;
     variables: Array<EnvironmentVariable>;
     color: string | null;
+    sortPriority: number;
 };
 export type EnvironmentVariable = {
     enabled?: boolean;
@@ -30,6 +75,51 @@ export type Folder = {
     name: string;
     sortPriority: number;
 };
+export type GraphQlIntrospection = {
+    model: "graphql_introspection";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    workspaceId: string;
+    requestId: string;
+    content: string | null;
+};
+export type GrpcConnection = {
+    model: "grpc_connection";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    workspaceId: string;
+    requestId: string;
+    elapsed: number;
+    error: string | null;
+    method: string;
+    service: string;
+    status: number;
+    state: GrpcConnectionState;
+    trailers: {
+        [key in string]?: string;
+    };
+    url: string;
+};
+export type GrpcConnectionState = "initialized" | "connected" | "closed";
+export type GrpcEvent = {
+    model: "grpc_event";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    workspaceId: string;
+    requestId: string;
+    connectionId: string;
+    content: string;
+    error: string | null;
+    eventType: GrpcEventType;
+    metadata: {
+        [key in string]?: string;
+    };
+    status: number | null;
+};
+export type GrpcEventType = "info" | "error" | "client_message" | "server_message" | "connection_start" | "connection_end";
 export type GrpcRequest = {
     model: "grpc_request";
     id: string;
@@ -82,17 +172,76 @@ export type HttpResponse = {
     requestId: string;
     bodyPath: string | null;
     contentLength: number | null;
+    contentLengthCompressed: number | null;
     elapsed: number;
     elapsedHeaders: number;
+    elapsedDns: number;
     error: string | null;
     headers: Array<HttpResponseHeader>;
     remoteAddr: string | null;
+    requestContentLength: number | null;
+    requestHeaders: Array<HttpResponseHeader>;
     status: number;
     statusReason: string | null;
     state: HttpResponseState;
     url: string;
     version: string | null;
 };
+export type HttpResponseEvent = {
+    model: "http_response_event";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    workspaceId: string;
+    responseId: string;
+    event: HttpResponseEventData;
+};
+/**
+ * Serializable representation of HTTP response events for DB storage.
+ * This mirrors `yaak_http::sender::HttpResponseEvent` but with serde support.
+ * The `From` impl is in yaak-http to avoid circular dependencies.
+ */
+export type HttpResponseEventData = {
+    "type": "setting";
+    name: string;
+    value: string;
+} | {
+    "type": "info";
+    message: string;
+} | {
+    "type": "redirect";
+    url: string;
+    status: number;
+    behavior: string;
+} | {
+    "type": "send_url";
+    method: string;
+    path: string;
+} | {
+    "type": "receive_url";
+    version: string;
+    status: string;
+} | {
+    "type": "header_up";
+    name: string;
+    value: string;
+} | {
+    "type": "header_down";
+    name: string;
+    value: string;
+} | {
+    "type": "chunk_sent";
+    bytes: number;
+} | {
+    "type": "chunk_received";
+    bytes: number;
+} | {
+    "type": "dns_resolved";
+    hostname: string;
+    addresses: Array<string>;
+    duration: bigint;
+    overridden: boolean;
+};
 export type HttpResponseHeader = {
     name: string;
     value: string;
@@ -104,6 +253,109 @@ export type HttpUrlParameter = {
     value: string;
     id?: string;
 };
+export type KeyValue = {
+    model: "key_value";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    key: string;
+    namespace: string;
+    value: string;
+};
+export type Plugin = {
+    model: "plugin";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    checkedAt: string | null;
+    directory: string;
+    enabled: boolean;
+    url: string | null;
+};
+export type ProxySetting = {
+    "type": "enabled";
+    http: string;
+    https: string;
+    auth: ProxySettingAuth | null;
+    bypass: string;
+    disabled: boolean;
+} | {
+    "type": "disabled";
+};
+export type ProxySettingAuth = {
+    user: string;
+    password: string;
+};
+export type Settings = {
+    model: "settings";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    appearance: string;
+    clientCertificates: Array<ClientCertificate>;
+    coloredMethods: boolean;
+    editorFont: string | null;
+    editorFontSize: number;
+    editorKeymap: EditorKeymap;
+    editorSoftWrap: boolean;
+    hideWindowControls: boolean;
+    useNativeTitlebar: boolean;
+    interfaceFont: string | null;
+    interfaceFontSize: number;
+    interfaceScale: number;
+    openWorkspaceNewWindow: boolean | null;
+    proxy: ProxySetting | null;
+    themeDark: string;
+    themeLight: string;
+    updateChannel: string;
+    hideLicenseBadge: boolean;
+    autoupdate: boolean;
+    autoDownloadUpdates: boolean;
+    checkNotifications: boolean;
+    hotkeys: {
+        [key in string]?: Array<string>;
+    };
+};
+export type SyncState = {
+    model: "sync_state";
+    id: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    flushedAt: string;
+    modelId: string;
+    checksum: string;
+    relPath: string;
+    syncDir: string;
+};
+export type WebsocketConnection = {
+    model: "websocket_connection";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    workspaceId: string;
+    requestId: string;
+    elapsed: number;
+    error: string | null;
+    headers: Array<HttpResponseHeader>;
+    state: WebsocketConnectionState;
+    status: number;
+    url: string;
+};
+export type WebsocketConnectionState = "initialized" | "connected" | "closing" | "closed";
+export type WebsocketEvent = {
+    model: "websocket_event";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    workspaceId: string;
+    requestId: string;
+    connectionId: string;
+    isServer: boolean;
+    message: Array<number>;
+    messageType: WebsocketEventType;
+};
+export type WebsocketEventType = "binary" | "close" | "frame" | "open" | "ping" | "pong" | "text";
 export type WebsocketRequest = {
     model: "websocket_request";
     id: string;
@@ -135,4 +387,14 @@ export type Workspace = {
     settingValidateCertificates: boolean;
     settingFollowRedirects: boolean;
     settingRequestTimeout: number;
+    settingDnsOverrides: Array<DnsOverride>;
+};
+export type WorkspaceMeta = {
+    model: "workspace_meta";
+    id: string;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    encryptionKey: EncryptedKey | null;
+    settingSyncDir: string | null;
 };

package/lib/plugins/AuthenticationPlugin.d.ts

@@ -1,11 +1,20 @@
-import { CallHttpAuthenticationActionArgs, CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, FormInput, GetHttpAuthenticationConfigRequest, GetHttpAuthenticationSummaryResponse, HttpAuthenticationAction } from '../bindings/gen_events';
-import { MaybePromise } from '../helpers';
-import { Context } from './Context';
-type DynamicFormInput = FormInput & {
-    dynamic(ctx: Context, args: GetHttpAuthenticationConfigRequest): MaybePromise<Partial<FormInput> | undefined | null>;
+import type { CallHttpAuthenticationActionArgs, CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, FormInput, GetHttpAuthenticationSummaryResponse, HttpAuthenticationAction } from '../bindings/gen_events';
+import type { MaybePromise } from '../helpers';
+import type { Context } from './Context';
+type AddDynamicMethod<T> = {
+    dynamic?: (ctx: Context, args: CallHttpAuthenticationActionArgs) => MaybePromise<Partial<T> | null | undefined>;
 };
+type AddDynamic<T> = T extends any ? T extends {
+    inputs?: FormInput[];
+} ? Omit<T, 'inputs'> & {
+    inputs: Array<AddDynamic<FormInput>>;
+    dynamic?: (ctx: Context, args: CallHttpAuthenticationActionArgs) => MaybePromise<Partial<Omit<T, 'inputs'> & {
+        inputs: Array<AddDynamic<FormInput>>;
+    }> | null | undefined>;
+} : T & AddDynamicMethod<T> : never;
+export type DynamicAuthenticationArg = AddDynamic<FormInput>;
 export type AuthenticationPlugin = GetHttpAuthenticationSummaryResponse & {
-    args: (FormInput | DynamicFormInput)[];
+    args: DynamicAuthenticationArg[];
     onApply(ctx: Context, args: CallHttpAuthenticationRequest): MaybePromise<CallHttpAuthenticationResponse>;
     actions?: (HttpAuthenticationAction & {
         onSelect(ctx: Context, args: CallHttpAuthenticationActionArgs): Promise<void> | void;

package/lib/plugins/Context.d.ts

@@ -1,4 +1,7 @@
-import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetCookieValueRequest, GetCookieValueResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, ListCookieNamesResponse, OpenWindowRequest, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '../bindings/gen_events.ts';
+import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetCookieValueRequest, GetCookieValueResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, ListCookieNamesResponse, ListFoldersRequest, ListFoldersResponse, ListHttpRequestsRequest, ListHttpRequestsResponse, OpenWindowRequest, PromptFormRequest, PromptFormResponse, PromptTextRequest, PromptTextResponse, RenderGrpcRequestRequest, RenderGrpcRequestResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, WorkspaceInfo } from '../bindings/gen_events.ts';
+import type { Folder, HttpRequest } from '../bindings/gen_models.ts';
+import type { JsonValue } from '../bindings/serde_json/JsonValue';
+export type WorkspaceHandle = Pick<WorkspaceInfo, 'id' | 'name'>;
 export interface Context {
     clipboard: {
         copyText(text: string): Promise<void>;
@@ -8,6 +11,7 @@ export interface Context {
     };
     prompt: {
         text(args: PromptTextRequest): Promise<PromptTextResponse['value']>;
+        form(args: PromptFormRequest): Promise<PromptFormResponse['values']>;
     };
     store: {
         set<T>(key: string, value: T): Promise<void>;
@@ -15,6 +19,9 @@ export interface Context {
         delete(key: string): Promise<boolean>;
     };
     window: {
+        requestId(): Promise<string | null>;
+        workspaceId(): Promise<string | null>;
+        environmentId(): Promise<string | null>;
         openUrl(args: OpenWindowRequest & {
             onNavigate?: (args: {
                 url: string;
@@ -23,20 +30,50 @@ export interface Context {
         }): Promise<{
             close: () => void;
         }>;
+        openExternalUrl(url: string): Promise<void>;
     };
     cookies: {
         listNames(): Promise<ListCookieNamesResponse['names']>;
         getValue(args: GetCookieValueRequest): Promise<GetCookieValueResponse['value']>;
     };
+    grpcRequest: {
+        render(args: RenderGrpcRequestRequest): Promise<RenderGrpcRequestResponse['grpcRequest']>;
+    };
     httpRequest: {
         send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
         getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;
         render(args: RenderHttpRequestRequest): Promise<RenderHttpRequestResponse['httpRequest']>;
+        list(args?: ListHttpRequestsRequest): Promise<ListHttpRequestsResponse['httpRequests']>;
+        create(args: Omit<Partial<HttpRequest>, 'id' | 'model' | 'createdAt' | 'updatedAt'> & Pick<HttpRequest, 'workspaceId' | 'url'>): Promise<HttpRequest>;
+        update(args: Omit<Partial<HttpRequest>, 'model' | 'createdAt' | 'updatedAt'> & Pick<HttpRequest, 'id'>): Promise<HttpRequest>;
+        delete(args: {
+            id: string;
+        }): Promise<HttpRequest>;
+    };
+    folder: {
+        list(args?: ListFoldersRequest): Promise<ListFoldersResponse['folders']>;
+        getById(args: {
+            id: string;
+        }): Promise<Folder | null>;
+        create(args: Omit<Partial<Folder>, 'id' | 'model' | 'createdAt' | 'updatedAt'> & Pick<Folder, 'workspaceId' | 'name'>): Promise<Folder>;
+        update(args: Omit<Partial<Folder>, 'model' | 'createdAt' | 'updatedAt'> & Pick<Folder, 'id'>): Promise<Folder>;
+        delete(args: {
+            id: string;
+        }): Promise<Folder>;
     };
     httpResponse: {
         find(args: FindHttpResponsesRequest): Promise<FindHttpResponsesResponse['httpResponses']>;
     };
     templates: {
-        render(args: TemplateRenderRequest): Promise<TemplateRenderResponse['data']>;
+        render<T extends JsonValue>(args: TemplateRenderRequest & {
+            data: T;
+        }): Promise<T>;
+    };
+    plugin: {
+        reload(): void;
+    };
+    workspace: {
+        list(): Promise<WorkspaceHandle[]>;
+        withContext(handle: WorkspaceHandle): Context;
     };
 }

package/lib/plugins/FilterPlugin.d.ts

@@ -1,7 +1,5 @@
+import type { FilterResponse } from '../bindings/gen_events';
 import type { Context } from './Context';
-type FilterPluginResponse = {
-    filtered: string;
-};
 export type FilterPlugin = {
     name: string;
     description?: string;
@@ -9,6 +7,5 @@ export type FilterPlugin = {
         payload: string;
         filter: string;
         mimeType: string;
-    }): Promise<FilterPluginResponse> | FilterPluginResponse;
+    }): Promise<FilterResponse> | FilterResponse;
 };
-export {};

package/lib/plugins/FolderActionPlugin.d.ts

@@ -0,0 +1,5 @@
+import type { CallFolderActionArgs, FolderAction } from '../bindings/gen_events';
+import type { Context } from './Context';
+export type FolderActionPlugin = FolderAction & {
+    onSelect(ctx: Context, args: CallFolderActionArgs): Promise<void> | void;
+};

package/lib/plugins/FolderActionPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/GrpcRequestActionPlugin.d.ts

@@ -0,0 +1,5 @@
+import type { CallGrpcRequestActionArgs, GrpcRequestAction } from '../bindings/gen_events';
+import type { Context } from './Context';
+export type GrpcRequestActionPlugin = GrpcRequestAction & {
+    onSelect(ctx: Context, args: CallGrpcRequestActionArgs): Promise<void> | void;
+};

package/lib/plugins/GrpcRequestActionPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/HttpCollectionActionPlugin.d.ts

@@ -0,0 +1,14 @@
+import type { Context } from './Context';
+import type { Folder, Workspace } from '../bindings/gen_models';
+import type { Icon } from '../bindings/gen_events';
+export type HttpCollectionAction = {
+    label: string;
+    icon?: Icon;
+};
+export type CallHttpCollectionActionArgs = {
+    folder?: Folder;
+    workspace?: Workspace;
+};
+export type HttpCollectionActionPlugin = HttpCollectionAction & {
+    onSelect(ctx: Context, args: CallHttpCollectionActionArgs): Promise<void> | void;
+};

package/lib/plugins/HttpCollectionActionPlugin.js

@@ -0,0 +1,2 @@
+
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/ImporterPlugin.d.ts

@@ -1,5 +1,5 @@
-import { ImportResources } from '../bindings/gen_events';
-import { AtLeast } from '../helpers';
+import type { ImportResources } from '../bindings/gen_events';
+import type { AtLeast, MaybePromise } from '../helpers';
 import type { Context } from './Context';
 type RootFields = 'name' | 'id' | 'model';
 type CommonFields = RootFields | 'workspaceId';
@@ -19,6 +19,6 @@ export type ImporterPlugin = {
     description?: string;
     onImport(ctx: Context, args: {
         text: string;
-    }): Promise<ImportPluginResponse>;
+    }): MaybePromise<ImportPluginResponse | null | undefined>;
 };
 export {};

package/lib/plugins/McpPlugin.d.ts

@@ -0,0 +1,56 @@
+import type { MaybePromise } from '../helpers';
+import type { Context } from './Context';
+/**
+ * JSON-RPC 2.0 message types for MCP
+ */
+export type JsonRpcRequest = {
+    jsonrpc: '2.0';
+    id: string | number;
+    method: string;
+    params?: unknown;
+};
+export type JsonRpcNotification = {
+    jsonrpc: '2.0';
+    method: string;
+    params?: unknown;
+};
+export type JsonRpcResponse = {
+    jsonrpc: '2.0';
+    id: string | number;
+    result?: unknown;
+    error?: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+};
+export type JsonRpcMessage = JsonRpcRequest | JsonRpcNotification | JsonRpcResponse;
+/**
+ * MCP Plugin type
+ *
+ * Plugins that implement this interface can handle MCP protocol messages
+ * via stdio transport, allowing external tools like Claude Desktop to
+ * interact with Yaak programmatically.
+ */
+export type McpPlugin = {
+    /**
+     * Display name for the MCP server
+     */
+    name: string;
+    /**
+     * Version of the MCP server
+     */
+    version: string;
+    /**
+     * Handle an incoming JSON-RPC message from the MCP client
+     *
+     * This method receives messages from stdin and should return
+     * appropriate JSON-RPC responses. Notifications (messages without id)
+     * should return null or undefined.
+     *
+     * @param ctx - Plugin context for accessing Yaak APIs
+     * @param message - The JSON-RPC message from the client
+     * @returns JSON-RPC response, or null/undefined for notifications
+     */
+    onMessage(ctx: Context, message: JsonRpcMessage): MaybePromise<JsonRpcResponse | null | undefined>;
+};

package/lib/plugins/McpPlugin.js

@@ -0,0 +1,2 @@
+
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/TemplateFunctionPlugin.d.ts

@@ -1,5 +1,20 @@
-import { CallTemplateFunctionArgs, TemplateFunction } from "../bindings/gen_events";
-import { Context } from "./Context";
-export type TemplateFunctionPlugin = TemplateFunction & {
+import type { CallTemplateFunctionArgs, FormInput, TemplateFunction } from '../bindings/gen_events';
+import type { MaybePromise } from '../helpers';
+import type { Context } from './Context';
+type AddDynamicMethod<T> = {
+    dynamic?: (ctx: Context, args: CallTemplateFunctionArgs) => MaybePromise<Partial<T> | null | undefined>;
+};
+type AddDynamic<T> = T extends any ? T extends {
+    inputs?: FormInput[];
+} ? Omit<T, 'inputs'> & {
+    inputs: Array<AddDynamic<FormInput>>;
+    dynamic?: (ctx: Context, args: CallTemplateFunctionArgs) => MaybePromise<Partial<Omit<T, 'inputs'> & {
+        inputs: Array<AddDynamic<FormInput>>;
+    }> | null | undefined>;
+} : T & AddDynamicMethod<T> : never;
+export type DynamicTemplateFunctionArg = AddDynamic<FormInput>;
+export type TemplateFunctionPlugin = Omit<TemplateFunction, 'args'> & {
+    args: DynamicTemplateFunctionArg[];
     onRender(ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null>;
 };
+export {};

package/lib/plugins/ThemePlugin.d.ts

@@ -1,2 +1,2 @@
-import { Theme } from '../bindings/gen_events';
+import type { Theme } from '../bindings/gen_events';
 export type ThemePlugin = Theme;

package/lib/plugins/WebSocketRequestActionPlugin.d.ts

@@ -0,0 +1,5 @@
+import type { CallWebsocketRequestActionArgs, WebsocketRequestAction } from '../bindings/gen_events';
+import type { Context } from './Context';
+export type WebsocketRequestActionPlugin = WebsocketRequestAction & {
+    onSelect(ctx: Context, args: CallWebsocketRequestActionArgs): Promise<void> | void;
+};

package/lib/plugins/WebSocketRequestActionPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/WorkspaceActionPlugin.d.ts

@@ -0,0 +1,5 @@
+import type { CallWorkspaceActionArgs, WorkspaceAction } from '../bindings/gen_events';
+import type { Context } from './Context';
+export type WorkspaceActionPlugin = WorkspaceAction & {
+    onSelect(ctx: Context, args: CallWorkspaceActionArgs): Promise<void> | void;
+};

package/lib/plugins/WorkspaceActionPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/index.d.ts

@@ -1,18 +1,34 @@
-import { AuthenticationPlugin } from './AuthenticationPlugin';
+import type { AuthenticationPlugin } from './AuthenticationPlugin';
+import type { Context } from './Context';
 import type { FilterPlugin } from './FilterPlugin';
+import type { GrpcRequestActionPlugin } from './GrpcRequestActionPlugin';
 import type { HttpRequestActionPlugin } from './HttpRequestActionPlugin';
+import type { WebsocketRequestActionPlugin } from './WebsocketRequestActionPlugin';
+import type { WorkspaceActionPlugin } from './WorkspaceActionPlugin';
+import type { FolderActionPlugin } from './FolderActionPlugin';
 import type { ImporterPlugin } from './ImporterPlugin';
 import type { TemplateFunctionPlugin } from './TemplateFunctionPlugin';
 import type { ThemePlugin } from './ThemePlugin';
-export type { Context } from './Context';
+export type { Context };
+export type { DynamicTemplateFunctionArg } from './TemplateFunctionPlugin';
+export type { DynamicAuthenticationArg } from './AuthenticationPlugin';
+export type { TemplateFunctionPlugin };
+export type { WorkspaceActionPlugin } from './WorkspaceActionPlugin';
+export type { FolderActionPlugin } from './FolderActionPlugin';
 /**
  * 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[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.6.6",
+  "version": "0.8.0",
   "keywords": [
     "api-client",
     "insomnia-alternative",
@@ -25,13 +25,13 @@
     "build": "run-s build:copy-types build:tsc",
     "build:tsc": "tsc",
     "build:copy-types": "run-p build:copy-types:*",
-    "build:copy-types:root": "cpy --flat ../../src-tauri/yaak-plugins/bindings/*.ts ./src/bindings",
-    "build:copy-types:next": "cpy --flat ../../src-tauri/yaak-plugins/bindings/serde_json/*.ts ./src/bindings/serde_json",
+    "build:copy-types:root": "cpy --flat ../../crates/yaak-plugins/bindings/*.ts ./src/bindings",
+    "build:copy-types:next": "cpy --flat ../../crates/yaak-plugins/bindings/serde_json/*.ts ./src/bindings/serde_json",
     "publish": "npm publish",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@types/node": "^22.5.4"
+    "@types/node": "^24.0.13"
   },
   "devDependencies": {
     "cpy-cli": "^5.0.0"