@yaakapp/api 0.2.19 → 0.2.21

package/lib/bindings/events.d.ts

@@ -1,5 +1,14 @@
-import type { Environment, Folder, GrpcRequest, HttpRequest, HttpResponse, Workspace } from './models';
-import type { JsonValue } from './serde_json/JsonValue';
+import type { Environment } from "./models";
+import type { Folder } from "./models";
+import type { GrpcRequest } from "./models";
+import type { HttpRequest } from "./models";
+import type { HttpResponse } from "./models";
+import type { JsonValue } from "./serde_json/JsonValue";
+import type { Workspace } from "./models";
+export type AuthMiddleware = {
+    name: string;
+    args: Array<FormInput>;
+};
 export type BootRequest = {
     dir: string;
     watch: boolean;
@@ -9,6 +18,18 @@ export type BootResponse = {
     version: string;
     capabilities: Array<string>;
 };
+export type CallAuthMiddlewareRequest = {
+    config: {
+        [key in string]?: JsonValue;
+    };
+    method: string;
+    url: string;
+    headers: Array<HttpHeader>;
+};
+export type CallAuthMiddlewareResponse = {
+    url: string;
+    headers: Array<HttpHeader>;
+};
 export type CallHttpRequestActionArgs = {
     httpRequest: HttpRequest;
 };
@@ -30,16 +51,24 @@ export type CallTemplateFunctionRequest = {
 export type CallTemplateFunctionResponse = {
     value: string | null;
 };
-export type Color = 'custom' | 'default' | 'primary' | 'secondary' | 'info' | 'success' | 'notice' | 'warning' | 'danger';
+export type Color = "custom" | "default" | "primary" | "secondary" | "info" | "success" | "notice" | "warning" | "danger";
 export type CopyTextRequest = {
     text: string;
 };
+export type EmptyPayload = {};
 export type ExportHttpRequestRequest = {
     httpRequest: HttpRequest;
 };
 export type ExportHttpRequestResponse = {
     content: string;
 };
+export type FileFilter = {
+    name: string;
+    /**
+     * File extensions to require
+     */
+    extensions: Array<string>;
+};
 export type FilterRequest = {
     content: string;
     filter: string;
@@ -54,190 +83,18 @@ export type FindHttpResponsesRequest = {
 export type FindHttpResponsesResponse = {
     httpResponses: Array<HttpResponse>;
 };
-export type GetHttpRequestActionsRequest = Record<string, never>;
-export type GetHttpRequestActionsResponse = {
-    actions: Array<HttpRequestAction>;
-    pluginRefId: string;
-};
-export type GetHttpRequestByIdRequest = {
-    id: string;
-};
-export type GetHttpRequestByIdResponse = {
-    httpRequest: HttpRequest | null;
-};
-export type GetTemplateFunctionsResponse = {
-    functions: Array<TemplateFunction>;
-    pluginRefId: string;
-};
-export type HttpRequestAction = {
-    key: string;
-    label: string;
-    icon?: Icon;
-};
-export type Icon = 'copy' | 'info' | 'check_circle' | 'alert_triangle' | '_unknown';
-export type ImportRequest = {
-    content: string;
-};
-export type ImportResources = {
-    workspaces: Array<Workspace>;
-    environments: Array<Environment>;
-    folders: Array<Folder>;
-    httpRequests: Array<HttpRequest>;
-    grpcRequests: Array<GrpcRequest>;
-};
-export type ImportResponse = {
-    resources: ImportResources;
-};
-export type InternalEvent = {
-    id: string;
-    pluginRefId: string;
-    replyId: string | null;
-    payload: InternalEventPayload;
-    windowContext: WindowContext;
-};
-export type InternalEventPayload = ({
-    type: 'boot_request';
-} & BootRequest) | ({
-    type: 'boot_response';
-} & BootResponse) | {
-    type: 'reload_request';
-} | {
-    type: 'reload_response';
-} | {
-    type: 'terminate_request';
-} | {
-    type: 'terminate_response';
-} | ({
-    type: 'import_request';
-} & ImportRequest) | ({
-    type: 'import_response';
-} & ImportResponse) | ({
-    type: 'filter_request';
-} & FilterRequest) | ({
-    type: 'filter_response';
-} & FilterResponse) | ({
-    type: 'export_http_request_request';
-} & ExportHttpRequestRequest) | ({
-    type: 'export_http_request_response';
-} & ExportHttpRequestResponse) | ({
-    type: 'send_http_request_request';
-} & SendHttpRequestRequest) | ({
-    type: 'send_http_request_response';
-} & SendHttpRequestResponse) | ({
-    type: 'get_http_request_actions_request';
-} & GetHttpRequestActionsRequest) | ({
-    type: 'get_http_request_actions_response';
-} & GetHttpRequestActionsResponse) | ({
-    type: 'call_http_request_action_request';
-} & CallHttpRequestActionRequest) | {
-    type: 'get_template_functions_request';
-} | ({
-    type: 'get_template_functions_response';
-} & GetTemplateFunctionsResponse) | ({
-    type: 'call_template_function_request';
-} & CallTemplateFunctionRequest) | ({
-    type: 'call_template_function_response';
-} & CallTemplateFunctionResponse) | ({
-    type: 'copy_text_request';
-} & CopyTextRequest) | ({
-    type: 'render_http_request_request';
-} & RenderHttpRequestRequest) | ({
-    type: 'render_http_request_response';
-} & RenderHttpRequestResponse) | ({
-    type: 'template_render_request';
-} & TemplateRenderRequest) | ({
-    type: 'template_render_response';
-} & TemplateRenderResponse) | ({
-    type: 'show_toast_request';
-} & ShowToastRequest) | ({
-    type: 'prompt_text_request';
-} & PromptTextRequest) | ({
-    type: 'prompt_text_response';
-} & PromptTextResponse) | ({
-    type: 'get_http_request_by_id_request';
-} & GetHttpRequestByIdRequest) | ({
-    type: 'get_http_request_by_id_response';
-} & GetHttpRequestByIdResponse) | ({
-    type: 'find_http_responses_request';
-} & FindHttpResponsesRequest) | ({
-    type: 'find_http_responses_response';
-} & FindHttpResponsesResponse) | {
-    type: 'empty_response';
-};
-export type OpenFileFilter = {
-    name: string;
-    /**
-     * File extensions to require
-     */
-    extensions: Array<string>;
-};
-export type PromptTextRequest = {
-    id: string;
-    title: string;
-    label: string;
-    description?: string;
-    defaultValue?: string;
-    placeholder?: string;
-    /**
-     * Text to add to the confirmation button
-     */
-    confirmText?: string;
-    /**
-     * Text to add to the cancel button
-     */
-    cancelText?: string;
-    /**
-     * Require the user to enter a non-empty value
-     */
-    require?: boolean;
-};
-export type PromptTextResponse = {
-    value: string | null;
-};
-export type RenderHttpRequestRequest = {
-    httpRequest: HttpRequest;
-    purpose: RenderPurpose;
-};
-export type RenderHttpRequestResponse = {
-    httpRequest: HttpRequest;
-};
-export type RenderPurpose = 'send' | 'preview';
-export type SendHttpRequestRequest = {
-    httpRequest: HttpRequest;
-};
-export type SendHttpRequestResponse = {
-    httpResponse: HttpResponse;
-};
-export type ShowToastRequest = {
-    message: string;
-    color?: Color;
-    icon?: Icon;
-};
-export type TemplateFunction = {
-    name: string;
-    description?: string;
-    /**
-     * Also support alternative names. This is useful for not breaking existing
-     * tags when changing the `name` property
-     */
-    aliases?: Array<string>;
-    args: Array<TemplateFunctionArg>;
-};
-export type TemplateFunctionArg = ({
-    type: 'text';
-} & TemplateFunctionTextArg) | ({
-    type: 'select';
-} & TemplateFunctionSelectArg) | ({
-    type: 'checkbox';
-} & TemplateFunctionCheckboxArg) | ({
-    type: 'http_request';
-} & TemplateFunctionHttpRequestArg) | ({
-    type: 'file';
-} & TemplateFunctionFileArg);
-export type TemplateFunctionBaseArg = {
-    /**
-     * The name of the argument. Should be `camelCase` format
-     */
+export type FormInput = {
+    "type": "text";
+} & FormInputText | {
+    "type": "select";
+} & FormInputSelect | {
+    "type": "checkbox";
+} & FormInputCheckbox | {
+    "type": "file";
+} & FormInputFile | {
+    "type": "http_request";
+} & FormInputHttpRequest;
+export type FormInputBase = {
     name: string;
     /**
      * Whether the user must fill in the argument
@@ -252,10 +109,7 @@ export type TemplateFunctionBaseArg = {
      */
     defaultValue?: string;
 };
-export type TemplateFunctionCheckboxArg = {
-    /**
-     * The name of the argument. Should be `camelCase` format
-     */
+export type FormInputCheckbox = {
     name: string;
     /**
      * Whether the user must fill in the argument
@@ -270,7 +124,7 @@ export type TemplateFunctionCheckboxArg = {
      */
     defaultValue?: string;
 };
-export type TemplateFunctionFileArg = {
+export type FormInputFile = {
     /**
      * The title of the file selection window
      */
@@ -281,10 +135,7 @@ export type TemplateFunctionFileArg = {
     multiple?: boolean;
     directory?: boolean;
     defaultPath?: string;
-    filters?: Array<OpenFileFilter>;
-    /**
-     * The name of the argument. Should be `camelCase` format
-     */
+    filters?: Array<FileFilter>;
     name: string;
     /**
      * Whether the user must fill in the argument
@@ -299,10 +150,7 @@ export type TemplateFunctionFileArg = {
      */
     defaultValue?: string;
 };
-export type TemplateFunctionHttpRequestArg = {
-    /**
-     * The name of the argument. Should be `camelCase` format
-     */
+export type FormInputHttpRequest = {
     name: string;
     /**
      * Whether the user must fill in the argument
@@ -317,14 +165,11 @@ export type TemplateFunctionHttpRequestArg = {
      */
     defaultValue?: string;
 };
-export type TemplateFunctionSelectArg = {
+export type FormInputSelect = {
     /**
      * The options that will be available in the select input
      */
-    options: Array<TemplateFunctionSelectOption>;
-    /**
-     * The name of the argument. Should be `camelCase` format
-     */
+    options: Array<FormInputSelectOption>;
     name: string;
     /**
      * Whether the user must fill in the argument
@@ -339,18 +184,15 @@ export type TemplateFunctionSelectArg = {
      */
     defaultValue?: string;
 };
-export type TemplateFunctionSelectOption = {
-    label: string;
+export type FormInputSelectOption = {
+    name: string;
     value: string;
 };
-export type TemplateFunctionTextArg = {
+export type FormInputText = {
     /**
      * Placeholder for the text input
      */
-    placeholder?: string;
-    /**
-     * The name of the argument. Should be `camelCase` format
-     */
+    placeholder?: string | null;
     name: string;
     /**
      * Whether the user must fill in the argument
@@ -365,6 +207,183 @@ export type TemplateFunctionTextArg = {
      */
     defaultValue?: string;
 };
+export type GetAuthMiddlewareResponse = {
+    authMiddleware: Array<AuthMiddleware>;
+};
+export type GetHttpRequestActionsRequest = Record<string, never>;
+export type GetHttpRequestActionsResponse = {
+    actions: Array<HttpRequestAction>;
+    pluginRefId: string;
+};
+export type GetHttpRequestByIdRequest = {
+    id: string;
+};
+export type GetHttpRequestByIdResponse = {
+    httpRequest: HttpRequest | null;
+};
+export type GetTemplateFunctionsResponse = {
+    functions: Array<TemplateFunction>;
+    pluginRefId: string;
+};
+export type HttpHeader = {
+    name: string;
+    value: string;
+};
+export type HttpRequestAction = {
+    key: string;
+    label: string;
+    icon?: Icon;
+};
+export type Icon = "copy" | "info" | "check_circle" | "alert_triangle" | "_unknown";
+export type ImportRequest = {
+    content: string;
+};
+export type ImportResources = {
+    workspaces: Array<Workspace>;
+    environments: Array<Environment>;
+    folders: Array<Folder>;
+    httpRequests: Array<HttpRequest>;
+    grpcRequests: Array<GrpcRequest>;
+};
+export type ImportResponse = {
+    resources: ImportResources;
+};
+export type InternalEvent = {
+    id: string;
+    pluginRefId: string;
+    replyId: string | null;
+    payload: InternalEventPayload;
+    windowContext: WindowContext;
+};
+export type InternalEventPayload = {
+    "type": "boot_request";
+} & BootRequest | {
+    "type": "boot_response";
+} & BootResponse | {
+    "type": "reload_request";
+} & EmptyPayload | {
+    "type": "reload_response";
+} & EmptyPayload | {
+    "type": "terminate_request";
+} | {
+    "type": "terminate_response";
+} | {
+    "type": "import_request";
+} & ImportRequest | {
+    "type": "import_response";
+} & ImportResponse | {
+    "type": "filter_request";
+} & FilterRequest | {
+    "type": "filter_response";
+} & FilterResponse | {
+    "type": "export_http_request_request";
+} & ExportHttpRequestRequest | {
+    "type": "export_http_request_response";
+} & ExportHttpRequestResponse | {
+    "type": "send_http_request_request";
+} & SendHttpRequestRequest | {
+    "type": "send_http_request_response";
+} & SendHttpRequestResponse | {
+    "type": "get_http_request_actions_request";
+} & EmptyPayload | {
+    "type": "get_http_request_actions_response";
+} & GetHttpRequestActionsResponse | {
+    "type": "call_http_request_action_request";
+} & CallHttpRequestActionRequest | {
+    "type": "get_template_functions_request";
+} | {
+    "type": "get_template_functions_response";
+} & GetTemplateFunctionsResponse | {
+    "type": "call_template_function_request";
+} & CallTemplateFunctionRequest | {
+    "type": "call_template_function_response";
+} & CallTemplateFunctionResponse | {
+    "type": "get_auth_middleware_request";
+} & EmptyPayload | {
+    "type": "get_auth_middleware_response";
+} & GetAuthMiddlewareResponse | {
+    "type": "call_auth_middleware_request";
+} & CallAuthMiddlewareRequest | {
+    "type": "call_auth_middleware_response";
+} & CallAuthMiddlewareResponse | {
+    "type": "copy_text_request";
+} & CopyTextRequest | {
+    "type": "render_http_request_request";
+} & RenderHttpRequestRequest | {
+    "type": "render_http_request_response";
+} & RenderHttpRequestResponse | {
+    "type": "template_render_request";
+} & TemplateRenderRequest | {
+    "type": "template_render_response";
+} & TemplateRenderResponse | {
+    "type": "show_toast_request";
+} & ShowToastRequest | {
+    "type": "prompt_text_request";
+} & PromptTextRequest | {
+    "type": "prompt_text_response";
+} & PromptTextResponse | {
+    "type": "get_http_request_by_id_request";
+} & GetHttpRequestByIdRequest | {
+    "type": "get_http_request_by_id_response";
+} & GetHttpRequestByIdResponse | {
+    "type": "find_http_responses_request";
+} & FindHttpResponsesRequest | {
+    "type": "find_http_responses_response";
+} & FindHttpResponsesResponse | {
+    "type": "empty_response";
+} & EmptyPayload;
+export type PromptTextRequest = {
+    id: string;
+    title: string;
+    label: string;
+    description?: string;
+    defaultValue?: string;
+    placeholder?: string;
+    /**
+     * Text to add to the confirmation button
+     */
+    confirmText?: string;
+    /**
+     * Text to add to the cancel button
+     */
+    cancelText?: string;
+    /**
+     * Require the user to enter a non-empty value
+     */
+    require?: boolean;
+};
+export type PromptTextResponse = {
+    value: string | null;
+};
+export type RenderHttpRequestRequest = {
+    httpRequest: HttpRequest;
+    purpose: RenderPurpose;
+};
+export type RenderHttpRequestResponse = {
+    httpRequest: HttpRequest;
+};
+export type RenderPurpose = "send" | "preview";
+export type SendHttpRequestRequest = {
+    httpRequest: HttpRequest;
+};
+export type SendHttpRequestResponse = {
+    httpResponse: HttpResponse;
+};
+export type ShowToastRequest = {
+    message: string;
+    color?: Color;
+    icon?: Icon;
+};
+export type TemplateFunction = {
+    name: string;
+    description?: string;
+    /**
+     * Also support alternative names. This is useful for not breaking existing
+     * tags when changing the `name` property
+     */
+    aliases?: Array<string>;
+    args: Array<FormInput>;
+};
 export type TemplateRenderRequest = {
     data: JsonValue;
     purpose: RenderPurpose;
@@ -373,8 +392,8 @@ export type TemplateRenderResponse = {
     data: JsonValue;
 };
 export type WindowContext = {
-    type: 'none';
+    "type": "none";
 } | {
-    type: 'label';
+    "type": "label";
     label: string;
 };

package/lib/bindings/models.d.ts

@@ -12,6 +12,7 @@ export type EnvironmentVariable = {
     enabled?: boolean;
     name: string;
     value: string;
+    id: string;
 };
 export type Folder = {
     model: "folder";
@@ -28,6 +29,7 @@ export type GrpcMetadataEntry = {
     enabled?: boolean;
     name: string;
     value: string;
+    id: string;
 };
 export type GrpcRequest = {
     model: "grpc_request";
@@ -70,6 +72,7 @@ export type HttpRequestHeader = {
     enabled?: boolean;
     name: string;
     value: string;
+    id: string;
 };
 export type HttpResponse = {
     model: "http_response";
@@ -100,6 +103,7 @@ export type HttpUrlParameter = {
     enabled?: boolean;
     name: string;
     value: string;
+    id: string;
 };
 export type Workspace = {
     model: "workspace";

package/lib/plugins/AuthenticationPlugin.d.ts

@@ -0,0 +1,5 @@
+import { CallAuthMiddlewareRequest, CallAuthMiddlewareResponse, GetAuthMiddlewareResponse } from '..';
+import type { Context } from './Context';
+export type AuthenticationPlugin = GetAuthMiddlewareResponse & {
+    onApply(ctx: Context, args: CallAuthMiddlewareRequest): Promise<CallAuthMiddlewareResponse> | CallAuthMiddlewareResponse;
+};

package/lib/plugins/AuthenticationPlugin.js

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

package/lib/plugins/index.d.ts

@@ -1,3 +1,4 @@
+import { AuthenticationPlugin } from './AuthenticationPlugin';
 import type { FilterPlugin } from './FilterPlugin';
 import type { HttpRequestActionPlugin } from './HttpRequestActionPlugin';
 import type { ImporterPlugin } from './ImporterPlugin';
@@ -11,6 +12,7 @@ export type PluginDefinition = {
     importer?: ImporterPlugin;
     theme?: ThemePlugin;
     filter?: FilterPlugin;
+    authentication?: AuthenticationPlugin;
     httpRequestActions?: HttpRequestActionPlugin[];
     templateFunctions?: TemplateFunctionPlugin[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.2.19",
+  "version": "0.2.21",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [
@@ -11,8 +11,8 @@
     "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-plugin-runtime/bindings/*.ts ./src/bindings",
-    "build:copy-types:next": "cpy --flat ../../src-tauri/yaak-plugin-runtime/bindings/serde_json/*.ts ./src/bindings/serde_json",
+    "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",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {