@expo/repack-app 0.1.10 → 0.1.11

package/README.md

@@ -98,3 +98,113 @@ $ bun bin/cli.js -p ios --source-app ./golden-debug-iphoneos.ipa \
 ```sh
 $ xcrun devicectl device install app --verbose --device <device-id> /path/to/sdk51onboard/repacked.ipa
 ```
+
+## API Documentation
+
+### CLI Usage
+
+```sh
+repack-app [options] [project-root]
+```
+
+#### Options
+
+- `-p, --platform <platform>` (required): Platform to repack the app for (`android` or `ios`)
+- `--source-app <path>` (required): Path to the source app file (APK for Android, IPA for iOS)
+- `--android-build-tools-dir <path>`: Path to the Android build tools directory
+- `-w, --working-directory <path>`: Path to the working directory
+- `-o, --output <path>`: Path to the output artifact
+- `-v, --verbose`: Enable verbose logging
+
+#### Android-specific Options
+
+- `--ks <path>`: Path to the keystore file
+- `--ks-pass <password>`: Keystore password (default: "pass:android")
+- `--ks-key-alias <alias>`: Keystore key alias
+- `--ks-key-pass <password>`: Keystore key password
+
+#### iOS-specific Options
+
+- `--signing-identity <identity>`: Signing identity (e.g., "Apple Development: Name (Team ID)")
+- `--provisioning-profile <path>`: Path to the provisioning profile
+
+#### Bundle Options
+
+- `--embed-bundle-assets`: Execute export:embed to embed new bundle assets
+- `--bundle-assets-sourcemap-output <path>`: Generate sourcemap to the specified path (paired with --embed-bundle-assets)
+
+### Programmatic Usage
+
+```typescript
+import { repackAppAndroidAsync, repackAppIosAsync } from '@expo/repack-app';
+
+// For Android
+await repackAppAndroidAsync({
+  platform: 'android',
+  projectRoot: '/path/to/project',
+  sourceAppPath: '/path/to/source.apk',
+  // Optional configurations
+  workingDirectory: '/path/to/working/dir',
+  outputPath: '/path/to/output.apk',
+  verbose: true,
+  androidSigningOptions: {
+    keyStorePath: '/path/to/keystore.jks',
+    keyStorePassword: 'password',
+    keyAlias: 'alias',
+    keyPassword: 'key-password',
+  },
+  androidBuildToolsDir: '/path/to/build-tools',
+  exportEmbedOptions: {
+    sourcemapOutput: '/path/to/sourcemap',
+  },
+});
+
+// For iOS
+await repackAppIosAsync({
+  platform: 'ios',
+  projectRoot: '/path/to/project',
+  sourceAppPath: '/path/to/source.ipa',
+  // Optional configurations
+  workingDirectory: '/path/to/working/dir',
+  outputPath: '/path/to/output.ipa',
+  verbose: true,
+  iosSigningOptions: {
+    signingIdentity: 'Apple Development: Name (Team ID)',
+    provisioningProfile: '/path/to/profile.mobileprovision',
+  },
+  exportEmbedOptions: {
+    sourcemapOutput: '/path/to/sourcemap',
+  },
+});
+```
+
+### Configuration Options
+
+The following options are available when using the API programmatically:
+
+#### Common Options
+
+- `platform`: 'android' | 'ios' - The platform to repack the app for
+- `projectRoot`: string - Path to the project root directory
+- `sourceAppPath`: string - Path to the prebuilt app file (APK/IPA)
+- `workingDirectory?`: string - Working directory for temporary files
+- `outputPath?`: string - Path to the output app file (defaults to `projectRoot/repacked.apk` or `projectRoot/repacked.ipa`)
+- `verbose?`: boolean - Enable verbose logging
+- `exportEmbedOptions?`: ExportEmbedOptions - Options for embedding JS bundle
+- `skipWorkingDirCleanup?`: boolean - Skip working directory cleanup
+- `env?`: Record<string, string | undefined> - Environment variables
+- `logger?`: Logger - Custom logger instance
+- `spawnAsync?`: SpawnProcessAsync - Custom spawn process function
+
+#### Android-specific Options
+
+- `androidSigningOptions?`: AndroidSigningOptions - Options for signing the Android app
+- `androidBuildToolsDir?`: string - Path to Android SDK build-tools directory
+
+#### iOS-specific Options
+
+- `iosSigningOptions?`: IosSigningOptions - Options for signing the iOS app
+
+### Environment Variables
+
+- `ANDROID_SDK_ROOT`: Path to the Android SDK root directory (required for Android builds)

package/bin/cli.js

@@ -1,3 +1,99 @@
-#!/usr/bin/env node
+import { Command } from 'commander';
+import pico from 'picocolors';
+import { ConsoleLogger, repackAppAndroidAsync, repackAppIosAsync } from '../dist/index';
 
-import('../build/cli.js');
+/**
+ * @import { Options } from '../dist/index'
+ */
+
+const program = new Command('repack-app')
+  .requiredOption('-p, --platform <platform>', 'Platform to repack the app for')
+  .requiredOption('--source-app <path>', 'Path to the source app file')
+  .option('--android-build-tools-dir <path>', 'Path to the Android build tools directory')
+  .option('-w, --working-directory <path>', 'Path to the working directory')
+  .option('-o, --output <path>', 'Path to the output artifact')
+  // Android signing options
+  .option('--ks <path>', 'Path to the keystore file')
+  .option('--ks-pass <password>', 'Keystore password', 'pass:android')
+  .option('--ks-key-alias <alias>', 'Keystore key alias')
+  .option('--ks-key-pass <password>', 'Keystore key password')
+  .option('-v, --verbose', 'Enable verbose logging')
+  // iOS signing options
+  .option('--signing-identity <identity>', 'Signing identity')
+  .option('--provisioning-profile <path>', 'Path to the provisioning profile')
+  // export:embed options
+  .option('--embed-bundle-assets', 'Whether to execute export:embed to embed new bundle assets')
+  .option(
+    '--bundle-assets-sourcemap-output <path>',
+    'Paired with --embed-bundle-assets and generate the sourcemap to the specified path'
+  )
+  // arguments
+  .argument('[project-root]', 'Path to the project root', process.cwd())
+  .version(require('../package.json').version)
+  .parse(process.argv);
+
+async function runAsync() {
+  const logger = new ConsoleLogger();
+  const platform = program.opts().platform;
+  const projectRoot = program.processedArgs[0];
+
+  /** @type Options['exportEmbedOptions']} */
+  const exportEmbedOptions = program.opts().embedBundleAssets
+    ? {
+        sourcemapOutput: program.opts().bundleAssetsSourcemapOutput,
+      }
+    : undefined;
+
+  if (platform === 'android') {
+    const outputPath = await repackAppAndroidAsync({
+      platform: program.opts().platform,
+      projectRoot,
+      verbose: !!program.opts().verbose,
+      sourceAppPath: program.opts().sourceApp,
+      workingDirectory: program.opts().workingDirectory,
+      outputPath: program.opts().output,
+      exportEmbedOptions,
+      androidSigningOptions: {
+        keyStorePath: program.opts().ks,
+        keyStorePassword: program.opts().ksPass,
+        keyAlias: program.opts().ksKeyAlias,
+        keyPassword: program.opts().ksKeyPass,
+      },
+      androidBuildToolsDir: program.opts().androidBuildToolsDir,
+      logger,
+    });
+    logger.info(pico.green(`Updated APK created at ${outputPath}`));
+  } else if (platform === 'ios') {
+    /** @type Options['iosSigningOptions']} */
+    const iosSigningOptions =
+      program.opts().signingIdentity && program.opts().provisioningProfile
+        ? {
+            signingIdentity: program.opts().signingIdentity,
+            provisioningProfile: program.opts().provisioningProfile,
+          }
+        : undefined;
+    const outputPath = await repackAppIosAsync({
+      platform: program.opts().platform,
+      projectRoot,
+      verbose: !!program.opts().verbose,
+      sourceAppPath: program.opts().sourceApp,
+      workingDirectory: program.opts().workingDirectory,
+      outputPath: program.opts().output,
+      exportEmbedOptions,
+      iosSigningOptions,
+      logger,
+    });
+    logger.info(pico.green(`Updated IPA created at ${outputPath}`));
+  } else {
+    throw new Error(`Unsupported platform: ${platform}`);
+  }
+}
+
+(async () => {
+  try {
+    await runAsync();
+  } catch (e) {
+    console.error('Uncaught Error', e);
+    process.exit(1);
+  }
+})();

package/{build/types.d.ts → dist/index.d.ts}

@@ -1,143 +1,218 @@
-import type { ChildProcess, SpawnOptions } from 'child_process';
-export interface Options {
-    /**
-     * The platform to repack the app for.
-     */
-    platform: 'android' | 'ios';
-    /**
-     * The path to the project root directory.
-     */
-    projectRoot: string;
-    /**
-     * The prebuilt app file path that acts as a source for repacking.
-     */
-    sourceAppPath: string;
-    /**
-     * Working directory.
-     */
-    workingDirectory?: string;
-    /**
-     * The path to the output app file.
-     * @default `projectRoot/repacked.apk` or `projectRoot/repacked.ipa`
-     */
-    outputPath?: string;
-    /**
-     * Enable verbose logging.
-     */
-    verbose?: boolean;
-    /**
-     * Whether to use the `npx export:embed` command to embed the JS bundle.
-     */
-    exportEmbedOptions?: ExportEmbedOptions;
-    /**
-     * The options for signing the android app.
-     */
-    androidSigningOptions?: AndroidSigningOptions;
-    /**
-     * The path to the Android SDK build-tools directory.
-     * @default Try to find the latest build-tools directory in the `ANDROID_SDK_ROOT` directory.
-     */
-    androidBuildToolsDir?: string;
-    /**
-     * The options for signing the ios app.
-     */
-    iosSigningOptions?: IosSigningOptions;
-    /**
-     * Skip the working directory cleanup.
-     */
-    skipWorkingDirCleanup?: boolean;
-    /**
-     * env variables
-     */
-    env?: Record<string, string | undefined>;
-    /**
-     * Customize the logger instance.
-     * @default `console`
-     */
-    logger?: Logger;
-    /**
-     * Customize the spawn process function.
-     * @default `@expo/spawn-async`
-     */
-    spawnAsync?: SpawnProcessAsync;
-}
-export interface NormalizedOptions extends Options {
-    workingDirectory: NonNullable<Options['workingDirectory']>;
-    outputPath: NonNullable<Options['outputPath']>;
-    logger: NonNullable<Options['logger']>;
-    spawnAsync: NonNullable<Options['spawnAsync']>;
-}
-export interface AndroidSigningOptions {
-    /**
-     * Load private key and certificate chain from the Java
-     * KeyStore initialized from the specified file.
-     */
-    keyStorePath: string;
-    /**
-     * KeyStore password.
-     * The following formats are supported:
-     *   - pass:<password> password provided inline
-     *   - env:<name>      password provided in the named environment variable
-     *   - file:<file>     password provided in the named file, as a single line
-     */
-    keyStorePassword: string;
-    /**
-     * Alias under which the private key and certificate are stored in the KeyStore.
-     */
-    keyAlias?: string;
-    /**
-     * Password with which the private key is protected.
-     * The following formats are supported:
-     *   - pass:<password> password provided inline
-     *   - env:<name>      password provided in the named environment variable
-     *   - file:<file>     password provided in the named file, as a single line
-     */
-    keyPassword?: string;
-}
-export interface IosSigningOptions {
-    /**
-     * Code signing identity.
-     */
-    signingIdentity: string;
-    /**
-     * Path to provisioning profile files.
-     */
-    provisioningProfile: string | Record<string, string>;
-    /**
-     * Provide a path to a keychain file that should be used by /usr/bin/codesign
-     */
-    keychainPath?: string;
-}
-/**
- * The options passed to the `npx export:embed` command.
- */
-export interface ExportEmbedOptions {
-    /**
-     * The path to the sourcemap output file.
-     */
-    sourcemapOutput?: string;
-}
-export interface Logger {
-    debug(...message: any[]): void;
-    info(...message: any[]): void;
-    warn(...message: any[]): void;
-    error(...message: any[]): void;
-    time(label: string): void;
-    timeEnd(label: string): void;
-}
-export interface SpawnProcessOptions extends SpawnOptions {
-}
-export interface SpawnProcessPromise<T> extends Promise<T> {
-    child: ChildProcess;
-}
-export interface SpawnProcessResult {
-    pid?: number;
-    output: string[];
-    stdout: string;
-    stderr: string;
-    status: number | null;
-    signal: string | null;
-}
-export interface SpawnProcessAsync {
-    (command: string, args: string[], options?: SpawnProcessOptions): SpawnProcessPromise<SpawnProcessResult>;
-}
+import type { ChildProcess } from 'child_process';
+import type { SpawnOptions } from 'child_process';
+
+/**
+ * The options for signing the android app.
+ * @public
+ */
+export declare interface AndroidSigningOptions {
+    /**
+     * Load private key and certificate chain from the Java
+     * KeyStore initialized from the specified file.
+     */
+    keyStorePath: string;
+    /**
+     * KeyStore password.
+     * The following formats are supported:
+     *   - pass:<password> password provided inline
+     *   - env:<name>      password provided in the named environment variable
+     *   - file:<file>     password provided in the named file, as a single line
+     */
+    keyStorePassword: string;
+    /**
+     * Alias under which the private key and certificate are stored in the KeyStore.
+     */
+    keyAlias?: string;
+    /**
+     * Password with which the private key is protected.
+     * The following formats are supported:
+     *   - pass:<password> password provided inline
+     *   - env:<name>      password provided in the named environment variable
+     *   - file:<file>     password provided in the named file, as a single line
+     */
+    keyPassword?: string;
+}
+
+/**
+ * The logger using [`console` API](https://nodejs.org/api/console.html).
+ * @public
+ */
+export declare class ConsoleLogger implements Logger {
+    debug(...message: any[]): void;
+    info(...message: any[]): void;
+    warn(...message: any[]): void;
+    error(...message: any[]): void;
+    time(label: string): void;
+    timeEnd(label: string): void;
+}
+
+/**
+ * The options passed to the `npx expo export:embed` command.
+ * @public
+ */
+export declare interface ExportEmbedOptions {
+    /**
+     * The path to the sourcemap output file.
+     */
+    sourcemapOutput?: string;
+}
+
+/**
+ * The options for signing the ios app.
+ * @public
+ */
+export declare interface IosSigningOptions {
+    /**
+     * Code signing identity.
+     */
+    signingIdentity: string;
+    /**
+     * Path to provisioning profile files.
+     */
+    provisioningProfile: string | Record<string, string>;
+    /**
+     * Provide a path to a keychain file that should be used by /usr/bin/codesign
+     */
+    keychainPath?: string;
+}
+
+/**
+ * The logger interface.
+ * @internal
+ */
+export declare interface Logger {
+    debug(...message: any[]): void;
+    info(...message: any[]): void;
+    warn(...message: any[]): void;
+    error(...message: any[]): void;
+    time(label: string): void;
+    timeEnd(label: string): void;
+}
+
+/**
+ * Normalized options.
+ * @internal
+ */
+export declare interface NormalizedOptions extends Options {
+    workingDirectory: NonNullable<Options['workingDirectory']>;
+    outputPath: NonNullable<Options['outputPath']>;
+    logger: NonNullable<Options['logger']>;
+    spawnAsync: NonNullable<Options['spawnAsync']>;
+}
+
+/**
+ * The options for repacking the app.
+ * @public
+ */
+export declare interface Options {
+    /**
+     * The platform to repack the app for.
+     */
+    platform: 'android' | 'ios';
+    /**
+     * The path to the project root directory.
+     */
+    projectRoot: string;
+    /**
+     * The prebuilt app file path that acts as a source for repacking.
+     */
+    sourceAppPath: string;
+    /**
+     * Working directory.
+     */
+    workingDirectory?: string;
+    /**
+     * The path to the output app file.
+     * @defaultValue `projectRoot/repacked.apk` or `projectRoot/repacked.ipa`
+     */
+    outputPath?: string;
+    /**
+     * Enable verbose logging.
+     */
+    verbose?: boolean;
+    /**
+     * Whether to use the `npx export:embed` command to embed the JS bundle.
+     */
+    exportEmbedOptions?: ExportEmbedOptions;
+    /**
+     * The options for signing the android app.
+     */
+    androidSigningOptions?: AndroidSigningOptions;
+    /**
+     * The path to the Android SDK build-tools directory.
+     * @defaultValue Try to find the latest build-tools directory in the `ANDROID_SDK_ROOT` directory.
+     */
+    androidBuildToolsDir?: string;
+    /**
+     * The options for signing the ios app.
+     */
+    iosSigningOptions?: IosSigningOptions;
+    /**
+     * Skip the working directory cleanup.
+     */
+    skipWorkingDirCleanup?: boolean;
+    /**
+     * env variables
+     */
+    env?: Record<string, string | undefined>;
+    /**
+     * Customize the logger instance.
+     * @defaultValue Logger instance of `ConsoleLogger`
+     */
+    logger?: Logger;
+    /**
+     * Customize the spawn process function.
+     * @defaultValue Use `@expo/spawn-async` to spawn the process.
+     */
+    spawnAsync?: SpawnProcessAsync;
+}
+
+/**
+ * Repack an Android app.
+ * @public
+ */
+export declare function repackAppAndroidAsync(_options: Options): Promise<string>;
+
+/**
+ * Repack an iOS app.
+ * @public
+ */
+export declare function repackAppIosAsync(_options: Options): Promise<string>;
+
+/**
+ * The interface for the spawn process.
+ * @internal
+ */
+export declare interface SpawnProcessAsync {
+    (command: string, args: string[], options?: SpawnProcessOptions): SpawnProcessPromise<SpawnProcessResult>;
+}
+
+/**
+ * The options for the spawn process.
+ * @internal
+ */
+export declare interface SpawnProcessOptions extends SpawnOptions {
+}
+
+/**
+ * The promise for the spawn process.
+ * @internal
+ */
+export declare interface SpawnProcessPromise<T> extends Promise<T> {
+    child: ChildProcess;
+}
+
+/**
+ * The result of the spawn process.
+ * @internal
+ */
+export declare interface SpawnProcessResult {
+    pid?: number;
+    output: string[];
+    stdout: string;
+    stderr: string;
+    status: number | null;
+    signal: string | null;
+}
+
+export { }