@yaakapp/api 0.6.5 → 0.7.0

package/README.md

@@ -24,5 +24,5 @@ the [Quick Start Guide](https://feedback.yaak.app/help/articles/6911763-plugins-
 If you prefer starting from scratch, manually install the types package:
 
 ```shell
-npm install @yaakapp/api
+npm install -D @yaakapp/api
 ```

package/lib/bindings/gen_events.d.ts

@@ -4,9 +4,14 @@ export type BootRequest = {
     dir: string;
     watch: boolean;
 };
-export type BootResponse = {
-    name: string;
-    version: string;
+export type CallGrpcRequestActionArgs = {
+    grpcRequest: GrpcRequest;
+    protoFiles: Array<string>;
+};
+export type CallGrpcRequestActionRequest = {
+    index: number;
+    pluginRefId: string;
+    args: CallGrpcRequestActionArgs;
 };
 export type CallHttpAuthenticationActionArgs = {
     contextId: string;
@@ -33,7 +38,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;
@@ -55,6 +65,7 @@ export type CallTemplateFunctionRequest = {
 };
 export type CallTemplateFunctionResponse = {
     value: string | null;
+    error?: string;
 };
 export type CloseWindowRequest = {
     label: string;
@@ -101,6 +112,7 @@ export type FilterRequest = {
 };
 export type FilterResponse = {
     content: string;
+    error?: string;
 };
 export type FindHttpResponsesRequest = {
     requestId: string;
@@ -425,6 +437,10 @@ export type GetCookieValueRequest = {
 export type GetCookieValueResponse = {
     value: string | null;
 };
+export type GetGrpcRequestActionsResponse = {
+    actions: Array<GrpcRequestAction>;
+    pluginRefId: string;
+};
 export type GetHttpAuthenticationConfigRequest = {
     contextId: string;
     values: {
@@ -441,7 +457,6 @@ export type GetHttpAuthenticationSummaryResponse = {
     label: string;
     shortLabel: string;
 };
-export type GetHttpRequestActionsRequest = Record<string, never>;
 export type GetHttpRequestActionsResponse = {
     actions: Array<HttpRequestAction>;
     pluginRefId: string;
@@ -458,10 +473,29 @@ 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;
 };
+export type GetThemesRequest = Record<string, never>;
+export type GetThemesResponse = {
+    themes: Array<Theme>;
+};
+export type GrpcRequestAction = {
+    label: string;
+    icon?: Icon;
+};
 export type HttpAuthenticationAction = {
     label: string;
     icon?: Icon;
@@ -501,11 +535,9 @@ 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";
@@ -540,10 +572,20 @@ export type InternalEventPayload = {
 } & GetHttpRequestActionsResponse | {
     "type": "call_http_request_action_request";
 } & CallHttpRequestActionRequest | {
-    "type": "get_template_functions_request";
-} | {
-    "type": "get_template_functions_response";
-} & GetTemplateFunctionsResponse | {
+    "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";
@@ -572,6 +614,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";
@@ -592,10 +642,6 @@ export type InternalEventPayload = {
 } | {
     "type": "close_window_request";
 } & CloseWindowRequest | {
-    "type": "template_render_request";
-} & TemplateRenderRequest | {
-    "type": "template_render_response";
-} & TemplateRenderResponse | {
     "type": "show_toast_request";
 } & ShowToastRequest | {
     "type": "show_toast_response";
@@ -612,6 +658,10 @@ export type InternalEventPayload = {
 } & FindHttpResponsesRequest | {
     "type": "find_http_responses_response";
 } & FindHttpResponsesResponse | {
+    "type": "get_themes_request";
+} & GetThemesRequest | {
+    "type": "get_themes_response";
+} & GetThemesResponse | {
     "type": "empty_response";
 } & EmptyPayload | {
     "type": "error_response";
@@ -661,6 +711,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;
@@ -684,6 +744,7 @@ export type ShowToastRequest = {
     message: string;
     color?: Color;
     icon?: Icon;
+    timeout?: number;
 };
 export type TemplateFunction = {
     name: string;
@@ -706,6 +767,63 @@ export type TemplateRenderRequest = {
 export type TemplateRenderResponse = {
     data: JsonValue;
 };
+export type Theme = {
+    /**
+     * How the theme is identified. This should never be changed
+     */
+    id: string;
+    /**
+     * The friendly name of the theme to be displayed to the user
+     */
+    label: string;
+    /**
+     * Whether the theme will be used for dark or light appearance
+     */
+    dark: boolean;
+    /**
+     * The default top-level colors for the theme
+     */
+    base: ThemeComponentColors;
+    /**
+     * Optionally override theme for individual UI components for more control
+     */
+    components?: ThemeComponents;
+};
+export type ThemeComponentColors = {
+    surface?: string;
+    surfaceHighlight?: string;
+    surfaceActive?: string;
+    text?: string;
+    textSubtle?: string;
+    textSubtlest?: string;
+    border?: string;
+    borderSubtle?: string;
+    borderFocus?: string;
+    shadow?: string;
+    backdrop?: string;
+    selection?: string;
+    primary?: string;
+    secondary?: string;
+    info?: string;
+    success?: string;
+    notice?: string;
+    warning?: string;
+    danger?: string;
+};
+export type ThemeComponents = {
+    dialog?: ThemeComponentColors;
+    menu?: ThemeComponentColors;
+    toast?: ThemeComponentColors;
+    sidebar?: ThemeComponentColors;
+    responsePane?: ThemeComponentColors;
+    appHeader?: ThemeComponentColors;
+    button?: ThemeComponentColors;
+    banner?: ThemeComponentColors;
+    templateTag?: ThemeComponentColors;
+    urlBar?: ThemeComponentColors;
+    editor?: ThemeComponentColors;
+    input?: ThemeComponentColors;
+};
 export type WindowNavigateEvent = {
     url: string;
 };

package/lib/bindings/gen_models.d.ts

@@ -6,7 +6,8 @@ export type Environment = {
     updatedAt: string;
     name: string;
     public: boolean;
-    base: boolean;
+    parentModel: string;
+    parentId: string | null;
     variables: Array<EnvironmentVariable>;
     color: string | null;
 };

package/lib/plugins/Context.d.ts

@@ -1,4 +1,5 @@
-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, OpenWindowRequest, PromptTextRequest, PromptTextResponse, RenderGrpcRequestRequest, RenderGrpcRequestResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest } from '../bindings/gen_events.ts';
+import { JsonValue } from '../bindings/serde_json/JsonValue';
 export interface Context {
     clipboard: {
         copyText(text: string): Promise<void>;
@@ -28,6 +29,9 @@ export interface Context {
         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']>;
@@ -37,6 +41,11 @@ export interface Context {
         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;
     };
 }

package/lib/plugins/FilterPlugin.d.ts

@@ -1,7 +1,5 @@
+import { 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/GrpcRequestActionPlugin.d.ts

@@ -0,0 +1,5 @@
+import { 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/ImporterPlugin.d.ts

@@ -1,5 +1,5 @@
 import { ImportResources } from '../bindings/gen_events';
-import { AtLeast } from '../helpers';
+import { 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/TemplateFunctionPlugin.d.ts

@@ -1,5 +1,10 @@
-import { CallTemplateFunctionArgs, TemplateFunction } from "../bindings/gen_events";
-import { Context } from "./Context";
+import { CallTemplateFunctionArgs, FormInput, GetHttpAuthenticationConfigRequest, TemplateFunction, TemplateFunctionArg } from '../bindings/gen_events';
+import { MaybePromise } from '../helpers';
+import { Context } from './Context';
+export type DynamicTemplateFunctionArg = FormInput & {
+    dynamic(ctx: Context, args: GetHttpAuthenticationConfigRequest): MaybePromise<Partial<FormInput> | undefined | null>;
+};
 export type TemplateFunctionPlugin = TemplateFunction & {
+    args: (TemplateFunctionArg | DynamicTemplateFunctionArg)[];
     onRender(ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null>;
 };

package/lib/plugins/ThemePlugin.d.ts

@@ -1,7 +1,2 @@
-import { Index } from "../themes";
-import { Context } from "./Context";
-export type ThemePlugin = {
-    name: string;
-    description?: string;
-    getTheme(ctx: Context, fileContents: string): Promise<Index>;
-};
+import { Theme } from '../bindings/gen_events';
+export type ThemePlugin = Theme;

package/lib/plugins/index.d.ts

@@ -1,18 +1,23 @@
 import { AuthenticationPlugin } from './AuthenticationPlugin';
 import type { FilterPlugin } from './FilterPlugin';
+import { GrpcRequestActionPlugin } from './GrpcRequestActionPlugin';
 import type { HttpRequestActionPlugin } from './HttpRequestActionPlugin';
 import type { ImporterPlugin } from './ImporterPlugin';
 import type { TemplateFunctionPlugin } from './TemplateFunctionPlugin';
 import type { ThemePlugin } from './ThemePlugin';
-export type { Context } from './Context';
+import type { Context } from './Context';
+export type { Context };
 /**
  * The global structure of a Yaak plugin
  */
 export type PluginDefinition = {
+    init?: (ctx: Context) => void | Promise<void>;
+    dispose?: () => void | Promise<void>;
     importer?: ImporterPlugin;
-    theme?: ThemePlugin;
+    themes?: ThemePlugin[];
     filter?: FilterPlugin;
     authentication?: AuthenticationPlugin;
     httpRequestActions?: HttpRequestActionPlugin[];
+    grpcRequestActions?: GrpcRequestActionPlugin[];
     templateFunctions?: TemplateFunctionPlugin[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.6.5",
+  "version": "0.7.0",
   "keywords": [
     "api-client",
     "insomnia-alternative",
@@ -31,7 +31,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@types/node": "^22.5.4"
+    "@types/node": "^24.0.13"
   },
   "devDependencies": {
     "cpy-cli": "^5.0.0"