@todesktop/shared 7.190.0 → 7.191.1

package/src/base.ts

@@ -7,6 +7,7 @@ import {
   Release,
 } from './desktopify';
 import { MacTarget, WindowsTarget } from './hsm';
+
 export interface Schemable {
   schemaVersion?: number;
 }
@@ -14,34 +15,34 @@ export interface Schemable {
 type CompositeIdFileLocationKey = string;
 export type StaticAnalysisItem = { hidden: boolean };
 
-export type ProgressTypes = 'queued' | 'progress' | 'done' | 'error';
+export type ProgressTypes = 'done' | 'error' | 'progress' | 'queued';
 
 export interface IChecklistItem {
   [id: string]: boolean;
 }
 
 export interface IDownloadButtonOptions {
-  buttonSize: 'small' | 'medium' | 'large';
-  fontFamily: 'serif' | 'sans-serif';
   bgColor: string;
-  fgColor: string;
   borderRadius: number;
+  btnText: string;
+  buttonSize: 'large' | 'medium' | 'small';
+  fgColor: string;
+  fontFamily: 'sans-serif' | 'serif';
   showAppIcon: {
+    alignment: 'left' | 'right';
     enabled: boolean;
-    alignment: 'right' | 'left';
   };
   showDownloadIcon: {
+    alignment: 'left' | 'right';
     enabled: boolean;
-    alignment: 'right' | 'left';
   };
-  btnText: string;
 }
 
 export enum WindowsEVOnboardingSteps {
-  'hasChosenProvider' = 'hasChosenProvider',
-  'hasOrderedCert' = 'hasOrderedCert',
   'hasBeenVerified' = 'hasBeenVerified',
+  'hasChosenProvider' = 'hasChosenProvider',
   'hasGeneratedCert' = 'hasGeneratedCert',
+  'hasOrderedCert' = 'hasOrderedCert',
   'hasUploadedCert' = 'hasUploadedCert',
 }
 
@@ -54,8 +55,8 @@ export interface IAppBuildProgress {
   isBuilding: boolean;
   message: string;
   percent: number;
-  type: ProgressTypes;
   shouldSkip: boolean;
+  type: ProgressTypes;
 }
 
 export interface IAppMeta {
@@ -66,80 +67,84 @@ export interface IAppMeta {
   currentBuildProgress?: {
     channel?: string;
     id?: string;
-    releaseId?: Release['id'];
     linux?: IAppBuildProgress;
     mac?: IAppBuildProgress;
     projectConfig?: ToDesktopJson;
+    releaseId?: Release['id'];
     shouldCodeSign?: boolean;
     shouldRelease?: boolean;
     shouldSendCompletionEmail?: boolean;
     sourceArchiveDetails?: {
       bucket: string;
+      hash?: string;
       key: string;
       url: string;
-      hash?: string;
     };
     windows?: IAppBuildProgress;
   };
   downloadButtons?: {
-    universal: IDownloadButtonOptions;
+    linux: IDownloadButtonOptions;
     mac: IDownloadButtonOptions;
+    universal: IDownloadButtonOptions;
     windows: IDownloadButtonOptions;
-    linux: IDownloadButtonOptions;
   };
   firstSuccessfulBuildEndedAt?: string;
-  staticAnalysis?: Record<CompositeIdFileLocationKey, StaticAnalysisItem>;
+  forceVersionNumber?: string;
   isAppChanged?: boolean;
   isFrameBlocked?: boolean;
   isHttps?: boolean;
   latestReleaseBuildId?: string;
+  previousInstallLockSha?: string;
   publishedVersions: {
     desktopify?: string;
     electron?: string;
     version?: string;
   };
-  previousInstallLockSha?: string;
   releaseRedirections?: ReleaseRedirectionRule[];
+  staticAnalysis?: Record<CompositeIdFileLocationKey, StaticAnalysisItem>;
+  webhookHMACKey?: string;
+  webhooks?: {
+    release?: string;
+  };
   windowsEVOnboarding?: {
-    provider: WindowsEVOnboardingProvider;
-    tempHSMCertName: string;
-    [WindowsEVOnboardingSteps.hasChosenProvider]: boolean;
-    [WindowsEVOnboardingSteps.hasOrderedCert]: boolean;
     [WindowsEVOnboardingSteps.hasBeenVerified]: boolean;
+    [WindowsEVOnboardingSteps.hasChosenProvider]: boolean;
     [WindowsEVOnboardingSteps.hasGeneratedCert]: boolean;
+    [WindowsEVOnboardingSteps.hasOrderedCert]: boolean;
     [WindowsEVOnboardingSteps.hasUploadedCert]: boolean;
+    provider: WindowsEVOnboardingProvider;
+    tempHSMCertName: string;
   };
-  forceVersionNumber?: string;
-  webhooks?: {
-    release?: string;
-  };
-  webhookHMACKey?: string;
 }
 
 export interface ToDesktopJson {
   appBuilderLibVersion?: string;
-  appId?: string;
   appFiles?: string[];
+  appId?: string;
   appPath?: FilePath;
   appProtocolScheme?: string | string[];
   asar?: boolean;
   asarUnpack?: boolean | string[];
   bucket?: string;
   buildVersion?: string;
+  bytenode?: {
+    enabled?: boolean;
+    files?: string[];
+  };
   copyright?: string;
   dmg?: {
-    background?: FilePath;
     artifactName?: string;
+    background?: FilePath;
     backgroundColor?: string;
+    contents?: NonNullable<IAppBuilderLib['config']['dmg']>['contents'];
     iconSize?: number;
     iconTextSize?: number;
     title?: string;
-    contents?: IAppBuilderLib['config']['dmg']['contents'];
-    window?: IAppBuilderLib['config']['dmg']['window'];
+    window?: NonNullable<IAppBuilderLib['config']['dmg']>['window'];
   };
-  extraContentFiles?: ExtraFileReference[];
   electronMirror?: string;
   electronVersion?: string;
+  extraContentFiles?: ExtraFileReference[];
   extraResources?: ExtraFileReference[];
   fileAssociations?: IAppBuilderLib['config']['fileAssociations'];
   filesForDistribution?: string[];
@@ -158,24 +163,25 @@ export interface ToDesktopJson {
     dmgBackground?: FilePath;
     entitlements?: FilePath;
     entitlementsInherit?: FilePath;
-    provisioningProfile?: FilePath;
-    extendInfo?: IAppBuilderLib['config']['mac']['extendInfo'];
+    extendInfo?: NonNullable<IAppBuilderLib['config']['mac']>['extendInfo'];
     icon?: FilePath;
+    provisioningProfile?: FilePath;
     requirements?: FilePath;
   };
   mas?: {
-    type?: 'development' | 'distribution'; // defaults to development
     entitlements?: FilePath;
     entitlementsInherit?: FilePath;
+    minimumSystemVersion?: string;
     provisioningProfile?: FilePath;
+    type?: 'development' | 'distribution'; // defaults to development
     x64ArchFiles?: string;
   };
   nodeVersion?: string;
   npmVersion?: string;
-  packageManager?: 'npm' | 'yarn' | 'pnpm';
+  packageManager?: 'npm' | 'pnpm' | 'yarn';
   pnpmVersion?: string;
   productName?: string;
-  rebuildLibrary?: 'app-builder' | '@electron/rebuild';
+  rebuildLibrary?: '@electron/rebuild' | 'app-builder';
   schemaVersion: number;
   snap?: IAppBuilderLib['config']['snap'];
   updateUrlBase?: string;
@@ -196,48 +202,48 @@ export interface ToDesktopJson {
 }
 
 export enum WindowsHSMCertType {
+  azureTrustedSigning = 'azureTrustedSigning',
   ev = 'ev',
   file = 'file',
-  azureTrustedSigning = 'azureTrustedSigning',
 }
 
 export interface CustomWindowsCodeSignFile {
   certType: string;
-  hsmCertType: WindowsHSMCertType.file;
   hsmCertName: string;
+  hsmCertType: WindowsHSMCertType.file;
 }
 
 export interface CustomWindowsCodeSignEV {
   certType: 'hsm';
-  hsmCertType: WindowsHSMCertType.ev;
   hsmCertName: string;
+  hsmCertType: WindowsHSMCertType.ev;
 }
 
 export interface CustomWindowsCodeSignAzureTrustedSigning {
-  certType: 'azureTrustedSigning';
-  azureCredentialsStored: boolean;
   azureBaseSettings: {
     $azureClientSecretRef: string;
     clientId: string;
-    tenantId: string;
     codeSigningAccountName: string;
-    subscriptionId: string;
     resourceGroupName: string;
+    subscriptionId: string;
+    tenantId: string;
   };
+  azureCredentialsStored: boolean;
   azureSettings?: {
     accountUri: string;
     certificateProfileId: string;
     certificateProfileName: string;
     publisherName: string;
   };
+  certType: 'azureTrustedSigning';
 }
 
 export type CustomMacCodeSign =
   | {
-      type: 'url';
       certName: string;
       certPassword: string;
       certUrl: string;
+      type: 'url';
     }
   | {
       type: 'hsm';
@@ -253,37 +259,28 @@ export type CustomMacNotarization =
   | CustomNotarizationPasswordHsmAuth;
 
 export interface CustomNotarizationApiKeyAuth {
-  type: 'hsm-api';
-  appleApiKeyId: string;
-  appleApiIssuer: string;
   $appleApiKey: string;
+  appleApiIssuer: string;
+  appleApiKeyId: string;
+  type: 'hsm-api';
 }
 
 export interface CustomNotarizationPasswordHsmAuth {
-  type: 'hsm';
+  $appSpecificPassword: string;
   appleId: string;
   teamId: string;
-  $appSpecificPassword: string;
+  type: 'hsm';
 }
 
 export type ReleaseRedirectionRule =
-  | {
-      appId: string;
-      rule: 'app';
-    }
-  | {
-      feedUrl: string;
-      rule: 'app';
-    }
   | {
       appId: string;
       ipList: string[];
       rule: 'appByIp';
     }
   | {
-      feedUrl: string;
-      ipList: string[];
-      rule: 'appByIp';
+      appId: string;
+      rule: 'app';
     }
   | {
       buildId: string;
@@ -294,33 +291,49 @@ export type ReleaseRedirectionRule =
       buildId: string;
       platforms: PlatformName[];
       rule: 'buildByPlatform';
+    }
+  | {
+      feedUrl: string;
+      ipList: string[];
+      rule: 'appByIp';
+    }
+  | {
+      feedUrl: string;
+      rule: 'app';
     };
 
 export interface BaseApp extends Schemable {
-  id: string;
   appModelId?: string;
+  // artifact configs
+  appxConfig?: Partial<IAppBuilderLib['config']['appx']>;
+  // artifact configs
   customDomain?: string;
-  domainVerificationCode?: string;
+  customLinuxPgpKey?: CustomLinuxPGPKey;
   customMacCodeSign?: CustomMacCodeSign;
   customNotarization?: CustomMacNotarization;
-  customLinuxPgpKey?: CustomLinuxPGPKey;
   customWindowsCodeSign?:
-    | CustomWindowsCodeSignFile
+    | CustomWindowsCodeSignAzureTrustedSigning
     | CustomWindowsCodeSignEV
-    | CustomWindowsCodeSignAzureTrustedSigning;
-  macHsmCertNames?: Record<MacTarget, string>;
-  windowsHsmCertNames?: Record<WindowsTarget, string>;
+    | CustomWindowsCodeSignFile;
+  domainVerificationCode?: string;
+  id: string;
 
+  macHsmCertNames?: Record<MacTarget, string>;
+  macUniversalInstallerConfig?: {
+    shouldPinToVersion?: boolean;
+  };
+  masConfig?: {
+    arch?: 'arm64' | 'universal';
+  } & Partial<IAppBuilderLib['config']['mas']>;
   meta?: IAppMeta;
+
+  nsisConfig?: Partial<IAppBuilderLib['config']['nsis']>;
+  parent?: { id: string; relationshipToParent: string } | null;
   // this property is dynamically resolved at queueBuild in cloud functions
   parentApp?: BaseApp;
-  parent?: { id: string; relationshipToParent: string } | null;
-  subscription?: Subscription;
-
   // artifacts
   shouldCreate32BitWindowsArtifacts?: boolean;
   shouldCreateAppImages?: boolean;
-
   shouldCreateAppleIntelArtifacts?: boolean;
   shouldCreateAppleSiliconAssets?: boolean;
   shouldCreateAppXFiles?: boolean;
@@ -337,23 +350,18 @@ 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;
-  };
+  snapStore?: { description?: string; login?: string };
+  subscription?: Subscription;
+  windowsHsmCertNames?: Record<WindowsTarget, string>;
 }
 
 export type Subscription = {
-  status: string;
-  subscriptionId: string;
   itemId: string;
   planId: string;
-
+  priceId?: string;
   // todo: remove optional qualifier once we complete migration
   productId?: string;
-  priceId?: string;
+
+  status: string;
+  subscriptionId: string;
 };