@yaakapp/api 0.2.6 → 0.2.7

package/lib/bindings/events.d.ts

@@ -0,0 +1,228 @@
+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 { 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 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/bindings/events.js

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

package/lib/bindings/models.d.ts

@@ -0,0 +1,109 @@
+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 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 Workspace = {
+    model: "workspace";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    description: string;
+    variables: Array<EnvironmentVariable>;
+    settingValidateCertificates: boolean;
+    settingFollowRedirects: boolean;
+    settingRequestTimeout: number;
+};

package/lib/bindings/models.js

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

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 export type * from './plugins';
 export type * from './themes';
-export * from '@yaakapp-internal/plugin';
+export * from './bindings/models';
+export * from './bindings/events';

package/lib/index.js

@@ -14,4 +14,5 @@ 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("@yaakapp-internal/plugin"), exports);
+__exportStar(require("./bindings/models"), exports);
+__exportStar(require("./bindings/events"), exports);

package/lib/plugins/Context.d.ts

@@ -1,4 +1,4 @@
-import { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest } from '@yaakapp-internal/plugin';
+import { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest } from '..';
 export type Context = {
     clipboard: {
         copyText(text: string): void;

package/lib/plugins/HttpRequestActionPlugin.d.ts

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

package/lib/plugins/ImporterPlugin.d.ts

@@ -1,4 +1,4 @@
-import { Environment, Folder, HttpRequest, Workspace } from '@yaakapp-internal/models';
+import { Environment, Folder, HttpRequest, Workspace } from '..';
 import { AtLeast } from '../helpers';
 import { Context } from './Context';
 export type ImportPluginResponse = null | {

package/lib/plugins/TemplateFunctionPlugin.d.ts

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

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [
-    "lib"
+    "lib/**/*"
   ],
   "scripts": {
-    "build": "tsc",
+    "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/",
     "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"
   }
 }