Class: IpaHub

Defined in: src/library/IpaHub.ts:25

Manage IPA sources, paired devices, installations, and updates. Create an instance with getIpaHub.

Accessors#

dataDir#

Get Signature#

get dataDir(): string;

Defined in: src/library/IpaHub.ts:56

The resolved data directory, including any compatibility fallback. Inactive instances do not create it.

Returns#

string

Methods#

checkUpdate()#

checkUpdate(
   device, 
   bundleId, 
   options?
): Promise<UpdateCheck>;

Defined in: src/library/IpaHub.ts:133

Check a tracked app's recorded update channel; prefetch optionally downloads the update without installing.

Parameters#

Returns#

Promise<UpdateCheck>

dispose()#

dispose(): Promise<void>;

Defined in: src/library/IpaHub.ts:61

Release this instance's resources after its outstanding operations have finished.

Returns#

Promise<void>

getAppRelease()#

getAppRelease(device, bundleId): Promise<ReleaseInfo | undefined>;

Defined in: src/library/IpaHub.ts:128

Read the installed release's notes and publication date, when the app came from a repository.

Parameters#

Returns#

Promise<ReleaseInfo | undefined>

getDeviceInfo()#

getDeviceInfo(
   device?, 
   filter?, 
   interaction?
): Promise<DeviceInfo>;

Defined in: src/library/IpaHub.ts:76

Inspect a paired device and the apps installed on it through ipa-hub.

Parameters#

Returns#

Promise<DeviceInfo>

install()#

install(options, interaction?): Promise<InstallResult>;

Defined in: src/library/IpaHub.ts:113

Download, sign, and install an app using the same workflow as ipa-hub install. Delegates to a compatible running server unless bypassServer is true. The caller handles publisher trust confirmation. Ambiguous choices use the selection callback or throw SelectionRequired; no terminal prompts are shown. Source access tokens are saved privately for future updates and omitted from results. App Manager enrollment URLs, when requested, contain credentials for that device.

Parameters#

Returns#

Promise<InstallResult>

installManager()#

installManager(options?, interaction?): Promise<ManagerInstallResult>;

Defined in: src/library/IpaHub.ts:157

Enroll App Manager on an iPhone/iPad, starting an already installed service when necessary. Keep this instance alive and call waitForManagerInstallation with the result to finish setup. The personal URL contains a temporary key, replaced when the Home Screen app connects.

Parameters#

Returns#

Promise<ManagerInstallResult>

listApps()#

listApps(device): Promise<InstalledApp[]>;

Defined in: src/library/IpaHub.ts:118

List apps installed through ipa-hub on a device. Does not expose the underlying storage records.

Parameters#

Returns#

Promise<InstalledApp[]>

listDevices()#

listDevices(filter?): Promise<Device[]>;

Defined in: src/library/IpaHub.ts:66

List paired devices. Use all to include unavailable devices, or includeSimulators for Simulator destinations.

Parameters#

Returns#

Promise<Device[]>

listReleases()#

listReleases(source, options?): Promise<ReleasePage>;

Defined in: src/library/IpaHub.ts:88

List one page of repository releases. Pass nextPage back as page to continue.

Parameters#

Returns#

Promise<ReleasePage>

listTeams()#

listTeams(): Promise<Team[]>;

Defined in: src/library/IpaHub.ts:71

List signing teams, local identities, and provisioning profiles discovered from the Mac's Xcode setup.

Returns#

Promise<Team[]>

pull()#

pull(options, interaction?): Promise<PullResult>;

Defined in: src/library/IpaHub.ts:99

Download an IPA into the managed cache, or return a local file unchanged. Ambiguous assets use the selection callback.

Parameters#

Returns#

Promise<PullResult>

resolve()#

resolve(source, options?): Promise<ResolvedSource>;

Defined in: src/library/IpaHub.ts:83

Browse a source's release and matching IPA assets without downloading them. A release may have no matching assets.

Parameters#

Returns#

Promise<ResolvedSource>

setAutomaticSignatureRefresh()#

setAutomaticSignatureRefresh(
   device, 
   bundleId, 
   enabled
): Promise<InstalledApp>;

Defined in: src/library/IpaHub.ts:123

Enable or disable the server's hourly signature refresh for a tracked app.

Parameters#

Returns#

Promise<InstalledApp>

updateApp()#

updateApp(
   device, 
   bundleId, 
   options?
): Promise<InstallResult>;

Defined in: src/library/IpaHub.ts:138

Install an available update, or renew the current release with resign: true. Delegates to a running server by default.

Parameters#

Returns#

Promise<InstallResult>

updateApps()#

updateApps(device, options?): Promise<AppUpdateResult[]>;

Defined in: src/library/IpaHub.ts:143

Update or re-sign all tracked apps on a device, returning each success, failure, or skipped app.

Parameters#

Returns#

Promise<AppUpdateResult[]>

waitForManagerInstallation()#

waitForManagerInstallation(result, interaction?): Promise<void>;

Defined in: src/library/IpaHub.ts:162

Wait for the Home Screen app to confirm its permanent key. Aborting or disposing cancels unfinished setup.

Parameters#

Returns#

Promise<void>