@yaakapp/api 0.3.4 → 0.4.0

package/lib/bindings/{events.d.ts → gen_events.d.ts}

@@ -1,10 +1,10 @@
-import type { Environment } from "./models.js";
-import type { Folder } from "./models.js";
-import type { GrpcRequest } from "./models.js";
-import type { HttpRequest } from "./models.js";
-import type { HttpResponse } from "./models.js";
+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 { JsonValue } from "./serde_json/JsonValue.js";
-import type { Workspace } from "./models.js";
+import type { Workspace } from "./gen_models.js";
 export type BootRequest = {
     dir: string;
     watch: boolean;
@@ -13,9 +13,21 @@ export type BootResponse = {
     name: string;
     version: string;
 };
+export type CallHttpAuthenticationActionArgs = {
+    contextId: string;
+    values: {
+        [key in string]?: JsonPrimitive;
+    };
+};
+export type CallHttpAuthenticationActionRequest = {
+    index: number;
+    pluginRefId: string;
+    args: CallHttpAuthenticationActionArgs;
+};
 export type CallHttpAuthenticationRequest = {
-    config: {
-        [key in string]?: JsonValue;
+    contextId: string;
+    values: {
+        [key in string]?: JsonPrimitive;
     };
     method: string;
     url: string;
@@ -32,7 +44,7 @@ export type CallHttpRequestActionArgs = {
     httpRequest: HttpRequest;
 };
 export type CallHttpRequestActionRequest = {
-    key: string;
+    index: number;
     pluginRefId: string;
     args: CallHttpRequestActionArgs;
 };
@@ -49,10 +61,27 @@ export type CallTemplateFunctionRequest = {
 export type CallTemplateFunctionResponse = {
     value: string | null;
 };
-export type Color = "custom" | "default" | "primary" | "secondary" | "info" | "success" | "notice" | "warning" | "danger";
+export type CloseWindowRequest = {
+    label: string;
+};
+export type Color = "primary" | "secondary" | "info" | "success" | "notice" | "warning" | "danger";
+export type CompletionOptionType = "constant" | "variable";
+export type Content = {
+    "type": "text";
+    content: string;
+} | {
+    "type": "markdown";
+    content: string;
+};
 export type CopyTextRequest = {
     text: string;
 };
+export type DeleteKeyValueRequest = {
+    key: string;
+};
+export type DeleteKeyValueResponse = {
+    deleted: boolean;
+};
 export type EditorLanguage = "text" | "javascript" | "json" | "html" | "xml" | "graphql" | "markdown";
 export type EmptyPayload = {};
 export type ErrorResponse = {
@@ -97,9 +126,33 @@ export type FormInput = {
     "type": "file";
 } & FormInputFile | {
     "type": "http_request";
-} & FormInputHttpRequest;
+} & FormInputHttpRequest | {
+    "type": "accordion";
+} & FormInputAccordion | {
+    "type": "banner";
+} & FormInputBanner | {
+    "type": "markdown";
+} & FormInputMarkdown;
+export type FormInputAccordion = {
+    label: string;
+    inputs?: Array<FormInput>;
+    hidden?: boolean;
+};
+export type FormInputBanner = {
+    inputs?: Array<FormInput>;
+    hidden?: boolean;
+    color?: Color;
+};
 export type FormInputBase = {
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
     name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
     /**
      * Whether the user must fill in the argument
      */
@@ -116,9 +169,18 @@ export type FormInputBase = {
      * The default value
      */
     defaultValue?: string;
+    disabled?: boolean;
 };
 export type FormInputCheckbox = {
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
     name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
     /**
      * Whether the user must fill in the argument
      */
@@ -135,6 +197,7 @@ export type FormInputCheckbox = {
      * The default value
      */
     defaultValue?: string;
+    disabled?: boolean;
 };
 export type FormInputEditor = {
     /**
@@ -149,7 +212,17 @@ export type FormInputEditor = {
      * Language for syntax highlighting
      */
     language?: EditorLanguage;
+    readOnly?: boolean;
+    completionOptions?: Array<GenericCompletionOption>;
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
     name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
     /**
      * Whether the user must fill in the argument
      */
@@ -166,6 +239,7 @@ export type FormInputEditor = {
      * The default value
      */
     defaultValue?: string;
+    disabled?: boolean;
 };
 export type FormInputFile = {
     /**
@@ -179,7 +253,15 @@ export type FormInputFile = {
     directory?: boolean;
     defaultPath?: string;
     filters?: Array<FileFilter>;
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
     name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
     /**
      * Whether the user must fill in the argument
      */
@@ -196,9 +278,18 @@ export type FormInputFile = {
      * The default value
      */
     defaultValue?: string;
+    disabled?: boolean;
 };
 export type FormInputHttpRequest = {
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
     name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
     /**
      * Whether the user must fill in the argument
      */
@@ -215,13 +306,26 @@ export type FormInputHttpRequest = {
      * The default value
      */
     defaultValue?: string;
+    disabled?: boolean;
+};
+export type FormInputMarkdown = {
+    content: string;
+    hidden?: boolean;
 };
 export type FormInputSelect = {
     /**
      * The options that will be available in the select input
      */
     options: Array<FormInputSelectOption>;
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
     name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
     /**
      * Whether the user must fill in the argument
      */
@@ -238,9 +342,10 @@ export type FormInputSelect = {
      * The default value
      */
     defaultValue?: string;
+    disabled?: boolean;
 };
 export type FormInputSelectOption = {
-    name: string;
+    label: string;
     value: string;
 };
 export type FormInputText = {
@@ -252,7 +357,20 @@ export type FormInputText = {
      * Placeholder for the text input
      */
     password?: boolean;
+    /**
+     * Whether to allow newlines in the input, like a <textarea/>
+     */
+    multiLine?: boolean;
+    completionOptions?: Array<GenericCompletionOption>;
+    /**
+     * The name of the input. The value will be stored at this object attribute in the resulting data
+     */
     name: string;
+    /**
+     * Whether this input is visible for the given configuration. Use this to
+     * make branching forms.
+     */
+    hidden?: boolean;
     /**
      * Whether the user must fill in the argument
      */
@@ -269,12 +387,30 @@ export type FormInputText = {
      * The default value
      */
     defaultValue?: string;
+    disabled?: boolean;
+};
+export type GenericCompletionOption = {
+    label: string;
+    detail?: string;
+    info?: string;
+    type?: CompletionOptionType;
+    boost?: number;
+};
+export type GetHttpAuthenticationConfigRequest = {
+    contextId: string;
+    values: {
+        [key in string]?: JsonPrimitive;
+    };
 };
-export type GetHttpAuthenticationResponse = {
+export type GetHttpAuthenticationConfigResponse = {
+    args: Array<FormInput>;
+    pluginRefId: string;
+    actions?: Array<HttpAuthenticationAction>;
+};
+export type GetHttpAuthenticationSummaryResponse = {
     name: string;
     label: string;
     shortLabel: string;
-    config: Array<FormInput>;
 };
 export type GetHttpRequestActionsRequest = Record<string, never>;
 export type GetHttpRequestActionsResponse = {
@@ -287,20 +423,29 @@ export type GetHttpRequestByIdRequest = {
 export type GetHttpRequestByIdResponse = {
     httpRequest: HttpRequest | null;
 };
+export type GetKeyValueRequest = {
+    key: string;
+};
+export type GetKeyValueResponse = {
+    value?: string;
+};
 export type GetTemplateFunctionsResponse = {
     functions: Array<TemplateFunction>;
     pluginRefId: string;
 };
+export type HttpAuthenticationAction = {
+    label: string;
+    icon?: Icon;
+};
 export type HttpHeader = {
     name: string;
     value: string;
 };
 export type HttpRequestAction = {
-    key: string;
     label: string;
     icon?: Icon;
 };
-export type Icon = "copy" | "info" | "check_circle" | "alert_triangle" | "_unknown";
+export type Icon = "alert_triangle" | "check" | "check_circle" | "chevron_down" | "copy" | "info" | "pin" | "search" | "trash" | "_unknown";
 export type ImportRequest = {
     content: string;
 };
@@ -365,26 +510,56 @@ export type InternalEventPayload = {
 } & CallTemplateFunctionRequest | {
     "type": "call_template_function_response";
 } & CallTemplateFunctionResponse | {
-    "type": "get_http_authentication_request";
+    "type": "get_http_authentication_summary_request";
 } & EmptyPayload | {
-    "type": "get_http_authentication_response";
-} & GetHttpAuthenticationResponse | {
+    "type": "get_http_authentication_summary_response";
+} & GetHttpAuthenticationSummaryResponse | {
+    "type": "get_http_authentication_config_request";
+} & GetHttpAuthenticationConfigRequest | {
+    "type": "get_http_authentication_config_response";
+} & GetHttpAuthenticationConfigResponse | {
     "type": "call_http_authentication_request";
 } & CallHttpAuthenticationRequest | {
     "type": "call_http_authentication_response";
 } & CallHttpAuthenticationResponse | {
+    "type": "call_http_authentication_action_request";
+} & CallHttpAuthenticationActionRequest | {
+    "type": "call_http_authentication_action_response";
+} & EmptyPayload | {
     "type": "copy_text_request";
 } & CopyTextRequest | {
+    "type": "copy_text_response";
+} & EmptyPayload | {
     "type": "render_http_request_request";
 } & RenderHttpRequestRequest | {
     "type": "render_http_request_response";
 } & RenderHttpRequestResponse | {
+    "type": "get_key_value_request";
+} & GetKeyValueRequest | {
+    "type": "get_key_value_response";
+} & GetKeyValueResponse | {
+    "type": "set_key_value_request";
+} & SetKeyValueRequest | {
+    "type": "set_key_value_response";
+} & SetKeyValueResponse | {
+    "type": "delete_key_value_request";
+} & DeleteKeyValueRequest | {
+    "type": "delete_key_value_response";
+} & DeleteKeyValueResponse | {
+    "type": "open_window_request";
+} & OpenWindowRequest | {
+    "type": "window_navigate_event";
+} & WindowNavigateEvent | {
+    "type": "close_window_request";
+} & CloseWindowRequest | {
     "type": "template_render_request";
 } & TemplateRenderRequest | {
     "type": "template_render_response";
 } & TemplateRenderResponse | {
     "type": "show_toast_request";
 } & ShowToastRequest | {
+    "type": "show_toast_response";
+} & EmptyPayload | {
     "type": "prompt_text_request";
 } & PromptTextRequest | {
     "type": "prompt_text_response";
@@ -401,6 +576,16 @@ export type InternalEventPayload = {
 } & EmptyPayload | {
     "type": "error_response";
 } & ErrorResponse;
+export type JsonPrimitive = string | number | boolean | null;
+export type OpenWindowRequest = {
+    url: string;
+    /**
+     * Label for the window. If not provided, a random one will be generated.
+     */
+    label: string;
+    title?: string;
+    size?: WindowSize;
+};
 export type PromptTextRequest = {
     id: string;
     title: string;
@@ -433,11 +618,16 @@ export type RenderHttpRequestResponse = {
 };
 export type RenderPurpose = "send" | "preview";
 export type SendHttpRequestRequest = {
-    httpRequest: HttpRequest;
+    httpRequest: Partial<HttpRequest>;
 };
 export type SendHttpRequestResponse = {
     httpResponse: HttpResponse;
 };
+export type SetKeyValueRequest = {
+    key: string;
+    value: string;
+};
+export type SetKeyValueResponse = {};
 export type ShowToastRequest = {
     message: string;
     color?: Color;
@@ -466,3 +656,10 @@ export type WindowContext = {
     "type": "label";
     label: string;
 };
+export type WindowNavigateEvent = {
+    url: string;
+};
+export type WindowSize = {
+    width: number;
+    height: number;
+};

package/lib/helpers.d.ts

@@ -1 +1,2 @@
 export type AtLeast<T, K extends keyof T> = Partial<T> & Pick<T, K>;
+export type MaybePromise<T> = Promise<T> | T;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
 export type * from './plugins';
 export type * from './themes';
-export * from './bindings/models';
-export * from './bindings/events';
+export * from './bindings/gen_models';
+export * from './bindings/gen_events';

package/lib/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./bindings/models"), exports);
-__exportStar(require("./bindings/events"), exports);
+__exportStar(require("./bindings/gen_models"), exports);
+__exportStar(require("./bindings/gen_events"), exports);

package/lib/plugins/AuthenticationPlugin.d.ts

@@ -1,5 +1,14 @@
-import { CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, GetHttpAuthenticationResponse } from '../bindings/events';
+import { CallHttpAuthenticationActionArgs, CallHttpAuthenticationRequest, CallHttpAuthenticationResponse, FormInput, GetHttpAuthenticationConfigRequest, GetHttpAuthenticationSummaryResponse, HttpAuthenticationAction } from '../bindings/gen_events';
+import { MaybePromise } from '../helpers';
 import { Context } from './Context';
-export type AuthenticationPlugin = Omit<GetHttpAuthenticationResponse, 'pluginName'> & {
-    onApply(ctx: Context, args: CallHttpAuthenticationRequest): Promise<CallHttpAuthenticationResponse> | CallHttpAuthenticationResponse;
+type DynamicFormInput = FormInput & {
+    dynamic(ctx: Context, args: GetHttpAuthenticationConfigRequest): MaybePromise<Partial<FormInput> | undefined | null>;
 };
+export type AuthenticationPlugin = GetHttpAuthenticationSummaryResponse & {
+    args: (FormInput | DynamicFormInput)[];
+    onApply(ctx: Context, args: CallHttpAuthenticationRequest): MaybePromise<CallHttpAuthenticationResponse>;
+    actions?: (HttpAuthenticationAction & {
+        onSelect(ctx: Context, args: CallHttpAuthenticationActionArgs): Promise<void> | void;
+    })[];
+};
+export {};

package/lib/plugins/Context.d.ts

@@ -1,4 +1,4 @@
-import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from "../bindings/events.ts";
+import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, OpenWindowRequest, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '../bindings/gen_events.ts';
 export interface Context {
     clipboard: {
         copyText(text: string): Promise<void>;
@@ -7,17 +7,31 @@ export interface Context {
         show(args: ShowToastRequest): Promise<void>;
     };
     prompt: {
-        text(args: PromptTextRequest): Promise<PromptTextResponse["value"]>;
+        text(args: PromptTextRequest): Promise<PromptTextResponse['value']>;
+    };
+    store: {
+        set<T>(key: string, value: T): Promise<void>;
+        get<T>(key: string): Promise<T | undefined>;
+        delete(key: string): Promise<boolean>;
+    };
+    window: {
+        openUrl(args: OpenWindowRequest & {
+            onNavigate?: (args: {
+                url: string;
+            }) => void;
+        }): Promise<{
+            close: () => void;
+        }>;
     };
     httpRequest: {
-        send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse["httpResponse"]>;
-        getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse["httpRequest"]>;
-        render(args: RenderHttpRequestRequest): Promise<RenderHttpRequestResponse["httpRequest"]>;
+        send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
+        getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;
+        render(args: RenderHttpRequestRequest): Promise<RenderHttpRequestResponse['httpRequest']>;
     };
     httpResponse: {
-        find(args: FindHttpResponsesRequest): Promise<FindHttpResponsesResponse["httpResponses"]>;
+        find(args: FindHttpResponsesRequest): Promise<FindHttpResponsesResponse['httpResponses']>;
     };
     templates: {
-        render(args: TemplateRenderRequest): Promise<TemplateRenderResponse["data"]>;
+        render(args: TemplateRenderRequest): Promise<TemplateRenderResponse['data']>;
     };
 }

package/lib/plugins/HttpRequestActionPlugin.d.ts

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

package/lib/plugins/ImporterPlugin.d.ts

@@ -1,13 +1,13 @@
-import { Environment, Folder, GrpcRequest, HttpRequest, Workspace } from "../bindings/models";
-import type { AtLeast } from "../helpers";
-import type { Context } from "./Context";
+import { Environment, Folder, GrpcRequest, HttpRequest, Workspace } from '../bindings/gen_models';
+import type { AtLeast } from '../helpers';
+import type { Context } from './Context';
 type ImportPluginResponse = null | {
     resources: {
-        workspaces: AtLeast<Workspace, "name" | "id" | "model">[];
-        environments: AtLeast<Environment, "name" | "id" | "model" | "workspaceId">[];
-        folders: AtLeast<Folder, "name" | "id" | "model" | "workspaceId">[];
-        httpRequests: AtLeast<HttpRequest, "name" | "id" | "model" | "workspaceId">[];
-        grpcRequests: AtLeast<GrpcRequest, "name" | "id" | "model" | "workspaceId">[];
+        workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
+        environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
+        folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
+        httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
+        grpcRequests: AtLeast<GrpcRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
     };
 };
 export type ImporterPlugin = {

package/lib/plugins/TemplateFunctionPlugin.d.ts

@@ -1,4 +1,4 @@
-import { CallTemplateFunctionArgs, TemplateFunction } from "../bindings/events";
+import { CallTemplateFunctionArgs, TemplateFunction } from "../bindings/gen_events";
 import { Context } from "./Context";
 export type TemplateFunctionPlugin = TemplateFunction & {
     onRender(ctx: Context, args: CallTemplateFunctionArgs): Promise<string | null>;

package/package.json

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