@yaakapp/api 0.6.0 → 0.6.2

package/README.md

@@ -0,0 +1,27 @@
+# Yaak Plugin API
+
+Yaak is a desktop API client for interacting with REST, GraphQL, Server Sent Events (SSE),
+WebSocket, and gRPC APIs. It's built using Tauri, Rust, and ReactJS.
+
+Plugins can be created in TypeScript, which are executed alongside Yaak in a NodeJS
+runtime. This package contains the TypeScript type definitions required to make building
+Yaak plugins a breeze.
+
+## Quick Start
+
+The easiest way to get started is by generating a plugin with the Yaak CLI:
+
+```shell
+npx @yaakapp/cli generate
+```
+
+For more details on creating plugins, check out
+the [Quick Start Guide](https://feedback.yaak.app/help/articles/6911763-plugins-quick-start)
+
+## Installation
+
+If you prefer starting from scratch, manually install the types package:
+
+```shell
+npm install @yaakapp/api
+```

package/lib/bindings/gen_events.d.ts

@@ -1,11 +1,5 @@
-import type { Environment } from "./gen_models.js";
-import type { Folder } from "./gen_models.js";
-import type { GrpcRequest } from "./gen_models.js";
-import type { HttpRequest } from "./gen_models.js";
-import type { HttpResponse } from "./gen_models.js";
+import type { Environment, Folder, GrpcRequest, HttpRequest, HttpResponse, WebsocketRequest, Workspace } from "./gen_models.js";
 import type { JsonValue } from "./serde_json/JsonValue.js";
-import type { WebsocketRequest } from "./gen_models.js";
-import type { Workspace } from "./gen_models.js";
 export type BootRequest = {
     dir: string;
     watch: boolean;
@@ -52,7 +46,7 @@ export type CallHttpRequestActionRequest = {
 export type CallTemplateFunctionArgs = {
     purpose: RenderPurpose;
     values: {
-        [key in string]?: string;
+        [key in string]?: JsonValue;
     };
 };
 export type CallTemplateFunctionRequest = {

package/lib/bindings/gen_models.d.ts

@@ -8,6 +8,7 @@ export type Environment = {
     public: boolean;
     base: boolean;
     variables: Array<EnvironmentVariable>;
+    color: string | null;
 };
 export type EnvironmentVariable = {
     enabled?: boolean;

package/package.json

@@ -1,6 +1,12 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.6.0",
+  "version": "0.6.2",
+  "keywords": [
+    "api-client",
+    "insomnia-alternative",
+    "bruno-alternative",
+    "postman-alternative"
+  ],
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [