@yaakapp/api 0.3.1 → 0.3.3

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: {
@@ -142,8 +141,11 @@ export type FormInputEditor = {
     /**
      * Don't show the editor gutter (line numbers, folds, etc.)
      */
-    hideGutter?: boolean | null;
-    language: EditorLanguage;
+    hideGutter?: boolean;
+    /**
+     * Language for syntax highlighting
+     */
+    language?: EditorLanguage;
     name: string;
     /**
      * Whether the user must fill in the argument
@@ -312,6 +314,7 @@ export type ImportResponse = {
 export type InternalEvent = {
     id: string;
     pluginRefId: string;
+    pluginName: string;
     replyId: string | null;
     payload: InternalEventPayload;
     windowContext: WindowContext;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-export type * from './plugins';
-export type * from './themes';
-export * from './bindings/models';
-export * from './bindings/events';
+export type * from './plugins/index.ts';
+export type * from './themes/index.ts';
+export * from './bindings/models.ts';
+export * from './bindings/events.ts';

package/lib/plugins/AuthenticationPlugin.d.ts

@@ -1,5 +1,5 @@
-import { CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, GetHttpAuthenticationResponse } from '..';
-import type { Context } from './Context';
-export type AuthenticationPlugin = Omit<GetHttpAuthenticationResponse, 'pluginName'> & {
+import { CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, GetHttpAuthenticationResponse } from "../bindings/events.ts";
+import { Context } from "./Context.ts";
+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[];
+import type { Context } from './Context.ts';
+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,5 +1,5 @@
-import type { CallHttpRequestActionArgs, HttpRequestAction } from '..';
-import type { Context } from './Context';
+import type { CallHttpRequestActionArgs, HttpRequestAction } from "../bindings/events.ts";
+import type { Context } from "./Context.ts";
 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.ts";
+import type { AtLeast } from "../helpers.ts";
+import type { Context } from "./Context.ts";
+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.ts";
+import { Context } from "./Context.ts";
 export type TemplateFunctionPlugin = TemplateFunction & {
     onRender(ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null>;
 };

package/lib/plugins/ThemePlugin.d.ts

@@ -1,5 +1,5 @@
-import type { Theme } from '../themes';
-import type { Context } from './Context';
+import { Theme } from "../themes/index.ts";
+import { Context } from "./Context.ts";
 export type ThemePlugin = {
     name: string;
     description?: string;

package/lib/plugins/index.d.ts

@@ -1,10 +1,10 @@
-import { AuthenticationPlugin } from './AuthenticationPlugin';
-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';
+import { AuthenticationPlugin } from './AuthenticationPlugin.ts';
+import type { FilterPlugin } from './FilterPlugin.ts';
+import type { HttpRequestActionPlugin } from './HttpRequestActionPlugin.ts';
+import type { ImporterPlugin } from './ImporterPlugin.ts';
+import type { TemplateFunctionPlugin } from './TemplateFunctionPlugin.ts';
+import type { ThemePlugin } from './ThemePlugin.ts';
+export type { Context } from './Context.ts';
 /**
  * The global structure of a Yaak plugin
  */

package/package.json

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

package/lib/bindings/events.js

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

package/lib/bindings/models.js

@@ -1,3 +0,0 @@
-"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/bindings/serde_json/JsonValue.js

@@ -1,3 +0,0 @@
-"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/helpers.js

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

package/lib/index.js

@@ -1,18 +0,0 @@
-"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("./bindings/models"), exports);
-__exportStar(require("./bindings/events"), exports);

package/lib/plugins/AuthenticationPlugin.js

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

package/lib/plugins/Context.js

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

package/lib/plugins/FilterPlugin.js

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

package/lib/plugins/HttpRequestActionPlugin.js

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

package/lib/plugins/ImporterPlugin.js

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

package/lib/plugins/TemplateFunctionPlugin.js

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

package/lib/plugins/ThemePlugin.js

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

package/lib/plugins/index.js

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

package/lib/themes/index.js

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