@hot-updater/android-helper 1.2.0-rc.11 → 1.2.0-rc.13

package/dist/index.d.cts

@@ -4,7 +4,7 @@ import { NativeBuildAndroidScheme } from "@hot-updater/plugin-core";
 /**
  * Validated scheme filled nullish values with default values.
  */
-type EnrichedNativeBuildAndroidScheme = Required<Omit<NativeBuildAndroidScheme, "signing">> & Pick<NativeBuildAndroidScheme, "signing"> & {
+type EnrichedNativeBuildAndroidScheme = Required<Omit<NativeBuildAndroidScheme, "signing" | "sandbox">> & Pick<NativeBuildAndroidScheme, "signing" | "sandbox"> & {
   hotUpdaterSchemeName: string;
 };
 declare const enrichNativeBuildAndroidScheme: ({ schemeConfig, hotUpdaterSchemeName }: {
@@ -13,7 +13,7 @@ declare const enrichNativeBuildAndroidScheme: ({ schemeConfig, hotUpdaterSchemeN
 }) => Promise<EnrichedNativeBuildAndroidScheme>;
 //#endregion
 //#region src/buildAndroid.d.ts
-declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader }: {
+declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader, minVersionCode }: {
   schemeConfig: EnrichedNativeBuildAndroidScheme;
   /** The MIN_BUNDLE_ID the build compiles in. */
   minBundleId?: string;
@@ -21,6 +21,8 @@ declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader
   credentials?: Pick<CredentialResolver, "resolve">;
   /** Lines the build log starts with, such as the native build key. */
   logHeader?: string[];
+  /** The lowest version code a sandbox build may have. */
+  minVersionCode?: number;
 }) => Promise<{
   buildDirectory: string;
   buildArtifactPath: string;
@@ -36,6 +38,29 @@ declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader
   };
 }>;
 //#endregion
+//#region src/device.d.ts
+interface AdbDevice {
+  readonly serial: string;
+  /** `device` when it takes commands; else `offline`, `unauthorized`, and so on. */
+  readonly state: string;
+}
+/** What `adb devices` lists. */
+declare const listAdbDevices: () => Promise<readonly AdbDevice[]>;
+/**
+ * The device to install on: `serial`, as adb's own `ANDROID_SERIAL` names it
+ * too, or else the only one that takes commands.
+ */
+declare const selectAdbDevice: (devices: readonly AdbDevice[], serial?: string | undefined) => AdbDevice;
+/**
+ * Installs an APK on a device, and opens its launcher activity. `appId` is
+ * the APK's own application ID, whatever suffix its build gave it.
+ */
+declare const installOnAndroidDevice: ({ serial, apkPath, appId }: {
+  readonly serial: string;
+  readonly apkPath: string;
+  readonly appId: string;
+}) => Promise<void>;
+//#endregion
 //#region src/uploadToPlay.d.ts
 /**
  * Google Play refused the upload: it already has a bundle or APK with the
@@ -84,18 +109,43 @@ declare const checkPlayAccess: ({ serviceAccount: { json }, packageName, fetch }
   packageName: string;
   fetch?: typeof globalThis.fetch;
 }) => Promise<PlayAccess>;
+/**
+ * The status of the internal testing release holding `versionCode`, such as
+ * `completed` or `draft`, or null when the track doesn't hold it: never
+ * uploaded, or replaced by a newer release, which testers get instead.
+ */
+declare const readPlayInternalRelease: ({ versionCode, packageName, serviceAccount, fetch }: {
+  versionCode: number;
+  /** The application ID the `.aab` was built with. */
+  packageName: string;
+  serviceAccount: Credentials["play-service-account"];
+  fetch?: typeof globalThis.fetch;
+}) => Promise<string | null>;
 /**
  * Whether Google Play's internal testing track already releases the
- * `.aab`'s version code, as when a reused native build was uploaded
- * before. It reads the track in an edit it then deletes, changing nothing.
+ * `.aab`'s version code, as when a reused native build was uploaded before.
  */
-declare const findPlayInternalRelease: ({ versionCode, packageName, serviceAccount: { json }, fetch }: {
+declare const findPlayInternalRelease: (options: {
   versionCode: number;
   /** The application ID the `.aab` was built with. */
   packageName: string;
   serviceAccount: Credentials["play-service-account"];
   fetch?: typeof globalThis.fetch;
 }) => Promise<boolean>;
+/**
+ * The highest version code Google Play has taken for the app, on any track,
+ * or null with none: a new `.aab` needs one above it.
+ */
+declare const readPlayHighestVersionCode: ({ packageName, serviceAccount, fetch }: {
+  packageName: string;
+  serviceAccount: Credentials["play-service-account"];
+  fetch?: typeof globalThis.fetch;
+}) => Promise<number | null>;
+/**
+ * The link that opts a tester in to the app's testing tracks. A build on the
+ * internal track installs through it, for the testers Play Console lists.
+ */
+declare const playTestingUrl: (packageName: string) => string;
 /**
  * Throws when the `.aab` is signed with the Android debug keystore, which
  * Google Play refuses: a release build type left on `signingConfigs.debug`,
@@ -150,6 +200,17 @@ declare const extractBuiltInBundle: ({ artifactPath, outputPath }: {
   outputPath: string;
 }) => Promise<void>;
 //#endregion
+//#region src/utils/sandboxGradle.d.ts
+/**
+ * Why a sandbox build of a scheme can't work, read from the project's files
+ * before anything is built, or null. The init script checks again, with what
+ * Gradle actually resolved.
+ */
+declare const findSandboxGradleBlocker: ({ variant, appModuleName }: {
+  readonly variant?: string;
+  readonly appModuleName?: string;
+}) => string | null;
+//#endregion
 //#region src/utils/readBuiltApp.d.ts
 /**
  * What the built `.apk` or `.aab` reports at runtime: the `versionName` and
@@ -185,4 +246,4 @@ declare const readBuiltVersionCode: ({ artifactPath, androidProjectPath }: {
   androidProjectPath: string;
 }) => Promise<number | undefined>;
 //#endregion
-export { type EnrichedNativeBuildAndroidScheme, type PlayAccess, PlayVersionCodeUsedError, type UploadToPlayResult, assertPlaySigned, buildAndroid, checkPlayAccess, enrichNativeBuildAndroidScheme, extractBuiltInBundle, findPlayInternalRelease, playConsoleInviteUrl, readBuiltApp, readBuiltPackageName, readBuiltVersionCode, resolvePlayUploadServiceAccount, uploadToPlay };
+export { type AdbDevice, type EnrichedNativeBuildAndroidScheme, type PlayAccess, PlayVersionCodeUsedError, type UploadToPlayResult, assertPlaySigned, buildAndroid, checkPlayAccess, enrichNativeBuildAndroidScheme, extractBuiltInBundle, findPlayInternalRelease, findSandboxGradleBlocker, installOnAndroidDevice, listAdbDevices, playConsoleInviteUrl, playTestingUrl, readBuiltApp, readBuiltPackageName, readBuiltVersionCode, readPlayHighestVersionCode, readPlayInternalRelease, resolvePlayUploadServiceAccount, selectAdbDevice, uploadToPlay };

package/dist/index.d.mts

@@ -5,7 +5,7 @@ import { NativeBuildAndroidScheme } from "@hot-updater/plugin-core";
 /**
  * Validated scheme filled nullish values with default values.
  */
-type EnrichedNativeBuildAndroidScheme = Required<Omit<NativeBuildAndroidScheme, "signing">> & Pick<NativeBuildAndroidScheme, "signing"> & {
+type EnrichedNativeBuildAndroidScheme = Required<Omit<NativeBuildAndroidScheme, "signing" | "sandbox">> & Pick<NativeBuildAndroidScheme, "signing" | "sandbox"> & {
   hotUpdaterSchemeName: string;
 };
 declare const enrichNativeBuildAndroidScheme: ({ schemeConfig, hotUpdaterSchemeName }: {
@@ -14,7 +14,7 @@ declare const enrichNativeBuildAndroidScheme: ({ schemeConfig, hotUpdaterSchemeN
 }) => Promise<EnrichedNativeBuildAndroidScheme>;
 //#endregion
 //#region src/buildAndroid.d.ts
-declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader }: {
+declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader, minVersionCode }: {
   schemeConfig: EnrichedNativeBuildAndroidScheme;
   /** The MIN_BUNDLE_ID the build compiles in. */
   minBundleId?: string;
@@ -22,6 +22,8 @@ declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader
   credentials?: Pick<CredentialResolver, "resolve">;
   /** Lines the build log starts with, such as the native build key. */
   logHeader?: string[];
+  /** The lowest version code a sandbox build may have. */
+  minVersionCode?: number;
 }) => Promise<{
   buildDirectory: string;
   buildArtifactPath: string;
@@ -37,6 +39,29 @@ declare const buildAndroid: ({ schemeConfig, minBundleId, credentials, logHeader
   };
 }>;
 //#endregion
+//#region src/device.d.ts
+interface AdbDevice {
+  readonly serial: string;
+  /** `device` when it takes commands; else `offline`, `unauthorized`, and so on. */
+  readonly state: string;
+}
+/** What `adb devices` lists. */
+declare const listAdbDevices: () => Promise<readonly AdbDevice[]>;
+/**
+ * The device to install on: `serial`, as adb's own `ANDROID_SERIAL` names it
+ * too, or else the only one that takes commands.
+ */
+declare const selectAdbDevice: (devices: readonly AdbDevice[], serial?: string | undefined) => AdbDevice;
+/**
+ * Installs an APK on a device, and opens its launcher activity. `appId` is
+ * the APK's own application ID, whatever suffix its build gave it.
+ */
+declare const installOnAndroidDevice: ({ serial, apkPath, appId }: {
+  readonly serial: string;
+  readonly apkPath: string;
+  readonly appId: string;
+}) => Promise<void>;
+//#endregion
 //#region src/uploadToPlay.d.ts
 /**
  * Google Play refused the upload: it already has a bundle or APK with the
@@ -85,18 +110,43 @@ declare const checkPlayAccess: ({ serviceAccount: { json }, packageName, fetch }
   packageName: string;
   fetch?: typeof globalThis.fetch;
 }) => Promise<PlayAccess>;
+/**
+ * The status of the internal testing release holding `versionCode`, such as
+ * `completed` or `draft`, or null when the track doesn't hold it: never
+ * uploaded, or replaced by a newer release, which testers get instead.
+ */
+declare const readPlayInternalRelease: ({ versionCode, packageName, serviceAccount, fetch }: {
+  versionCode: number;
+  /** The application ID the `.aab` was built with. */
+  packageName: string;
+  serviceAccount: Credentials["play-service-account"];
+  fetch?: typeof globalThis.fetch;
+}) => Promise<string | null>;
 /**
  * Whether Google Play's internal testing track already releases the
- * `.aab`'s version code, as when a reused native build was uploaded
- * before. It reads the track in an edit it then deletes, changing nothing.
+ * `.aab`'s version code, as when a reused native build was uploaded before.
  */
-declare const findPlayInternalRelease: ({ versionCode, packageName, serviceAccount: { json }, fetch }: {
+declare const findPlayInternalRelease: (options: {
   versionCode: number;
   /** The application ID the `.aab` was built with. */
   packageName: string;
   serviceAccount: Credentials["play-service-account"];
   fetch?: typeof globalThis.fetch;
 }) => Promise<boolean>;
+/**
+ * The highest version code Google Play has taken for the app, on any track,
+ * or null with none: a new `.aab` needs one above it.
+ */
+declare const readPlayHighestVersionCode: ({ packageName, serviceAccount, fetch }: {
+  packageName: string;
+  serviceAccount: Credentials["play-service-account"];
+  fetch?: typeof globalThis.fetch;
+}) => Promise<number | null>;
+/**
+ * The link that opts a tester in to the app's testing tracks. A build on the
+ * internal track installs through it, for the testers Play Console lists.
+ */
+declare const playTestingUrl: (packageName: string) => string;
 /**
  * Throws when the `.aab` is signed with the Android debug keystore, which
  * Google Play refuses: a release build type left on `signingConfigs.debug`,
@@ -151,6 +201,17 @@ declare const extractBuiltInBundle: ({ artifactPath, outputPath }: {
   outputPath: string;
 }) => Promise<void>;
 //#endregion
+//#region src/utils/sandboxGradle.d.ts
+/**
+ * Why a sandbox build of a scheme can't work, read from the project's files
+ * before anything is built, or null. The init script checks again, with what
+ * Gradle actually resolved.
+ */
+declare const findSandboxGradleBlocker: ({ variant, appModuleName }: {
+  readonly variant?: string;
+  readonly appModuleName?: string;
+}) => string | null;
+//#endregion
 //#region src/utils/readBuiltApp.d.ts
 /**
  * What the built `.apk` or `.aab` reports at runtime: the `versionName` and
@@ -186,4 +247,4 @@ declare const readBuiltVersionCode: ({ artifactPath, androidProjectPath }: {
   androidProjectPath: string;
 }) => Promise<number | undefined>;
 //#endregion
-export { type EnrichedNativeBuildAndroidScheme, type PlayAccess, PlayVersionCodeUsedError, type UploadToPlayResult, assertPlaySigned, buildAndroid, checkPlayAccess, enrichNativeBuildAndroidScheme, extractBuiltInBundle, findPlayInternalRelease, playConsoleInviteUrl, readBuiltApp, readBuiltPackageName, readBuiltVersionCode, resolvePlayUploadServiceAccount, uploadToPlay };
+export { type AdbDevice, type EnrichedNativeBuildAndroidScheme, type PlayAccess, PlayVersionCodeUsedError, type UploadToPlayResult, assertPlaySigned, buildAndroid, checkPlayAccess, enrichNativeBuildAndroidScheme, extractBuiltInBundle, findPlayInternalRelease, findSandboxGradleBlocker, installOnAndroidDevice, listAdbDevices, playConsoleInviteUrl, playTestingUrl, readBuiltApp, readBuiltPackageName, readBuiltVersionCode, readPlayHighestVersionCode, readPlayInternalRelease, resolvePlayUploadServiceAccount, selectAdbDevice, uploadToPlay };