@yaakapp/api 0.5.1 → 0.6.0

package/lib/bindings/gen_events.d.ts

@@ -171,6 +171,10 @@ export type FormInputBase = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputCheckbox = {
     /**
@@ -199,6 +203,10 @@ export type FormInputCheckbox = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputEditor = {
     /**
@@ -241,6 +249,10 @@ export type FormInputEditor = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputFile = {
     /**
@@ -280,6 +292,10 @@ export type FormInputFile = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputHttpRequest = {
     /**
@@ -308,6 +324,10 @@ export type FormInputHttpRequest = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputMarkdown = {
     content: string;
@@ -344,6 +364,10 @@ export type FormInputSelect = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type FormInputSelectOption = {
     label: string;
@@ -389,6 +413,10 @@ export type FormInputText = {
      */
     defaultValue?: string;
     disabled?: boolean;
+    /**
+     * Longer description of the input, likely shown in a tooltip
+     */
+    description?: string;
 };
 export type GenericCompletionOption = {
     label: string;
@@ -397,6 +425,12 @@ export type GenericCompletionOption = {
     type?: CompletionOptionType;
     boost?: number;
 };
+export type GetCookieValueRequest = {
+    name: string;
+};
+export type GetCookieValueResponse = {
+    value: string | null;
+};
 export type GetHttpAuthenticationConfigRequest = {
     contextId: string;
     values: {
@@ -498,6 +532,14 @@ export type InternalEventPayload = {
 } & SendHttpRequestRequest | {
     "type": "send_http_request_response";
 } & SendHttpRequestResponse | {
+    "type": "list_cookie_names_request";
+} & ListCookieNamesRequest | {
+    "type": "list_cookie_names_response";
+} & ListCookieNamesResponse | {
+    "type": "get_cookie_value_request";
+} & GetCookieValueRequest | {
+    "type": "get_cookie_value_response";
+} & GetCookieValueResponse | {
     "type": "get_http_request_actions_request";
 } & EmptyPayload | {
     "type": "get_http_request_actions_response";
@@ -581,6 +623,10 @@ export type InternalEventPayload = {
     "type": "error_response";
 } & ErrorResponse;
 export type JsonPrimitive = string | number | boolean | null;
+export type ListCookieNamesRequest = {};
+export type ListCookieNamesResponse = {
+    names: Array<string>;
+};
 export type OpenWindowRequest = {
     url: string;
     /**

package/lib/bindings/gen_models.d.ts

@@ -22,15 +22,12 @@ export type Folder = {
     updatedAt: string;
     workspaceId: string;
     folderId: string | null;
-    name: string;
+    authentication: Record<string, any>;
+    authenticationType: string | null;
     description: string;
-    sortPriority: number;
-};
-export type GrpcMetadataEntry = {
-    enabled?: boolean;
+    headers: Array<HttpRequestHeader>;
     name: string;
-    value: string;
-    id?: string;
+    sortPriority: number;
 };
 export type GrpcRequest = {
     model: "grpc_request";
@@ -43,7 +40,7 @@ export type GrpcRequest = {
     authentication: Record<string, any>;
     description: string;
     message: string;
-    metadata: Array<GrpcMetadataEntry>;
+    metadata: Array<HttpRequestHeader>;
     method: string | null;
     name: string;
     service: string | null;
@@ -128,8 +125,11 @@ export type Workspace = {
     id: string;
     createdAt: string;
     updatedAt: string;
-    name: string;
+    authentication: Record<string, any>;
+    authenticationType: string | null;
     description: string;
+    headers: Array<HttpRequestHeader>;
+    name: string;
     encryptionKeyChallenge: string | null;
     settingValidateCertificates: boolean;
     settingFollowRedirects: boolean;

package/lib/index.d.ts

@@ -2,3 +2,4 @@ export type * from './plugins';
 export type * from './themes';
 export * from './bindings/gen_models';
 export * from './bindings/gen_events';
+export type { PartialImportResources } from './plugins/ImporterPlugin';

package/lib/plugins/Context.d.ts

@@ -1,4 +1,4 @@
-import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, OpenWindowRequest, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '../bindings/gen_events.ts';
+import type { FindHttpResponsesRequest, FindHttpResponsesResponse, GetCookieValueRequest, GetCookieValueResponse, GetHttpRequestByIdRequest, GetHttpRequestByIdResponse, ListCookieNamesResponse, OpenWindowRequest, PromptTextRequest, PromptTextResponse, RenderHttpRequestRequest, RenderHttpRequestResponse, SendHttpRequestRequest, SendHttpRequestResponse, ShowToastRequest, TemplateRenderRequest, TemplateRenderResponse } from '../bindings/gen_events.ts';
 export interface Context {
     clipboard: {
         copyText(text: string): Promise<void>;
@@ -19,11 +19,15 @@ export interface Context {
             onNavigate?: (args: {
                 url: string;
             }) => void;
-            onClose: () => void;
+            onClose?: () => void;
         }): Promise<{
             close: () => void;
         }>;
     };
+    cookies: {
+        listNames(): Promise<ListCookieNamesResponse['names']>;
+        getValue(args: GetCookieValueRequest): Promise<GetCookieValueResponse['value']>;
+    };
     httpRequest: {
         send(args: SendHttpRequestRequest): Promise<SendHttpRequestResponse['httpResponse']>;
         getById(args: GetHttpRequestByIdRequest): Promise<GetHttpRequestByIdResponse['httpRequest']>;

package/lib/plugins/FilterPlugin.d.ts

@@ -1,5 +1,5 @@
 import type { Context } from './Context';
-export type FilterPluginResponse = {
+type FilterPluginResponse = {
     filtered: string;
 };
 export type FilterPlugin = {
@@ -11,3 +11,4 @@ export type FilterPlugin = {
         mimeType: string;
     }): Promise<FilterPluginResponse> | FilterPluginResponse;
 };
+export {};

package/lib/plugins/ImporterPlugin.d.ts

@@ -1,14 +1,18 @@
-import { Environment, Folder, GrpcRequest, HttpRequest, Workspace } from '../bindings/gen_models';
-import type { AtLeast } from '../helpers';
+import { ImportResources } from '../bindings/gen_events';
+import { 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'>[];
-    };
+type RootFields = 'name' | 'id' | 'model';
+type CommonFields = RootFields | 'workspaceId';
+export type PartialImportResources = {
+    workspaces: Array<AtLeast<ImportResources['workspaces'][0], RootFields>>;
+    environments: Array<AtLeast<ImportResources['environments'][0], CommonFields>>;
+    folders: Array<AtLeast<ImportResources['folders'][0], CommonFields>>;
+    httpRequests: Array<AtLeast<ImportResources['httpRequests'][0], CommonFields>>;
+    grpcRequests: Array<AtLeast<ImportResources['grpcRequests'][0], CommonFields>>;
+    websocketRequests: Array<AtLeast<ImportResources['websocketRequests'][0], CommonFields>>;
+};
+export type ImportPluginResponse = null | {
+    resources: PartialImportResources;
 };
 export type ImporterPlugin = {
     name: string;

package/package.json

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