@todesktop/shared 7.191.0 → 7.192.0

package/lib/esm/desktopify.d.ts

@@ -0,0 +1,365 @@
+import { Configuration, PackagerOptions, PublishOptions } from 'app-builder-lib';
+import { IApp2 } from './desktopify2';
+import { BreakpointPauseLease, BreakpointQueueEntry, CurrentBreakpointState } from './introspection/breakpoints';
+import { IApp } from './toDesktop';
+type appBuilderLib = PackagerOptions & PublishOptions;
+export interface IAppBuilderLib extends appBuilderLib {
+    config: Configuration;
+}
+export interface ExtraFileReference {
+    from: FilePath;
+    to?: FilePath;
+}
+export type ISODate = string;
+export declare enum PlatformName {
+    linux = "linux",
+    mac = "mac",
+    windows = "windows"
+}
+export type FilePath = string;
+export type SemanticVersion = string;
+export type URL = string;
+export declare enum PackageManager {
+    npm = "npm",
+    pnpm = "pnpm",
+    yarn = "yarn"
+}
+export declare enum BuildStatus {
+    building = "building",
+    cancelled = "cancelled",
+    failed = "failed",
+    preparation = "preparation",
+    queued = "queued",
+    succeeded = "succeeded"
+}
+export declare enum AnalysisStatus {
+    analyzing = "analyzing",
+    done = "done",
+    downloading = "downloading",
+    error = "error",
+    extracting = "extracting",
+    initializing = "initializing",
+    notStarted = "notStarted"
+}
+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' | 'installer' | 'mas' | 'pkg' | 'zip';
+export type WindowsArtifactName = 'appx' | 'msi' | 'nsis-web-7z' | 'nsis-web' | 'nsis';
+type ArtifactObject = {
+    size: number;
+    standardUrl: URL;
+    url: URL;
+};
+type ArtifactDownload = null | Record<Arch, ArtifactObject | null>;
+type InstallerArtifact = {
+    [K in Arch]: ({
+        isPinnedToVersion?: boolean;
+    } & ArtifactObject) | null;
+};
+export type LinuxArtifactDownloads = Record<LinuxArtifactName, ArtifactDownload>;
+export type MacArtifactDownloads = {
+    [K in MacArtifactName]: K extends 'installer' ? InstallerArtifact : ArtifactDownload;
+};
+export type WindowsArtifactDownloads = Record<WindowsArtifactName, ArtifactDownload>;
+export type CodeSignSkipReason = 'no-cert' | 'user-disabled';
+export interface PlatformBuild {
+    appBuilderLibConfig?: IAppBuilderLib;
+    artifactDownloads?: LinuxArtifactDownloads | MacArtifactDownloads | WindowsArtifactDownloads;
+    codeSignSkipReason?: CodeSignSkipReason;
+    desktopifyVersion?: SemanticVersion;
+    didCodeSign: boolean;
+    didUseCachedDependencies?: boolean;
+    downloadUrl?: URL;
+    electronVersionUsed?: SemanticVersion;
+    endedAt: ISODate;
+    errorMessage?: string;
+    isBeingCancelled?: boolean;
+    logs?: {
+        content: string;
+        label: string;
+    }[];
+    numberOfAttemptedBuilds: number;
+    platform: PlatformName;
+    progressActivityName: string;
+    progressActivityType: string;
+    progressPercentage: number;
+    screenshotUrl?: URL;
+    shouldSkip: boolean;
+    standardDownloadUrl?: URL;
+    startedAt: ISODate;
+    status: BuildStatus;
+}
+export type CIRunner = 'azure' | 'circle';
+export type IntrospectBreakpointStatus = 'error' | 'finished' | 'initializing' | 'paused' | 'ready' | 'resuming';
+export type IntrospectShellStatus = 'connected' | 'connecting' | 'disconnected' | 'error' | 'initializing' | 'ready';
+export interface IntrospectPlatformData {
+    breakpointQueue?: BreakpointQueueEntry[];
+    breakpointStatus: IntrospectBreakpointStatus;
+    connectedAt?: Date;
+    connectedUserId?: string;
+    createdAt: ISODate;
+    currentBreakpoint?: CurrentBreakpointState;
+    disconnectedAt?: Date;
+    enabled: boolean;
+    error?: string;
+    jtiExpiresAt?: Date;
+    pauseLease?: BreakpointPauseLease;
+    sessionJti?: string;
+    shellStatus: IntrospectShellStatus;
+    tunnelUrl?: string;
+    usedJti?: string;
+}
+export interface IntrospectData {
+    linux: IntrospectPlatformData;
+    mac: IntrospectPlatformData;
+    windows: IntrospectPlatformData;
+}
+export interface Build {
+    appCustomDomain?: string;
+    appName: string;
+    appNotarizaionBundleId: string;
+    appVersion?: SemanticVersion;
+    buildServerExecutionId?: number;
+    bundlePhobiaData?: Record<string, BundlePhobiaItem>;
+    ciRunner?: CIRunner;
+    cliConfigSchemaVersion: number;
+    commitId?: string;
+    commitMessage?: string;
+    continuousIntegrationServiceName?: string;
+    createdAt: ISODate;
+    dependencyAnalysis?: {
+        result?: string;
+        status: AnalysisStatus;
+    };
+    desktopifyVersion?: SemanticVersion;
+    electronVersionSpecified?: SemanticVersion;
+    electronVersionUsed?: SemanticVersion;
+    endedAt?: ISODate;
+    environmentVariables?: IApp['environmentVariables'];
+    errorMessage?: string;
+    hash?: string;
+    icon?: string;
+    id: string;
+    introspect?: IntrospectData;
+    isArtifactsPruned?: boolean;
+    isBeingCancelled?: boolean;
+    linux?: PlatformBuild;
+    mac?: PlatformBuild;
+    onBuildFinishedWebhook?: string;
+    partiallyReleasedAt?: ISODate;
+    projectConfig?: string;
+    releasedAt?: ISODate;
+    shouldCodeSign: boolean;
+    shouldRelease: boolean;
+    shouldRetainForever?: boolean;
+    smokeTest?: {
+        buildServerExecutionId?: string;
+        isCanceled?: boolean;
+        linux?: SmokeTestProgress;
+        mac?: SmokeTestProgress;
+        windows?: SmokeTestProgress;
+    };
+    sourcePackageManager?: PackageManager;
+    standardUniversalDownloadUrl?: URL;
+    startedAt: ISODate;
+    staticAnalysis?: {
+        error?: string;
+        result?: string;
+        status: AnalysisStatus;
+    };
+    status: BuildStatus;
+    todesktopRuntimeVersionSpecified?: SemanticVersion;
+    todesktopRuntimeVersionUsed?: SemanticVersion;
+    universalDownloadUrl?: URL;
+    url?: URL;
+    useCachedDependencies?: boolean;
+    versionControlInfo?: {
+        branchName: string;
+        commitDate: string;
+        commitId: string;
+        commitMessage: string;
+        hasUncommittedChanges: boolean;
+        repositoryRemoteUrl: string;
+        versionControlSystemName: string;
+    };
+    windows?: PlatformBuild;
+}
+export type BundlePhobiaItem = {
+    error: null | string;
+    result: {
+        description: string;
+        gzip: string;
+        name: string;
+        size: number;
+    } | null;
+};
+export type ComputedBuildProperties = Pick<Build, 'desktopifyVersion' | 'electronVersionUsed' | 'endedAt' | 'errorMessage' | 'releasedAt' | 'standardUniversalDownloadUrl' | 'startedAt' | 'status' | 'universalDownloadUrl'>;
+export declare enum ManifestCategory {
+    buildStamped = "build-stamped",
+    primary = "primary",
+    versioned = "versioned"
+}
+export interface CustomManifestArtifactDetails {
+    path: FilePath;
+    url: URL;
+}
+export interface CustomManifest {
+    artifacts: {
+        [propertyName: string]: null | Record<string, CustomManifestArtifactDetails | null>;
+    };
+    createdAt: ISODate;
+    version: SemanticVersion;
+}
+export interface LinuxCustomManifest extends CustomManifest {
+    artifacts: Record<LinuxArtifactName, null | Record<LinuxArch, CustomManifestArtifactDetails | null>>;
+}
+export interface MacCustomManifest extends CustomManifest {
+    artifacts: Record<MacArtifactName, null | Record<MacArch, CustomManifestArtifactDetails | null>>;
+}
+export interface WindowsCustomManifest extends CustomManifest {
+    artifacts: Record<WindowsArtifactName, null | Record<WindowsArch, CustomManifestArtifactDetails | null>>;
+}
+export interface SmokeTestProgress {
+    abSkipReason?: string;
+    abState?: SmokeTestState;
+    appLaunched?: boolean;
+    appUpdated?: boolean;
+    bcState?: SmokeTestState;
+    buildAId?: string;
+    code?: string;
+    message?: string;
+    performance?: {
+        ab?: SmokeTestPerformance;
+        bc: SmokeTestPerformance;
+    };
+    progress: number;
+    screenshot?: string;
+    state: SmokeTestState;
+    updatedAppHasNoMainErrors?: boolean;
+    vm: {
+        agentVersion: string;
+        cpu?: string;
+        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 = 'done' | 'error' | 'progress' | 'skipped';
+export declare const hasBuildKickedOff: (build: Build) => boolean;
+export declare const isPlatformBuildRunning: (platformBuild: PlatformBuild) => boolean;
+export declare const isCiBuildRunning: (build: Build) => boolean;
+export declare const isBuildRunning: (build: Build) => boolean;
+export declare const isBuildCancellable: (build: Build) => boolean;
+export interface DesktopifyApp {
+    alwaysOnTop: boolean;
+    appId: string;
+    appProtocol?: string;
+    appType?: string;
+    autoHideMenuBar?: boolean;
+    companyName?: string;
+    crashReporter?: string;
+    disableContextMenu: boolean;
+    disableDevTools: boolean;
+    enablePushNotifications?: boolean;
+    extraBrowserWindowOptions?: any;
+    fullScreen: boolean;
+    googleOAuthIsExternal?: boolean;
+    height: number;
+    insecure?: boolean;
+    internalUrls?: string;
+    isFindInPageEnabled?: boolean;
+    isNativeWindowOpenDisabled?: boolean;
+    isResizable: boolean;
+    isTitleStatic?: boolean;
+    maxHeight?: number;
+    maxWidth?: number;
+    menubarIcon?: string;
+    minHeight?: number;
+    minWidth?: number;
+    name: string;
+    pollForAppUpdatesEveryXMinutes?: number;
+    preventBackgroundThrottling?: boolean;
+    runtimeEnvs?: string;
+    shouldLaunchAtStartupByDefault?: boolean;
+    shouldMakeSameDomainAnExternalLink?: boolean;
+    shouldOnlySendAbsolutelyNecessaryRequests?: boolean;
+    shouldReuseRendererProcess?: boolean;
+    shouldUseRealUserAgent?: boolean;
+    singleInstance: boolean;
+    targetUrl: string;
+    themeSource?: 'dark' | 'light' | 'system';
+    themeSourceMac?: 'dark' | 'light' | 'system';
+    titleBarStyle?: 'customButtonsOnHover' | 'hidden' | 'hiddenInset';
+    toggleVisibilityKeyboardShortcut?: string;
+    trayIcon?: string;
+    userAgent?: string;
+    useSafeInternalUrlMatcher?: boolean;
+    width: number;
+}
+export interface Release {
+    appReleaseSnapshot?: IApp2;
+    id: string;
+    releasedAt?: string;
+    startedAt?: string;
+}
+export {};