@todesktop/shared 7.128.0 → 7.130.0

package/lib/desktopify2.d.ts

@@ -3,24 +3,27 @@ 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 = {
+import { ValidTranslationKeys, ValidTranslationLanguages } from "./translation";
+interface BaseAssetDetails {
     /**
      * 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";
-};
+}
+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
  */
@@ -35,7 +38,7 @@ export interface DesktopifyMenuItemConstructorOptions extends Omit<MenuItemConst
     actionType?: "jsEvent" | "role";
     iconUrl?: string;
     bundledIcon?: string;
-    iconAssetDetails?: AssetDetails;
+    iconAssetDetails?: MenuIconAssetDetails;
     useTemplateImage?: boolean;
 }
 /**
@@ -68,13 +71,13 @@ export interface DesktopifyAppTray {
     icon?: string;
     useSeparateIcons?: boolean;
     windowsIcon?: string;
-    windowsIconAssetDetails?: AssetDetails;
+    windowsIconAssetDetails?: TrayMenubarIconAssetDetails;
     macOSIcon?: string;
-    macOSIconAssetDetails?: AssetDetails;
+    macOSIconAssetDetails?: TrayMenubarIconAssetDetails;
     linuxIcon?: string;
-    linuxIconAssetDetails?: AssetDetails;
+    linuxIconAssetDetails?: TrayMenubarIconAssetDetails;
     bundledIcon?: string;
-    iconAssetDetails?: AssetDetails;
+    iconAssetDetails?: TrayMenubarIconAssetDetails;
     useTemplateImage?: boolean;
     rightClick: DesktopifyAppTrayAction;
     leftClick: DesktopifyAppTrayAction;
@@ -202,17 +205,17 @@ export interface DesktopifyApp2 {
     /**
      * Details concerning how the app icon should be handled across ToDesktop services
      */
-    iconAssetDetails?: AssetDetails;
+    iconAssetDetails?: AppIconAssetDetails;
     /**
      * Instead of using one icon for every platform, use a separate icon for different platforms
      */
     useSeparateIcons?: boolean;
     windowsIcon?: string;
-    windowsIconAssetDetails?: AssetDetails;
+    windowsIconAssetDetails?: AppIconAssetDetails;
     macOSIcon?: string;
-    macOSIconAssetDetails?: AssetDetails;
+    macOSIconAssetDetails?: AppIconAssetDetails;
     linuxIcon?: string;
-    linuxIconAssetDetails?: AssetDetails;
+    linuxIconAssetDetails?: AppIconAssetDetails;
     /**
      * The name of the company that the app belongs to
      */
@@ -341,6 +344,14 @@ export interface DesktopifyApp2 {
         buttonBackgroundColor: string;
         buttonTextColor: string;
     };
+    /**
+     * Sets strings to be used in the app UI. Currently only supports English
+     */
+    appStrings?: {
+        [key in ValidTranslationKeys]?: {
+            [lang in ValidTranslationLanguages]?: string;
+        };
+    };
 }
 export interface IApp2 extends BaseApp {
     desktopApp: DesktopifyApp2;

package/lib/translation.d.ts

@@ -0,0 +1,2 @@
+export declare type ValidTranslationKeys = "updateNotification.title" | "updateNotification.body";
+export declare type ValidTranslationLanguages = "default";

package/lib/translation.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* TODO - Support more languages here */
+// | "en"
+// | "es"
+// | "fr"
+// | "de"
+// | "it"
+// | "ja"
+// | "ko"
+// | "pt-BR"
+// | "ru"
+// | "zh-CN"
+// | "zh-TW";

package/package.json

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

package/src/desktopify2.ts

@@ -6,25 +6,35 @@ import {
 } from "@todesktop/client-electron-types";
 import { BaseApp, Schemable } from "./base";
 import { DesktopAppPlugin } from "./plugin";
+import { ValidTranslationKeys, ValidTranslationLanguages } from "./translation";
 
-export type AssetDetails = {
+interface BaseAssetDetails {
   /**
    * 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"
-};
+}
+
+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
@@ -59,7 +69,7 @@ export interface DesktopifyMenuItemConstructorOptions
   actionType?: "jsEvent" | "role";
   iconUrl?: string;
   bundledIcon?: string;
-  iconAssetDetails?: AssetDetails;
+  iconAssetDetails?: MenuIconAssetDetails;
   useTemplateImage?: boolean;
 }
 
@@ -100,13 +110,13 @@ export interface DesktopifyAppTray {
   icon?: string;
   useSeparateIcons?: boolean;
   windowsIcon?: string;
-  windowsIconAssetDetails?: AssetDetails;
+  windowsIconAssetDetails?: TrayMenubarIconAssetDetails;
   macOSIcon?: string;
-  macOSIconAssetDetails?: AssetDetails;
+  macOSIconAssetDetails?: TrayMenubarIconAssetDetails;
   linuxIcon?: string;
-  linuxIconAssetDetails?: AssetDetails;
+  linuxIconAssetDetails?: TrayMenubarIconAssetDetails;
   bundledIcon?: string;
-  iconAssetDetails?: AssetDetails;
+  iconAssetDetails?: TrayMenubarIconAssetDetails;
   useTemplateImage?: boolean;
   rightClick: DesktopifyAppTrayAction;
   leftClick: DesktopifyAppTrayAction;
@@ -316,19 +326,19 @@ export interface DesktopifyApp2 {
   /**
    * Details concerning how the app icon should be handled across ToDesktop services
    */
-  iconAssetDetails?: AssetDetails;
+  iconAssetDetails?: AppIconAssetDetails;
   /**
    * Instead of using one icon for every platform, use a separate icon for different platforms
    */
   useSeparateIcons?: boolean;
   windowsIcon?: string;
-  windowsIconAssetDetails?: AssetDetails;
+  windowsIconAssetDetails?: AppIconAssetDetails;
 
   macOSIcon?: string;
-  macOSIconAssetDetails?: AssetDetails;
+  macOSIconAssetDetails?: AppIconAssetDetails;
 
   linuxIcon?: string;
-  linuxIconAssetDetails?: AssetDetails;
+  linuxIconAssetDetails?: AppIconAssetDetails;
   /**
    * The name of the company that the app belongs to
    */
@@ -457,6 +467,14 @@ export interface DesktopifyApp2 {
     buttonBackgroundColor: string;
     buttonTextColor: string;
   };
+  /**
+   * Sets strings to be used in the app UI. Currently only supports English
+   */
+  appStrings?: {
+    [key in ValidTranslationKeys]?: {
+      [lang in ValidTranslationLanguages]?: string;
+    };
+  };
 }
 
 export interface IApp2 extends BaseApp {

package/src/translation.ts

@@ -0,0 +1,16 @@
+export type ValidTranslationKeys =
+  | "updateNotification.title"
+  | "updateNotification.body";
+export type ValidTranslationLanguages = "default";
+/* TODO - Support more languages here */
+// | "en"
+// | "es"
+// | "fr"
+// | "de"
+// | "it"
+// | "ja"
+// | "ko"
+// | "pt-BR"
+// | "ru"
+// | "zh-CN"
+// | "zh-TW";