Move JS monorepo packages to folder

packages/plugin-runtime-types/.gitignore

@@ -0,0 +1,2 @@
+lib
+node_modules

packages/plugin-runtime-types/package-lock.json

@@ -0,0 +1,47 @@
+{
+  "name": "@yaakapp/api",
+  "version": "0.1.17",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@yaakapp/api",
+      "version": "0.1.17",
+      "dependencies": {
+        "@types/node": "^22.5.4"
+      },
+      "devDependencies": {
+        "typescript": "^5.6.2"
+      }
+    },
+    "node_modules/@types/node": {
+      "version": "22.5.4",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.5.4.tgz",
+      "integrity": "sha512-FDuKUJQm/ju9fT/SeX/6+gBzoPzlVCzfzmGkwKvRHQVxi4BntVbyIwf6a4Xn62mrvndLiml6z/UBXIdEVjQLXg==",
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~6.19.2"
+      }
+    },
+    "node_modules/typescript": {
+      "version": "5.6.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz",
+      "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "6.19.8",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz",
+      "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==",
+      "license": "MIT"
+    }
+  }
+}

packages/plugin-runtime-types/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@yaakapp/api",
+  "version": "0.2.17",
+  "main": "lib/index.js",
+  "typings": "./lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "bootstrap": "npm run build",
+    "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",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@types/node": "^22.5.4"
+  },
+  "devDependencies": {
+    "cpy-cli": "^5.0.0",
+    "npm-run-all": "^4.1.5",
+    "typescript": "^5.6.2"
+  }
+}

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

@@ -0,0 +1,338 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type {
+  Environment,
+  Folder,
+  GrpcRequest,
+  HttpRequest,
+  HttpResponse,
+  Workspace,
+} from './models';
+import type { JsonValue } from './serde_json/JsonValue';
+
+export type BootRequest = { dir: string; watch: boolean };
+
+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 };
+
+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
+   */
+  name: string;
+  /**
+   * Whether the user must fill in the argument
+   */
+  optional?: boolean;
+  /**
+   * The label of the input
+   */
+  label?: string;
+  /**
+   * The default value
+   */
+  defaultValue?: string;
+};
+
+export type TemplateFunctionCheckboxArg = {
+  /**
+   * The name of the argument. Should be `camelCase` format
+   */
+  name: string;
+  /**
+   * Whether the user must fill in the argument
+   */
+  optional?: boolean;
+  /**
+   * The label of the input
+   */
+  label?: string;
+  /**
+   * The default value
+   */
+  defaultValue?: string;
+};
+
+export type TemplateFunctionFileArg = {
+  /**
+   * The title of the file selection window
+   */
+  title: string;
+  /**
+   * Allow selecting multiple files
+   */
+  multiple?: boolean;
+  directory?: boolean;
+  defaultPath?: string;
+  filters?: Array<OpenFileFilter>;
+  /**
+   * The name of the argument. Should be `camelCase` format
+   */
+  name: string;
+  /**
+   * Whether the user must fill in the argument
+   */
+  optional?: boolean;
+  /**
+   * The label of the input
+   */
+  label?: string;
+  /**
+   * The default value
+   */
+  defaultValue?: string;
+};
+
+export type TemplateFunctionHttpRequestArg = {
+  /**
+   * The name of the argument. Should be `camelCase` format
+   */
+  name: string;
+  /**
+   * Whether the user must fill in the argument
+   */
+  optional?: boolean;
+  /**
+   * The label of the input
+   */
+  label?: string;
+  /**
+   * The default value
+   */
+  defaultValue?: string;
+};
+
+export type TemplateFunctionSelectArg = {
+  /**
+   * The options that will be available in the select input
+   */
+  options: Array<TemplateFunctionSelectOption>;
+  /**
+   * The name of the argument. Should be `camelCase` format
+   */
+  name: string;
+  /**
+   * Whether the user must fill in the argument
+   */
+  optional?: boolean;
+  /**
+   * The label of the input
+   */
+  label?: string;
+  /**
+   * The default value
+   */
+  defaultValue?: string;
+};
+
+export type TemplateFunctionSelectOption = { label: string; value: string };
+
+export type TemplateFunctionTextArg = {
+  /**
+   * Placeholder for the text input
+   */
+  placeholder?: string;
+  /**
+   * The name of the argument. Should be `camelCase` format
+   */
+  name: string;
+  /**
+   * Whether the user must fill in the argument
+   */
+  optional?: boolean;
+  /**
+   * The label of the input
+   */
+  label?: string;
+  /**
+   * The default value
+   */
+  defaultValue?: string;
+};
+
+export type TemplateRenderRequest = { data: JsonValue; purpose: RenderPurpose };
+
+export type TemplateRenderResponse = { data: JsonValue };
+
+export type WindowContext = { type: 'none' } | { type: 'label'; label: string };

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

@@ -0,0 +1,25 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type Environment = { model: "environment", id: string, workspaceId: string, environmentId: string | null, 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, description: string, sortPriority: number, };
+
+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>, description: string, 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, description: string, 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, state: HttpResponseState, url: string, version: string | null, };
+
+export type HttpResponseHeader = { name: string, value: string, };
+
+export type HttpResponseState = "initialized" | "connected" | "closed";
+
+export type HttpUrlParameter = { enabled?: boolean, name: string, value: string, };
+
+export type Workspace = { model: "workspace", id: string, createdAt: string, updatedAt: string, name: string, description: string, settingValidateCertificates: boolean, settingFollowRedirects: boolean, settingRequestTimeout: number, };

packages/plugin-runtime-types/src/bindings/serde_json/JsonValue.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type JsonValue = number | string | Array<JsonValue> | { [key in string]?: JsonValue };

packages/plugin-runtime-types/src/helpers.ts

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

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

@@ -0,0 +1,5 @@
+export type * from './plugins';
+export type * from './themes';
+
+export * from './bindings/models';
+export * from './bindings/events';

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

@@ -0,0 +1,38 @@
+import type {
+  FindHttpResponsesRequest,
+  FindHttpResponsesResponse,
+  GetHttpRequestByIdRequest,
+  GetHttpRequestByIdResponse,
+  PromptTextRequest,
+  PromptTextResponse,
+  RenderHttpRequestRequest,
+  RenderHttpRequestResponse,
+  SendHttpRequestRequest,
+  SendHttpRequestResponse,
+  ShowToastRequest,
+  TemplateRenderRequest,
+  TemplateRenderResponse,
+} from '..';
+
+export type Context = {
+  clipboard: {
+    copyText(text: string): void;
+  };
+  toast: {
+    show(args: ShowToastRequest): void;
+  };
+  prompt: {
+    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']>;
+  };
+  httpResponse: {
+    find(args: FindHttpResponsesRequest): Promise<FindHttpResponsesResponse['httpResponses']>;
+  };
+  templates: {
+    render(args: TemplateRenderRequest): Promise<TemplateRenderResponse['data']>;
+  };
+};

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

@@ -0,0 +1,13 @@
+import type { 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>;
+};

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

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

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

@@ -0,0 +1,17 @@
+import type { Environment, Folder, GrpcRequest, HttpRequest, Workspace } from '..';
+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'>[];
+};
+
+export type ImporterPlugin = {
+  name: string;
+  description?: string;
+  onImport(ctx: Context, args: { text: string }): Promise<ImportPluginResponse>;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,44 @@
+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>;
+  }>;
+};

packages/plugin-runtime-types/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "target": "es6",
+    "lib": ["es2021"],
+    "declaration": true,
+    "declarationDir": "./lib",
+    "outDir": "./lib",
+    "strict": true,
+    "types": ["node"]
+  },
+  "files": [
+    "src/index.ts"
+  ]
+}