@yaakapp/api 0.2.8 → 0.2.10

package/lib/bindings/events.d.ts

@@ -3,9 +3,11 @@ 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 BootRequest = {
     dir: string;
+    watch: boolean;
 };
 export type BootResponse = {
     name: string;
@@ -96,6 +98,7 @@ export type InternalEvent = {
     pluginRefId: string;
     replyId: string | null;
     payload: InternalEventPayload;
+    windowContext: WindowContext;
 };
 export type InternalEventPayload = {
     "type": "boot_request";
@@ -142,10 +145,10 @@ export type InternalEventPayload = {
 } & 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": "get_http_request_by_id_request";
@@ -179,6 +182,7 @@ export type ShowToastRequest = {
 };
 export type TemplateFunction = {
     name: string;
+    aliases: Array<string>;
     args: Array<TemplateFunctionArg>;
 };
 export type TemplateFunctionArg = {
@@ -226,3 +230,16 @@ export type TemplateFunctionTextArg = {
     label?: string | null;
     defaultValue?: string | null;
 };
+export type TemplateRenderRequest = {
+    data: JsonValue;
+    purpose: RenderPurpose;
+};
+export type TemplateRenderResponse = {
+    data: JsonValue;
+};
+export type WindowContext = {
+    "type": "none";
+} | {
+    "type": "label";
+    label: string;
+};

package/lib/bindings/serde_json/JsonValue.d.ts

@@ -0,0 +1,3 @@
+export type JsonValue = number | string | Array<JsonValue> | {
+    [key in string]?: JsonValue;
+};

package/lib/{src-tauri/yaak_plugin_runtime/bindings/models.js → bindings/serde_json/JsonValue.js}

@@ -1,2 +1,3 @@
+"use strict";
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
-export {};
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/Context.d.ts

@@ -1,3 +1,4 @@
+import { TemplateRenderRequest, TemplateRenderResponse } from '@yaakapp-internal/plugin';
 import { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest } from '..';
 export type Context = {
     clipboard: {
@@ -14,4 +15,7 @@ export type Context = {
     httpResponse: {
         find(args: FindHttpResponsesRequest): Promise<FindHttpResponsesResponse['httpResponses']>;
     };
+    templates: {
+        render(args: TemplateRenderRequest): Promise<TemplateRenderResponse['data']>;
+    };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.2.8",
+  "version": "0.2.10",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [
@@ -9,7 +9,9 @@
   "scripts": {
     "build": "run-s build:copy-types build:tsc",
     "build:tsc": "tsc",
-    "build:copy-types": "cpy --flat ../src-tauri/yaak_plugin_runtime/bindings/*.ts ./src/bindings/",
+    "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",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {

package/lib/plugin-runtime-types/src/helpers.d.ts

@@ -1,2 +0,0 @@
-export type AtLeast<T, K extends keyof T> = Partial<T> & Pick<T, K>;
-export type OneOrMany<T> = T[] | T;

package/lib/plugin-runtime-types/src/helpers.js

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

package/lib/plugin-runtime-types/src/index.d.ts

@@ -1,4 +0,0 @@
-export type * from './plugins';
-export type * from './themes';
-export * from '../../src-tauri/yaak_plugin_runtime/bindings/models.ts';
-export * from '../../src-tauri/yaak_plugin_runtime/bindings/events.ts';

package/lib/plugin-runtime-types/src/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("../../src-tauri/yaak_plugin_runtime/bindings/models.ts"), exports);
-__exportStar(require("../../src-tauri/yaak_plugin_runtime/bindings/events.ts"), exports);

package/lib/plugin-runtime-types/src/plugins/Context.d.ts

@@ -1,17 +0,0 @@
-import { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest } from '../gen/events';
-export type Context = {
-    clipboard: {
-        copyText(text: string): void;
-    };
-    toast: {
-        show(args: ShowToastRequest): void;
-    };
-    httpRequest: {
-        send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
-        getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;
-        render(args: RenderHttpRequestRequest): Promise<RenderHttpRequestResponse['httpRequest']>;
-    };
-    httpResponse: {
-        find(args: FindHttpResponsesRequest): Promise<FindHttpResponsesResponse['httpResponses']>;
-    };
-};

package/lib/plugin-runtime-types/src/plugins/Context.js

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

package/lib/plugin-runtime-types/src/plugins/FilterPlugin.d.ts

@@ -1,13 +0,0 @@
-import { Context } from './Context';
-export type FilterPluginResponse = string[];
-export type FilterPlugin = {
-    name: string;
-    description?: string;
-    canFilter(ctx: Context, args: {
-        mimeType: string;
-    }): Promise<boolean>;
-    onFilter(ctx: Context, args: {
-        payload: string;
-        mimeType: string;
-    }): Promise<FilterPluginResponse>;
-};

package/lib/plugin-runtime-types/src/plugins/FilterPlugin.js

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

package/lib/plugin-runtime-types/src/plugins/HttpRequestActionPlugin.d.ts

@@ -1,5 +0,0 @@
-import { CallHttpRequestActionArgs, HttpRequestAction } from '../gen/events';
-import { Context } from './Context';
-export type HttpRequestActionPlugin = HttpRequestAction & {
-    onSelect(ctx: Context, args: CallHttpRequestActionArgs): Promise<void> | void;
-};

package/lib/plugin-runtime-types/src/plugins/HttpRequestActionPlugin.js

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

package/lib/plugin-runtime-types/src/plugins/ImporterPlugin.d.ts

@@ -1,16 +0,0 @@
-import { Environment, Folder, HttpRequest, Workspace } from '../gen/model_util';
-import { AtLeast } from '../helpers';
-import { Context } from './Context';
-export type ImportPluginResponse = null | {
-    workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
-    environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
-    httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
-    folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
-};
-export type ImporterPlugin = {
-    name: string;
-    description?: string;
-    onImport(ctx: Context, args: {
-        text: string;
-    }): Promise<ImportPluginResponse>;
-};

package/lib/plugin-runtime-types/src/plugins/ImporterPlugin.js

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

package/lib/plugin-runtime-types/src/plugins/TemplateFunctionPlugin.d.ts

@@ -1,5 +0,0 @@
-import { CallTemplateFunctionArgs, TemplateFunction } from '../gen/events';
-import { Context } from './Context';
-export type TemplateFunctionPlugin = TemplateFunction & {
-    onRender(ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null>;
-};

package/lib/plugin-runtime-types/src/plugins/TemplateFunctionPlugin.js

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

package/lib/plugin-runtime-types/src/plugins/ThemePlugin.d.ts

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

package/lib/plugin-runtime-types/src/plugins/ThemePlugin.js

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

package/lib/plugin-runtime-types/src/plugins/index.d.ts

@@ -1,16 +0,0 @@
-import { FilterPlugin } from './FilterPlugin';
-import { HttpRequestActionPlugin } from './HttpRequestActionPlugin';
-import { ImporterPlugin } from './ImporterPlugin';
-import { TemplateFunctionPlugin } from './TemplateFunctionPlugin';
-import { ThemePlugin } from './ThemePlugin';
-export type { Context } from './Context';
-/**
- * The global structure of a Yaak plugin
- */
-export type PluginDefinition = {
-    importer?: ImporterPlugin;
-    theme?: ThemePlugin;
-    filter?: FilterPlugin;
-    httpRequestActions?: HttpRequestActionPlugin[];
-    templateFunctions?: TemplateFunctionPlugin[];
-};

package/lib/plugin-runtime-types/src/plugins/index.js

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

package/lib/plugin-runtime-types/src/themes/index.d.ts

@@ -1,39 +0,0 @@
-export type Colors = {
-    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 Theme = Colors & {
-    id: string;
-    name: string;
-    components?: Partial<{
-        dialog: Partial<Colors>;
-        menu: Partial<Colors>;
-        toast: Partial<Colors>;
-        sidebar: Partial<Colors>;
-        responsePane: Partial<Colors>;
-        appHeader: Partial<Colors>;
-        button: Partial<Colors>;
-        banner: Partial<Colors>;
-        placeholder: Partial<Colors>;
-        urlBar: Partial<Colors>;
-        editor: Partial<Colors>;
-        input: Partial<Colors>;
-    }>;
-};

package/lib/plugin-runtime-types/src/themes/index.js

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

package/lib/src-tauri/yaak_plugin_runtime/bindings/events.d.ts

@@ -1,232 +0,0 @@
-import type { Environment } from "./models";
-import type { Folder } from "./models";
-import type { GrpcConnection } from "./models";
-import type { GrpcEvent } from "./models";
-import type { GrpcRequest } from "./models";
-import type { HttpRequest } from "./models";
-import type { HttpResponse } from "./models";
-import type { KeyValue } from "./models";
-import type { Workspace } from "./models";
-export type BootRequest = {
-    dir: string;
-};
-export type BootResponse = {
-    name: string;
-    version: string;
-    capabilities: Array<string>;
-};
-export type CallHttpRequestActionArgs = {
-    httpRequest: HttpRequest;
-};
-export type CallHttpRequestActionRequest = {
-    key: string;
-    pluginRefId: string;
-    args: CallHttpRequestActionArgs;
-};
-export type CallTemplateFunctionArgs = {
-    purpose: RenderPurpose;
-    values: {
-        [key in string]?: string;
-    };
-};
-export type CallTemplateFunctionRequest = {
-    name: string;
-    args: CallTemplateFunctionArgs;
-};
-export type CallTemplateFunctionResponse = {
-    value: string | null;
-};
-export type Color = "custom" | "default" | "primary" | "secondary" | "info" | "success" | "notice" | "warning" | "danger";
-export type CopyTextRequest = {
-    text: string;
-};
-export type ExportHttpRequestRequest = {
-    httpRequest: HttpRequest;
-};
-export type ExportHttpRequestResponse = {
-    content: string;
-};
-export type FilterRequest = {
-    content: string;
-    filter: string;
-};
-export type FilterResponse = {
-    content: string;
-};
-export type FindHttpResponsesRequest = {
-    requestId: string;
-    limit: number | null;
-};
-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: string | null;
-};
-export type Icon = "copy" | "info" | "check_circle" | "alert_triangle";
-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;
-};
-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": "show_toast_request";
-} & ShowToastRequest | {
-    "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 Model = Environment | Folder | GrpcConnection | GrpcEvent | GrpcRequest | HttpRequest | HttpResponse | KeyValue | Workspace;
-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 | null;
-    icon?: Icon | null;
-};
-export type TemplateFunction = {
-    name: string;
-    args: Array<TemplateFunctionArg>;
-};
-export type TemplateFunctionArg = {
-    "type": "text";
-} & TemplateFunctionTextArg | {
-    "type": "select";
-} & TemplateFunctionSelectArg | {
-    "type": "checkbox";
-} & TemplateFunctionCheckboxArg | {
-    "type": "http_request";
-} & TemplateFunctionHttpRequestArg;
-export type TemplateFunctionBaseArg = {
-    name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
-};
-export type TemplateFunctionCheckboxArg = {
-    name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
-};
-export type TemplateFunctionHttpRequestArg = {
-    name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
-};
-export type TemplateFunctionSelectArg = {
-    options: Array<TemplateFunctionSelectOption>;
-    name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
-};
-export type TemplateFunctionSelectOption = {
-    name: string;
-    value: string;
-};
-export type TemplateFunctionTextArg = {
-    placeholder?: string | null;
-    name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
-};

package/lib/src-tauri/yaak_plugin_runtime/bindings/events.js

@@ -1 +0,0 @@
-export {};

package/lib/src-tauri/yaak_plugin_runtime/bindings/models.d.ts

@@ -1,151 +0,0 @@
-export type Environment = {
-    model: "environment";
-    id: string;
-    workspaceId: string;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    variables: Array<EnvironmentVariable>;
-};
-export type EnvironmentVariable = {
-    enabled?: boolean;
-    name: string;
-    value: string;
-};
-export type Folder = {
-    model: "folder";
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    workspaceId: string;
-    folderId: string | null;
-    name: string;
-    sortPriority: number;
-};
-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;
-    trailers: {
-        [key in string]?: string;
-    };
-    url: string;
-};
-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 GrpcMetadataEntry = {
-    enabled?: boolean;
-    name: string;
-    value: string;
-};
-export type GrpcRequest = {
-    model: "grpc_request";
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    workspaceId: string;
-    folderId: string | null;
-    authenticationType: string | null;
-    authentication: Record<string, any>;
-    message: string;
-    metadata: Array<GrpcMetadataEntry>;
-    method: string | null;
-    name: string;
-    service: string | null;
-    sortPriority: number;
-    url: string;
-};
-export type HttpRequest = {
-    model: "http_request";
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    workspaceId: string;
-    folderId: string | null;
-    authentication: Record<string, any>;
-    authenticationType: string | null;
-    body: Record<string, any>;
-    bodyType: string | null;
-    headers: Array<HttpRequestHeader>;
-    method: string;
-    name: string;
-    sortPriority: number;
-    url: string;
-    urlParameters: Array<HttpUrlParameter>;
-};
-export type HttpRequestHeader = {
-    enabled?: boolean;
-    name: string;
-    value: string;
-};
-export type HttpResponse = {
-    model: "http_response";
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    workspaceId: string;
-    requestId: string;
-    bodyPath: string | null;
-    contentLength: number | null;
-    elapsed: number;
-    elapsedHeaders: number;
-    error: string | null;
-    headers: Array<HttpResponseHeader>;
-    remoteAddr: string | null;
-    status: number;
-    statusReason: string | null;
-    url: string;
-    version: string | null;
-};
-export type HttpResponseHeader = {
-    name: string;
-    value: string;
-};
-export type HttpUrlParameter = {
-    enabled?: boolean;
-    name: string;
-    value: string;
-};
-export type KeyValue = {
-    model: "key_value";
-    createdAt: string;
-    updatedAt: string;
-    key: string;
-    namespace: string;
-    value: string;
-};
-export type Workspace = {
-    model: "workspace";
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    name: string;
-    description: string;
-    variables: Array<EnvironmentVariable>;
-    settingValidateCertificates: boolean;
-    settingFollowRedirects: boolean;
-    settingRequestTimeout: number;
-};