@yaakapp/api 0.5.3 → 0.6.1

package/README.md

@@ -0,0 +1,23 @@
+# 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.
+
+Yaak plugins are written in TypeScript and executed within 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
+```
+
+## 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 = {
@@ -171,6 +165,10 @@ export type FormInputBase = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputCheckbox = {
     /**
@@ -199,6 +197,10 @@ export type FormInputCheckbox = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputEditor = {
     /**
@@ -241,6 +243,10 @@ export type FormInputEditor = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputFile = {
     /**
@@ -280,6 +286,10 @@ export type FormInputFile = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputHttpRequest = {
     /**
@@ -308,6 +318,10 @@ export type FormInputHttpRequest = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputMarkdown = {
     content: string;
@@ -344,6 +358,10 @@ export type FormInputSelect = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputSelectOption = {
     label: string;
@@ -389,6 +407,10 @@ export type FormInputText = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type GenericCompletionOption = {
     label: string;
@@ -397,6 +419,12 @@ export type GenericCompletionOption = {
     type?: CompletionOptionType;
     boost?: number;
 };
+export type GetCookieValueRequest = {
+    name: string;
+};
+export type GetCookieValueResponse = {
+    value: string | null;
+};
 export type GetHttpAuthenticationConfigRequest = {
     contextId: string;
     values: {
@@ -498,6 +526,14 @@ export type InternalEventPayload = {
 } & SendHttpRequestRequest | {
     "type": "send_http_request_response";
 } & SendHttpRequestResponse | {
+    "type": "list_cookie_names_request";
+} & ListCookieNamesRequest | {
+    "type": "list_cookie_names_response";
+} & ListCookieNamesResponse | {
+    "type": "get_cookie_value_request";
+} & GetCookieValueRequest | {
+    "type": "get_cookie_value_response";
+} & GetCookieValueResponse | {
     "type": "get_http_request_actions_request";
 } & EmptyPayload | {
     "type": "get_http_request_actions_response";
@@ -581,6 +617,10 @@ export type InternalEventPayload = {
     "type": "error_response";
 } & ErrorResponse;
 export type JsonPrimitive = string | number | boolean | null;
+export type ListCookieNamesRequest = {};
+export type ListCookieNamesResponse = {
+    names: Array<string>;
+};
 export type OpenWindowRequest = {
     url: string;
     /**

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;
@@ -22,15 +23,12 @@ export type Folder = {
     updatedAt: string;
     workspaceId: string;
     folderId: string | null;
-    name: string;
+    authentication: Record<string, any>;
+    authenticationType: string | null;
     description: string;
-    sortPriority: number;
-};
-export type GrpcMetadataEntry = {
-    enabled?: boolean;
+    headers: Array<HttpRequestHeader>;
     name: string;
-    value: string;
-    id?: string;
+    sortPriority: number;
 };
 export type GrpcRequest = {
     model: "grpc_request";
@@ -43,7 +41,7 @@ export type GrpcRequest = {
     authentication: Record<string, any>;
     description: string;
     message: string;
-    metadata: Array<GrpcMetadataEntry>;
+    metadata: Array<HttpRequestHeader>;
     method: string | null;
     name: string;
     service: string | null;
@@ -128,8 +126,11 @@ export type Workspace = {
     id: string;
     createdAt: string;
     updatedAt: string;
-    name: string;
+    authentication: Record<string, any>;
+    authenticationType: string | null;
     description: string;
+    headers: Array<HttpRequestHeader>;
+    name: string;
     encryptionKeyChallenge: string | null;
     settingValidateCertificates: boolean;
     settingFollowRedirects: boolean;

package/lib/plugins/Context.d.ts

@@ -1,4 +1,4 @@
-import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, OpenWindowRequest, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '../bindings/gen_events.ts';
+import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetCookieValueRequest, GetCookieValueResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, ListCookieNamesResponse, OpenWindowRequest, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '../bindings/gen_events.ts';
 export interface Context {
     clipboard: {
         copyText(text: string): Promise<void>;
@@ -24,6 +24,10 @@ export interface Context {
             close: () => void;
         }>;
     };
+    cookies: {
+        listNames(): Promise<ListCookieNamesResponse['names']>;
+        getValue(args: GetCookieValueRequest): Promise<GetCookieValueResponse['value']>;
+    };
     httpRequest: {
         send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
         getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;

package/package.json

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