@yaakapp/api 0.2.13 → 0.2.15

package/lib/bindings/events.d.ts

@@ -155,10 +155,10 @@ export type InternalEventPayload = {
 } & TemplateRenderResponse | {
     "type": "show_toast_request";
 } & ShowToastRequest | {
-    "type": "show_prompt_request";
-} & ShowPromptRequest | {
-    "type": "show_prompt_response";
-} & ShowPromptResponse | {
+    "type": "prompt_text_request";
+} & PromptTextRequest | {
+    "type": "prompt_text_response";
+} & PromptTextResponse | {
     "type": "get_http_request_by_id_request";
 } & GetHttpRequestByIdRequest | {
     "type": "get_http_request_by_id_response";
@@ -171,23 +171,12 @@ export type InternalEventPayload = {
 };
 export type OpenFileFilter = {
     name: string;
+    /**
+     * File extensions to require
+     */
     extensions: Array<string>;
 };
-export type RenderHttpRequestRequest = {
-    httpRequest: HttpRequest;
-    purpose: RenderPurpose;
-};
-export type RenderHttpRequestResponse = {
-    httpRequest: HttpRequest;
-};
-export type RenderPurpose = "send" | "preview";
-export type SendHttpRequestRequest = {
-    httpRequest: HttpRequest;
-};
-export type SendHttpRequestResponse = {
-    httpResponse: HttpResponse;
-};
-export type ShowPromptRequest = {
+export type PromptTextRequest = {
     id: string;
     title: string;
     label: string;
@@ -207,8 +196,22 @@ export type ShowPromptRequest = {
      */
     require?: boolean;
 };
-export type ShowPromptResponse = {
-    value: string;
+export type PromptTextResponse = {
+    value: string | null;
+};
+export type RenderHttpRequestRequest = {
+    httpRequest: HttpRequest;
+    purpose: RenderPurpose;
+};
+export type RenderHttpRequestResponse = {
+    httpRequest: HttpRequest;
+};
+export type RenderPurpose = "send" | "preview";
+export type SendHttpRequestRequest = {
+    httpRequest: HttpRequest;
+};
+export type SendHttpRequestResponse = {
+    httpResponse: HttpResponse;
 };
 export type ShowToastRequest = {
     message: string;
@@ -232,50 +235,134 @@ export type TemplateFunctionArg = {
     "type": "file";
 } & TemplateFunctionFileArg;
 export type TemplateFunctionBaseArg = {
+    /**
+     * The name of the argument. Should be `camelCase` format
+     */
     name: string;
+    /**
+     * Whether the user must fill in the argument
+     */
     optional?: boolean;
+    /**
+     * The label of the input
+     */
     label?: string;
+    /**
+     * The default value
+     */
     defaultValue?: string;
 };
 export type TemplateFunctionCheckboxArg = {
+    /**
+     * The name of the argument. Should be `camelCase` format
+     */
     name: string;
+    /**
+     * Whether the user must fill in the argument
+     */
     optional?: boolean;
+    /**
+     * The label of the input
+     */
     label?: string;
+    /**
+     * The default value
+     */
     defaultValue?: string;
 };
 export type TemplateFunctionFileArg = {
+    /**
+     * The title of the file selection window
+     */
     title: string;
+    /**
+     * Allow selecting multiple files
+     */
     multiple?: boolean;
     directory?: boolean;
     defaultPath?: string;
     filters?: Array<OpenFileFilter>;
+    /**
+     * The name of the argument. Should be `camelCase` format
+     */
     name: string;
+    /**
+     * Whether the user must fill in the argument
+     */
     optional?: boolean;
+    /**
+     * The label of the input
+     */
     label?: string;
+    /**
+     * The default value
+     */
     defaultValue?: string;
 };
 export type TemplateFunctionHttpRequestArg = {
+    /**
+     * The name of the argument. Should be `camelCase` format
+     */
     name: string;
+    /**
+     * Whether the user must fill in the argument
+     */
     optional?: boolean;
+    /**
+     * The label of the input
+     */
     label?: string;
+    /**
+     * The default value
+     */
     defaultValue?: string;
 };
 export type TemplateFunctionSelectArg = {
+    /**
+     * The options that will be available in the select input
+     */
     options: Array<TemplateFunctionSelectOption>;
+    /**
+     * The name of the argument. Should be `camelCase` format
+     */
     name: string;
+    /**
+     * Whether the user must fill in the argument
+     */
     optional?: boolean;
+    /**
+     * The label of the input
+     */
     label?: string;
+    /**
+     * The default value
+     */
     defaultValue?: string;
 };
 export type TemplateFunctionSelectOption = {
-    name: string;
+    label: string;
     value: string;
 };
 export type TemplateFunctionTextArg = {
+    /**
+     * Placeholder for the text input
+     */
     placeholder?: string;
+    /**
+     * The name of the argument. Should be `camelCase` format
+     */
     name: string;
+    /**
+     * Whether the user must fill in the argument
+     */
     optional?: boolean;
+    /**
+     * The label of the input
+     */
     label?: string;
+    /**
+     * The default value
+     */
     defaultValue?: string;
 };
 export type TemplateRenderRequest = {

package/lib/plugins/Context.d.ts

@@ -1,4 +1,4 @@
-import { ShowPromptRequest, ShowPromptResponse, TemplateRenderRequest, TemplateRenderResponse, FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest } from '..';
+import { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '..';
 export type Context = {
     clipboard: {
         copyText(text: string): void;
@@ -7,7 +7,7 @@ export type Context = {
         show(args: ShowToastRequest): void;
     };
     prompt: {
-        show(args: ShowPromptRequest): Promise<ShowPromptResponse['value']>;
+        text(args: PromptTextRequest): Promise<PromptTextResponse['value']>;
     };
     httpRequest: {
         send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.2.13",
+  "version": "0.2.15",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [
     "lib/**/*"
   ],
   "scripts": {
+    "bootstrap": "npm run build",
     "build": "run-s build:copy-types build:tsc",
     "build:tsc": "tsc",
     "build:copy-types": "run-p build:copy-types:*",