@teardown/cli 1.2.38 → 2.0.41

package/src/config/schema.ts

@@ -0,0 +1,235 @@
+import { z } from "zod";
+
+/**
+ * iOS-specific configuration schema
+ */
+export const iOSConfigSchema = z.object({
+	/** Bundle identifier in reverse domain notation */
+	bundleIdentifier: z
+		.string()
+		.regex(
+			/^[a-z][a-z0-9_]*(\.[a-z0-9_]+)+$/i,
+			"Bundle identifier must be reverse domain notation (e.g., com.example.myapp)"
+		),
+
+	/** Build number for App Store */
+	buildNumber: z.number().int().positive().optional().default(1),
+
+	/** Minimum iOS deployment target */
+	deploymentTarget: z
+		.string()
+		.regex(/^\d+\.\d+$/, "Deployment target must be in format X.Y (e.g., 15.0)")
+		.optional()
+		.default("15.0"),
+
+	/** Additional Info.plist entries */
+	infoPlist: z.record(z.string(), z.unknown()).optional(),
+
+	/** Additional entitlements */
+	entitlements: z.record(z.string(), z.unknown()).optional(),
+
+	/** Development team ID */
+	developmentTeamId: z.string().optional(),
+
+	/** Code signing style */
+	codeSigningStyle: z.enum(["Automatic", "Manual"]).optional().default("Automatic"),
+
+	/** Provisioning profile name (for manual signing) */
+	provisioningProfile: z.string().optional(),
+});
+
+/**
+ * Android-specific configuration schema
+ */
+export const AndroidConfigSchema = z.object({
+	/** Android package name */
+	packageName: z
+		.string()
+		.regex(
+			/^[a-z][a-z0-9_]*(\.[a-z0-9_]+)+$/i,
+			"Package name must be reverse domain notation (e.g., com.example.myapp)"
+		),
+
+	/** Version code for Play Store */
+	versionCode: z.number().int().positive().optional().default(1),
+
+	/** Minimum SDK version */
+	minSdkVersion: z.number().int().min(21).max(35).optional().default(23),
+
+	/** Target SDK version */
+	targetSdkVersion: z.number().int().min(21).max(35).optional().default(34),
+
+	/** Compile SDK version */
+	compileSdkVersion: z.number().int().min(21).max(35).optional().default(34),
+
+	/** Manifest placeholders */
+	manifestPlaceholders: z.record(z.string(), z.string()).optional(),
+
+	/** Enable Jetifier for AndroidX migration */
+	enableJetifier: z.boolean().optional().default(true),
+
+	/** Enable R8 minification */
+	enableR8: z.boolean().optional().default(true),
+
+	/** ProGuard rules file */
+	proguardRules: z.string().optional(),
+
+	/** Signing configuration */
+	signingConfig: z
+		.object({
+			storeFile: z.string(),
+			storePassword: z.string().optional(),
+			keyAlias: z.string(),
+			keyPassword: z.string().optional(),
+		})
+		.optional(),
+});
+
+/**
+ * Splash screen configuration schema
+ */
+export const SplashConfigSchema = z.object({
+	/** Path to splash image */
+	image: z.string(),
+
+	/** Background color in hex format */
+	backgroundColor: z.string().regex(/^#[0-9A-Fa-f]{6}$/, "Background color must be hex format (e.g., #FFFFFF)"),
+
+	/** Resize mode for the image */
+	resizeMode: z.enum(["contain", "cover", "native"]).optional().default("contain"),
+});
+
+/**
+ * Plugin entry schema - supports string names or [Plugin, config] tuples
+ */
+export const PluginEntrySchema = z.union([
+	z.string(),
+	z.tuple([z.any(), z.record(z.string(), z.unknown())]),
+	z.tuple([z.any()]),
+]);
+
+/**
+ * Main Teardown configuration schema
+ */
+export const TeardownConfigSchema = z.object({
+	/** App display name */
+	name: z.string().min(1, "App name is required"),
+
+	/** URL-safe slug for the app */
+	slug: z.string().regex(/^[a-z0-9-]+$/, "Slug must be lowercase alphanumeric with dashes"),
+
+	/** Semantic version */
+	version: z.string().regex(/^\d+\.\d+\.\d+$/, "Version must be semver format (e.g., 1.0.0)"),
+
+	/** iOS-specific configuration */
+	ios: iOSConfigSchema.optional(),
+
+	/** Android-specific configuration */
+	android: AndroidConfigSchema.optional(),
+
+	/** Path to app icon */
+	icon: z.string().optional(),
+
+	/** Splash screen configuration */
+	splash: SplashConfigSchema.optional(),
+
+	/** Plugin configurations */
+	plugins: z.array(PluginEntrySchema).optional().default([]),
+
+	/** Custom scheme for deep linking (legacy support) */
+	scheme: z.string().optional(),
+
+	/** App orientation */
+	orientation: z.enum(["portrait", "landscape", "default"]).optional().default("default"),
+
+	/** User interface style */
+	userInterfaceStyle: z.enum(["light", "dark", "automatic"]).optional().default("automatic"),
+
+	/** Additional native modules to include */
+	nativeModules: z.array(z.string()).optional(),
+
+	/** Environment variables to inject */
+	env: z.record(z.string(), z.string()).optional(),
+});
+
+/**
+ * Validation error with suggestions
+ */
+export interface ValidationError {
+	path: string;
+	message: string;
+	suggestion?: string;
+}
+
+/**
+ * Format Zod validation errors into human-readable messages
+ */
+export function formatValidationErrors(error: z.ZodError): ValidationError[] {
+	return error.issues.map((issue) => {
+		const path = issue.path.join(".");
+		const suggestion = getSuggestion(issue);
+
+		return {
+			path,
+			message: issue.message,
+			suggestion,
+		};
+	});
+}
+
+/**
+ * Get helpful suggestions for common validation errors
+ */
+function getSuggestion(issue: z.ZodIssue): string | undefined {
+	const path = issue.path.join(".");
+
+	if (path === "ios.bundleIdentifier" || path === "android.packageName") {
+		return 'Use reverse domain notation like "com.yourcompany.appname"';
+	}
+
+	if (path === "version") {
+		return 'Use semantic versioning like "1.0.0"';
+	}
+
+	if (path === "slug") {
+		return 'Use lowercase letters, numbers, and dashes only like "my-app"';
+	}
+
+	if (path === "splash.backgroundColor") {
+		return 'Use hex color format like "#FFFFFF"';
+	}
+
+	if (issue.code === "invalid_type") {
+		return "Expected a different type";
+	}
+
+	return undefined;
+}
+
+/**
+ * Validate configuration and return detailed errors
+ */
+export function validateConfig(config: unknown): {
+	success: boolean;
+	data?: z.infer<typeof TeardownConfigSchema>;
+	errors?: ValidationError[];
+} {
+	const result = TeardownConfigSchema.safeParse(config);
+
+	if (result.success) {
+		return { success: true, data: result.data };
+	}
+
+	return {
+		success: false,
+		errors: formatValidationErrors(result.error),
+	};
+}
+
+/**
+ * Helper to create type-safe config (for defineConfig function)
+ */
+export function defineConfig(config: z.input<typeof TeardownConfigSchema>): z.infer<typeof TeardownConfigSchema> {
+	const result = TeardownConfigSchema.parse(config);
+	return result;
+}

package/src/config/types.ts

@@ -0,0 +1,322 @@
+import type { z } from "zod";
+import type { BasePlugin } from "../plugins/base";
+import type { AndroidConfigSchema, iOSConfigSchema, TeardownConfigSchema } from "./schema";
+
+/**
+ * Unified permission status across platforms
+ */
+export type PermissionStatus =
+	| "unavailable" // Feature not available on device
+	| "denied" // User denied, can request again
+	| "limited" // iOS 14+ limited photo access
+	| "granted" // Full permission granted
+	| "blocked"; // User denied with "don't ask again"
+
+/**
+ * Permission mapping interface for cross-platform abstraction
+ */
+export interface PermissionMapping {
+	capability: string;
+	ios: {
+		infoPlistKey: string;
+		entitlement?: string;
+		framework?: string;
+	};
+	android: {
+		permissions: string[];
+		protectionLevel: "normal" | "dangerous" | "signature";
+		minSdk?: number;
+	};
+}
+
+/**
+ * iOS-specific configuration
+ */
+export type iOSConfig = z.infer<typeof iOSConfigSchema>;
+
+/**
+ * Android-specific configuration
+ */
+export type AndroidConfig = z.infer<typeof AndroidConfigSchema>;
+
+/**
+ * Main Teardown configuration type
+ */
+export type TeardownConfig = z.infer<typeof TeardownConfigSchema>;
+
+/**
+ * Splash screen configuration
+ */
+export interface SplashConfig {
+	image: string;
+	backgroundColor: string;
+	resizeMode?: "contain" | "cover" | "native";
+}
+
+/**
+ * Plugin entry - can be a string name or tuple with config
+ */
+export type PluginEntry<TConfig = unknown> = string | [new () => BasePlugin<TConfig>, TConfig];
+
+/**
+ * Build configuration for native projects
+ */
+export interface BuildConfig {
+	ios?: {
+		scheme?: string;
+		configuration?: "Debug" | "Release";
+		destination?: string;
+	};
+	android?: {
+		variant?: string;
+		flavor?: string;
+	};
+}
+
+/**
+ * App configuration after plugin processing
+ */
+export interface ProcessedAppConfig extends TeardownConfig {
+	/**
+	 * Resolved iOS Info.plist entries
+	 */
+	resolvedInfoPlist: Record<string, unknown>;
+
+	/**
+	 * Resolved iOS entitlements
+	 */
+	resolvedEntitlements: Record<string, unknown>;
+
+	/**
+	 * Resolved Android manifest permissions
+	 */
+	resolvedAndroidPermissions: string[];
+
+	/**
+	 * Resolved Android manifest features
+	 */
+	resolvedAndroidFeatures: string[];
+
+	/**
+	 * Resolved Android manifest metadata
+	 */
+	resolvedAndroidMetadata: Record<string, string>;
+
+	/**
+	 * Resolved Gradle dependencies
+	 */
+	resolvedGradleDependencies: string[];
+
+	/**
+	 * Resolved frameworks for iOS
+	 */
+	resolvedFrameworks: string[];
+
+	/**
+	 * Resolved CocoaPods dependencies
+	 */
+	resolvedPodDependencies: Array<{ name: string; version?: string; options?: Record<string, unknown> }>;
+
+	/**
+	 * iOS background modes
+	 */
+	resolvedBackgroundModes: string[];
+
+	/**
+	 * iOS URL schemes
+	 */
+	resolvedUrlSchemes: string[];
+
+	/**
+	 * Android intent filters
+	 */
+	resolvedIntentFilters: AndroidIntentFilter[];
+}
+
+/**
+ * Android intent filter configuration
+ */
+export interface AndroidIntentFilter {
+	actions: string[];
+	categories: string[];
+	data?: {
+		scheme?: string;
+		host?: string;
+		pathPrefix?: string;
+	}[];
+	autoVerify?: boolean;
+}
+
+/**
+ * File change operation for dry-run mode
+ */
+export interface FileChange {
+	path: string;
+	operation: "create" | "modify" | "delete";
+	before?: string;
+	after: string;
+	diff?: string;
+}
+
+/**
+ * Warning during prebuild process
+ */
+export interface PrebuildWarning {
+	code: string;
+	message: string;
+	plugin?: string;
+	file?: string;
+	suggestion?: string;
+}
+
+/**
+ * Error during prebuild process
+ */
+export interface PrebuildError {
+	code: string;
+	message: string;
+	plugin?: string;
+	file?: string;
+	stack?: string;
+}
+
+/**
+ * Dry run result
+ */
+export interface DryRunResult {
+	changes: FileChange[];
+	warnings: PrebuildWarning[];
+	errors: PrebuildError[];
+}
+
+/**
+ * Prebuild options
+ */
+export interface PrebuildOptions {
+	/** Target platform */
+	platform: "ios" | "android" | "all";
+
+	/** Clean native directories before prebuild */
+	clean?: boolean;
+
+	/** Dry run mode - preview changes without applying */
+	dryRun?: boolean;
+
+	/** Project root directory */
+	projectRoot?: string;
+
+	/** Skip plugin validation */
+	skipValidation?: boolean;
+
+	/** Verbose logging */
+	verbose?: boolean;
+}
+
+/**
+ * Template context for rendering
+ */
+export interface TemplateContext {
+	APP_NAME: string;
+	BUNDLE_IDENTIFIER: string;
+	PACKAGE_NAME: string;
+	VERSION: string;
+	BUILD_NUMBER: number;
+	PERMISSIONS: Record<string, PermissionConfig>;
+	ENTITLEMENTS: string[];
+	BACKGROUND_MODES: string[];
+	[key: string]: unknown;
+}
+
+/**
+ * Permission configuration for templates
+ */
+export interface PermissionConfig {
+	key: string;
+	description: string;
+	required?: boolean;
+}
+
+/**
+ * Health data types for HealthKit
+ */
+export type HealthKitDataType =
+	| "steps"
+	| "distance"
+	| "calories"
+	| "heart_rate"
+	| "sleep"
+	| "workout"
+	| "weight"
+	| "height"
+	| "blood_glucose"
+	| "blood_pressure"
+	| "body_fat"
+	| "respiratory_rate";
+
+/**
+ * Health data types for Health Connect (Android)
+ */
+export type HealthConnectDataType =
+	| "Steps"
+	| "Distance"
+	| "TotalCaloriesBurned"
+	| "HeartRate"
+	| "SleepSession"
+	| "ExerciseSession"
+	| "Weight"
+	| "Height"
+	| "BloodGlucose"
+	| "BloodPressure"
+	| "BodyFat"
+	| "RespiratoryRate";
+
+/**
+ * Widget definition for iOS
+ */
+export interface WidgetDefinition {
+	name: string;
+	displayName: string;
+	description: string;
+	supportedFamilies: (
+		| "systemSmall"
+		| "systemMedium"
+		| "systemLarge"
+		| "accessoryCircular"
+		| "accessoryRectangular"
+		| "accessoryInline"
+	)[];
+}
+
+/**
+ * Widget definition for Android
+ */
+export interface AndroidWidgetDefinition {
+	name: string;
+	label: string;
+	minWidth: number;
+	minHeight: number;
+	updatePeriodMillis?: number;
+	previewImage?: string;
+	resizeMode?: "horizontal" | "vertical" | "both" | "none";
+}
+
+/**
+ * Intent definition for Siri Shortcuts
+ */
+export interface IntentDefinition {
+	identifier: string;
+	title: string;
+	description: string;
+	category: "generic" | "order" | "buy" | "search";
+	parameters?: IntentParameter[];
+}
+
+/**
+ * Intent parameter definition
+ */
+export interface IntentParameter {
+	name: string;
+	type: "string" | "integer" | "boolean" | "url";
+	displayName: string;
+	required?: boolean;
+}