@yaakapp/api 0.1.4 → 0.1.6

package/lib/gen/CallHttpRequestActionArgs.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequest } from "./HttpRequest";
+export type CallHttpRequestActionArgs = {
+    httpRequest: HttpRequest;
+};

package/lib/gen/CallHttpRequestActionArgs.js

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

package/lib/gen/CallHttpRequestActionRequest.d.ts

@@ -0,0 +1,6 @@
+import type { CallHttpRequestActionArgs } from "./CallHttpRequestActionArgs";
+export type CallHttpRequestActionRequest = {
+    key: string;
+    pluginRefId: string;
+    args: CallHttpRequestActionArgs;
+};

package/lib/gen/CallHttpRequestActionRequest.js

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

package/lib/gen/CopyTextRequest.d.ts

@@ -0,0 +1,3 @@
+export type CopyTextRequest = {
+    text: string;
+};

package/lib/gen/CopyTextRequest.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/gen/GetHttpRequestActionsRequest.d.ts

@@ -0,0 +1,3 @@
+export type GetHttpRequestActionsRequest = {
+    nothing: boolean;
+};

package/lib/gen/GetHttpRequestActionsRequest.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/gen/GetHttpRequestActionsResponse.d.ts

@@ -0,0 +1,5 @@
+import type { HttpRequestAction } from "./HttpRequestAction";
+export type GetHttpRequestActionsResponse = {
+    actions: Array<HttpRequestAction>;
+    pluginRefId: string;
+};

package/lib/gen/GetHttpRequestActionsResponse.js

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

package/lib/gen/GetHttpRequestByIdRequest.d.ts

@@ -0,0 +1,3 @@
+export type GetHttpRequestByIdRequest = {
+    id: string;
+};

package/lib/gen/GetHttpRequestByIdRequest.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/gen/GetHttpRequestByIdResponse.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequest } from "./HttpRequest";
+export type GetHttpRequestByIdResponse = {
+    httpRequest: HttpRequest | null;
+};

package/lib/gen/GetHttpRequestByIdResponse.js

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

package/lib/gen/HttpRequestAction.d.ts

@@ -0,0 +1,5 @@
+export type HttpRequestAction = {
+    key: string;
+    label: string;
+    icon: string | null;
+};

package/lib/gen/HttpRequestAction.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/gen/InternalEventPayload.d.ts

@@ -1,12 +1,22 @@
 import type { BootRequest } from "./BootRequest";
 import type { BootResponse } from "./BootResponse";
+import type { CallHttpRequestActionRequest } from "./CallHttpRequestActionRequest";
+import type { CopyTextRequest } from "./CopyTextRequest";
 import type { EmptyResponse } from "./EmptyResponse";
 import type { ExportHttpRequestRequest } from "./ExportHttpRequestRequest";
 import type { ExportHttpRequestResponse } from "./ExportHttpRequestResponse";
 import type { FilterRequest } from "./FilterRequest";
 import type { FilterResponse } from "./FilterResponse";
+import type { GetHttpRequestActionsResponse } from "./GetHttpRequestActionsResponse";
+import type { GetHttpRequestByIdRequest } from "./GetHttpRequestByIdRequest";
+import type { GetHttpRequestByIdResponse } from "./GetHttpRequestByIdResponse";
 import type { ImportRequest } from "./ImportRequest";
 import type { ImportResponse } from "./ImportResponse";
+import type { RenderHttpRequestRequest } from "./RenderHttpRequestRequest";
+import type { RenderHttpRequestResponse } from "./RenderHttpRequestResponse";
+import type { SendHttpRequestRequest } from "./SendHttpRequestRequest";
+import type { SendHttpRequestResponse } from "./SendHttpRequestResponse";
+import type { ShowToastRequest } from "./ShowToastRequest";
 export type InternalEventPayload = {
     "type": "boot_request";
 } & BootRequest | {
@@ -24,5 +34,27 @@ export type InternalEventPayload = {
 } & 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";
+} | {
+    "type": "get_http_request_actions_response";
+} & GetHttpRequestActionsResponse | {
+    "type": "call_http_request_action_request";
+} & CallHttpRequestActionRequest | {
+    "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": "empty_response";
 } & EmptyResponse;

package/lib/gen/RenderHttpRequestRequest.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequest } from "./HttpRequest";
+export type RenderHttpRequestRequest = {
+    httpRequest: HttpRequest;
+};

package/lib/gen/RenderHttpRequestRequest.js

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

package/lib/gen/RenderHttpRequestResponse.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequest } from "./HttpRequest";
+export type RenderHttpRequestResponse = {
+    httpRequest: HttpRequest;
+};

package/lib/gen/RenderHttpRequestResponse.js

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

package/lib/gen/SendHttpRequestRequest.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequest } from "./HttpRequest";
+export type SendHttpRequestRequest = {
+    httpRequest: HttpRequest;
+};

package/lib/gen/SendHttpRequestRequest.js

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

package/lib/gen/SendHttpRequestResponse.d.ts

@@ -0,0 +1,4 @@
+import type { HttpResponse } from "./HttpResponse";
+export type SendHttpRequestResponse = {
+    httpResponse: HttpResponse;
+};

package/lib/gen/SendHttpRequestResponse.js

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

package/lib/gen/ShowToastRequest.d.ts

@@ -0,0 +1,5 @@
+import type { ToastVariant } from "./ToastVariant";
+export type ShowToastRequest = {
+    message: string;
+    variant: ToastVariant;
+};

package/lib/gen/ShowToastRequest.js

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

package/lib/gen/ToastVariant.d.ts

@@ -0,0 +1 @@
+export type ToastVariant = "custom" | "copied" | "success" | "info" | "warning" | "error";

package/lib/gen/ToastVariant.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

@@ -2,6 +2,8 @@ export type * from './plugins';
 export type * from './themes';
 export * from './gen/BootRequest';
 export * from './gen/BootResponse';
+export * from './gen/CallHttpRequestActionRequest';
+export * from './gen/CallHttpRequestActionArgs';
 export * from './gen/Cookie';
 export * from './gen/CookieDomain';
 export * from './gen/CookieExpires';
@@ -14,11 +16,16 @@ export * from './gen/ExportHttpRequestResponse';
 export * from './gen/FilterRequest';
 export * from './gen/FilterResponse';
 export * from './gen/Folder';
+export * from './gen/GetHttpRequestActionsResponse';
+export * from './gen/GetHttpRequestByIdRequest';
+export * from './gen/CopyTextRequest';
+export * from './gen/GetHttpRequestByIdResponse';
 export * from './gen/GrpcConnection';
 export * from './gen/GrpcEvent';
 export * from './gen/GrpcMetadataEntry';
 export * from './gen/GrpcRequest';
 export * from './gen/HttpRequest';
+export * from './gen/HttpRequestAction';
 export * from './gen/HttpRequestHeader';
 export * from './gen/HttpResponse';
 export * from './gen/HttpResponseHeader';
@@ -30,5 +37,12 @@ export * from './gen/InternalEvent';
 export * from './gen/InternalEventPayload';
 export * from './gen/KeyValue';
 export * from './gen/Model';
+export * from './gen/SendHttpRequestRequest';
+export * from './gen/ToastVariant';
+export * from './gen/ShowToastRequest';
+export * from './gen/RenderHttpRequestRequest';
+export * from './gen/RenderHttpRequestResponse';
+export * from './gen/SendHttpRequestResponse';
+export * from './gen/SendHttpRequestResponse';
 export * from './gen/Settings';
 export * from './gen/Workspace';

package/lib/index.js

@@ -14,8 +14,11 @@ 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 });
+// TODO: The next ts-rs release includes the ability to put everything in 1 file!
 __exportStar(require("./gen/BootRequest"), exports);
 __exportStar(require("./gen/BootResponse"), exports);
+__exportStar(require("./gen/CallHttpRequestActionRequest"), exports);
+__exportStar(require("./gen/CallHttpRequestActionArgs"), exports);
 __exportStar(require("./gen/Cookie"), exports);
 __exportStar(require("./gen/CookieDomain"), exports);
 __exportStar(require("./gen/CookieExpires"), exports);
@@ -28,11 +31,16 @@ __exportStar(require("./gen/ExportHttpRequestResponse"), exports);
 __exportStar(require("./gen/FilterRequest"), exports);
 __exportStar(require("./gen/FilterResponse"), exports);
 __exportStar(require("./gen/Folder"), exports);
+__exportStar(require("./gen/GetHttpRequestActionsResponse"), exports);
+__exportStar(require("./gen/GetHttpRequestByIdRequest"), exports);
+__exportStar(require("./gen/CopyTextRequest"), exports);
+__exportStar(require("./gen/GetHttpRequestByIdResponse"), exports);
 __exportStar(require("./gen/GrpcConnection"), exports);
 __exportStar(require("./gen/GrpcEvent"), exports);
 __exportStar(require("./gen/GrpcMetadataEntry"), exports);
 __exportStar(require("./gen/GrpcRequest"), exports);
 __exportStar(require("./gen/HttpRequest"), exports);
+__exportStar(require("./gen/HttpRequestAction"), exports);
 __exportStar(require("./gen/HttpRequestHeader"), exports);
 __exportStar(require("./gen/HttpResponse"), exports);
 __exportStar(require("./gen/HttpResponseHeader"), exports);
@@ -44,5 +52,12 @@ __exportStar(require("./gen/InternalEvent"), exports);
 __exportStar(require("./gen/InternalEventPayload"), exports);
 __exportStar(require("./gen/KeyValue"), exports);
 __exportStar(require("./gen/Model"), exports);
+__exportStar(require("./gen/SendHttpRequestRequest"), exports);
+__exportStar(require("./gen/ToastVariant"), exports);
+__exportStar(require("./gen/ShowToastRequest"), exports);
+__exportStar(require("./gen/RenderHttpRequestRequest"), exports);
+__exportStar(require("./gen/RenderHttpRequestResponse"), exports);
+__exportStar(require("./gen/SendHttpRequestResponse"), exports);
+__exportStar(require("./gen/SendHttpRequestResponse"), exports);
 __exportStar(require("./gen/Settings"), exports);
 __exportStar(require("./gen/Workspace"), exports);

package/lib/plugins/context.d.ts

@@ -1,11 +1,20 @@
-import { HttpRequest } from '../gen/HttpRequest';
-import { HttpResponse } from '../gen/HttpResponse';
+import { GetHttpRequestByIdRequest } from '../gen/GetHttpRequestByIdRequest';
+import { GetHttpRequestByIdResponse } from '../gen/GetHttpRequestByIdResponse';
+import { RenderHttpRequestRequest } from '../gen/RenderHttpRequestRequest';
+import { RenderHttpRequestResponse } from '../gen/RenderHttpRequestResponse';
+import { SendHttpRequestRequest } from '../gen/SendHttpRequestRequest';
+import { SendHttpRequestResponse } from '../gen/SendHttpRequestResponse';
+import { ShowToastRequest } from '../gen/ShowToastRequest';
 export type YaakContext = {
-    metadata: {
-        getVersion(): Promise<string>;
+    clipboard: {
+        copyText(text: string): void;
+    };
+    toast: {
+        show(args: ShowToastRequest): void;
     };
     httpRequest: {
-        send(id: string): Promise<HttpResponse>;
-        getById(id: string): Promise<HttpRequest | null>;
+        send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
+        getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;
+        render(args: RenderHttpRequestRequest): Promise<RenderHttpRequestResponse['httpRequest']>;
     };
 };

package/lib/plugins/httpRequestAction.d.ts

@@ -1,9 +1,6 @@
-import { HttpRequest } from '../gen/HttpRequest';
+import { CallHttpRequestActionArgs } from '../gen/CallHttpRequestActionArgs';
+import { HttpRequestAction } from '../gen/HttpRequestAction';
 import { YaakContext } from './context';
-export type HttpRequestActionPlugin = {
-    key: string;
-    label: string;
-    onSelect(ctx: YaakContext, args: {
-        httpRequest: HttpRequest;
-    }): void;
+export type HttpRequestActionPlugin = HttpRequestAction & {
+    onSelect(ctx: YaakContext, args: CallHttpRequestActionArgs): Promise<void> | void;
 };

package/lib/plugins/index.d.ts

@@ -1,14 +1,14 @@
-import { OneOrMany } from '../helpers';
 import { FilterPlugin } from './filter';
 import { HttpRequestActionPlugin } from './httpRequestAction';
 import { ImporterPlugin } from './import';
 import { ThemePlugin } from './theme';
+export { YaakContext } from './context';
 /**
  * The global structure of a Yaak plugin
  */
 export type YaakPlugin = {
-    importer?: OneOrMany<ImporterPlugin>;
-    theme?: OneOrMany<ThemePlugin>;
-    filter?: OneOrMany<FilterPlugin>;
-    httpRequestAction?: OneOrMany<HttpRequestActionPlugin>;
+    importer?: ImporterPlugin;
+    theme?: ThemePlugin;
+    filter?: FilterPlugin;
+    httpRequestActions?: HttpRequestActionPlugin[];
 };

package/package.json

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