@todesktop/shared 7.184.17 → 7.184.19

package/src/desktopify.ts

@@ -1,13 +1,14 @@
-import { IApp2 } from "./desktopify2";
-import { IApp } from "./toDesktop";
+import { IApp2 } from './desktopify2';
+import { IApp } from './toDesktop';
 import {
   Configuration,
   PackagerOptions,
   PublishOptions,
   // app-builder-lib shouldn't be installed as a dependency for dependent
   // packages since it's too large
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-} from "app-builder-lib";
+} from 'app-builder-lib';
 
 type appBuilderLib = PackagerOptions & PublishOptions;
 export interface IAppBuilderLib extends appBuilderLib {
@@ -22,9 +23,9 @@ export interface ExtraFileReference {
 export type ISODate = string; // TODO: define more
 
 export enum PlatformName {
-  linux = "linux",
-  mac = "mac",
-  windows = "windows",
+  linux = 'linux',
+  mac = 'mac',
+  windows = 'windows',
 }
 
 export type FilePath = string;
@@ -32,30 +33,30 @@ export type SemanticVersion = string; // TODO: define more
 export type URL = string; // TODO: define more
 
 export enum PackageManager {
-  npm = "npm",
-  yarn = "yarn",
-  pnpm = "pnpm",
+  npm = 'npm',
+  yarn = 'yarn',
+  pnpm = 'pnpm',
 }
 
 export enum BuildStatus {
-  queued = "queued",
-  failed = "failed",
-  building = "building",
-  preparation = "preparation",
-  succeeded = "succeeded",
-  cancelled = "cancelled",
+  queued = 'queued',
+  failed = 'failed',
+  building = 'building',
+  preparation = 'preparation',
+  succeeded = 'succeeded',
+  cancelled = 'cancelled',
 }
 
-export type Arch = "ia32" | "x64" | "arm64";
-export type MacArch = "ia32" | "x64" | "arm64" | "universal";
-export type LinuxArtifactName = "appImage" | "deb" | "rpm" | "snap";
-export type MacArtifactName = "dmg" | "zip" | "installer";
+export type Arch = 'ia32' | 'x64' | 'arm64';
+export type MacArch = 'ia32' | 'x64' | 'arm64' | 'universal';
+export type LinuxArtifactName = 'appImage' | 'deb' | 'rpm' | 'snap';
+export type MacArtifactName = 'dmg' | 'zip' | 'installer';
 export type WindowsArtifactName =
-  | "msi"
-  | "nsis"
-  | "nsis-web"
-  | "nsis-web-7z"
-  | "appx";
+  | 'msi'
+  | 'nsis'
+  | 'nsis-web'
+  | 'nsis-web-7z'
+  | 'appx';
 
 type ArtifactDownload = Record<
   Arch,
@@ -71,7 +72,7 @@ export type WindowsArtifactDownloads = Record<
   ArtifactDownload
 >;
 
-export type CodeSignSkipReason = "no-cert" | "user-disabled";
+export type CodeSignSkipReason = 'no-cert' | 'user-disabled';
 
 export interface PlatformBuild {
   appBuilderLibConfig?: IAppBuilderLib;
@@ -104,7 +105,7 @@ export interface PlatformBuild {
   status: BuildStatus;
 }
 
-export type CIRunner = "circle" | "azure";
+export type CIRunner = 'circle' | 'azure';
 
 export interface Build {
   appCustomDomain?: string;
@@ -126,7 +127,7 @@ export interface Build {
   endedAt?: ISODate;
   electronVersionSpecified?: SemanticVersion;
   electronVersionUsed?: SemanticVersion;
-  environmentVariables?: IApp["environmentVariables"];
+  environmentVariables?: IApp['environmentVariables'];
   errorMessage?: string;
   icon?: string;
   id: string;
@@ -167,21 +168,21 @@ export interface Build {
 
 export type ComputedBuildProperties = Pick<
   Build,
-  | "desktopifyVersion"
-  | "electronVersionUsed"
-  | "endedAt"
-  | "errorMessage"
-  | "releasedAt"
-  | "standardUniversalDownloadUrl"
-  | "startedAt"
-  | "status"
-  | "universalDownloadUrl"
+  | 'desktopifyVersion'
+  | 'electronVersionUsed'
+  | 'endedAt'
+  | 'errorMessage'
+  | 'releasedAt'
+  | 'standardUniversalDownloadUrl'
+  | 'startedAt'
+  | 'status'
+  | 'universalDownloadUrl'
 >;
 
 export enum ManifestCategory {
-  primary = "primary",
-  buildStamped = "build-stamped",
-  versioned = "versioned",
+  primary = 'primary',
+  buildStamped = 'build-stamped',
+  versioned = 'versioned',
 }
 
 export interface CustomManifestArtifactDetails {
@@ -227,7 +228,7 @@ export interface SmokeTestProgress {
   message?: string;
   progress: number;
   screenshot?: string;
-  state: "progress" | "done" | "error" | "skipped";
+  state: 'progress' | 'done' | 'error' | 'skipped';
   updatedAppHasNoMainErrors?: boolean;
 }
 
@@ -246,8 +247,8 @@ export const isPlatformBuildRunning = (
   }
   return (
     !platformBuild.shouldSkip && // <-- Noteworthy
-    !["cancelled", "succeeded"].includes(platformBuild.status) &&
-    ("failed" !== platformBuild.status ||
+    !['cancelled', 'succeeded'].includes(platformBuild.status) &&
+    ('failed' !== platformBuild.status ||
       platformBuild.numberOfAttemptedBuilds < 2)
   );
 };
@@ -258,12 +259,12 @@ export const isCiBuildRunning = (build: Build): boolean => {
     return false;
   }
   return (
-    build.status === "building" ||
-    (build.status === "failed" &&
-      ["linux", "mac", "windows"].some(
+    build.status === 'building' ||
+    (build.status === 'failed' &&
+      ['linux', 'mac', 'windows'].some(
         (platform) =>
-          build.status === "building" ||
-          (build.status === "failed" && isPlatformBuildRunning(build[platform]))
+          build.status === 'building' ||
+          (build.status === 'failed' && isPlatformBuildRunning(build[platform]))
       ))
   );
 };
@@ -273,8 +274,8 @@ export const isBuildRunning = (build: Build): boolean => {
     return false;
   }
   return (
-    !["cancelled", "succeeded"].includes(build.status) &&
-    ["linux", "mac", "windows"].some((platform) =>
+    !['cancelled', 'succeeded'].includes(build.status) &&
+    ['linux', 'mac', 'windows'].some((platform) =>
       isPlatformBuildRunning(build[platform])
     )
   );
@@ -299,7 +300,7 @@ export interface DesktopifyApp {
   maxWidth?: number; // remove
   singleInstance: boolean;
   disableContextMenu: boolean;
-  titleBarStyle?: "hidden" | "hiddenInset" | "customButtonsOnHover"; // remove
+  titleBarStyle?: 'hidden' | 'hiddenInset' | 'customButtonsOnHover'; // remove
   alwaysOnTop: boolean; // remove
   internalUrls?: string;
   isNativeWindowOpenDisabled?: boolean;
@@ -322,8 +323,8 @@ export interface DesktopifyApp {
   shouldReuseRendererProcess?: boolean;
   shouldMakeSameDomainAnExternalLink?: boolean;
   enablePushNotifications?: boolean;
-  themeSource?: "system" | "light" | "dark";
-  themeSourceMac?: "system" | "light" | "dark";
+  themeSource?: 'system' | 'light' | 'dark';
+  themeSourceMac?: 'system' | 'light' | 'dark';
   crashReporter?: string;
   companyName?: string;
   pollForAppUpdatesEveryXMinutes?: number;

package/src/desktopify2.ts

@@ -1,12 +1,12 @@
-import { ISwitchableValue } from "./toDesktop";
+import { ISwitchableValue } from './toDesktop';
 import {
   MenuItemConstructorOptions,
   BrowserWindowConstructorOptions,
   WebPreferences,
-} from "@todesktop/client-electron-types";
-import { BaseApp, Schemable } from "./base";
-import { DesktopAppPlugin } from "./plugin";
-import { ValidTranslationKeys, ValidTranslationLanguages } from "./translation";
+} from '@todesktop/client-electron-types';
+import { BaseApp } from './base';
+import { DesktopAppPlugin } from './plugin';
+import { ValidTranslationKeys, ValidTranslationLanguages } from './translation';
 
 interface BaseAssetDetails {
   /**
@@ -20,20 +20,20 @@ interface BaseAssetDetails {
 }
 
 export interface AppIconAssetDetails extends BaseAssetDetails {
-  type: "appIcon";
+  type: 'appIcon';
 }
 
 export interface MenuIconAssetDetails extends BaseAssetDetails {
-  type: "menuIcon";
+  type: 'menuIcon';
 }
 
 export interface TrayMenubarIconAssetDetails extends BaseAssetDetails {
-  type: "trayMenubarIcon";
+  type: 'trayMenubarIcon';
 }
 
 export interface FileAssetDetails extends BaseAssetDetails {
   md5Hash: string;
-  type: "file";
+  type: 'file';
 }
 
 export type AssetDetails =
@@ -46,39 +46,39 @@ export type AssetDetails =
  * Custom ToDesktop Roles for Application & Tray Menus
  */
 type todesktopRoles =
-  | "todesktop:launch-at-startup"
-  | "todesktop:check-for-updates"
-  | "todesktop:quit"
-  | "todesktop:quit-completely"
-  | "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"
-  | "todesktop:toggle-window"
-  | "todesktop:toggle-window0"
-  | "todesktop:toggle-window1"
-  | "todesktop:toggle-window2"
-  | "todesktop:toggle-window3"
-  | "todesktop:toggle-window4";
+  | 'todesktop:launch-at-startup'
+  | 'todesktop:check-for-updates'
+  | 'todesktop:quit'
+  | 'todesktop:quit-completely'
+  | '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'
+  | 'todesktop:toggle-window'
+  | 'todesktop:toggle-window0'
+  | 'todesktop:toggle-window1'
+  | 'todesktop:toggle-window2'
+  | 'todesktop:toggle-window3'
+  | 'todesktop:toggle-window4';
 
 export interface DesktopifyMenuItemConstructorOptions
-  extends Omit<MenuItemConstructorOptions, "role" | "submenu"> {
+  extends Omit<MenuItemConstructorOptions, 'role' | 'submenu'> {
   platforms?: NodeJS.Platform[];
   submenu?: DesktopifyMenuItemConstructorOptions[];
-  role?: MenuItemConstructorOptions["role"] | todesktopRoles;
+  role?: MenuItemConstructorOptions['role'] | todesktopRoles;
   useSystemLabel?: boolean;
   event?: string;
   targetWindowId?: string;
-  actionType?: "jsEvent" | "role";
+  actionType?: 'jsEvent' | 'role';
   iconUrl?: string;
   bundledIcon?: string;
   iconAssetDetails?: MenuIconAssetDetails;
   useTemplateImage?: boolean;
-  acceleratorBehaviour?: "none" | "default" | "custom";
+  acceleratorBehaviour?: 'none' | 'default' | 'custom';
 }
 
 /**
@@ -87,7 +87,7 @@ export interface DesktopifyMenuItemConstructorOptions
  * @param windowId - The id of the window to toggle
  */
 export type DesktopifyAppTrayToggleWindowAction = {
-  role: "toggleWindow";
+  role: 'toggleWindow';
   windowId: string;
 };
 
@@ -97,7 +97,7 @@ export type DesktopifyAppTrayToggleWindowAction = {
  * @param menu - The menu to show when action triggered
  */
 export type DesktopifyAppTrayToggleMenuAction = {
-  role: "toggleMenu";
+  role: 'toggleMenu';
   menu: DesktopifyMenuItemConstructorOptions[];
 };
 
@@ -105,7 +105,7 @@ export type DesktopifyAppTrayToggleMenuAction = {
  * No Action Tray Action
  */
 export type DesktopifyAppTrayNoAction = {
-  role: "noAction";
+  role: 'noAction';
 };
 
 export type DesktopifyAppTrayAction =
@@ -141,50 +141,52 @@ export type DesktopifyAppMenu = DesktopifyMenuItemConstructorOptions;
 export const allowedBrowserWindowConstructorOptions: Readonly<
   (keyof BrowserWindowConstructorOptions)[]
 > = [
-  "width",
-  "height",
+  'width',
+  'height',
   // "x",
   // "y",
-  "useContentSize",
-  "center",
-  "minWidth",
-  "minHeight",
-  "maxWidth",
-  "maxHeight",
-  "resizable",
-  "movable",
-  "minimizable",
-  "maximizable",
-  "closable",
-  "focusable",
-  "alwaysOnTop",
-  "fullscreen",
-  "fullscreenable",
-  "simpleFullscreen",
-  "skipTaskbar",
-  "kiosk",
-  "icon",
-  "paintWhenInitiallyHidden",
-  "frame",
-  "acceptFirstMouse",
-  "disableAutoHideCursor",
-  "autoHideMenuBar",
-  "enableLargerThanScreen",
-  "backgroundColor",
-  "hasShadow",
-  "opacity",
-  "darkTheme",
-  "transparent",
-  "visualEffectState",
-  "titleBarStyle",
-  "trafficLightPosition",
+  'useContentSize',
+  'center',
+  'minWidth',
+  'minHeight',
+  'maxWidth',
+  'maxHeight',
+  'resizable',
+  'movable',
+  'minimizable',
+  'maximizable',
+  'closable',
+  'focusable',
+  'alwaysOnTop',
+  'fullscreen',
+  'fullscreenable',
+  'simpleFullscreen',
+  'skipTaskbar',
+  'kiosk',
+  'icon',
+  'paintWhenInitiallyHidden',
+  'frame',
+  'acceptFirstMouse',
+  'disableAutoHideCursor',
+  'autoHideMenuBar',
+  'enableLargerThanScreen',
+  'backgroundColor',
+  'hasShadow',
+  'opacity',
+  'darkTheme',
+  'transparent',
+  'visualEffectState',
+  'titleBarStyle',
+  'trafficLightPosition',
   // "roundedCorners",
-  "fullscreenWindowTitle",
-  "thickFrame",
-  "type",
-  "vibrancy",
-  "zoomToPageWidth",
-  "tabbingIdentifier",
+  'fullscreenWindowTitle',
+  'thickFrame',
+  'type',
+  'vibrancy',
+  'zoomToPageWidth',
+  'tabbingIdentifier',
+  'webPreferences',
+  'titleBarOverlay',
 ] as const;
 
 // Make type from all numbered index values
@@ -198,24 +200,24 @@ export type whitelistedBrowserWindowConstructorOptions =
  */
 export const allowedWebPreferencesOptions: Readonly<(keyof WebPreferences)[]> =
   [
-    "devTools",
-    "zoomFactor",
-    "textAreasAreResizable",
-    "scrollBounce",
-    "defaultFontFamily",
-    "defaultFontSize",
-    "defaultMonospaceFontSize",
-    "minimumFontSize",
-    "defaultEncoding",
-    "backgroundThrottling",
-    "offscreen",
-    "safeDialogs",
-    "safeDialogsMessage",
-    "navigateOnDragDrop",
-    "autoplayPolicy",
-    "disableHtmlFullscreenWindowResize",
-    "accessibleTitle",
-    "spellcheck",
+    'devTools',
+    'zoomFactor',
+    'textAreasAreResizable',
+    'scrollBounce',
+    'defaultFontFamily',
+    'defaultFontSize',
+    'defaultMonospaceFontSize',
+    'minimumFontSize',
+    'defaultEncoding',
+    'backgroundThrottling',
+    'offscreen',
+    'safeDialogs',
+    'safeDialogsMessage',
+    'navigateOnDragDrop',
+    'autoplayPolicy',
+    'disableHtmlFullscreenWindowResize',
+    'accessibleTitle',
+    'spellcheck',
   ] as const;
 
 // Make type from all numbered index values
@@ -245,7 +247,7 @@ export interface DesktopifyAppWindow {
   /**
    * The type of window
    */
-  type: "menubar" | "app" | "panel";
+  type: 'menubar' | 'app' | 'panel';
   /**
    * Keyboard shortcut to toggle window visibility
    */
@@ -270,7 +272,7 @@ export interface DesktopifyAppWindow {
   /**
    * Inital visibility of window
    */
-  visibility: "visible" | "hidden" | "show-when-contents-loaded";
+  visibility: 'visible' | 'hidden' | 'show-when-contents-loaded';
   /**
    * MacOS option for whether the window should be visible on all workspaces
    */
@@ -459,13 +461,13 @@ export interface DesktopifyApp2 {
    *
    * See {@link https://www.electronjs.org/docs/api/native-theme#nativethemethemesource}
    */
-  themeSource?: "system" | "light" | "dark";
+  themeSource?: 'system' | 'light' | 'dark';
   /**
    * Sets theme source for only mac
    *
    * See {@link https://www.electronjs.org/docs/api/native-theme#nativethemethemesource}
    */
-  themeSourceMac?: "system" | "light" | "dark";
+  themeSourceMac?: 'system' | 'light' | 'dark';
   /**
    * URL that crash reports will be POSTed to
    */

package/src/getSiteInfo.ts

@@ -7,7 +7,7 @@ export interface IAppFromServerProps {
   html?: string;
   iconUrl?: string;
   secret: string;
-  appType: "app" | "menubar" | "tabbed" | "electron";
+  appType: 'app' | 'menubar' | 'tabbed' | 'electron';
   // dimension: IAppFromServerPropsDimension;
 }
 

package/src/index.ts

@@ -1,14 +1,14 @@
-import { version } from "../package.json";
+import { version } from '../package.json';
 
-export * from "./toDesktop";
-export * from "./desktopify";
-export * from "./validations";
-export * from "./getSiteInfo";
-export * from "./plans";
+export * from './toDesktop';
+export * from './desktopify';
+export * from './validations';
+export * from './getSiteInfo';
+export * from './plans';
 export * from './base';
 export * from './plugin';
 
-export * from "./desktopify2";
+export * from './desktopify2';
 
 const schemaVersion = version;
 export { schemaVersion };

package/src/json.d.ts

@@ -1,9 +1,9 @@
-declare module "*.json" {
+declare module '*.json' {
   const value: any;
   export const version: string;
   export default value;
 }
 
-declare module "is-regex";
+declare module 'is-regex';
 
 // declare module "debug";