@yaakapp/api 0.2.10 → 0.2.12

package/lib/bindings/events.d.ts

@@ -54,7 +54,7 @@ export type FilterResponse = {
 };
 export type FindHttpResponsesRequest = {
     requestId: string;
-    limit: number | null;
+    limit?: number;
 };
 export type FindHttpResponsesResponse = {
     httpResponses: Array<HttpResponse>;
@@ -77,9 +77,9 @@ export type GetTemplateFunctionsResponse = {
 export type HttpRequestAction = {
     key: string;
     label: string;
-    icon: string | null;
+    icon?: Icon;
 };
-export type Icon = "copy" | "info" | "check_circle" | "alert_triangle";
+export type Icon = "copy" | "info" | "check_circle" | "alert_triangle" | "_unknown";
 export type ImportRequest = {
     content: string;
 };
@@ -145,12 +145,20 @@ export type InternalEventPayload = {
 } & CallTemplateFunctionResponse | {
     "type": "copy_text_request";
 } & CopyTextRequest | {
+    "type": "render_http_request_request";
+} & RenderHttpRequestRequest | {
+    "type": "render_http_request_response";
+} & RenderHttpRequestResponse | {
     "type": "template_render_request";
 } & TemplateRenderRequest | {
     "type": "template_render_response";
 } & TemplateRenderResponse | {
     "type": "show_toast_request";
 } & ShowToastRequest | {
+    "type": "show_prompt_request";
+} & ShowPromptRequest | {
+    "type": "show_prompt_response";
+} & ShowPromptResponse | {
     "type": "get_http_request_by_id_request";
 } & GetHttpRequestByIdRequest | {
     "type": "get_http_request_by_id_response";
@@ -161,6 +169,10 @@ export type InternalEventPayload = {
 } & FindHttpResponsesResponse | {
     "type": "empty_response";
 };
+export type OpenFileFilter = {
+    name: string;
+    extensions: Array<string>;
+};
 export type RenderHttpRequestRequest = {
     httpRequest: HttpRequest;
     purpose: RenderPurpose;
@@ -175,14 +187,37 @@ export type SendHttpRequestRequest = {
 export type SendHttpRequestResponse = {
     httpResponse: HttpResponse;
 };
+export type ShowPromptRequest = {
+    id: string;
+    title: string;
+    label: string;
+    description?: string;
+    defaultValue?: string;
+    placeholder?: string;
+    /**
+     * Text to add to the confirmation button
+     */
+    confirmText?: string;
+    /**
+     * Text to add to the cancel button
+     */
+    cancelText?: string;
+    /**
+     * Require the user to enter a non-empty value
+     */
+    require?: boolean;
+};
+export type ShowPromptResponse = {
+    value: string;
+};
 export type ShowToastRequest = {
     message: string;
-    color?: Color | null;
-    icon?: Icon | null;
+    color?: Color;
+    icon?: Icon;
 };
 export type TemplateFunction = {
     name: string;
-    aliases: Array<string>;
+    aliases?: Array<string>;
     args: Array<TemplateFunctionArg>;
 };
 export type TemplateFunctionArg = {
@@ -193,42 +228,55 @@ export type TemplateFunctionArg = {
     "type": "checkbox";
 } & TemplateFunctionCheckboxArg | {
     "type": "http_request";
-} & TemplateFunctionHttpRequestArg;
+} & TemplateFunctionHttpRequestArg | {
+    "type": "file";
+} & TemplateFunctionFileArg;
 export type TemplateFunctionBaseArg = {
     name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
+    optional?: boolean;
+    label?: string;
+    defaultValue?: string;
 };
 export type TemplateFunctionCheckboxArg = {
     name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
+    optional?: boolean;
+    label?: string;
+    defaultValue?: string;
+};
+export type TemplateFunctionFileArg = {
+    title: string;
+    multiple?: boolean;
+    directory?: boolean;
+    defaultPath?: string;
+    filters?: Array<OpenFileFilter>;
+    name: string;
+    optional?: boolean;
+    label?: string;
+    defaultValue?: string;
 };
 export type TemplateFunctionHttpRequestArg = {
     name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
+    optional?: boolean;
+    label?: string;
+    defaultValue?: string;
 };
 export type TemplateFunctionSelectArg = {
     options: Array<TemplateFunctionSelectOption>;
     name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
+    optional?: boolean;
+    label?: string;
+    defaultValue?: string;
 };
 export type TemplateFunctionSelectOption = {
     name: string;
     value: string;
 };
 export type TemplateFunctionTextArg = {
-    placeholder?: string | null;
+    placeholder?: string;
     name: string;
-    optional?: boolean | null;
-    label?: string | null;
-    defaultValue?: string | null;
+    optional?: boolean;
+    label?: string;
+    defaultValue?: string;
 };
 export type TemplateRenderRequest = {
     data: JsonValue;

package/lib/plugins/Context.d.ts

@@ -1,4 +1,4 @@
-import { TemplateRenderRequest, TemplateRenderResponse } from '@yaakapp-internal/plugin';
+import { ShowPromptRequest, ShowPromptResponse, TemplateRenderRequest, TemplateRenderResponse } from '@yaakapp-internal/plugin';
 import { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest } from '..';
 export type Context = {
     clipboard: {
@@ -7,6 +7,9 @@ export type Context = {
     toast: {
         show(args: ShowToastRequest): void;
     };
+    prompt: {
+        show(args: ShowPromptRequest): Promise<ShowPromptResponse['value']>;
+    };
     httpRequest: {
         send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
         getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;

package/package.json

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