@yaakapp/api 0.3.2 → 0.3.4

package/lib/bindings/events.d.ts

@@ -1,10 +1,10 @@
-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;
@@ -12,7 +12,6 @@ export type BootRequest = {
 export type BootResponse = {
     name: string;
     version: string;
-    capabilities: Array<string>;
 };
 export type CallHttpAuthenticationRequest = {
     config: {
@@ -56,6 +55,9 @@ export type CopyTextRequest = {
 };
 export type EditorLanguage = "text" | "javascript" | "json" | "html" | "xml" | "graphql" | "markdown";
 export type EmptyPayload = {};
+export type ErrorResponse = {
+    error: string;
+};
 export type ExportHttpRequestRequest = {
     httpRequest: HttpRequest;
 };
@@ -315,9 +317,10 @@ export type ImportResponse = {
 export type InternalEvent = {
     id: string;
     pluginRefId: string;
+    pluginName: string;
     replyId: string | null;
-    payload: InternalEventPayload;
     windowContext: WindowContext;
+    payload: InternalEventPayload;
 };
 export type InternalEventPayload = {
     "type": "boot_request";
@@ -395,7 +398,9 @@ export type InternalEventPayload = {
     "type": "find_http_responses_response";
 } & FindHttpResponsesResponse | {
     "type": "empty_response";
-} & EmptyPayload;
+} & EmptyPayload | {
+    "type": "error_response";
+} & ErrorResponse;
 export type PromptTextRequest = {
     id: string;
     title: string;

package/lib/plugins/AuthenticationPlugin.d.ts

@@ -1,5 +1,5 @@
-import { CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, GetHttpAuthenticationResponse } from '..';
-import type { Context } from './Context';
+import { CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, GetHttpAuthenticationResponse } from '../bindings/events';
+import { Context } from './Context';
 export type AuthenticationPlugin = Omit<GetHttpAuthenticationResponse, 'pluginName'> & {
     onApply(ctx: Context, args: CallHttpAuthenticationRequest): Promise<CallHttpAuthenticationResponse> | CallHttpAuthenticationResponse;
 };

package/lib/plugins/Context.d.ts

@@ -1,23 +1,23 @@
-import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '..';
-export type Context = {
+import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from "../bindings/events.ts";
+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"]>;
     };
-};
+}

package/lib/plugins/FilterPlugin.d.ts

@@ -1,13 +1,13 @@
 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;
+        filter: string;
         mimeType: string;
-    }): Promise<FilterPluginResponse>;
+    }): Promise<FilterPluginResponse> | FilterPluginResponse;
 };

package/lib/plugins/HttpRequestActionPlugin.d.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 & {
     onSelect(ctx: Context, args: CallHttpRequestActionArgs): Promise<void> | void;

package/lib/plugins/ImporterPlugin.d.ts

@@ -1,12 +1,14 @@
-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'>[];
+import { Environment, Folder, GrpcRequest, HttpRequest, Workspace } from "../bindings/models";
+import type { AtLeast } from "../helpers";
+import type { Context } from "./Context";
+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 = {
     name: string;
@@ -15,3 +17,4 @@ export type ImporterPlugin = {
         text: string;
     }): Promise<ImportPluginResponse>;
 };
+export {};

package/lib/plugins/TemplateFunctionPlugin.d.ts

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

package/lib/plugins/ThemePlugin.d.ts

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

package/lib/themes/Theme.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/themes/index.d.ts

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

package/package.json

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