@todesktop/shared 7.126.0 → 7.128.0

package/lib/desktopify2.d.ts

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

package/package.json

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

package/src/desktopify2.ts

@@ -7,6 +7,25 @@ import {
 import { BaseApp, Schemable } from "./base";
 import { DesktopAppPlugin } from "./plugin";
 
+export type AssetDetails = {
+  /**
+   * Remote URL where the asset can be downloaded
+   */
+  url: string;
+  /**
+   * Whether the asset is bundled into the final built app
+   */
+  isBundled: boolean;
+  /**
+   * Local path where the asset is/should be stored. This path is relative to the app directory
+   */
+  relativeLocalPath: string;
+  /**
+   * The type of asset being stored
+   */
+  type: "templateImage" | "default"
+};
+
 /**
  * Custom ToDesktop Roles for Application & Tray Menus
  */
@@ -40,6 +59,7 @@ export interface DesktopifyMenuItemConstructorOptions
   actionType?: "jsEvent" | "role";
   iconUrl?: string;
   bundledIcon?: string;
+  iconAssetDetails?: AssetDetails;
   useTemplateImage?: boolean;
 }
 
@@ -80,9 +100,13 @@ export interface DesktopifyAppTray {
   icon?: string;
   useSeparateIcons?: boolean;
   windowsIcon?: string;
+  windowsIconAssetDetails?: AssetDetails;
   macOSIcon?: string;
+  macOSIconAssetDetails?: AssetDetails;
   linuxIcon?: string;
+  linuxIconAssetDetails?: AssetDetails;
   bundledIcon?: string;
+  iconAssetDetails?: AssetDetails;
   useTemplateImage?: boolean;
   rightClick: DesktopifyAppTrayAction;
   leftClick: DesktopifyAppTrayAction;
@@ -282,16 +306,29 @@ export interface DesktopifyApp2 {
    */
   name: string;
   /**
-   * The app icon
+   * The app icon url
    */
   icon?: string;
+  /**
+   * The locally-bundled app icon.
+   */
+  bundledIcon?: string;
+  /**
+   * Details concerning how the app icon should be handled across ToDesktop services
+   */
+  iconAssetDetails?: AssetDetails;
   /**
    * Instead of using one icon for every platform, use a separate icon for different platforms
    */
   useSeparateIcons?: boolean;
   windowsIcon?: string;
+  windowsIconAssetDetails?: AssetDetails;
+
   macOSIcon?: string;
+  macOSIconAssetDetails?: AssetDetails;
+
   linuxIcon?: string;
+  linuxIconAssetDetails?: AssetDetails;
   /**
    * The name of the company that the app belongs to
    */