@geekmidas/cli 9.0.2 → 10.0.0-alpha.0

package/src/types.ts

@@ -1,363 +0,0 @@
-export type MainProvider = 'aws' | 'server';
-export type LegacyProvider =
-	| 'server'
-	| 'aws-apigatewayv1'
-	| 'aws-apigatewayv2'
-	| 'aws-lambda';
-
-export interface PartitionedRoutes {
-	paths: string | string[];
-	partition: (filepath: string) => string;
-}
-
-export type Routes = string | string[] | PartitionedRoutes;
-
-export function isPartitionedRoutes(
-	routes: Routes | undefined,
-): routes is PartitionedRoutes {
-	return (
-		typeof routes === 'object' &&
-		routes !== null &&
-		!Array.isArray(routes) &&
-		'paths' in routes
-	);
-}
-
-export interface ProviderConfig {
-	enabled?: boolean;
-	outputDir?: string;
-}
-
-export interface AWSApiGatewayConfig extends ProviderConfig {
-	// Additional AWS API Gateway specific options
-}
-
-export interface AWSLambdaConfig extends ProviderConfig {
-	// Additional AWS Lambda specific options
-}
-
-export interface ProductionConfig {
-	/** Enable production mode (default: false) */
-	enabled?: boolean;
-	/** Bundle server into single file (default: true) */
-	bundle?: boolean;
-	/** Minify bundled output (default: true) */
-	minify?: boolean;
-	/** Health check endpoint path (default: '/health') */
-	healthCheck?: string;
-	/** Enable graceful shutdown handling (default: true) */
-	gracefulShutdown?: boolean;
-	/** Packages to exclude from bundling (default: []) */
-	external?: string[];
-	/** Include subscribers in production build (default: 'exclude' for serverless) */
-	subscribers?: 'include' | 'exclude';
-	/** Include OpenAPI spec in production (default: false) */
-	openapi?: boolean;
-	/**
-	 * Enable build-time optimized handler generation (default: true)
-	 * Generates specialized handlers based on endpoint tier:
-	 * - minimal: Near-raw-Hono performance for simple endpoints
-	 * - standard: Optimized handlers for auth/services
-	 * - full: Uses HonoEndpoint.addRoutes for complex endpoints
-	 */
-	optimizedHandlers?: boolean;
-}
-
-/** Service-specific configuration for docker-compose */
-export interface ServiceConfig {
-	/**
-	 * Full Docker image reference (e.g., 'postgis/postgis:16-3.4-alpine').
-	 * When specified, overrides the default image entirely.
-	 */
-	image?: string;
-	/**
-	 * Docker image version/tag (e.g., '15-alpine' for postgres).
-	 * Only used when `image` is not specified.
-	 */
-	version?: string;
-}
-
-/**
- * Supported event backend types.
- *
- * - `pgboss`: Reuses PostgreSQL with a dedicated user/schema. Auto-enables db service.
- * - `sns`: Adds LocalStack container with SNS+SQS services.
- * - `rabbitmq`: Adds RabbitMQ container.
- *
- * All backends generate EVENT_PUBLISHER_CONNECTION_STRING and EVENT_SUBSCRIBER_CONNECTION_STRING.
- */
-export type EventsBackend = 'pgboss' | 'sns' | 'rabbitmq';
-
-/** Supported docker-compose service names */
-export type ComposeServiceName =
-	| 'postgres'
-	| 'redis'
-	| 'rabbitmq'
-	| 'minio'
-	| 'mailpit'
-	| 'localstack';
-
-/** Services configuration - can be boolean (use defaults) or object with version */
-export type ComposeServicesConfig = {
-	[K in ComposeServiceName]?: boolean | ServiceConfig;
-};
-
-export interface DockerConfig {
-	/** Container registry URL (e.g., 'ghcr.io/myorg') */
-	registry?: string;
-	/** Docker image name (default: derived from package.json name) */
-	imageName?: string;
-	/** Base Docker image (default: 'node:22-alpine') */
-	baseImage?: string;
-	/** Container port (default: 3000) */
-	port?: number;
-	/** docker-compose services to include */
-	compose?: {
-		/**
-		 * Services to include in docker-compose.
-		 * Can be an object with service configs or an array of service names (legacy).
-		 *
-		 * @example Object format (recommended)
-		 * services: {
-		 *   postgres: { version: '15-alpine' },
-		 *   redis: true,  // use default version
-		 * }
-		 *
-		 * @example Array format (legacy, uses default versions)
-		 * services: ['postgres', 'redis']
-		 */
-		services?: ComposeServicesConfig | ComposeServiceName[];
-	};
-}
-
-export interface ServerConfig extends ProviderConfig {
-	enableOpenApi?: boolean;
-	port?: number;
-	/** Production build configuration */
-	production?: ProductionConfig;
-}
-
-export type Runtime = 'node' | 'bun';
-
-export interface TelescopeConfig {
-	/** Enable/disable telescope (default: true in development) */
-	enabled?: boolean;
-	/** Port for telescope to use (defaults to server port) */
-	port?: number;
-	/** Path prefix for telescope UI (default: /__telescope) */
-	path?: string;
-	/** Ignore patterns for telescope (e.g., ['/health', '/metrics']) */
-	ignore?: string[];
-	/** Record request/response bodies (default: true) */
-	recordBody?: boolean;
-	/** Maximum entries to keep in memory (default: 1000) */
-	maxEntries?: number;
-	/** Enable WebSocket for real-time updates (default: true, requires @hono/node-ws for Node.js) */
-	websocket?: boolean;
-}
-
-export interface StudioConfig {
-	/** Enable/disable studio (default: true in development) */
-	enabled?: boolean;
-	/** Path prefix for studio UI (default: /__studio) */
-	path?: string;
-	/** Schema to introspect (default: 'public') */
-	schema?: string;
-}
-
-export interface OpenApiConfig {
-	/** Enable OpenAPI generation (default: true) */
-	enabled?: boolean;
-	/** API title */
-	title?: string;
-	/** API version */
-	version?: string;
-	/** API description */
-	description?: string;
-}
-
-export interface HooksConfig {
-	/**
-	 * Path to a module exporting server lifecycle hooks.
-	 * The module should export `beforeSetup` and/or `afterSetup` functions.
-	 *
-	 * @example
-	 * ```typescript
-	 * // src/config/hooks.ts
-	 * import type { Hono } from 'hono';
-	 * import type { Logger } from '@geekmidas/logger';
-	 * import type { EnvironmentParser } from '@geekmidas/envkit';
-	 *
-	 * // Called BEFORE gkm endpoints are registered
-	 * export function beforeSetup(app: Hono, ctx: { envParser: EnvironmentParser; logger: Logger }) {
-	 *   app.use('*', cors());
-	 *   app.get('/custom/health', (c) => c.json({ status: 'ok' }));
-	 * }
-	 *
-	 * // Called AFTER gkm endpoints are registered
-	 * export function afterSetup(app: Hono, ctx: { envParser: EnvironmentParser; logger: Logger }) {
-	 *   app.notFound((c) => c.json({ error: 'Not found' }, 404));
-	 *   app.onError((err, c) => c.json({ error: err.message }, 500));
-	 * }
-	 * ```
-	 */
-	server?: string;
-}
-
-/** Dokploy deployment configuration */
-export interface DokployProviderConfig {
-	/** Dokploy API endpoint (e.g., 'https://dokploy.example.com') */
-	endpoint: string;
-	/** Project ID in Dokploy */
-	projectId: string;
-	/** Application ID in Dokploy */
-	applicationId: string;
-	/** Container registry (overrides docker.registry if set) */
-	registry?: string;
-	/** Registry ID in Dokploy (recommended for private registries) */
-	registryId?: string;
-}
-
-export interface ProvidersConfig {
-	aws?: {
-		apiGateway?: {
-			v1?: boolean | AWSApiGatewayConfig;
-			v2?: boolean | AWSApiGatewayConfig;
-		};
-		lambda?: {
-			functions?: boolean | AWSLambdaConfig;
-			crons?: boolean | AWSLambdaConfig;
-		};
-	};
-	server?: boolean | ServerConfig;
-	/** Dokploy deployment configuration */
-	dokploy?: boolean | DokployProviderConfig;
-}
-
-export interface GkmConfig {
-	routes: Routes;
-	functions?: Routes;
-	crons?: Routes;
-	subscribers?: Routes;
-	queues?: Routes;
-	topics?: Routes;
-	envParser: string;
-	logger: string;
-	providers?: ProvidersConfig;
-	/**
-	 * Server lifecycle hooks for customizing the Hono app.
-	 * Allows adding custom routes, middleware, error handlers, etc.
-	 *
-	 * @example
-	 * hooks: {
-	 *   server: './src/config/hooks'
-	 * }
-	 */
-	hooks?: HooksConfig;
-	/**
-	 * Telescope configuration for debugging/monitoring.
-	 * Can be:
-	 * - A string path to a module that exports a Telescope instance (recommended)
-	 * - A boolean to enable/disable with defaults
-	 * - A TelescopeConfig object for inline configuration
-	 */
-	telescope?: string | boolean | TelescopeConfig;
-	/**
-	 * Studio configuration for database browsing.
-	 * Can be:
-	 * - A string path to a module that exports a Studio instance (recommended)
-	 * - A boolean to enable/disable with defaults
-	 * - A StudioConfig object for inline configuration
-	 *
-	 * Requires a database connection configured via services.
-	 */
-	studio?: string | boolean | StudioConfig;
-	/**
-	 * OpenAPI generation configuration.
-	 * Can be:
-	 * - A boolean to enable/disable with defaults (output: ./src/api/openapi.ts)
-	 * - An OpenApiConfig object for customization
-	 *
-	 * When enabled, OpenAPI spec is generated on startup and regenerated on route changes.
-	 *
-	 * @example
-	 * openapi: true
-	 *
-	 * @example
-	 * openapi: {
-	 *   output: './src/api/openapi.ts',
-	 *   title: 'My API',
-	 *   version: '1.0.0',
-	 * }
-	 */
-	openapi?: boolean | OpenApiConfig;
-	/** Runtime to use for dev server (default: 'node') */
-	runtime?: Runtime;
-	/**
-	 * Environment file(s) to load for development.
-	 * Can be:
-	 * - A string path to a single env file (e.g., '.env.local')
-	 * - An array of paths to load in order (later files override earlier)
-	 * - Defaults to '.env' if not specified
-	 *
-	 * @example
-	 * env: '.env.local'
-	 *
-	 * @example
-	 * env: ['.env', '.env.local']
-	 */
-	env?: string | string[];
-	/**
-	 * Docker deployment configuration.
-	 * Used by `gkm docker` and `gkm prepack` commands.
-	 *
-	 * @example
-	 * docker: {
-	 *   registry: 'ghcr.io/myorg',
-	 *   imageName: 'my-api',
-	 *   compose: {
-	 *     services: ['postgres', 'redis']
-	 *   }
-	 * }
-	 */
-	docker?: DockerConfig;
-}
-
-export interface BuildOptions {
-	provider?: MainProvider;
-	// Legacy support - will be deprecated
-	providers?: LegacyProvider[];
-	enableOpenApi?: boolean;
-	/** Build for production (no dev tools, bundled output) */
-	production?: boolean;
-	/** Skip bundling step in production build */
-	skipBundle?: boolean;
-	/** Stage for secrets injection (e.g., 'production', 'staging') */
-	stage?: string;
-	/**
-	 * When true, optional environment variables (those with `.optional()` or
-	 * `.default()` in the envParser) are suffixed with `?` within each
-	 * construct's `environment` array in the manifest (e.g. `PORT?`).
-	 * Defaults to false.
-	 */
-	markOptional?: boolean;
-}
-
-/** Result from build command when secrets are injected */
-export interface BuildResult {
-	/** Ephemeral master key for deployment (only if stage was provided) */
-	masterKey?: string;
-}
-
-// The deployment manifest types are a shared, dependency-free data contract
-// in `@geekmidas/manifest`, re-exported here for back-compat with existing
-// `@geekmidas/cli` imports.
-export type {
-	CronInfo,
-	FunctionInfo,
-	Manifest,
-	QueueInfo,
-	RouteInfo,
-	SubscriberInfo,
-	TopicInfo,
-} from '@geekmidas/manifest';

package/src/upgrade/__tests__/index.spec.ts

@@ -1,354 +0,0 @@
-import { execSync } from 'node:child_process';
-import { writeFileSync } from 'node:fs';
-import { mkdir, rm } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-import { HttpResponse, http } from 'msw';
-import { setupServer } from 'msw/node';
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { upgradeCommand } from '../index';
-
-vi.mock('node:child_process', () => ({
-	execSync: vi.fn(),
-}));
-
-const NPM_REGISTRY = 'https://registry.npmjs.org';
-
-const server = setupServer();
-
-function writePackageJson(dir: string, content: Record<string, unknown>) {
-	writeFileSync(join(dir, 'package.json'), JSON.stringify(content, null, 2));
-}
-
-describe('upgradeCommand', () => {
-	let tempDir: string;
-	let originalCwd: string;
-
-	beforeEach(async () => {
-		tempDir = join(tmpdir(), `gkm-upgrade-test-${Date.now()}`);
-		await mkdir(tempDir, { recursive: true });
-		originalCwd = process.cwd();
-		process.chdir(tempDir);
-		server.listen({ onUnhandledRequest: 'bypass' });
-		vi.mocked(execSync).mockReset();
-	});
-
-	afterEach(async () => {
-		process.chdir(originalCwd);
-		server.resetHandlers();
-		server.close();
-		await rm(tempDir, { recursive: true, force: true });
-	});
-
-	it('should report no packages found when none exist', async () => {
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: { lodash: '^4.0.0' },
-		});
-		// Create a lockfile so detectPackageManager finds a root
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand();
-
-		const output = logSpy.mock.calls.flat().join('\n');
-		expect(output).toContain('No @geekmidas packages found');
-
-		logSpy.mockRestore();
-	});
-
-	it('should detect workspace refs and mark them as workspace status', async () => {
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-		writePackageJson(tempDir, {
-			name: 'test-monorepo',
-			workspaces: ['packages/*'],
-			dependencies: {
-				'@geekmidas/constructs': 'workspace:*',
-			},
-		});
-
-		const pkgDir = join(tempDir, 'packages', 'api');
-		await mkdir(pkgDir, { recursive: true });
-		writePackageJson(pkgDir, {
-			name: '@test/api',
-			dependencies: {
-				'@geekmidas/auth': 'workspace:~',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/constructs/latest`, () => {
-				return HttpResponse.json({ version: '1.1.1' });
-			}),
-			http.get(`${NPM_REGISTRY}/@geekmidas/auth/latest`, () => {
-				return HttpResponse.json({ version: '1.0.0' });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand();
-
-		const output = logSpy.mock.calls.flat().join('\n');
-		expect(output).toContain('workspace');
-		expect(output).toContain('All @geekmidas packages are up to date');
-
-		logSpy.mockRestore();
-	});
-
-	it('should identify packages that need upgrade', async () => {
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: {
-				'@geekmidas/constructs': '^1.0.0',
-				'@geekmidas/auth': '~1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/constructs/latest`, () => {
-				return HttpResponse.json({ version: '1.2.0' });
-			}),
-			http.get(`${NPM_REGISTRY}/@geekmidas/auth/latest`, () => {
-				return HttpResponse.json({ version: '1.1.0' });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand({ dryRun: true });
-
-		const output = logSpy.mock.calls.flat().join('\n');
-		expect(output).toContain('⬆ upgrade');
-		expect(output).toContain('2 package(s) can be upgraded');
-		expect(output).toContain('--dry-run: No changes made');
-		expect(output).toContain('npm update');
-
-		logSpy.mockRestore();
-	});
-
-	it('should report up-to-date when versions match', async () => {
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: {
-				'@geekmidas/errors': '1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/errors/latest`, () => {
-				return HttpResponse.json({ version: '1.0.0' });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand();
-
-		const output = logSpy.mock.calls.flat().join('\n');
-		expect(output).toContain('✓ up-to-date');
-		expect(output).toContain('All @geekmidas packages are up to date');
-
-		logSpy.mockRestore();
-	});
-
-	it('should execute upgrade command when not dry-run', async () => {
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: {
-				'@geekmidas/errors': '^1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/errors/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand();
-
-		expect(execSync).toHaveBeenCalledWith(
-			expect.stringContaining('npm update @geekmidas/errors'),
-			expect.objectContaining({ stdio: 'inherit' }),
-		);
-
-		logSpy.mockRestore();
-	});
-
-	it('should use pnpm update -r when pnpm is detected', async () => {
-		writeFileSync(join(tempDir, 'pnpm-lock.yaml'), '');
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: {
-				'@geekmidas/logger': '^1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/logger/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand();
-
-		expect(execSync).toHaveBeenCalledWith(
-			expect.stringContaining('pnpm update -r @geekmidas/logger --latest'),
-			expect.anything(),
-		);
-
-		logSpy.mockRestore();
-	});
-
-	it('should scan all workspace packages in pnpm workspace', async () => {
-		writeFileSync(join(tempDir, 'pnpm-lock.yaml'), '');
-		writeFileSync(
-			join(tempDir, 'pnpm-workspace.yaml'),
-			'packages:\n  - "packages/*"\n  - "apps/*"\n',
-		);
-		writePackageJson(tempDir, {
-			name: 'test-monorepo',
-			devDependencies: {
-				'@geekmidas/cli': '^1.0.0',
-			},
-		});
-
-		const apiDir = join(tempDir, 'apps', 'api');
-		await mkdir(apiDir, { recursive: true });
-		writePackageJson(apiDir, {
-			name: '@test/api',
-			dependencies: {
-				'@geekmidas/constructs': '^1.0.0',
-			},
-		});
-
-		const libDir = join(tempDir, 'packages', 'shared');
-		await mkdir(libDir, { recursive: true });
-		writePackageJson(libDir, {
-			name: '@test/shared',
-			dependencies: {
-				'@geekmidas/errors': '^1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/cli/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-			http.get(`${NPM_REGISTRY}/@geekmidas/constructs/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-			http.get(`${NPM_REGISTRY}/@geekmidas/errors/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand({ dryRun: true });
-
-		const output = logSpy.mock.calls.flat().join('\n');
-		expect(output).toContain('Found 3 package(s) in workspace');
-		expect(output).toContain('3 package(s) can be upgraded');
-
-		logSpy.mockRestore();
-	});
-
-	it('should handle npm registry errors gracefully', async () => {
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: {
-				'@geekmidas/nonexistent': '^1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/nonexistent/latest`, () => {
-				return new HttpResponse(null, { status: 404 });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand();
-
-		const output = logSpy.mock.calls.flat().join('\n');
-		expect(output).toContain('unknown');
-
-		logSpy.mockRestore();
-	});
-
-	it('should throw when execSync fails', async () => {
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: {
-				'@geekmidas/errors': '^1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/errors/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-		);
-
-		vi.mocked(execSync).mockImplementation(() => {
-			throw new Error('command failed');
-		});
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await expect(upgradeCommand()).rejects.toThrow('Package upgrade failed');
-
-		logSpy.mockRestore();
-	});
-
-	it('should scan deps, devDeps, and peerDeps', async () => {
-		writeFileSync(join(tempDir, 'package-lock.json'), '{}');
-		writePackageJson(tempDir, {
-			name: 'test-project',
-			dependencies: {
-				'@geekmidas/constructs': '^1.0.0',
-			},
-			devDependencies: {
-				'@geekmidas/testkit': '^1.0.0',
-			},
-			peerDependencies: {
-				'@geekmidas/logger': '^1.0.0',
-			},
-		});
-
-		server.use(
-			http.get(`${NPM_REGISTRY}/@geekmidas/constructs/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-			http.get(`${NPM_REGISTRY}/@geekmidas/testkit/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-			http.get(`${NPM_REGISTRY}/@geekmidas/logger/latest`, () => {
-				return HttpResponse.json({ version: '2.0.0' });
-			}),
-		);
-
-		const logSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
-
-		await upgradeCommand({ dryRun: true });
-
-		const output = logSpy.mock.calls.flat().join('\n');
-		expect(output).toContain('Checking 3 unique @geekmidas package(s)');
-		expect(output).toContain('3 package(s) can be upgraded');
-
-		logSpy.mockRestore();
-	});
-});