@todesktop/shared 7.51.0 → 7.55.0

package/lib/desktopify.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="node" />
 import { IApp } from "./toDesktop";
 import { Configuration, PackagerOptions, PublishOptions } from "app-builder-lib";
+import { MenuItemConstructorOptions, BrowserWindowConstructorOptions } from "@todesktop/client-electron-types";
 declare type appBuilderLib = PackagerOptions & PublishOptions;
 export interface IAppBuilderLib extends appBuilderLib {
     config: Configuration;
@@ -137,22 +139,52 @@ export declare const isPlatformBuildRunning: (platformBuild: PlatformBuild) => b
 export declare const isCiBuildRunning: (build: Build) => boolean;
 export declare const isBuildRunning: (build: Build) => boolean;
 export declare const isBuildCancellable: (build: Build) => boolean;
+declare type todesktopRoles = "todesktop:launch-at-startup" | "todesktop:check-for-updates" | "todesktop:quit" | "todesktop:new-window" | "todesktop:new-tab" | "todesktop:check-for-updates" | "todesktop:history-home" | "todesktop:history-back" | "todesktop:history-forward" | "todesktop:show-window" | "todesktop:hide-window";
+export interface DesktopifyMenuItemConstructorOptions extends Omit<MenuItemConstructorOptions, "role" | "submenu"> {
+    platforms?: NodeJS.Platform[];
+    submenu?: DesktopifyMenuItemConstructorOptions[];
+    role?: MenuItemConstructorOptions["role"] | todesktopRoles;
+}
 export interface DesktopifyAppWindow {
     id: string;
     name: string;
     url: string;
     fullScreen: boolean;
+    height: number;
     minHeight?: number;
-    minWidth?: number;
     maxHeight?: number;
-    maxWidth?: number;
-    height: number;
+    hasMinHeight?: boolean;
+    hasMaxHeight?: boolean;
     width: number;
+    minWidth?: number;
+    maxWidth?: number;
+    hasMinWidth?: boolean;
+    hasMaxWidth?: boolean;
     isResizable: boolean;
     titleBarStyle?: "hidden" | "hiddenInset" | "customButtonsOnHover";
     alwaysOnTop: boolean;
     visibility: "visible" | "hidden" | "show-when-contents-loaded";
     isMain: boolean;
+    applicationMenu: DesktopifyMenuItemConstructorOptions[];
+    type: "menubar" | "app";
+    transparentTitlebar: boolean;
+    shouldResetDimensions?: boolean;
+    vibrancy?: BrowserWindowConstructorOptions["vibrancy"];
+    toggleVisibilityKeyboardShortcut?: string;
+}
+export declare type DesktopifyAppTrayToggleWindowAction = {
+    role: "toggleWindow";
+    windowId: string;
+};
+export declare type DesktopifyAppTrayToggleMenuAction = {
+    role: "toggleMenu";
+    menu: DesktopifyMenuItemConstructorOptions[];
+};
+export declare type DesktopifyAppTrayAction = DesktopifyAppTrayToggleMenuAction | DesktopifyAppTrayToggleWindowAction;
+export interface DesktopifyAppTray {
+    icon: string;
+    rightClick?: DesktopifyAppTrayAction;
+    leftClick?: DesktopifyAppTrayAction;
 }
 export interface DesktopifyApp {
     name: string;
@@ -201,5 +233,6 @@ export interface DesktopifyApp {
 }
 export interface DesktopifyApp2 extends DesktopifyApp {
     windows: DesktopifyAppWindow[];
+    trays: DesktopifyAppTray[];
 }
 export {};

package/lib/desktopify.js

@@ -59,3 +59,4 @@ exports.isBuildRunning = (build) => {
         ["linux", "mac", "windows"].some((platform) => exports.isPlatformBuildRunning(build[platform])));
 };
 exports.isBuildCancellable = (build) => exports.hasBuildKickedOff(build) && exports.isBuildRunning(build);
+let s;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@todesktop/shared",
-  "version": "7.51.0",
+  "version": "7.55.0",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -8,11 +8,13 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "rm -f ./lib/* && tsc",
     "prepublishOnly": "npm run build",
-    "bump": "npm version minor && git push && npm publish"
+    "bump": "npm version minor && git push && npm publish",
+    "dev": "tsc"
   },
   "author": "Dave Jeffery <dave@davejeffery.com>",
   "license": "UNLICENSED",
   "dependencies": {
+    "@todesktop/client-electron-types": "^0.1.0",
     "@types/debug": "^4.1.1",
     "@types/node": "^13.11.1",
     "@types/yup": "^0.26.9",

package/src/desktopify.ts

@@ -4,6 +4,10 @@ import {
   PackagerOptions,
   PublishOptions,
 } from "app-builder-lib";
+import {
+  MenuItemConstructorOptions,
+  BrowserWindowConstructorOptions,
+} from "@todesktop/client-electron-types";
 
 type appBuilderLib = PackagerOptions & PublishOptions;
 export interface IAppBuilderLib extends appBuilderLib {
@@ -250,22 +254,77 @@ export const isBuildRunning = (build: Build): boolean => {
 export const isBuildCancellable = (build: Build): boolean =>
   hasBuildKickedOff(build) && isBuildRunning(build);
 
+type todesktopRoles =
+  | "todesktop:launch-at-startup"
+  | "todesktop:check-for-updates"
+  | "todesktop:quit"
+  | "todesktop:new-window"
+  | "todesktop:new-tab"
+  | "todesktop:check-for-updates"
+  | "todesktop:history-home"
+  | "todesktop:history-back"
+  | "todesktop:history-forward"
+  | "todesktop:show-window"
+  | "todesktop:hide-window";
+
+let s: MenuItemConstructorOptions;
+
+export interface DesktopifyMenuItemConstructorOptions
+  extends Omit<MenuItemConstructorOptions, "role" | "submenu"> {
+  platforms?: NodeJS.Platform[];
+  submenu?: DesktopifyMenuItemConstructorOptions[];
+  role?: MenuItemConstructorOptions["role"] | todesktopRoles;
+}
+
 export interface DesktopifyAppWindow {
   id: string;
   name: string;
   url: string;
   fullScreen: boolean;
-  minHeight?: number; 
-  minWidth?: number; 
-  maxHeight?: number; 
-  maxWidth?: number;
+
   height: number;
+  minHeight?: number;
+  maxHeight?: number;
+  hasMinHeight?: boolean;
+  hasMaxHeight?: boolean;
+
   width: number;
+  minWidth?: number;
+  maxWidth?: number;
+  hasMinWidth?: boolean;
+  hasMaxWidth?: boolean;
+
   isResizable: boolean;
   titleBarStyle?: "hidden" | "hiddenInset" | "customButtonsOnHover";
   alwaysOnTop: boolean;
   visibility: "visible" | "hidden" | "show-when-contents-loaded";
   isMain: boolean;
+  applicationMenu: DesktopifyMenuItemConstructorOptions[];
+  type: "menubar" | "app";
+  transparentTitlebar: boolean;
+  shouldResetDimensions?: boolean;
+  vibrancy?: BrowserWindowConstructorOptions["vibrancy"];
+  toggleVisibilityKeyboardShortcut?: string;
+}
+
+export type DesktopifyAppTrayToggleWindowAction = {
+  role: "toggleWindow";
+  windowId: string;
+};
+
+export type DesktopifyAppTrayToggleMenuAction = {
+  role: "toggleMenu";
+  menu: DesktopifyMenuItemConstructorOptions[];
+};
+
+export type DesktopifyAppTrayAction =
+  | DesktopifyAppTrayToggleMenuAction
+  | DesktopifyAppTrayToggleWindowAction;
+
+export interface DesktopifyAppTray {
+  icon: string;
+  rightClick?: DesktopifyAppTrayAction;
+  leftClick?: DesktopifyAppTrayAction;
 }
 
 export interface DesktopifyApp {
@@ -281,7 +340,7 @@ export interface DesktopifyApp {
   minHeight?: number; // remove
   minWidth?: number; // remove
   maxHeight?: number; // remove
-  maxWidth?: number; // remove 
+  maxWidth?: number; // remove
   singleInstance: boolean;
   disableContextMenu: boolean;
   titleBarStyle?: "hidden" | "hiddenInset" | "customButtonsOnHover"; // remove
@@ -316,4 +375,5 @@ export interface DesktopifyApp {
 
 export interface DesktopifyApp2 extends DesktopifyApp {
   windows: DesktopifyAppWindow[];
-}
+  trays: DesktopifyAppTray[];
+}