expo-release 2.0.0 → 2.2.1

package/dist/runtime/push.d.ts

@@ -0,0 +1,70 @@
+import * as Notifications from 'expo-notifications';
+/** Async key-value store. AsyncStorage and expo-secure-store adapters fit. */
+export interface KeyValueStorage {
+    getItem(key: string): Promise<string | null>;
+    setItem(key: string, value: string): Promise<void>;
+}
+export interface PushNotificationsOptions {
+    /** Remembers that the one-time prompt ran. */
+    storage: KeyValueStorage;
+    /** Saves this device's Expo push token on your backend; `null` removes it. */
+    registerDevice: (token: string | null) => Promise<void>;
+    /**
+     * Explains push before the OS dialog. Resolve `true` to continue. Without
+     * it, `prompt()` goes straight to the OS dialog.
+     */
+    confirm?: () => Promise<boolean>;
+    /** Push is off: the app runs on a simulator or the user denied permission. */
+    onUnavailable?: (reason: 'not-a-device' | 'denied') => void;
+    onError?: (message: string, error: unknown) => void;
+    /** Defaults to what expo-notifications reads from the app config. */
+    projectId?: string;
+    /** Android channel `default`, needed for heads-up notifications. */
+    androidChannel?: Notifications.NotificationChannelInput;
+    /** How notifications show while the app is in the foreground. */
+    foregroundBehavior?: Notifications.NotificationBehavior;
+    storageKey?: string;
+}
+export interface NotificationListeners {
+    onReceived?: (notification: Notifications.Notification) => void;
+    /** Also called with the response that launched the app, if any. */
+    onResponse?: (response: Notifications.NotificationResponse) => void;
+}
+export type PushNotifications = ReturnType<typeof createPushNotifications>;
+/**
+ * expo-notifications behind one object: permission flow, Expo push token and
+ * device registration. Create it once at module level.
+ */
+export declare function createPushNotifications(options: PushNotificationsOptions): {
+    getPermissionStatus: () => Promise<Notifications.NotificationPermissionsStatus>;
+    hasPrompted: () => Promise<boolean>;
+    requestPermissions: () => Promise<boolean>;
+    getPushToken: () => Promise<string | null>;
+    syncToken: () => Promise<boolean>;
+    /**
+     * Asks for push once per install (after sign-in, say), then registers the
+     * token. Never throws; concurrent calls share one dialog.
+     */
+    prompt(): Promise<boolean>;
+    /** Turns push on from settings. Resolves whether it is on. */
+    enable(): Promise<boolean>;
+    /** Removes this device's token from your backend. */
+    disable(): Promise<void>;
+    /** Subscribes to notifications. Returns the unsubscribe function. */
+    listen({ onReceived, onResponse }: NotificationListeners): () => void;
+};
+/**
+ * Push state for a settings screen. `enabled` is the user's saved preference;
+ * while it is on, the token is re-registered on mount.
+ */
+export declare function usePushNotifications(push: PushNotifications, { enabled }?: {
+    enabled?: boolean;
+}): {
+    permission: Notifications.NotificationPermissionsStatus | null;
+    isEnabled: boolean;
+    isLoading: boolean;
+    prompt: () => Promise<boolean>;
+    enable: () => Promise<boolean>;
+    disable: () => Promise<void>;
+    refresh: () => Promise<void>;
+};

package/dist/source-maps.d.ts

@@ -0,0 +1,8 @@
+import type { ReleasePlatform } from './args';
+export declare const SOURCE_MAP_OUTPUT_DIR = "dist";
+export declare function expoCommand(...args: string[]): string[];
+export declare function sourceMapExportCommand(platform: ReleasePlatform): string[];
+export declare function sourceMapUpdateArgs(): string[];
+export declare function mergeUpdateArgs(extra: string[] | undefined, exportSourceMaps: boolean): string[];
+export declare function defaultHasSourceMaps(directory?: string): Promise<boolean>;
+export declare function assertSourceMaps(hasSourceMaps?: () => Promise<boolean>): Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "expo-release",
-	"version": "2.0.0",
-	"description": "Fingerprint-driven Expo EAS release: OTA update or native store build",
+	"version": "2.2.1",
+	"description": "Fingerprint-driven Expo EAS release: OTA update or native store build, plus app runtime helpers",
 	"type": "module",
 	"module": "./dist/index.js",
 	"main": "./dist/index.js",
@@ -39,25 +39,62 @@
 			"bun": "./src/index.ts",
 			"import": "./dist/index.js",
 			"default": "./dist/index.js"
+		},
+		"./runtime": {
+			"types": "./dist/runtime/index.d.ts",
+			"import": "./dist/runtime/index.js",
+			"default": "./dist/runtime/index.js"
 		}
 	},
 	"scripts": {
 		"build": "bun run build:js && bun run build:types",
-		"build:js": "bun build ./src/index.ts ./src/cli.ts --outdir ./dist --target bun --packages external",
+		"build:js": "bun build ./src/index.ts ./src/cli.ts --outdir ./dist --target bun --packages external && bun build ./src/runtime/index.ts --outdir ./dist/runtime --target browser --packages external",
 		"build:types": "tsgo -p tsconfig.build.json",
 		"prepublishOnly": "bun run build",
-		"publish:patch": "npm version patch && npm publish",
-		"publish:minor": "npm version minor && npm publish",
-		"publish:major": "npm version major && npm publish",
 		"test": "bun test",
 		"lint": "bun run typecheck && bun biome check",
 		"lint:write": "bun run typecheck && bun biome check --write",
-		"typecheck": "tsgo --noEmit"
+		"typecheck": "tsgo --noEmit && tsgo --noEmit -p tsconfig.runtime.json",
+		"verify:package": "node scripts/verify-package.mjs"
+	},
+	"dependencies": {
+		"hanzio": "^3.1.0",
+		"zod": "^4.3.6"
+	},
+	"peerDependencies": {
+		"expo-device": ">=55",
+		"expo-notifications": ">=55",
+		"expo-updates": ">=55",
+		"react": ">=19"
+	},
+	"peerDependenciesMeta": {
+		"expo-device": {
+			"optional": true
+		},
+		"expo-notifications": {
+			"optional": true
+		},
+		"expo-updates": {
+			"optional": true
+		},
+		"react": {
+			"optional": true
+		}
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.4.6",
 		"@types/bun": "latest",
+		"@types/react": "~19.2.0",
 		"@typescript/native-preview": "^7.0.0-dev.20260306.1",
+		"expo-device": "~55.0.10",
+		"expo-notifications": "~55.0.14",
+		"expo-updates": "~55.0.16",
+		"react": "19.2.0",
 		"typescript": "^5.7.0"
-	}
+	},
+	"homepage": "https://github.com/HansKristoffer/expo-release#readme",
+	"bugs": {
+		"url": "https://github.com/HansKristoffer/expo-release/issues"
+	},
+	"packageManager": "bun@1.4.2"
 }

package/src/args.ts

@@ -1,4 +1,5 @@
-import { parseArgs } from 'node:util'
+import type { CommandContext } from 'hanzio/cli'
+import { z } from 'zod'
 
 export const DEFAULT_IMPACT_PATHS = ['apps/expo/'] as const
 
@@ -31,6 +32,7 @@ export type ReleaseOptions = {
 	preUpdate?: string
 	postUpdate?: string
 	updateExtraArgs?: string
+	exportSourceMaps: boolean
 	group?: string
 	runtimeVersion?: string
 	message?: string
@@ -38,76 +40,133 @@ export type ReleaseOptions = {
 	dryRun: boolean
 }
 
-export const USAGE =
-	'Usage: expo-release <release|decide|operate> --profile <profile> [--base <sha>] [--head <sha>] [--platform ios|android] [--impact-paths apps/expo/] [--operation deploy|force-native|retry-ota|republish|rollback-embedded] [--deploy-type none|ota|native] [--channel <channel>] [--environment <env>] [--group <id>] [--runtime-version <hash>] [--message <msg>] [--fingerprint <hash>] [--auto-submit true] [--pre-update <cmd>] [--post-update <cmd>] [--update-extra-args <args>] [--dry-run] [--ignore-expo-impact true]'
-
-function fromEnv(env: NodeJS.ProcessEnv, name: string): string | undefined {
-	const value = env[name]?.trim()
-	return value ? value : undefined
-}
-
-function firstDefined(
-	...values: Array<string | undefined>
-): string | undefined {
-	return values.find((value) => value !== undefined && value.length > 0)
-}
-
-export function optionalString(value: string | undefined): string | undefined {
-	const trimmed = value?.trim()
-	return trimmed ? trimmed : undefined
-}
-
-export function parseImpactPaths(value: string | undefined): string[] {
-	const paths = (value ?? DEFAULT_IMPACT_PATHS.join(','))
-		.split(',')
-		.map((path) => path.trim())
-		.filter(Boolean)
-	if (paths.length === 0) {
-		throw new Error('At least one --impact-paths entry is required')
-	}
-	return paths
-}
-
-export function parsePlatform(value: string | undefined): ReleasePlatform {
-	if (value === undefined || value === 'ios') return 'ios'
-	if (value === 'android') return 'android'
-	throw new Error('Usage: --platform ios|android')
-}
-
-export function parseBoolean(value: string | undefined, fallback: boolean) {
-	if (value === undefined) return fallback
-	if (value === 'true') return true
-	if (value === 'false') return false
-	throw new Error(`Expected true or false, received: ${value}`)
-}
-
-export function parseOperation(value: string | undefined): Operation {
-	if (
-		value === undefined ||
-		value === 'deploy' ||
-		value === 'force-native' ||
-		value === 'retry-ota' ||
-		value === 'republish' ||
-		value === 'rollback-embedded'
-	) {
-		return value ?? 'deploy'
-	}
-	throw new Error(
-		'Usage: --operation deploy|force-native|retry-ota|republish|rollback-embedded'
-	)
-}
-
-export function parseDeployType(value: string | undefined): DeployType {
-	if (value === undefined || value === 'none') return 'none'
-	if (value === 'ota' || value === 'native') return value
-	throw new Error('Usage: --deploy-type none|ota|native')
-}
-
-export function parseCommandName(value: string | undefined): CommandName {
-	if (value === 'release' || value === 'decide' || value === 'operate') {
-		return value
+// Every flag falls back to an EXPO_RELEASE_* variable: the composite action passes its inputs that way.
+const text = (env: string) =>
+	z
+		.string()
+		.transform((value) => value.trim() || undefined)
+		.optional()
+		.meta({ env: `EXPO_RELEASE_${env}` })
+
+// `--auto-submit false` takes a value, so these are not boolean switches.
+const trueFalse = (env: string, fallback: 'true' | 'false') =>
+	z
+		.enum(['true', 'false'])
+		.default(fallback)
+		.transform((value) => value === 'true')
+		.meta({ env: `EXPO_RELEASE_${env}` })
+
+export const releaseFlags = z
+	.object({
+		profile: z
+			.string()
+			.trim()
+			.min(1)
+			.meta({ env: 'EXPO_RELEASE_PROFILE' })
+			.describe('EAS build profile, also the default update channel'),
+		base: text('BASE').describe(
+			'Git base SHA for the impact diff (falls back to GITHUB_EVENT_BEFORE)'
+		),
+		head: text('HEAD').describe(
+			'Git head SHA for the impact diff (falls back to GITHUB_SHA)'
+		),
+		platform: z
+			.enum(['ios', 'android'])
+			.default('ios')
+			.meta({ env: 'EXPO_RELEASE_PLATFORM' })
+			.describe('Native platform'),
+		impactPaths: z
+			.string()
+			.default(DEFAULT_IMPACT_PATHS.join(','))
+			.transform((value, ctx) => {
+				const paths = value
+					.split(',')
+					.map((path) => path.trim())
+					.filter(Boolean)
+				if (paths.length === 0)
+					ctx.addIssue({
+						code: 'custom',
+						message: 'At least one --impact-paths entry is required'
+					})
+				return paths
+			})
+			.meta({ env: 'EXPO_RELEASE_IMPACT_PATHS' })
+			.describe('Comma-separated repo-root paths that count as an Expo change'),
+		ignoreExpoImpact: trueFalse('IGNORE_EXPO_IMPACT', 'false').describe(
+			'Check the fingerprint even when no impact path changed'
+		),
+		operation: z
+			.enum([
+				'deploy',
+				'force-native',
+				'retry-ota',
+				'republish',
+				'rollback-embedded'
+			])
+			.default('deploy')
+			.meta({ env: 'EXPO_RELEASE_OPERATION' })
+			.describe('What to run'),
+		deployType: z
+			.enum(['none', 'ota', 'native'])
+			.default('none')
+			.meta({ env: 'EXPO_RELEASE_DEPLOY_TYPE' })
+			.describe('Decision type for operate'),
+		channel: text('CHANNEL').describe(
+			'EAS Update channel (default: the profile)'
+		),
+		environment: text('ENVIRONMENT').describe(
+			'EAS environment for eas update (required for Expo SDK 55+)'
+		),
+		autoSubmit: trueFalse('AUTO_SUBMIT', 'true').describe(
+			'Pass --auto-submit on native builds'
+		),
+		preUpdate: text('PRE_UPDATE').describe(
+			'Shell command run before eas update'
+		),
+		postUpdate: text('POST_UPDATE').describe(
+			'Shell command run after a successful eas update'
+		),
+		updateExtraArgs: text('UPDATE_EXTRA_ARGS').describe(
+			'Extra tokens appended to eas update'
+		),
+		exportSourceMaps: trueFalse('EXPORT_SOURCE_MAPS', 'false').describe(
+			'On OTA, expo export with external source maps, then publish dist'
+		),
+		group: text('GROUP').describe('Update group ID for --operation republish'),
+		runtimeVersion: text('RUNTIME_VERSION').describe(
+			'Runtime version for rollback-embedded (default: the fingerprint)'
+		),
+		message: text('MESSAGE').describe('Override the eas update message'),
+		fingerprint: text('FINGERPRINT').describe(
+			'Fingerprint hash to use instead of generating one'
+		),
+		dryRun: z
+			.boolean()
+			.meta({ env: 'EXPO_RELEASE_DRY_RUN' })
+			.describe('Print mutating EAS commands without running them')
+	})
+	.superRefine((flags, ctx) => {
+		if (flags.operation === 'republish' && !flags.group)
+			ctx.addIssue({
+				code: 'custom',
+				path: ['group'],
+				message: 'required by --operation republish'
+			})
+	})
+
+export type ReleaseFlags = z.output<typeof releaseFlags>
+
+export function toReleaseOptions(
+	command: CommandName,
+	{ context: flags, env }: CommandContext<ReleaseFlags>
+): ReleaseOptions {
+	return {
+		...flags,
+		command,
+		base: flags.base ?? env.GITHUB_EVENT_BEFORE,
+		head: flags.head ?? env.GITHUB_SHA,
+		channel: flags.channel ?? flags.profile
 	}
-	throw new Error(USAGE)
 }
 
 export function needsDecide(operation: Operation): boolean {
@@ -136,183 +195,3 @@ export function shouldIgnoreExpoImpact(
 		options.operation === 'deploy'
 	)
 }
-
-export function parseReleaseOptions(
-	args: string[],
-	env: NodeJS.ProcessEnv = process.env
-): ReleaseOptions {
-	let values: {
-		profile?: string
-		base?: string
-		head?: string
-		platform?: string
-		'impact-paths'?: string
-		'ignore-expo-impact'?: string
-		operation?: string
-		'deploy-type'?: string
-		channel?: string
-		environment?: string
-		'auto-submit'?: string
-		'pre-update'?: string
-		'post-update'?: string
-		'update-extra-args'?: string
-		group?: string
-		'runtime-version'?: string
-		message?: string
-		fingerprint?: string
-		'dry-run'?: boolean
-	}
-	let positionals: string[]
-
-	try {
-		const parsed = parseArgs({
-			args,
-			allowPositionals: true,
-			strict: true,
-			options: {
-				profile: { type: 'string' },
-				base: { type: 'string' },
-				head: { type: 'string' },
-				platform: { type: 'string' },
-				'impact-paths': { type: 'string' },
-				'ignore-expo-impact': { type: 'string' },
-				operation: { type: 'string' },
-				'deploy-type': { type: 'string' },
-				channel: { type: 'string' },
-				environment: { type: 'string' },
-				'auto-submit': { type: 'string' },
-				'pre-update': { type: 'string' },
-				'post-update': { type: 'string' },
-				'update-extra-args': { type: 'string' },
-				group: { type: 'string' },
-				'runtime-version': { type: 'string' },
-				message: { type: 'string' },
-				fingerprint: { type: 'string' },
-				'dry-run': { type: 'boolean', default: false }
-			}
-		})
-		values = parsed.values
-		positionals = parsed.positionals
-	} catch (error) {
-		const message = error instanceof Error ? error.message : String(error)
-		throw new Error(`${USAGE}\n${message}`)
-	}
-
-	if (positionals.length > 1) {
-		throw new Error(USAGE)
-	}
-
-	const command = parseCommandName(
-		positionals[0] ?? fromEnv(env, 'EXPO_RELEASE_COMMAND')
-	)
-	const profile = firstDefined(
-		values.profile,
-		fromEnv(env, 'EXPO_RELEASE_PROFILE')
-	)
-	if (!profile) {
-		throw new Error(USAGE)
-	}
-
-	const operation = parseOperation(
-		firstDefined(values.operation, fromEnv(env, 'EXPO_RELEASE_OPERATION'))
-	)
-	const group = optionalString(
-		firstDefined(values.group, fromEnv(env, 'EXPO_RELEASE_GROUP'))
-	)
-	if (operation === 'republish' && !group) {
-		throw new Error(
-			'Usage: --operation republish requires --group <update-group-id>'
-		)
-	}
-
-	const channel =
-		firstDefined(values.channel, fromEnv(env, 'EXPO_RELEASE_CHANNEL')) ??
-		profile
-
-	return {
-		command,
-		profile,
-		base: optionalString(
-			firstDefined(
-				values.base,
-				fromEnv(env, 'EXPO_RELEASE_BASE'),
-				fromEnv(env, 'GITHUB_EVENT_BEFORE')
-			)
-		),
-		head: optionalString(
-			firstDefined(
-				values.head,
-				fromEnv(env, 'EXPO_RELEASE_HEAD'),
-				fromEnv(env, 'GITHUB_SHA')
-			)
-		),
-		platform: parsePlatform(
-			firstDefined(values.platform, fromEnv(env, 'EXPO_RELEASE_PLATFORM'))
-		),
-		impactPaths: parseImpactPaths(
-			firstDefined(
-				values['impact-paths'],
-				fromEnv(env, 'EXPO_RELEASE_IMPACT_PATHS')
-			)
-		),
-		ignoreExpoImpact: parseBoolean(
-			firstDefined(
-				values['ignore-expo-impact'],
-				fromEnv(env, 'EXPO_RELEASE_IGNORE_EXPO_IMPACT')
-			),
-			false
-		),
-		operation,
-		deployType: parseDeployType(
-			firstDefined(
-				values['deploy-type'],
-				fromEnv(env, 'EXPO_RELEASE_DEPLOY_TYPE')
-			)
-		),
-		channel,
-		environment: optionalString(
-			firstDefined(values.environment, fromEnv(env, 'EXPO_RELEASE_ENVIRONMENT'))
-		),
-		autoSubmit: parseBoolean(
-			firstDefined(
-				values['auto-submit'],
-				fromEnv(env, 'EXPO_RELEASE_AUTO_SUBMIT')
-			),
-			true
-		),
-		preUpdate: optionalString(
-			firstDefined(
-				values['pre-update'],
-				fromEnv(env, 'EXPO_RELEASE_PRE_UPDATE')
-			)
-		),
-		postUpdate: optionalString(
-			firstDefined(
-				values['post-update'],
-				fromEnv(env, 'EXPO_RELEASE_POST_UPDATE')
-			)
-		),
-		updateExtraArgs: optionalString(
-			firstDefined(
-				values['update-extra-args'],
-				fromEnv(env, 'EXPO_RELEASE_UPDATE_EXTRA_ARGS')
-			)
-		),
-		group,
-		runtimeVersion: optionalString(
-			firstDefined(
-				values['runtime-version'],
-				fromEnv(env, 'EXPO_RELEASE_RUNTIME_VERSION')
-			)
-		),
-		message: optionalString(
-			firstDefined(values.message, fromEnv(env, 'EXPO_RELEASE_MESSAGE'))
-		),
-		fingerprint: optionalString(
-			firstDefined(values.fingerprint, fromEnv(env, 'EXPO_RELEASE_FINGERPRINT'))
-		),
-		dryRun:
-			values['dry-run'] === true ||
-			parseBoolean(fromEnv(env, 'EXPO_RELEASE_DRY_RUN'), false)
-	}
-}