@todesktop/shared 7.190.0 → 7.191.0

package/src/desktopify.ts

@@ -1,5 +1,4 @@
-import { IApp2 } from './desktopify2';
-import { IApp } from './toDesktop';
+// eslint-disable-next-line import-x/no-extraneous-dependencies
 import {
   Configuration,
   PackagerOptions,
@@ -9,6 +8,8 @@ import {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
 } from 'app-builder-lib';
+import { IApp2 } from './desktopify2';
+import { IApp } from './toDesktop';
 
 type appBuilderLib = PackagerOptions & PublishOptions;
 export interface IAppBuilderLib extends appBuilderLib {
@@ -34,49 +35,49 @@ export type URL = string; // TODO: define more
 
 export enum PackageManager {
   npm = 'npm',
-  yarn = 'yarn',
   pnpm = 'pnpm',
+  yarn = 'yarn',
 }
 
 export enum BuildStatus {
-  queued = 'queued',
-  failed = 'failed',
   building = 'building',
+  cancelled = 'cancelled',
+  failed = 'failed',
   preparation = 'preparation',
+  queued = 'queued',
   succeeded = 'succeeded',
-  cancelled = 'cancelled',
 }
 
 export enum AnalysisStatus {
-  notStarted = 'notStarted',
-  initializing = 'initializing',
-  downloading = 'downloading',
-  extracting = 'extracting',
   analyzing = 'analyzing',
   done = 'done',
+  downloading = 'downloading',
   error = 'error',
+  extracting = 'extracting',
+  initializing = 'initializing',
+  notStarted = 'notStarted',
 }
 
-export type Arch = 'ia32' | 'x64' | 'arm64' | 'universal';
-export type MacArch = 'x64' | 'arm64' | 'universal';
-export type LinuxArch = 'x64' | 'arm64';
-export type WindowsArch = 'ia32' | 'x64' | 'arm64' | 'universal';
+export type Arch = 'arm64' | 'ia32' | 'universal' | 'x64';
+export type MacArch = 'arm64' | 'universal' | 'x64';
+export type LinuxArch = 'arm64' | 'x64';
+export type WindowsArch = 'arm64' | 'ia32' | 'universal' | 'x64';
 export type LinuxArtifactName = 'appImage' | 'deb' | 'rpm' | 'snap';
-export type MacArtifactName = 'dmg' | 'zip' | 'installer' | 'mas' | 'pkg';
+export type MacArtifactName = 'dmg' | 'installer' | 'mas' | 'pkg' | 'zip';
 export type WindowsArtifactName =
+  | 'appx'
   | 'msi'
-  | 'nsis'
-  | 'nsis-web'
   | 'nsis-web-7z'
-  | 'appx';
+  | 'nsis-web'
+  | 'nsis';
 
 type ArtifactObject = { size: number; standardUrl: URL; url: URL };
-type ArtifactDownload = Record<Arch, ArtifactObject | null> | null;
+type ArtifactDownload = null | Record<Arch, ArtifactObject | null>;
 
 // The `installer` artifact is special because it has an additional property
 // `isPinnedToVersion` for apps that have `appData.macUniversalInstallerConfig?.shouldPinToVersion` set to true
 type InstallerArtifact = {
-  [K in Arch]: (ArtifactObject & { isPinnedToVersion?: boolean }) | null;
+  [K in Arch]: ({ isPinnedToVersion?: boolean } & ArtifactObject) | null;
 };
 
 export type LinuxArtifactDownloads = Record<
@@ -114,7 +115,7 @@ export interface PlatformBuild {
   isBeingCancelled?: boolean;
   // nodeVersion: number;
   // npmVersion: number;
-  logs?: { label: string; content: string }[];
+  logs?: { content: string; label: string }[];
   numberOfAttemptedBuilds: number;
   platform: PlatformName;
   progressActivityName: string;
@@ -127,7 +128,7 @@ export interface PlatformBuild {
   status: BuildStatus;
 }
 
-export type CIRunner = 'circle' | 'azure';
+export type CIRunner = 'azure' | 'circle';
 
 export interface Build {
   appCustomDomain?: string;
@@ -138,18 +139,23 @@ export interface Build {
   bundlePhobiaData?: Record<string, BundlePhobiaItem>;
   ciRunner?: CIRunner;
   cliConfigSchemaVersion: number;
-  continuousIntegrationServiceName?: string;
   commitId?: string;
   commitMessage?: string;
+  continuousIntegrationServiceName?: string;
   createdAt: ISODate;
+  dependencyAnalysis?: {
+    // `result` is a stringified JSON object
+    result?: string;
+    status: AnalysisStatus;
+  };
   // createdByOsArch: string;
   // createdByOsName: string;
   // createdByOsVersion: string;
   // createdByUserId: string;
   desktopifyVersion?: SemanticVersion;
-  endedAt?: ISODate;
   electronVersionSpecified?: SemanticVersion;
   electronVersionUsed?: SemanticVersion;
+  endedAt?: ISODate;
   environmentVariables?: IApp['environmentVariables'];
   errorMessage?: string;
   hash?: string;
@@ -173,21 +179,16 @@ export interface Build {
     mac?: SmokeTestProgress;
     windows?: SmokeTestProgress;
   };
+  // sourceArchiveUrl: URL;
+  sourcePackageManager?: PackageManager;
+  standardUniversalDownloadUrl?: URL;
+  startedAt: ISODate;
   staticAnalysis?: {
-    status: AnalysisStatus;
-    // `result` is a stringified JSON object
-    result?: string;
     error?: string;
-  };
-  dependencyAnalysis?: {
-    status: AnalysisStatus;
     // `result` is a stringified JSON object
     result?: string;
+    status: AnalysisStatus;
   };
-  // sourceArchiveUrl: URL;
-  sourcePackageManager?: PackageManager;
-  standardUniversalDownloadUrl?: URL;
-  startedAt: ISODate;
   status: BuildStatus;
   todesktopRuntimeVersionSpecified?: SemanticVersion;
   todesktopRuntimeVersionUsed?: SemanticVersion;
@@ -209,13 +210,13 @@ export interface Build {
 }
 
 export type BundlePhobiaItem = {
+  error: null | string;
   result: {
     description: string;
     gzip: string;
     name: string;
     size: number;
   } | null;
-  error: string | null;
 };
 
 export type ComputedBuildProperties = Pick<
@@ -232,8 +233,8 @@ export type ComputedBuildProperties = Pick<
 >;
 
 export enum ManifestCategory {
-  primary = 'primary',
   buildStamped = 'build-stamped',
+  primary = 'primary',
   versioned = 'versioned',
 }
 
@@ -244,10 +245,10 @@ export interface CustomManifestArtifactDetails {
 
 export interface CustomManifest {
   artifacts: {
-    [propertyName: string]: Record<
+    [propertyName: string]: null | Record<
       string,
       CustomManifestArtifactDetails | null
-    > | null;
+    >;
   };
   createdAt: ISODate;
   version: SemanticVersion;
@@ -256,27 +257,27 @@ export interface CustomManifest {
 export interface LinuxCustomManifest extends CustomManifest {
   artifacts: Record<
     LinuxArtifactName,
-    Record<LinuxArch, CustomManifestArtifactDetails | null> | null
+    null | Record<LinuxArch, CustomManifestArtifactDetails | null>
   >;
 }
 
 export interface MacCustomManifest extends CustomManifest {
   artifacts: Record<
     MacArtifactName,
-    Record<MacArch, CustomManifestArtifactDetails | null> | null
+    null | Record<MacArch, CustomManifestArtifactDetails | null>
   >;
 }
 
 export interface WindowsCustomManifest extends CustomManifest {
   artifacts: Record<
     WindowsArtifactName,
-    Record<WindowsArch, CustomManifestArtifactDetails | null> | null
+    null | Record<WindowsArch, CustomManifestArtifactDetails | null>
   >;
 }
 
 export interface SmokeTestProgress {
-  abState?: SmokeTestState;
   abSkipReason?: string;
+  abState?: SmokeTestState;
   appLaunched?: boolean;
   appUpdated?: boolean;
   bcState?: SmokeTestState;
@@ -358,7 +359,7 @@ export interface SmokeTestPerformance {
   webContentsFinishLoadMs?: number;
 }
 
-export type SmokeTestState = 'progress' | 'done' | 'error' | 'skipped';
+export type SmokeTestState = 'done' | 'error' | 'progress' | 'skipped';
 
 export const hasBuildKickedOff = (build: Build): boolean => {
   if (!build) {
@@ -368,7 +369,7 @@ export const hasBuildKickedOff = (build: Build): boolean => {
 };
 
 export const isPlatformBuildRunning = (
-  platformBuild: PlatformBuild
+  platformBuild: PlatformBuild,
 ): boolean => {
   if (!platformBuild) {
     return false;
@@ -376,7 +377,7 @@ export const isPlatformBuildRunning = (
   return (
     !platformBuild.shouldSkip && // <-- Noteworthy
     !['cancelled', 'succeeded'].includes(platformBuild.status) &&
-    ('failed' !== platformBuild.status ||
+    (platformBuild.status !== 'failed' ||
       platformBuild.numberOfAttemptedBuilds < 2)
   );
 };
@@ -392,7 +393,8 @@ export const isCiBuildRunning = (build: Build): boolean => {
       ['linux', 'mac', 'windows'].some(
         (platform) =>
           build.status === 'building' ||
-          (build.status === 'failed' && isPlatformBuildRunning(build[platform]))
+          (build.status === 'failed' &&
+            isPlatformBuildRunning(build[platform as 'mac']!)),
       ))
   );
 };
@@ -404,7 +406,7 @@ export const isBuildRunning = (build: Build): boolean => {
   return (
     !['cancelled', 'succeeded'].includes(build.status) &&
     ['linux', 'mac', 'windows'].some((platform) =>
-      isPlatformBuildRunning(build[platform])
+      isPlatformBuildRunning(build[platform as 'mac']!),
     )
   );
 };
@@ -413,56 +415,56 @@ export const isBuildCancellable = (build: Build): boolean =>
   hasBuildKickedOff(build) && isBuildRunning(build);
 
 export interface DesktopifyApp {
-  name: string;
-  targetUrl: string;
+  alwaysOnTop: boolean; // remove
   appId: string;
+  appProtocol?: string;
+  appType?: string;
   autoHideMenuBar?: boolean; // remove
-  height: number; // remove
-  width: number; // remove
+  companyName?: string;
+  crashReporter?: string;
+  disableContextMenu: boolean;
+  disableDevTools: boolean;
+  enablePushNotifications?: boolean;
+  extraBrowserWindowOptions?: any;
   fullScreen: boolean; // remove
+  googleOAuthIsExternal?: boolean;
+  height: number; // remove
+  insecure?: boolean;
+  internalUrls?: string;
+  isFindInPageEnabled?: boolean;
+  isNativeWindowOpenDisabled?: boolean;
   isResizable: boolean; // remove
   isTitleStatic?: boolean;
-  minHeight?: number; // remove
-  minWidth?: number; // remove
   maxHeight?: number; // remove
   maxWidth?: number; // remove
-  singleInstance: boolean;
-  disableContextMenu: boolean;
-  titleBarStyle?: 'hidden' | 'hiddenInset' | 'customButtonsOnHover'; // remove
-  alwaysOnTop: boolean; // remove
-  internalUrls?: string;
-  isNativeWindowOpenDisabled?: boolean;
-  isFindInPageEnabled?: boolean;
-  userAgent?: string;
-  disableDevTools: boolean;
-  appProtocol?: string;
-  insecure?: boolean;
-  preventBackgroundThrottling?: boolean;
-  googleOAuthIsExternal?: boolean;
-  shouldUseRealUserAgent?: boolean;
-  extraBrowserWindowOptions?: any;
   menubarIcon?: string;
-  trayIcon?: string;
-  toggleVisibilityKeyboardShortcut?: string;
-  appType?: string;
+  minHeight?: number; // remove
+  minWidth?: number; // remove
+  name: string;
+  pollForAppUpdatesEveryXMinutes?: number;
+  preventBackgroundThrottling?: boolean;
   runtimeEnvs?: string;
   shouldLaunchAtStartupByDefault?: boolean;
+  shouldMakeSameDomainAnExternalLink?: boolean;
   shouldOnlySendAbsolutelyNecessaryRequests?: boolean;
   shouldReuseRendererProcess?: boolean;
-  shouldMakeSameDomainAnExternalLink?: boolean;
-  enablePushNotifications?: boolean;
-  themeSource?: 'system' | 'light' | 'dark';
-  themeSourceMac?: 'system' | 'light' | 'dark';
-  crashReporter?: string;
-  companyName?: string;
-  pollForAppUpdatesEveryXMinutes?: number;
+  shouldUseRealUserAgent?: boolean;
+  singleInstance: boolean;
+  targetUrl: string;
+  themeSource?: 'dark' | 'light' | 'system';
+  themeSourceMac?: 'dark' | 'light' | 'system';
+  titleBarStyle?: 'customButtonsOnHover' | 'hidden' | 'hiddenInset'; // remove
+  toggleVisibilityKeyboardShortcut?: string;
+  trayIcon?: string;
+  userAgent?: string;
   // https://linear.app/todesktop/issue/TD-1428/html-injection-due-to-regular-expression-bypass
   useSafeInternalUrlMatcher?: boolean;
+  width: number; // remove
 }
 
 export interface Release {
-  id: string;
   appReleaseSnapshot?: IApp2;
-  startedAt?: string;
+  id: string;
   releasedAt?: string;
+  startedAt?: string;
 }