@yaakapp/api 0.2.5 → 0.2.6

package/lib/helpers.d.ts

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

package/lib/index.d.ts

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

package/lib/index.js

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

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

@@ -0,0 +1,2 @@
+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/index.d.ts

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,18 @@
+"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

@@ -0,0 +1,17 @@
+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

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

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

@@ -0,0 +1,13 @@
+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

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

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

@@ -0,0 +1,5 @@
+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

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

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

@@ -0,0 +1,16 @@
+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

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

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

@@ -0,0 +1,5 @@
+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

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

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

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

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

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

@@ -0,0 +1,16 @@
+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

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

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

@@ -0,0 +1,39 @@
+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

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

package/lib/plugins/Context.d.ts

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

package/lib/plugins/HttpRequestActionPlugin.d.ts

@@ -1,4 +1,4 @@
-import { CallHttpRequestActionArgs, HttpRequestAction } from '../gen/events';
+import { CallHttpRequestActionArgs, HttpRequestAction } from '@yaakapp-internal/plugin';
 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 '../gen/models';
+import { Environment, Folder, HttpRequest, Workspace } from '@yaakapp-internal/models';
 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 '../gen/events';
+import { CallTemplateFunctionArgs, TemplateFunction } from '@yaakapp-internal/plugin';
 import { Context } from './Context';
 export type TemplateFunctionPlugin = TemplateFunction & {
     onRender(ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null>;

package/lib/{gen → src-tauri/yaak_plugin_runtime/bindings}/events.d.ts

@@ -1,4 +1,3 @@
-import type { CookieJar } from "./models";
 import type { Environment } from "./models";
 import type { Folder } from "./models";
 import type { GrpcConnection } from "./models";
@@ -7,8 +6,6 @@ import type { GrpcRequest } from "./models";
 import type { HttpRequest } from "./models";
 import type { HttpResponse } from "./models";
 import type { KeyValue } from "./models";
-import type { Plugin } from "./models";
-import type { Settings } from "./models";
 import type { Workspace } from "./models";
 export type BootRequest = {
     dir: string;
@@ -164,7 +161,7 @@ export type InternalEventPayload = {
 } & FindHttpResponsesResponse | {
     "type": "empty_response";
 };
-export type Model = Environment | Folder | GrpcConnection | GrpcEvent | GrpcRequest | HttpRequest | HttpResponse | KeyValue | Workspace | CookieJar | Settings | Plugin;
+export type Model = Environment | Folder | GrpcConnection | GrpcEvent | GrpcRequest | HttpRequest | HttpResponse | KeyValue | Workspace;
 export type RenderHttpRequestRequest = {
     httpRequest: HttpRequest;
     purpose: RenderPurpose;

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

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

package/lib/{gen → src-tauri/yaak_plugin_runtime/bindings}/models.d.ts

@@ -1,30 +1,7 @@
-export type Cookie = {
-    raw_cookie: string;
-    domain: CookieDomain;
-    expires: CookieExpires;
-    path: [string, boolean];
-};
-export type CookieDomain = {
-    "HostOnly": string;
-} | {
-    "Suffix": string;
-} | "NotPresent" | "Empty";
-export type CookieExpires = {
-    "AtUtc": string;
-} | "SessionEnd";
-export type CookieJar = {
-    id: string;
-    model: "cookie_jar";
-    createdAt: string;
-    updatedAt: string;
-    workspaceId: string;
-    name: string;
-    cookies: Array<Cookie>;
-};
 export type Environment = {
+    model: "environment";
     id: string;
     workspaceId: string;
-    model: "environment";
     createdAt: string;
     updatedAt: string;
     name: string;
@@ -36,47 +13,47 @@ export type EnvironmentVariable = {
     value: string;
 };
 export type Folder = {
+    model: "folder";
+    id: string;
     createdAt: string;
     updatedAt: string;
-    id: string;
     workspaceId: string;
     folderId: string | null;
-    model: "folder";
     name: string;
     sortPriority: number;
 };
 export type GrpcConnection = {
-    id: string;
     model: "grpc_connection";
-    workspaceId: string;
-    requestId: string;
+    id: string;
     createdAt: string;
     updatedAt: string;
-    service: string;
-    method: string;
+    workspaceId: string;
+    requestId: string;
     elapsed: number;
-    status: number;
-    url: string;
     error: string | null;
+    method: string;
+    service: string;
+    status: number;
     trailers: {
         [key in string]?: string;
     };
+    url: string;
 };
 export type GrpcEvent = {
-    id: string;
     model: "grpc_event";
+    id: string;
+    createdAt: string;
+    updatedAt: string;
     workspaceId: string;
     requestId: string;
     connectionId: string;
-    createdAt: string;
-    updatedAt: string;
     content: string;
+    error: string | null;
     eventType: GrpcEventType;
     metadata: {
         [key in string]?: string;
     };
     status: number | null;
-    error: string | null;
 };
 export type GrpcEventType = "info" | "error" | "client_message" | "server_message" | "connection_start" | "connection_end";
 export type GrpcMetadataEntry = {
@@ -85,39 +62,39 @@ export type GrpcMetadataEntry = {
     value: string;
 };
 export type GrpcRequest = {
-    id: string;
     model: "grpc_request";
-    workspaceId: string;
+    id: string;
     createdAt: string;
     updatedAt: string;
+    workspaceId: string;
     folderId: string | null;
-    name: string;
-    sortPriority: number;
-    url: string;
-    service: string | null;
-    method: string | null;
-    message: string;
     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;
-    id: string;
     workspaceId: string;
     folderId: string | null;
-    model: "http_request";
-    sortPriority: number;
-    name: string;
-    url: string;
-    urlParameters: Array<HttpUrlParameter>;
-    method: string;
-    body: Record<string, any>;
-    bodyType: 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;
@@ -125,23 +102,23 @@ export type HttpRequestHeader = {
     value: string;
 };
 export type HttpResponse = {
-    id: string;
     model: "http_response";
-    workspaceId: string;
-    requestId: string;
+    id: string;
     createdAt: string;
     updatedAt: string;
-    error: string | null;
-    url: string;
+    workspaceId: string;
+    requestId: string;
+    bodyPath: string | null;
     contentLength: number | null;
-    version: string | null;
     elapsed: number;
     elapsedHeaders: number;
+    error: string | null;
+    headers: Array<HttpResponseHeader>;
     remoteAddr: string | null;
     status: number;
     statusReason: string | null;
-    bodyPath: string | null;
-    headers: Array<HttpResponseHeader>;
+    url: string;
+    version: string | null;
 };
 export type HttpResponseHeader = {
     name: string;
@@ -156,40 +133,13 @@ export type KeyValue = {
     model: "key_value";
     createdAt: string;
     updatedAt: string;
-    namespace: string;
     key: string;
+    namespace: string;
     value: string;
 };
-export type Plugin = {
-    id: string;
-    model: "plugin";
-    createdAt: string;
-    updatedAt: string;
-    checkedAt: string | null;
-    directory: string;
-    url: string | null;
-    enabled: boolean;
-};
-export type Settings = {
-    id: string;
-    model: "settings";
-    createdAt: string;
-    updatedAt: string;
-    theme: string;
-    appearance: string;
-    themeDark: string;
-    themeLight: string;
-    updateChannel: string;
-    interfaceFontSize: number;
-    interfaceScale: number;
-    editorFontSize: number;
-    editorSoftWrap: boolean;
-    telemetry: boolean;
-    openWorkspaceNewWindow: boolean | null;
-};
 export type Workspace = {
-    id: string;
     model: "workspace";
+    id: string;
     createdAt: string;
     updatedAt: string;
     name: string;

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

@@ -1,3 +1,2 @@
-"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 });
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [