@todesktop/shared 7.188.17 → 7.188.19-beta.1

package/lib/plugin.d.ts

@@ -1,4 +1,4 @@
-declare type AjvJSONSchemaType = object;
+type AjvJSONSchemaType = object;
 export interface DesktopAppPlugin {
     /**
      * Configuration gathered from the todesktop plugin.
@@ -11,28 +11,28 @@ export interface DesktopAppPlugin {
      */
     package: string;
 }
-export declare type ToDesktopPlugin = {
+export type ToDesktopPlugin = {
     namespace: string;
     version: number;
     main?: string;
     preload?: string;
     preferences?: PluginPreferences;
 };
-export declare type PluginPreferences = {
+export type PluginPreferences = {
     [id: string]: PluginPreference;
 };
-export declare type PluginPreference = NumberSpec | TextSpec | CheckboxSpec;
-export declare type TextSpec = PreferenceSpec<'text', {
+export type PluginPreference = NumberSpec | TextSpec | CheckboxSpec;
+export type TextSpec = PreferenceSpec<'text', {
     validator?: AjvJSONSchemaType;
     value?: string;
     placeholder?: string;
 }>;
-export declare type NumberSpec = PreferenceSpec<'number', {
+export type NumberSpec = PreferenceSpec<'number', {
     validator?: AjvJSONSchemaType;
     value?: number;
     placeholder?: number;
 }>;
-export declare type CheckboxSpec = PreferenceSpec<'checkbox', {
+export type CheckboxSpec = PreferenceSpec<'checkbox', {
     validator?: AjvJSONSchemaType;
     value?: boolean;
 }>;

package/lib/toDesktop.d.ts

@@ -1,6 +1,6 @@
 import { BaseApp, Schemable } from './base';
 import { IAppBuilderLib } from './desktopify';
-export declare type IUploadFileStatus = 'error' | 'success' | 'done' | 'uploading' | 'removed';
+export type IUploadFileStatus = 'error' | 'success' | 'done' | 'uploading' | 'removed';
 export interface IUploadFile {
     uid: string;
     size: number;
@@ -25,7 +25,7 @@ export interface IAppIcon {
     appId: string;
     icon: IHueIcon;
 }
-export declare type IAppIcons = IAppIcon[];
+export type IAppIcons = IAppIcon[];
 export interface IAppWindowOptions {
     startInFullscreenMode: boolean;
     isResizable: boolean;
@@ -77,12 +77,6 @@ export interface IIcon {
     height: number;
     type: string;
 }
-export interface CustomNotarization {
-    appleId: string;
-    appleIdPassword: string;
-    ascProvider?: string;
-    teamId?: string;
-}
 export interface IApp extends BaseApp {
     appModelId: string;
     appPkgName?: string;
@@ -148,9 +142,11 @@ export interface IUser extends Schemable {
     disableShouldCodeSign?: boolean;
     allowedIPs?: string[];
     seenReleaseTutorial?: boolean;
+    seenApplicationGroupsTutorial?: boolean;
 }
 export interface FeatureFlags {
     desktopAppPlugins: boolean;
+    macAppStore: boolean;
 }
 export interface UserIHaveSentInviteTo {
     email: string;

package/lib/translation.d.ts

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

package/lib/validations.d.ts

@@ -5,9 +5,9 @@ export declare const appTitleValidation: yup.StringSchema;
 export declare const forceVersionValidation: yup.StringSchema;
 export declare const iconValidation: yup.StringSchema;
 export declare const urlValidation: yup.StringSchema;
-export declare const urlValidationForm: yup.ObjectSchema<yup.Shape<object, {
+export declare const urlValidationForm: yup.ObjectSchema<{
     url: string;
-}>>;
+}>;
 export declare const heightValidation: yup.NumberSchema;
 export declare const widthValidation: yup.NumberSchema;
 export declare const internalAppRegexValidation: yup.StringSchema;
@@ -51,4 +51,4 @@ export declare const appConfigValidation: yup.ObjectSchema<{
         publishedVersions: any;
     };
 }>;
-export declare const shouldMinimizeToTrayIsActive: <Plugin_1 = DesktopAppPlugin>(desktopApp: DesktopifyApp2<Plugin_1>) => boolean;
+export declare const shouldMinimizeToTrayIsActive: <Plugin = DesktopAppPlugin>(desktopApp: DesktopifyApp2<Plugin>) => boolean;

package/lib/validations.js

@@ -133,6 +133,7 @@ exports.appConfigValidation = yup.object({
     })
         .required(),
 });
-exports.shouldMinimizeToTrayIsActive = (desktopApp) => {
+const shouldMinimizeToTrayIsActive = (desktopApp) => {
     return desktopApp.trays.some((t) => t.leftClick.role === 'toggleMenu' || t.rightClick.role === 'toggleMenu');
 };
+exports.shouldMinimizeToTrayIsActive = shouldMinimizeToTrayIsActive;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@todesktop/shared",
-  "version": "7.188.17",
+  "version": "7.188.19-beta.1",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -26,14 +26,17 @@
     "yup": "^0.26.10"
   },
   "devDependencies": {
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.9.1",
     "@types/semver": "^7.3.9",
-    "@typescript-eslint/eslint-plugin": "^5.60.1",
-    "@typescript-eslint/parser": "^5.60.1",
+    "@typescript-eslint/eslint-plugin": "^8.4.0",
+    "@typescript-eslint/parser": "^8.4.0",
     "app-builder-lib": "^22.10.4",
-    "eslint": "^8.43.0",
+    "eslint": "^9.9.1",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
+    "globals": "^15.9.0",
     "prettier": "^2.8.8",
-    "typescript": "^3.9.10"
+    "typescript": "^5.5.4"
   }
 }

package/src/base.ts

@@ -2,6 +2,7 @@ import {
   ExtraFileReference,
   FilePath,
   IAppBuilderLib,
+  PlatformName,
   Release,
 } from './desktopify';
 export interface Schemable {
@@ -115,6 +116,7 @@ export interface ToDesktopJson {
   asar?: boolean;
   asarUnpack?: boolean | string[];
   bucket?: string;
+  buildVersion?: string;
   copyright?: string;
   dmg?: {
     background?: FilePath;
@@ -150,6 +152,13 @@ export interface ToDesktopJson {
     icon?: FilePath;
     requirements?: FilePath;
   };
+  mas?: {
+    type?: 'development' | 'distribution'; // defaults to development
+    entitlements?: FilePath;
+    entitlementsInherit?: FilePath;
+    provisioningProfile?: FilePath;
+    x64ArchFiles?: string;
+  };
   nodeVersion?: string;
   npmVersion?: string;
   packageManager?: 'npm' | 'yarn' | 'pnpm';
@@ -181,9 +190,6 @@ export interface CustomWindowsCodeSignFile {
   certType: string;
   hsmCertType: WindowsHSMCertType.file;
   hsmCertName: string;
-  // following are still used in desktopify, but no longer used/saved from web app
-  certPassword?: string;
-  certUrl?: URL;
 }
 
 export interface CustomWindowsCodeSignEV {
@@ -204,19 +210,27 @@ export type CustomMacCodeSign =
     };
 
 export type CustomMacNotarization =
-  | {
-      appleId: string;
-      appleIdPassword: string;
-      ascProvider?: string;
-      teamId?: string;
-    }
-  | {
-      // password is stored on hsm
-      type: 'hsm';
-      appleId: string;
-      ascProvider?: string;
-      teamId?: string;
-    };
+  | CustomNotarizationApiKeyAuth
+  | CustomNotarizationPasswordAuth
+  | CustomNotarizationPasswordHsmAuth;
+
+export interface CustomNotarizationApiKeyAuth {
+  appleApiKeyId: string;
+  appleApiIssuer: string;
+  type: 'hsm-api';
+}
+
+export interface CustomNotarizationPasswordAuth {
+  appleId: string;
+  appleIdPassword: string;
+  teamId: string;
+}
+
+export interface CustomNotarizationPasswordHsmAuth {
+  appleId: string;
+  teamId: string;
+  type: 'hsm';
+}
 
 export type ReleaseRedirectionRule =
   | {
@@ -232,6 +246,11 @@ export type ReleaseRedirectionRule =
       buildId: string;
       ipList: string[];
       rule: 'buildByIp';
+    }
+  | {
+      buildId: string;
+      platforms: PlatformName[];
+      rule: 'buildByPlatform';
     };
 
 export interface BaseApp extends Schemable {
@@ -243,12 +262,10 @@ export interface BaseApp extends Schemable {
   customWindowsCodeSign?: CustomWindowsCodeSignFile | CustomWindowsCodeSignEV;
 
   meta?: IAppMeta;
-  subscription?: {
-    status: string;
-    subscriptionId: string;
-    itemId: string;
-    planId: string;
-  };
+  // this property is dynamically resolved at queueBuild in cloud functions
+  parentApp?: BaseApp;
+  parent?: { id: string; relationshipToParent: string } | null;
+  subscription?: Subscription;
 
   // artifacts
   shouldCreate32BitWindowsArtifacts?: boolean;
@@ -259,6 +276,8 @@ export interface BaseApp extends Schemable {
   shouldCreateArm64WindowsArtifacts?: boolean;
   shouldCreateDebianPackages?: boolean;
   shouldCreateDMGs?: boolean;
+  shouldCreateMacAppStoreFiles?: boolean;
+  shouldCreateMacPKG?: boolean;
   shouldCreateMacUniversalInstaller?: boolean;
   shouldCreateMacZipInstallers?: boolean;
   shouldCreateMSIInstallers?: boolean;
@@ -266,9 +285,23 @@ export interface BaseApp extends Schemable {
   shouldCreateNSISWebInstaller?: boolean;
   shouldCreateRPMPackages?: boolean;
   shouldCreateSnapFiles?: boolean;
-
   // artifact configs
   appxConfig?: Partial<IAppBuilderLib['config']['appx']>;
+  masConfig?: Partial<IAppBuilderLib['config']['mas']>;
   nsisConfig?: Partial<IAppBuilderLib['config']['nsis']>;
   snapStore?: { login?: string; description?: string };
+  macUniversalInstallerConfig?: {
+    shouldPinToVersion?: boolean;
+  };
 }
+
+export type Subscription = {
+  status: string;
+  subscriptionId: string;
+  itemId: string;
+  planId: string;
+
+  // todo: remove optional qualifier once we complete migration
+  productId?: string;
+  priceId?: string;
+};

package/src/desktopify.ts

@@ -62,7 +62,7 @@ export type MacArch = 'x64' | 'arm64' | 'universal';
 export type LinuxArch = 'x64' | 'arm64';
 export type WindowsArch = 'ia32' | 'x64' | 'arm64' | 'universal';
 export type LinuxArtifactName = 'appImage' | 'deb' | 'rpm' | 'snap';
-export type MacArtifactName = 'dmg' | 'zip' | 'installer';
+export type MacArtifactName = 'dmg' | 'zip' | 'installer' | 'mas' | 'pkg';
 export type WindowsArtifactName =
   | 'msi'
   | 'nsis'
@@ -145,14 +145,17 @@ export interface Build {
   hash?: string;
   icon?: string;
   id: string;
+  isArtifactsPruned?: boolean;
   isBeingCancelled?: boolean;
   linux?: PlatformBuild;
   mac?: PlatformBuild;
   onBuildFinishedWebhook?: string;
+  partiallyReleasedAt?: ISODate;
   projectConfig?: string; // Stringified version of todesktop.json
   releasedAt?: ISODate;
   shouldCodeSign: boolean;
   shouldRelease: boolean;
+  shouldRetainForever?: boolean; // Artifacts can't be pruned
   smokeTest?: {
     buildServerExecutionId?: string;
     isCanceled?: boolean;
@@ -164,6 +167,7 @@ export interface Build {
     status: AnalysisStatus;
     // `result` is a stringified JSON object
     result?: string;
+    error?: string;
   };
   dependencyAnalysis?: {
     status: AnalysisStatus;
@@ -194,10 +198,13 @@ export interface Build {
 }
 
 export type BundlePhobiaItem = {
-  description: string;
-  gzip: string;
-  name: string;
-  size: number;
+  result: {
+    description: string;
+    gzip: string;
+    name: string;
+    size: number;
+  } | null;
+  error: string | null;
 };
 
 export type ComputedBuildProperties = Pick<
@@ -258,15 +265,86 @@ export interface WindowsCustomManifest extends CustomManifest {
 
 export interface SmokeTestProgress {
   abState?: SmokeTestState;
+  abSkipReason?: string;
   appLaunched?: boolean;
   appUpdated?: boolean;
   bcState?: SmokeTestState;
+  buildAId?: string;
   code?: string; // string currently, since it's still a subject to change
   message?: string;
+  performance?: {
+    ab?: SmokeTestPerformance;
+    bc: SmokeTestPerformance;
+  };
   progress: number;
   screenshot?: string;
   state: SmokeTestState;
   updatedAppHasNoMainErrors?: boolean;
+  vm: {
+    agentVersion: string;
+    cpu?: string; // win only
+    image: string;
+    imageVersion: string;
+  };
+}
+
+export interface SmokeTestPerformance {
+  /**
+   * Time between `process.getCreationTime()` and `App#redy event`
+   */
+  appReadyMs: number;
+  /**
+   * Time between `process.getCreationTime()` and app is closed for update
+   */
+  appReadyToRestartForUpdateMs: number;
+  /**
+   * Time between `process.getCreationTime()` and connect event received from
+   * the restarted app. It can be up to 4 minutes on Windows.
+   */
+  appRestartedAfterUpdateMs: number;
+  /**
+   * From `process.cpuUsage()` user + system.
+   * This value measures time spent in user and system code, and may end up
+   * being greater than actual elapsed time if multiple CPU cores are
+   * performing work for this process.
+   * Under the hood, low-level calls like `getrusage` are used, so this value
+   * is calculated from the process start.
+   * It measures for the first 10-12 seconds of the app execution.
+   */
+  cpuUsageMainProcessMs: number;
+  /**
+   * Maximum memory consumption by the main + renders + any other helper
+   * processes
+   */
+  memoryUsageAllProcessesMb: number;
+  /**
+   * Maximum memory consumption by the main process
+   */
+  memoryUsageMainProcessMb: number;
+  /**
+   * Maximum memory consumption by a renderer process (if started)
+   */
+  memoryUsageRendererProcessMb?: number;
+  /**
+   * Time between `process.getCreationTime()` and `initSmokeTest()` of
+   * runtime execution
+   */
+  runtimeLoadedMs: number;
+  /**
+   * Time between `process.getCreationTime()` and the update file downloaded
+   * from the server.
+   */
+  updateDownloadedMs: number;
+  /**
+   * Time between `process.getCreationTime()` and the first firing of
+   * WebContents#dom-ready if any window is created
+   */
+  webContentsDomReadyMs?: number;
+  /**
+   * Time between `process.getCreationTime()` and the first firing of
+   * WebContents#did-finish-load if any window is created
+   */
+  webContentsFinishLoadMs?: number;
 }
 
 export type SmokeTestState = 'progress' | 'done' | 'error' | 'skipped';

package/src/desktopify2.ts

@@ -288,6 +288,10 @@ export interface DesktopifyAppWindow {
    * Disables default rightClick menu
    */
   disableContextMenu: boolean;
+  /**
+   * Disables the menu item for opening a link in a new app window
+   */
+  disableContextMenuOpenInWindow: boolean;
   /**
    * Allows user to `Cmd+F` or `Edit>Find` to search for text on page
    */
@@ -521,9 +525,17 @@ export interface DesktopifyApp2<Plugin = DesktopAppPlugin> {
    */
   shouldMakeSameDomainAnExternalLink?: boolean;
   /**
-   * Enables push notifications
+   * Enables push notifications — uses `electron-push-receiver`
    */
   enablePushNotifications?: boolean;
+  /**
+   * Enables NEW push notifications — uses `@cuj1559/electron-push-receiver`
+   */
+  enableNewPushNotifications?: boolean;
+  /**
+   * Disable error reporting (Sentry)
+   */
+  disableErrorTracking?: boolean;
   /**
    * Sets theme for Electron UI elements and css.
    *

package/src/hsm.ts

@@ -0,0 +1,63 @@
+/**
+ * - mac = Developer ID Application
+ * - mac-installer = Developer ID Installer
+ * - mas = Apple Distribution or Mac App Distribution (for Mac App Store)
+ * - mas-installer = Mac Installer Distribution (for Mac App Store)
+ * - mas-dev = Apple Development
+ */
+export type MacTarget =
+  | 'mac'
+  | 'mac-installer'
+  | 'mas'
+  | 'mas-installer'
+  | 'mas-dev';
+
+export type WindowsTarget = 'windows';
+
+export function isMacTarget(type: string): type is MacTarget {
+  return ['mac', 'mac-installer', 'mas', 'mas-installer', 'mas-dev'].includes(
+    type
+  );
+}
+
+export function isWindowsTarget(type: string): type is MacTarget {
+  return ['windows'].includes(type);
+}
+
+/**
+ * Files that are uploaded to HSM have a unique secretName that depends on the appId and target.
+ * This function returns the key name that is used for certificate files that have a `.p12` postfix.
+ *
+ * @param appId the application id
+ * @param target the target type
+ * @returns the name of the secret that is required for downloading the cert from HSM.
+ */
+export const getCertificateNameFromHSM = (
+  appId: string,
+  target: MacTarget | WindowsTarget
+) => {
+  if (!isMacTarget(target) && !isWindowsTarget(target)) {
+    throw new Error(
+      `Invalid target '${target}'. Only windows or mac certs are supported`
+    );
+  }
+
+  return `todesktop-${appId}-${target}-cert`;
+};
+
+/**
+ * Files that are uploaded to HSM have a unique secretName that depends on the appId and target.
+ * This function returns the key name that is used for key files that have a `.p8` postfix.
+ * Currently only used for mac notarization.
+ *
+ * @param appId the application id
+ * @param target the target type
+ * @returns the name of the secret that is required for downloading the cert from HSM.
+ */
+export const getAPIKeyNameFromHSM = (appId: string, target: MacTarget) => {
+  if (!isMacTarget(target)) {
+    throw new Error(`Invalid target '${target}'. Only mac certs are supported`);
+  }
+
+  return `todesktop-${appId}-${target}-api-key`;
+};

package/src/index.ts

@@ -7,6 +7,7 @@ export * from './getSiteInfo';
 export * from './plans';
 export * from './base';
 export * from './plugin';
+export * from './hsm';
 
 export * from './desktopify2';