@todesktop/shared 7.127.0 → 7.129.0

package/lib/desktopify2.d.ts

@@ -3,6 +3,26 @@ import { ISwitchableValue } from "./toDesktop";
 import { MenuItemConstructorOptions, BrowserWindowConstructorOptions, WebPreferences } from "@todesktop/client-electron-types";
 import { BaseApp } from "./base";
 import { DesktopAppPlugin } from "./plugin";
+interface BaseAssetDetails {
+    /**
+     * Remote URL where the asset can be downloaded
+     */
+    url: string;
+    /**
+     * Local path where the asset is/should be stored. This path is relative to the app directory
+     */
+    relativeLocalPath: string;
+}
+export interface AppIconAssetDetails extends BaseAssetDetails {
+    type: "appIcon";
+}
+export interface MenuIconAssetDetails extends BaseAssetDetails {
+    type: "menuIcon";
+}
+export interface TrayMenubarIconAssetDetails extends BaseAssetDetails {
+    type: "trayMenubarIcon";
+}
+export declare type AssetDetails = AppIconAssetDetails | MenuIconAssetDetails | TrayMenubarIconAssetDetails;
 /**
  * Custom ToDesktop Roles for Application & Tray Menus
  */
@@ -17,6 +37,7 @@ export interface DesktopifyMenuItemConstructorOptions extends Omit<MenuItemConst
     actionType?: "jsEvent" | "role";
     iconUrl?: string;
     bundledIcon?: string;
+    iconAssetDetails?: MenuIconAssetDetails;
     useTemplateImage?: boolean;
 }
 /**
@@ -49,9 +70,13 @@ export interface DesktopifyAppTray {
     icon?: string;
     useSeparateIcons?: boolean;
     windowsIcon?: string;
+    windowsIconAssetDetails?: TrayMenubarIconAssetDetails;
     macOSIcon?: string;
+    macOSIconAssetDetails?: TrayMenubarIconAssetDetails;
     linuxIcon?: string;
+    linuxIconAssetDetails?: TrayMenubarIconAssetDetails;
     bundledIcon?: string;
+    iconAssetDetails?: TrayMenubarIconAssetDetails;
     useTemplateImage?: boolean;
     rightClick: DesktopifyAppTrayAction;
     leftClick: DesktopifyAppTrayAction;
@@ -176,13 +201,20 @@ export interface DesktopifyApp2 {
      * The locally-bundled app icon.
      */
     bundledIcon?: string;
+    /**
+     * Details concerning how the app icon should be handled across ToDesktop services
+     */
+    iconAssetDetails?: AppIconAssetDetails;
     /**
      * Instead of using one icon for every platform, use a separate icon for different platforms
      */
     useSeparateIcons?: boolean;
     windowsIcon?: string;
+    windowsIconAssetDetails?: AppIconAssetDetails;
     macOSIcon?: string;
+    macOSIconAssetDetails?: AppIconAssetDetails;
     linuxIcon?: string;
+    linuxIconAssetDetails?: AppIconAssetDetails;
     /**
      * The name of the company that the app belongs to
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@todesktop/shared",
-  "version": "7.127.0",
+  "version": "7.129.0",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

package/src/desktopify2.ts

@@ -7,6 +7,34 @@ import {
 import { BaseApp, Schemable } from "./base";
 import { DesktopAppPlugin } from "./plugin";
 
+interface BaseAssetDetails {
+  /**
+   * Remote URL where the asset can be downloaded
+   */
+  url: string;
+  /**
+   * Local path where the asset is/should be stored. This path is relative to the app directory
+   */
+  relativeLocalPath: string;
+}
+
+export interface AppIconAssetDetails extends BaseAssetDetails {
+  type: "appIcon";
+}
+
+export interface MenuIconAssetDetails extends BaseAssetDetails {
+  type: "menuIcon";
+}
+
+export interface TrayMenubarIconAssetDetails extends BaseAssetDetails {
+  type: "trayMenubarIcon";
+}
+
+export type AssetDetails =
+  | AppIconAssetDetails
+  | MenuIconAssetDetails
+  | TrayMenubarIconAssetDetails;
+
 /**
  * Custom ToDesktop Roles for Application & Tray Menus
  */
@@ -40,6 +68,7 @@ export interface DesktopifyMenuItemConstructorOptions
   actionType?: "jsEvent" | "role";
   iconUrl?: string;
   bundledIcon?: string;
+  iconAssetDetails?: MenuIconAssetDetails;
   useTemplateImage?: boolean;
 }
 
@@ -80,9 +109,13 @@ export interface DesktopifyAppTray {
   icon?: string;
   useSeparateIcons?: boolean;
   windowsIcon?: string;
+  windowsIconAssetDetails?: TrayMenubarIconAssetDetails;
   macOSIcon?: string;
+  macOSIconAssetDetails?: TrayMenubarIconAssetDetails;
   linuxIcon?: string;
+  linuxIconAssetDetails?: TrayMenubarIconAssetDetails;
   bundledIcon?: string;
+  iconAssetDetails?: TrayMenubarIconAssetDetails;
   useTemplateImage?: boolean;
   rightClick: DesktopifyAppTrayAction;
   leftClick: DesktopifyAppTrayAction;
@@ -288,14 +321,23 @@ export interface DesktopifyApp2 {
   /**
    * The locally-bundled app icon.
    */
-   bundledIcon?: string;
+  bundledIcon?: string;
+  /**
+   * Details concerning how the app icon should be handled across ToDesktop services
+   */
+  iconAssetDetails?: AppIconAssetDetails;
   /**
    * Instead of using one icon for every platform, use a separate icon for different platforms
    */
   useSeparateIcons?: boolean;
   windowsIcon?: string;
+  windowsIconAssetDetails?: AppIconAssetDetails;
+
   macOSIcon?: string;
+  macOSIconAssetDetails?: AppIconAssetDetails;
+
   linuxIcon?: string;
+  linuxIconAssetDetails?: AppIconAssetDetails;
   /**
    * The name of the company that the app belongs to
    */