@yaakapp/api 0.6.4 → 0.6.6

package/README.md

@@ -24,5 +24,5 @@ the [Quick Start Guide](https://feedback.yaak.app/help/articles/6911763-plugins-
 If you prefer starting from scratch, manually install the types package:
 
 ```shell
-npm install @yaakapp/api
+npm install -D @yaakapp/api
 ```

package/lib/bindings/gen_events.d.ts

@@ -462,6 +462,10 @@ export type GetTemplateFunctionsResponse = {
     functions: Array<TemplateFunction>;
     pluginRefId: string;
 };
+export type GetThemesRequest = Record<string, never>;
+export type GetThemesResponse = {
+    themes: Array<Theme>;
+};
 export type HttpAuthenticationAction = {
     label: string;
     icon?: Icon;
@@ -505,7 +509,7 @@ export type InternalEventPayload = {
     "type": "reload_request";
 } & EmptyPayload | {
     "type": "reload_response";
-} & EmptyPayload | {
+} & BootResponse | {
     "type": "terminate_request";
 } | {
     "type": "terminate_response";
@@ -612,6 +616,10 @@ export type InternalEventPayload = {
 } & FindHttpResponsesRequest | {
     "type": "find_http_responses_response";
 } & FindHttpResponsesResponse | {
+    "type": "get_themes_request";
+} & GetThemesRequest | {
+    "type": "get_themes_response";
+} & GetThemesResponse | {
     "type": "empty_response";
 } & EmptyPayload | {
     "type": "error_response";
@@ -706,6 +714,63 @@ export type TemplateRenderRequest = {
 export type TemplateRenderResponse = {
     data: JsonValue;
 };
+export type Theme = {
+    /**
+     * How the theme is identified. This should never be changed
+     */
+    id: string;
+    /**
+     * The friendly name of the theme to be displayed to the user
+     */
+    label: string;
+    /**
+     * Whether the theme will be used for dark or light appearance
+     */
+    dark: boolean;
+    /**
+     * The default top-level colors for the theme
+     */
+    base: ThemeComponentColors;
+    /**
+     * Optionally override theme for individual UI components for more control
+     */
+    components?: ThemeComponents;
+};
+export type ThemeComponentColors = {
+    surface?: string;
+    surfaceHighlight?: string;
+    surfaceActive?: string;
+    text?: string;
+    textSubtle?: string;
+    textSubtlest?: string;
+    border?: string;
+    borderSubtle?: string;
+    borderFocus?: string;
+    shadow?: string;
+    backdrop?: string;
+    selection?: string;
+    primary?: string;
+    secondary?: string;
+    info?: string;
+    success?: string;
+    notice?: string;
+    warning?: string;
+    danger?: string;
+};
+export type ThemeComponents = {
+    dialog?: ThemeComponentColors;
+    menu?: ThemeComponentColors;
+    toast?: ThemeComponentColors;
+    sidebar?: ThemeComponentColors;
+    responsePane?: ThemeComponentColors;
+    appHeader?: ThemeComponentColors;
+    button?: ThemeComponentColors;
+    banner?: ThemeComponentColors;
+    templateTag?: ThemeComponentColors;
+    urlBar?: ThemeComponentColors;
+    editor?: ThemeComponentColors;
+    input?: ThemeComponentColors;
+};
 export type WindowNavigateEvent = {
     url: string;
 };

package/lib/plugins/ThemePlugin.d.ts

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

package/lib/plugins/index.d.ts

@@ -10,7 +10,7 @@ export type { Context } from './Context';
  */
 export type PluginDefinition = {
     importer?: ImporterPlugin;
-    theme?: ThemePlugin;
+    themes?: ThemePlugin[];
     filter?: FilterPlugin;
     authentication?: AuthenticationPlugin;
     httpRequestActions?: HttpRequestActionPlugin[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.6.4",
+  "version": "0.6.6",
   "keywords": [
     "api-client",
     "insomnia-alternative",