@yaakapp/api 0.1.5 → 0.1.7

package/lib/gen/CallTemplateFunctionArgs.d.ts

@@ -0,0 +1,7 @@
+import type { CallTemplateFunctionPurpose } from "./CallTemplateFunctionPurpose";
+export type CallTemplateFunctionArgs = {
+    purpose: CallTemplateFunctionPurpose;
+    values: {
+        [key: string]: string;
+    };
+};

package/lib/gen/CallTemplateFunctionArgs.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/CallTemplateFunctionPurpose.d.ts

@@ -0,0 +1,5 @@
+export type CallTemplateFunctionPurpose = {
+    "type": "send";
+} | {
+    "type": "preview";
+};

package/lib/gen/CallTemplateFunctionPurpose.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/CallTemplateFunctionRequest.d.ts

@@ -0,0 +1,5 @@
+import type { CallTemplateFunctionArgs } from "./CallTemplateFunctionArgs";
+export type CallTemplateFunctionRequest = {
+    name: string;
+    args: CallTemplateFunctionArgs;
+};

package/lib/gen/CallTemplateFunctionRequest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/CallTemplateFunctionResponse.d.ts

@@ -0,0 +1,3 @@
+export type CallTemplateFunctionResponse = {
+    value: string | null;
+};

package/lib/gen/CallTemplateFunctionResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/GetHttpRequestActionsRequest.d.ts

@@ -1,3 +1 @@
-export type GetHttpRequestActionsRequest = {
-    nothing: boolean;
-};
+export type GetHttpRequestActionsRequest = Record<string, never>;

package/lib/gen/GetTemplateFunctionsResponse.d.ts

@@ -0,0 +1,5 @@
+import type { TemplateFunction } from "./TemplateFunction";
+export type GetTemplateFunctionsResponse = {
+    functions: Array<TemplateFunction>;
+    pluginRefId: string;
+};

package/lib/gen/GetTemplateFunctionsResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/HttpRequestAction.d.ts

@@ -1,4 +1,5 @@
 export type HttpRequestAction = {
     key: string;
     label: string;
+    icon: string | null;
 };

package/lib/gen/InternalEventPayload.d.ts

@@ -1,19 +1,26 @@
 import type { BootRequest } from "./BootRequest";
 import type { BootResponse } from "./BootResponse";
 import type { CallHttpRequestActionRequest } from "./CallHttpRequestActionRequest";
+import type { CallTemplateFunctionRequest } from "./CallTemplateFunctionRequest";
+import type { CallTemplateFunctionResponse } from "./CallTemplateFunctionResponse";
 import type { CopyTextRequest } from "./CopyTextRequest";
 import type { EmptyResponse } from "./EmptyResponse";
 import type { ExportHttpRequestRequest } from "./ExportHttpRequestRequest";
 import type { ExportHttpRequestResponse } from "./ExportHttpRequestResponse";
 import type { FilterRequest } from "./FilterRequest";
 import type { FilterResponse } from "./FilterResponse";
+import type { GetHttpRequestActionsRequest } from "./GetHttpRequestActionsRequest";
 import type { GetHttpRequestActionsResponse } from "./GetHttpRequestActionsResponse";
 import type { GetHttpRequestByIdRequest } from "./GetHttpRequestByIdRequest";
 import type { GetHttpRequestByIdResponse } from "./GetHttpRequestByIdResponse";
+import type { GetTemplateFunctionsResponse } from "./GetTemplateFunctionsResponse";
 import type { ImportRequest } from "./ImportRequest";
 import type { ImportResponse } from "./ImportResponse";
+import type { RenderHttpRequestRequest } from "./RenderHttpRequestRequest";
+import type { RenderHttpRequestResponse } from "./RenderHttpRequestResponse";
 import type { SendHttpRequestRequest } from "./SendHttpRequestRequest";
 import type { SendHttpRequestResponse } from "./SendHttpRequestResponse";
+import type { ShowToastRequest } from "./ShowToastRequest";
 export type InternalEventPayload = {
     "type": "boot_request";
 } & BootRequest | {
@@ -36,13 +43,27 @@ export type InternalEventPayload = {
     "type": "send_http_request_response";
 } & SendHttpRequestResponse | {
     "type": "get_http_request_actions_request";
-} | {
+} & GetHttpRequestActionsRequest | {
     "type": "get_http_request_actions_response";
 } & GetHttpRequestActionsResponse | {
     "type": "call_http_request_action_request";
 } & CallHttpRequestActionRequest | {
+    "type": "get_template_functions_request";
+} | {
+    "type": "get_template_functions_response";
+} & GetTemplateFunctionsResponse | {
+    "type": "call_template_function_request";
+} & CallTemplateFunctionRequest | {
+    "type": "call_template_function_response";
+} & CallTemplateFunctionResponse | {
     "type": "copy_text_request";
 } & CopyTextRequest | {
+    "type": "render_http_request_request";
+} & RenderHttpRequestRequest | {
+    "type": "render_http_request_response";
+} & RenderHttpRequestResponse | {
+    "type": "show_toast_request";
+} & ShowToastRequest | {
     "type": "get_http_request_by_id_request";
 } & GetHttpRequestByIdRequest | {
     "type": "get_http_request_by_id_response";

package/lib/gen/RenderHttpRequestRequest.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequest } from "./HttpRequest";
+export type RenderHttpRequestRequest = {
+    httpRequest: HttpRequest;
+};

package/lib/gen/RenderHttpRequestRequest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/RenderHttpRequestResponse.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequest } from "./HttpRequest";
+export type RenderHttpRequestResponse = {
+    httpRequest: HttpRequest;
+};

package/lib/gen/RenderHttpRequestResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/ShowToastRequest.d.ts

@@ -0,0 +1,5 @@
+import type { ToastVariant } from "./ToastVariant";
+export type ShowToastRequest = {
+    message: string;
+    variant: ToastVariant;
+};

package/lib/gen/ShowToastRequest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/TemplateFunction.d.ts

@@ -0,0 +1,5 @@
+import type { TemplateFunctionArg } from "./TemplateFunctionArg";
+export type TemplateFunction = {
+    name: string;
+    args: Array<TemplateFunctionArg>;
+};

package/lib/gen/TemplateFunction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/TemplateFunctionArg.d.ts

@@ -0,0 +1,10 @@
+import type { TemplateFunctionHttpRequestArg } from "./TemplateFunctionHttpRequestArg";
+import type { TemplateFunctionSelectArg } from "./TemplateFunctionSelectArg";
+import type { TemplateFunctionTextArg } from "./TemplateFunctionTextArg";
+export type TemplateFunctionArg = {
+    "type": "text";
+} & TemplateFunctionTextArg | {
+    "type": "select";
+} & TemplateFunctionSelectArg | {
+    "type": "http_request";
+} & TemplateFunctionHttpRequestArg;

package/lib/gen/TemplateFunctionArg.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/TemplateFunctionBaseArg.d.ts

@@ -0,0 +1,6 @@
+export type TemplateFunctionBaseArg = {
+    name: string;
+    optional?: boolean | null;
+    label?: string | null;
+    defaultValue?: string | null;
+};

package/lib/gen/TemplateFunctionBaseArg.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/TemplateFunctionHttpRequestArg.d.ts

@@ -0,0 +1,6 @@
+export type TemplateFunctionHttpRequestArg = {
+    name: string;
+    optional?: boolean | null;
+    label?: string | null;
+    defaultValue?: string | null;
+};

package/lib/gen/TemplateFunctionHttpRequestArg.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/TemplateFunctionSelectArg.d.ts

@@ -0,0 +1,8 @@
+import type { TemplateFunctionSelectOption } from "./TemplateFunctionSelectOption";
+export type TemplateFunctionSelectArg = {
+    options: Array<TemplateFunctionSelectOption>;
+    name: string;
+    optional?: boolean | null;
+    label?: string | null;
+    defaultValue?: string | null;
+};

package/lib/gen/TemplateFunctionSelectArg.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/TemplateFunctionSelectOption.d.ts

@@ -0,0 +1,4 @@
+export type TemplateFunctionSelectOption = {
+    name: string;
+    value: string;
+};

package/lib/gen/TemplateFunctionSelectOption.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/TemplateFunctionTextArg.d.ts

@@ -0,0 +1,7 @@
+export type TemplateFunctionTextArg = {
+    placeholder?: string | null;
+    name: string;
+    optional?: boolean | null;
+    label?: string | null;
+    defaultValue?: string | null;
+};

package/lib/gen/TemplateFunctionTextArg.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/gen/ToastVariant.d.ts

@@ -0,0 +1 @@
+export type ToastVariant = "custom" | "copied" | "success" | "info" | "warning" | "error";

package/lib/gen/ToastVariant.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/index.d.ts

@@ -2,12 +2,17 @@ export type * from './plugins';
 export type * from './themes';
 export * from './gen/BootRequest';
 export * from './gen/BootResponse';
-export * from './gen/CallHttpRequestActionRequest';
 export * from './gen/CallHttpRequestActionArgs';
+export * from './gen/CallTemplateFunctionPurpose';
+export * from './gen/CallHttpRequestActionRequest';
+export * from './gen/CallTemplateFunctionRequest';
+export * from './gen/CallTemplateFunctionResponse';
+export * from './gen/CallTemplateFunctionArgs';
 export * from './gen/Cookie';
 export * from './gen/CookieDomain';
 export * from './gen/CookieExpires';
 export * from './gen/CookieJar';
+export * from './gen/CopyTextRequest';
 export * from './gen/EmptyResponse';
 export * from './gen/Environment';
 export * from './gen/EnvironmentVariable';
@@ -18,8 +23,8 @@ export * from './gen/FilterResponse';
 export * from './gen/Folder';
 export * from './gen/GetHttpRequestActionsResponse';
 export * from './gen/GetHttpRequestByIdRequest';
-export * from './gen/CopyTextRequest';
 export * from './gen/GetHttpRequestByIdResponse';
+export * from './gen/GetTemplateFunctionsResponse';
 export * from './gen/GrpcConnection';
 export * from './gen/GrpcEvent';
 export * from './gen/GrpcMetadataEntry';
@@ -37,8 +42,19 @@ export * from './gen/InternalEvent';
 export * from './gen/InternalEventPayload';
 export * from './gen/KeyValue';
 export * from './gen/Model';
+export * from './gen/RenderHttpRequestRequest';
+export * from './gen/RenderHttpRequestResponse';
 export * from './gen/SendHttpRequestRequest';
 export * from './gen/SendHttpRequestResponse';
 export * from './gen/SendHttpRequestResponse';
 export * from './gen/Settings';
+export * from './gen/ShowToastRequest';
+export * from './gen/TemplateFunction';
+export * from './gen/TemplateFunctionArg';
+export * from './gen/TemplateFunctionBaseArg';
+export * from './gen/TemplateFunctionHttpRequestArg';
+export * from './gen/TemplateFunctionSelectArg';
+export * from './gen/TemplateFunctionSelectOption';
+export * from './gen/TemplateFunctionTextArg';
+export * from './gen/ToastVariant';
 export * from './gen/Workspace';

package/lib/index.js

@@ -17,12 +17,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // TODO: The next ts-rs release includes the ability to put everything in 1 file!
 __exportStar(require("./gen/BootRequest"), exports);
 __exportStar(require("./gen/BootResponse"), exports);
-__exportStar(require("./gen/CallHttpRequestActionRequest"), exports);
 __exportStar(require("./gen/CallHttpRequestActionArgs"), exports);
+__exportStar(require("./gen/CallTemplateFunctionPurpose"), exports);
+__exportStar(require("./gen/CallHttpRequestActionRequest"), exports);
+__exportStar(require("./gen/CallTemplateFunctionRequest"), exports);
+__exportStar(require("./gen/CallTemplateFunctionResponse"), exports);
+__exportStar(require("./gen/CallTemplateFunctionArgs"), exports);
 __exportStar(require("./gen/Cookie"), exports);
 __exportStar(require("./gen/CookieDomain"), exports);
 __exportStar(require("./gen/CookieExpires"), exports);
 __exportStar(require("./gen/CookieJar"), exports);
+__exportStar(require("./gen/CopyTextRequest"), exports);
 __exportStar(require("./gen/EmptyResponse"), exports);
 __exportStar(require("./gen/Environment"), exports);
 __exportStar(require("./gen/EnvironmentVariable"), exports);
@@ -33,8 +38,8 @@ __exportStar(require("./gen/FilterResponse"), exports);
 __exportStar(require("./gen/Folder"), exports);
 __exportStar(require("./gen/GetHttpRequestActionsResponse"), exports);
 __exportStar(require("./gen/GetHttpRequestByIdRequest"), exports);
-__exportStar(require("./gen/CopyTextRequest"), exports);
 __exportStar(require("./gen/GetHttpRequestByIdResponse"), exports);
+__exportStar(require("./gen/GetTemplateFunctionsResponse"), exports);
 __exportStar(require("./gen/GrpcConnection"), exports);
 __exportStar(require("./gen/GrpcEvent"), exports);
 __exportStar(require("./gen/GrpcMetadataEntry"), exports);
@@ -52,8 +57,19 @@ __exportStar(require("./gen/InternalEvent"), exports);
 __exportStar(require("./gen/InternalEventPayload"), exports);
 __exportStar(require("./gen/KeyValue"), exports);
 __exportStar(require("./gen/Model"), exports);
+__exportStar(require("./gen/RenderHttpRequestRequest"), exports);
+__exportStar(require("./gen/RenderHttpRequestResponse"), exports);
 __exportStar(require("./gen/SendHttpRequestRequest"), exports);
 __exportStar(require("./gen/SendHttpRequestResponse"), exports);
 __exportStar(require("./gen/SendHttpRequestResponse"), exports);
 __exportStar(require("./gen/Settings"), exports);
+__exportStar(require("./gen/ShowToastRequest"), exports);
+__exportStar(require("./gen/TemplateFunction"), exports);
+__exportStar(require("./gen/TemplateFunctionArg"), exports);
+__exportStar(require("./gen/TemplateFunctionBaseArg"), exports);
+__exportStar(require("./gen/TemplateFunctionHttpRequestArg"), exports);
+__exportStar(require("./gen/TemplateFunctionSelectArg"), exports);
+__exportStar(require("./gen/TemplateFunctionSelectOption"), exports);
+__exportStar(require("./gen/TemplateFunctionTextArg"), exports);
+__exportStar(require("./gen/ToastVariant"), exports);
 __exportStar(require("./gen/Workspace"), exports);

package/lib/plugins/FilterPlugin.d.ts

@@ -0,0 +1,13 @@
+import { Context } from './Context';
+export type FilterPluginResponse = string[];
+export type FilterPlugin = {
+    name: string;
+    description?: string;
+    canFilter(ctx: Context, args: {
+        mimeType: string;
+    }): Promise<boolean>;
+    onFilter(ctx: Context, args: {
+        payload: string;
+        mimeType: string;
+    }): Promise<FilterPluginResponse>;
+};

package/lib/plugins/FilterPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/HttpRequestActionPlugin.d.ts

@@ -0,0 +1,6 @@
+import { CallHttpRequestActionArgs } from '../gen/CallHttpRequestActionArgs';
+import { HttpRequestAction } from '../gen/HttpRequestAction';
+import { Context } from './Context';
+export type HttpRequestActionPlugin = HttpRequestAction & {
+    onSelect(ctx: Context, args: CallHttpRequestActionArgs): Promise<void> | void;
+};

package/lib/plugins/HttpRequestActionPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/ImporterPlugin.d.ts

@@ -0,0 +1,19 @@
+import { Environment } from '../gen/Environment';
+import { Folder } from '../gen/Folder';
+import { HttpRequest } from '../gen/HttpRequest';
+import { Workspace } from '../gen/Workspace';
+import { AtLeast } from '../helpers';
+import { Context } from './Context';
+export type ImportPluginResponse = null | {
+    workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
+    environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
+    httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
+    folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
+};
+export type ImporterPlugin = {
+    name: string;
+    description?: string;
+    onImport(ctx: Context, args: {
+        text: string;
+    }): Promise<ImportPluginResponse>;
+};

package/lib/plugins/ImporterPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/TemplateFunctionPlugin.d.ts

@@ -0,0 +1,6 @@
+import { CallTemplateFunctionArgs } from '../gen/CallTemplateFunctionArgs';
+import { TemplateFunction } from '../gen/TemplateFunction';
+import { Context } from './Context';
+export type TemplateFunctionPlugin = TemplateFunction & {
+    onRender(ctx: Context, args: CallTemplateFunctionArgs): Promise<string>;
+};

package/lib/plugins/TemplateFunctionPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/ThemePlugin.d.ts

@@ -0,0 +1,7 @@
+import { Theme } from '../themes';
+import { Context } from './Context';
+export type ThemePlugin = {
+    name: string;
+    description?: string;
+    getTheme(ctx: Context, fileContents: string): Promise<Theme>;
+};

package/lib/plugins/ThemePlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/context.d.ts

@@ -1,13 +1,20 @@
 import { GetHttpRequestByIdRequest } from '../gen/GetHttpRequestByIdRequest';
 import { GetHttpRequestByIdResponse } from '../gen/GetHttpRequestByIdResponse';
+import { RenderHttpRequestRequest } from '../gen/RenderHttpRequestRequest';
+import { RenderHttpRequestResponse } from '../gen/RenderHttpRequestResponse';
 import { SendHttpRequestRequest } from '../gen/SendHttpRequestRequest';
 import { SendHttpRequestResponse } from '../gen/SendHttpRequestResponse';
-export type YaakContext = {
+import { ShowToastRequest } from '../gen/ShowToastRequest';
+export type Context = {
     clipboard: {
         copyText(text: string): void;
     };
+    toast: {
+        show(args: ShowToastRequest): void;
+    };
     httpRequest: {
         send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
         getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;
+        render(args: RenderHttpRequestRequest): Promise<RenderHttpRequestResponse['httpRequest']>;
     };
 };

package/lib/plugins/index.d.ts

@@ -1,14 +1,16 @@
-import { FilterPlugin } from './filter';
-import { HttpRequestActionPlugin } from './httpRequestAction';
-import { ImporterPlugin } from './import';
-import { ThemePlugin } from './theme';
-export { YaakContext } from './context';
+import { FilterPlugin } from './FilterPlugin';
+import { HttpRequestActionPlugin } from './HttpRequestActionPlugin';
+import { ImporterPlugin } from './ImporterPlugin';
+import { TemplateFunctionPlugin } from './TemplateFunctionPlugin';
+import { ThemePlugin } from './ThemePlugin';
+export type { Context } from './Context';
 /**
  * The global structure of a Yaak plugin
  */
-export type YaakPlugin = {
+export type Plugin = {
     importer?: ImporterPlugin;
     theme?: ThemePlugin;
     filter?: FilterPlugin;
     httpRequestActions?: HttpRequestActionPlugin[];
+    templateFunctions?: TemplateFunctionPlugin[];
 };

package/lib/plugins/templateTag.d.ts

@@ -0,0 +1,6 @@
+import { CallTemplateFunctionArgs } from '../gen/CallTemplateFunctionArgs';
+import { TemplateFunction } from '../gen/TemplateFunction';
+import { YaakContext } from './context';
+export type TemplateFunctionPlugin = TemplateFunction & {
+    onRender(ctx: YaakContext, args: CallTemplateFunctionArgs): Promise<string>;
+};

package/lib/plugins/templateTag.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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