@yaakapp/api 0.2.14 → 0.2.16

package/lib/bindings/events.d.ts

@@ -171,6 +171,9 @@ export type InternalEventPayload = {
 };
 export type OpenFileFilter = {
     name: string;
+    /**
+     * File extensions to require
+     */
     extensions: Array<string>;
 };
 export type PromptTextRequest = {
@@ -217,6 +220,11 @@ export type ShowToastRequest = {
 };
 export type TemplateFunction = {
     name: string;
+    description?: string;
+    /**
+     * Also support alternative names. This is useful for not breaking existing
+     * tags when changing the `name` property
+     */
     aliases?: Array<string>;
     args: Array<TemplateFunctionArg>;
 };
@@ -232,50 +240,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.2.14",
+  "version": "0.2.16",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [
@@ -13,7 +13,8 @@
     "build:copy-types": "run-p build:copy-types:*",
     "build:copy-types:root": "cpy --flat ../src-tauri/yaak_plugin_runtime/bindings/*.ts ./src/bindings",
     "build:copy-types:next": "cpy --flat ../src-tauri/yaak_plugin_runtime/bindings/serde_json/*.ts ./src/bindings/serde_json",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "publish": "npm publish"
   },
   "dependencies": {
     "@types/node": "^22.5.4"