Websockets for plugin runtime communication (#156)

packages/plugin-runtime-types/src/bindings/events.ts

@@ -1,15 +1,15 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
-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";
+import type { Environment } from "./models.js";
+import type { Folder } from "./models.js";
+import type { GrpcRequest } from "./models.js";
+import type { HttpRequest } from "./models.js";
+import type { HttpResponse } from "./models.js";
+import type { JsonValue } from "./serde_json/JsonValue.js";
+import type { Workspace } from "./models.js";
 
 export type BootRequest = { dir: string, watch: boolean, };
 
-export type BootResponse = { name: string, version: string, capabilities: Array<string>, };
+export type BootResponse = { name: string, version: string, };
 
 export type CallHttpAuthenticationRequest = { config: { [key in string]?: JsonValue }, method: string, url: string, headers: Array<HttpHeader>, };
 
@@ -38,6 +38,8 @@ export type EditorLanguage = "text" | "javascript" | "json" | "html" | "xml" | "
 
 export type EmptyPayload = {};
 
+export type ErrorResponse = { error: string, };
+
 export type ExportHttpRequestRequest = { httpRequest: HttpRequest, };
 
 export type ExportHttpRequestResponse = { content: string, };
@@ -242,9 +244,9 @@ export type ImportResources = { workspaces: Array<Workspace>, environments: Arra
 
 export type ImportResponse = { resources: ImportResources, };
 
-export type InternalEvent = { id: string, pluginRefId: string, replyId: string | null, payload: InternalEventPayload, windowContext: WindowContext, };
+export type InternalEvent = { id: string, pluginRefId: string, pluginName: string, replyId: string | null, windowContext: WindowContext, payload: InternalEventPayload, };
 
-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_http_authentication_request" } & EmptyPayload | { "type": "get_http_authentication_response" } & GetHttpAuthenticationResponse | { "type": "call_http_authentication_request" } & CallHttpAuthenticationRequest | { "type": "call_http_authentication_response" } & CallHttpAuthenticationResponse | { "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 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_http_authentication_request" } & EmptyPayload | { "type": "get_http_authentication_response" } & GetHttpAuthenticationResponse | { "type": "call_http_authentication_request" } & CallHttpAuthenticationRequest | { "type": "call_http_authentication_response" } & CallHttpAuthenticationResponse | { "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 | { "type": "error_response" } & ErrorResponse;
 
 export type PromptTextRequest = { id: string, title: string, label: string, description?: string, defaultValue?: string, placeholder?: string, 
 /**

packages/plugin-runtime-types/src/plugins/AuthenticationPlugin.ts

@@ -2,8 +2,8 @@ import {
   CallHttpAuthenticationRequest,
   CallHttpAuthenticationResponse,
   GetHttpAuthenticationResponse,
-} from '..';
-import type { Context } from './Context';
+} from '../bindings/events';
+import { Context } from './Context';
 
 export type AuthenticationPlugin = Omit<GetHttpAuthenticationResponse, 'pluginName'> & {
   onApply(

packages/plugin-runtime-types/src/plugins/Context.ts

@@ -12,27 +12,37 @@ import type {
   ShowToastRequest,
   TemplateRenderRequest,
   TemplateRenderResponse,
-} from '..';
+} from "../bindings/events.ts";
 
-export type Context = {
+export interface Context {
   clipboard: {
-    copyText(text: string): void;
+    copyText(text: string): Promise<void>;
   };
   toast: {
-    show(args: ShowToastRequest): void;
+    show(args: ShowToastRequest): Promise<void>;
   };
   prompt: {
-    text(args: PromptTextRequest): Promise<PromptTextResponse['value']>;
+    text(args: PromptTextRequest): Promise<PromptTextResponse["value"]>;
   };
   httpRequest: {
-    send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
-    getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;
-    render(args: RenderHttpRequestRequest): Promise<RenderHttpRequestResponse['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']>;
+    find(
+      args: FindHttpResponsesRequest,
+    ): Promise<FindHttpResponsesResponse["httpResponses"]>;
   };
   templates: {
-    render(args: TemplateRenderRequest): Promise<TemplateRenderResponse['data']>;
+    render(
+      args: TemplateRenderRequest,
+    ): Promise<TemplateRenderResponse["data"]>;
   };
-};
+}

packages/plugin-runtime-types/src/plugins/FilterPlugin.ts

@@ -1,13 +1,12 @@
 import type { Context } from './Context';
 
-export type FilterPluginResponse = string[];
+export type FilterPluginResponse = { filtered: 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>;
+    args: { payload: string; filter: string; mimeType: string },
+  ): Promise<FilterPluginResponse> | FilterPluginResponse;
 };

packages/plugin-runtime-types/src/plugins/HttpRequestActionPlugin.ts

@@ -1,4 +1,4 @@
-import type { CallHttpRequestActionArgs, HttpRequestAction } from '..';
+import type { CallHttpRequestActionArgs, HttpRequestAction } from '../bindings/events';
 import type { Context } from './Context';
 
 export type HttpRequestActionPlugin = HttpRequestAction & {

packages/plugin-runtime-types/src/plugins/ImporterPlugin.ts

@@ -1,13 +1,30 @@
-import type { Environment, Folder, GrpcRequest, HttpRequest, Workspace } from '..';
-import type { AtLeast } from '../helpers';
-import type { Context } from './Context';
+import {
+  Environment,
+  Folder,
+  GrpcRequest,
+  HttpRequest,
+  Workspace,
+} from "../bindings/models";
+import type { AtLeast } from "../helpers";
+import type { Context } from "./Context";
 
-export type ImportPluginResponse = null | {
-  workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
-  environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
-  folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
-  httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
-  grpcRequests: AtLeast<GrpcRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
+type ImportPluginResponse = null | {
+  resources: {
+    workspaces: AtLeast<Workspace, "name" | "id" | "model">[];
+    environments: AtLeast<
+      Environment,
+      "name" | "id" | "model" | "workspaceId"
+    >[];
+    folders: AtLeast<Folder, "name" | "id" | "model" | "workspaceId">[];
+    httpRequests: AtLeast<
+      HttpRequest,
+      "name" | "id" | "model" | "workspaceId"
+    >[];
+    grpcRequests: AtLeast<
+      GrpcRequest,
+      "name" | "id" | "model" | "workspaceId"
+    >[];
+  };
 };
 
 export type ImporterPlugin = {

packages/plugin-runtime-types/src/plugins/TemplateFunctionPlugin.ts

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

packages/plugin-runtime-types/src/plugins/ThemePlugin.ts

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

packages/plugin-runtime-types/src/themes/index.ts

@@ -24,7 +24,7 @@ export type Colors = {
   danger?: string;
 };
 
-export type Theme = Colors & {
+export type Index = Colors & {
   id: string;
   name: string;
   components?: Partial<{