@gravito/launchpad 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @gravito/launchpad
 
+## 1.2.2
+
+### Patch Changes
+
+- 905588f: fix: replace insecure Math.random() with crypto.randomUUID() for ID and temporary path generation (CWE-330)
+
+## 1.2.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @gravito/core@1.2.1
+  - @gravito/enterprise@1.0.3
+  - @gravito/ripple@3.0.1
+  - @gravito/stasis@3.0.1
+
 ## 1.2.0
 
 ### Minor Changes

package/debug-launch.ts

@@ -21,7 +21,10 @@ async function run() {
       console.log('🧹 Cleaning up old containers...')
       await runtime.spawn(['docker', 'rm', '-f', ...containers.trim().split('\n')]).exited
     }
-  } catch (_e) {}
+  } catch {
+    // Intentionally ignored: Container cleanup is best-effort.
+    // Failure could mean containers don't exist or Docker is unavailable, which is acceptable.
+  }
 
   // 2. Start Server
   const config = await bootstrapLaunchpad()

package/dist/index.d.mts

@@ -9,6 +9,15 @@ interface MissionProps {
     branch: string;
     commitSha: string;
 }
+/**
+ * Mission represents a deployment task for a specific code version.
+ *
+ * It is a Value Object containing information about the source repository,
+ * branch, and commit to be deployed.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class Mission extends ValueObject<MissionProps> {
     get id(): string;
     get repoUrl(): string;
@@ -28,6 +37,16 @@ declare enum RocketStatus {
     DECOMMISSIONED = "DECOMMISSIONED"
 }
 
+/**
+ * Rocket represents a managed application container within Launchpad.
+ *
+ * It acts as an Aggregate Root in the domain, maintaining its lifecycle state
+ * (IDLE, PREPARING, ORBITING, etc.) and emitting domain events when
+ * state transitions occur.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class Rocket extends AggregateRoot<string> {
     private _status;
     private _currentMission;
@@ -140,6 +159,15 @@ interface IRocketRepository {
     delete(id: string): Promise<void>;
 }
 
+/**
+ * PayloadInjector is responsible for deploying application code into Rocket containers.
+ *
+ * It clones the repository, copies files into the container, installs
+ * dependencies (using Bun), and starts the application.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class PayloadInjector {
     private docker;
     private git;
@@ -147,6 +175,16 @@ declare class PayloadInjector {
     deploy(rocket: Rocket): Promise<void>;
 }
 
+/**
+ * RefurbishUnit handles the cleaning and restoration of Rocket containers.
+ *
+ * After a mission is complete, this unit resets the container environment
+ * (clearing files, stopping processes) so the container can be returned
+ * to the idle pool for future reuse.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class RefurbishUnit {
     private docker;
     constructor(docker: IDockerAdapter);
@@ -156,6 +194,15 @@ declare class RefurbishUnit {
     refurbish(rocket: Rocket): Promise<void>;
 }
 
+/**
+ * PoolManager handles the lifecycle and pooling of Rocket containers.
+ *
+ * It manages a pool of pre-warmed containers to ensure fast deployment of
+ * new missions. It also handles rocket assignment and recycling (refurbishment).
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class PoolManager {
     private dockerAdapter;
     private rocketRepository;
@@ -176,6 +223,15 @@ declare class PoolManager {
     recycle(missionId: string): Promise<void>;
 }
 
+/**
+ * MissionControl orchestrates the high-level process of launching missions.
+ *
+ * it coordinates between the `PoolManager`, `PayloadInjector`, and `DockerAdapter`
+ * to deploy code into containers, assign domains, and monitor execution.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class MissionControl {
     private poolManager;
     private injector;
@@ -186,15 +242,33 @@ declare class MissionControl {
 }
 
 /**
- * Gravito Launchpad Orbit
+ * LaunchpadOrbit provides automated deployment and preview capabilities for Gravito.
+ * It integrates with Docker and GitHub to provide "Preview Deployments" for Pull Requests.
+ *
+ * @public
  */
 declare class LaunchpadOrbit implements GravitoOrbit {
     private ripple;
+    /**
+     * Create a new LaunchpadOrbit instance.
+     * @param ripple - Ripple instance for real-time telemetry communication.
+     */
     constructor(ripple: OrbitRipple);
+    /**
+     * Install the Launchpad orbit into PlanetCore.
+     * Registers the service provider and sets up webhook routes for deployment.
+     *
+     * @param core - The PlanetCore instance.
+     */
     install(core: PlanetCore): Promise<void>;
 }
 /**
- * 一鍵啟動 Launchpad 應用程式
+ * Bootstrap the Launchpad application.
+ * Initializes PlanetCore with necessary orbits (Cache, Ripple, Launchpad)
+ * and returns the configuration for the server entry point.
+ *
+ * @returns Server configuration object including port and fetch handler.
+ * @public
  */
 declare function bootstrapLaunchpad(): Promise<{
     port: number;

package/dist/index.d.ts

@@ -9,6 +9,15 @@ interface MissionProps {
     branch: string;
     commitSha: string;
 }
+/**
+ * Mission represents a deployment task for a specific code version.
+ *
+ * It is a Value Object containing information about the source repository,
+ * branch, and commit to be deployed.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class Mission extends ValueObject<MissionProps> {
     get id(): string;
     get repoUrl(): string;
@@ -28,6 +37,16 @@ declare enum RocketStatus {
     DECOMMISSIONED = "DECOMMISSIONED"
 }
 
+/**
+ * Rocket represents a managed application container within Launchpad.
+ *
+ * It acts as an Aggregate Root in the domain, maintaining its lifecycle state
+ * (IDLE, PREPARING, ORBITING, etc.) and emitting domain events when
+ * state transitions occur.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class Rocket extends AggregateRoot<string> {
     private _status;
     private _currentMission;
@@ -140,6 +159,15 @@ interface IRocketRepository {
     delete(id: string): Promise<void>;
 }
 
+/**
+ * PayloadInjector is responsible for deploying application code into Rocket containers.
+ *
+ * It clones the repository, copies files into the container, installs
+ * dependencies (using Bun), and starts the application.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class PayloadInjector {
     private docker;
     private git;
@@ -147,6 +175,16 @@ declare class PayloadInjector {
     deploy(rocket: Rocket): Promise<void>;
 }
 
+/**
+ * RefurbishUnit handles the cleaning and restoration of Rocket containers.
+ *
+ * After a mission is complete, this unit resets the container environment
+ * (clearing files, stopping processes) so the container can be returned
+ * to the idle pool for future reuse.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class RefurbishUnit {
     private docker;
     constructor(docker: IDockerAdapter);
@@ -156,6 +194,15 @@ declare class RefurbishUnit {
     refurbish(rocket: Rocket): Promise<void>;
 }
 
+/**
+ * PoolManager handles the lifecycle and pooling of Rocket containers.
+ *
+ * It manages a pool of pre-warmed containers to ensure fast deployment of
+ * new missions. It also handles rocket assignment and recycling (refurbishment).
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class PoolManager {
     private dockerAdapter;
     private rocketRepository;
@@ -176,6 +223,15 @@ declare class PoolManager {
     recycle(missionId: string): Promise<void>;
 }
 
+/**
+ * MissionControl orchestrates the high-level process of launching missions.
+ *
+ * it coordinates between the `PoolManager`, `PayloadInjector`, and `DockerAdapter`
+ * to deploy code into containers, assign domains, and monitor execution.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class MissionControl {
     private poolManager;
     private injector;
@@ -186,15 +242,33 @@ declare class MissionControl {
 }
 
 /**
- * Gravito Launchpad Orbit
+ * LaunchpadOrbit provides automated deployment and preview capabilities for Gravito.
+ * It integrates with Docker and GitHub to provide "Preview Deployments" for Pull Requests.
+ *
+ * @public
  */
 declare class LaunchpadOrbit implements GravitoOrbit {
     private ripple;
+    /**
+     * Create a new LaunchpadOrbit instance.
+     * @param ripple - Ripple instance for real-time telemetry communication.
+     */
     constructor(ripple: OrbitRipple);
+    /**
+     * Install the Launchpad orbit into PlanetCore.
+     * Registers the service provider and sets up webhook routes for deployment.
+     *
+     * @param core - The PlanetCore instance.
+     */
     install(core: PlanetCore): Promise<void>;
 }
 /**
- * 一鍵啟動 Launchpad 應用程式
+ * Bootstrap the Launchpad application.
+ * Initializes PlanetCore with necessary orbits (Cache, Ripple, Launchpad)
+ * and returns the configuration for the server entry point.
+ *
+ * @returns Server configuration object including port and fetch handler.
+ * @public
  */
 declare function bootstrapLaunchpad(): Promise<{
     port: number;

package/dist/index.js

@@ -298,7 +298,7 @@ var PoolManager = class {
     console.log(`[LaunchPad] \u6B63\u5728\u71B1\u6A5F\uFF0C\u6E96\u5099\u767C\u5C04 ${needed} \u67B6\u65B0\u706B\u7BAD...`);
     for (let i = 0; i < needed; i++) {
       const containerId = await this.dockerAdapter.createBaseContainer();
-      const rocketId = `rocket-${Math.random().toString(36).substring(2, 9)}`;
+      const rocketId = `rocket-${crypto.randomUUID()}`;
       const rocket = new Rocket(rocketId, containerId);
       await this.rocketRepository.save(rocket);
     }
@@ -394,7 +394,7 @@ var DockerAdapter = class {
   baseImage = "oven/bun:1.0-slim";
   runtime = (0, import_core.getRuntimeAdapter)();
   async createBaseContainer() {
-    const rocketId = `rocket-${Math.random().toString(36).substring(2, 9)}`;
+    const rocketId = `rocket-${crypto.randomUUID()}`;
     const proc = this.runtime.spawn([
       "docker",
       "run",
@@ -509,7 +509,7 @@ var import_core2 = require("@gravito/core");
 var ShellGitAdapter = class {
   baseDir = "/tmp/gravito-launchpad-git";
   async clone(repoUrl, branch) {
-    const dirName = `${Date.now()}-${Math.random().toString(36).slice(2)}`;
+    const dirName = `${Date.now()}-${crypto.randomUUID()}`;
     const targetDir = `${this.baseDir}/${dirName}`;
     await (0, import_promises.mkdir)(this.baseDir, { recursive: true });
     const runtime = (0, import_core2.getRuntimeAdapter)();
@@ -648,10 +648,6 @@ var BunProxyAdapter = class {
 var LaunchpadServiceProvider = class extends import_core4.ServiceProvider {
   register(container) {
     if (!container.has("cache")) {
-      const cacheFromServices = this.core?.services?.get("cache");
-      if (cacheFromServices) {
-        container.instance("cache", cacheFromServices);
-      }
     }
     container.singleton("launchpad.docker", () => new DockerAdapter());
     container.singleton("launchpad.git", () => new ShellGitAdapter());
@@ -708,9 +704,19 @@ var LaunchpadServiceProvider = class extends import_core4.ServiceProvider {
   }
 };
 var LaunchpadOrbit = class {
+  /**
+   * Create a new LaunchpadOrbit instance.
+   * @param ripple - Ripple instance for real-time telemetry communication.
+   */
   constructor(ripple) {
     this.ripple = ripple;
   }
+  /**
+   * Install the Launchpad orbit into PlanetCore.
+   * Registers the service provider and sets up webhook routes for deployment.
+   *
+   * @param core - The PlanetCore instance.
+   */
   async install(core) {
     core.register(new LaunchpadServiceProvider());
     core.router.post("/launch", async (c) => {
@@ -784,12 +790,7 @@ async function bootstrapLaunchpad() {
       PORT: 4e3,
       CACHE_DRIVER: "file"
     },
-    orbits: [
-      new import_stasis.OrbitCache(),
-      ripple,
-      new LaunchpadOrbit(ripple)
-      // 傳入實例
-    ]
+    orbits: [new import_stasis.OrbitCache(), ripple, new LaunchpadOrbit(ripple)]
   });
   await core.bootstrap();
   const liftoffConfig = core.liftoff();

package/dist/index.mjs

@@ -266,7 +266,7 @@ var PoolManager = class {
     console.log(`[LaunchPad] \u6B63\u5728\u71B1\u6A5F\uFF0C\u6E96\u5099\u767C\u5C04 ${needed} \u67B6\u65B0\u706B\u7BAD...`);
     for (let i = 0; i < needed; i++) {
       const containerId = await this.dockerAdapter.createBaseContainer();
-      const rocketId = `rocket-${Math.random().toString(36).substring(2, 9)}`;
+      const rocketId = `rocket-${crypto.randomUUID()}`;
       const rocket = new Rocket(rocketId, containerId);
       await this.rocketRepository.save(rocket);
     }
@@ -362,7 +362,7 @@ var DockerAdapter = class {
   baseImage = "oven/bun:1.0-slim";
   runtime = getRuntimeAdapter();
   async createBaseContainer() {
-    const rocketId = `rocket-${Math.random().toString(36).substring(2, 9)}`;
+    const rocketId = `rocket-${crypto.randomUUID()}`;
     const proc = this.runtime.spawn([
       "docker",
       "run",
@@ -477,7 +477,7 @@ import { getRuntimeAdapter as getRuntimeAdapter2 } from "@gravito/core";
 var ShellGitAdapter = class {
   baseDir = "/tmp/gravito-launchpad-git";
   async clone(repoUrl, branch) {
-    const dirName = `${Date.now()}-${Math.random().toString(36).slice(2)}`;
+    const dirName = `${Date.now()}-${crypto.randomUUID()}`;
     const targetDir = `${this.baseDir}/${dirName}`;
     await mkdir(this.baseDir, { recursive: true });
     const runtime = getRuntimeAdapter2();
@@ -616,10 +616,6 @@ var BunProxyAdapter = class {
 var LaunchpadServiceProvider = class extends ServiceProvider {
   register(container) {
     if (!container.has("cache")) {
-      const cacheFromServices = this.core?.services?.get("cache");
-      if (cacheFromServices) {
-        container.instance("cache", cacheFromServices);
-      }
     }
     container.singleton("launchpad.docker", () => new DockerAdapter());
     container.singleton("launchpad.git", () => new ShellGitAdapter());
@@ -676,9 +672,19 @@ var LaunchpadServiceProvider = class extends ServiceProvider {
   }
 };
 var LaunchpadOrbit = class {
+  /**
+   * Create a new LaunchpadOrbit instance.
+   * @param ripple - Ripple instance for real-time telemetry communication.
+   */
   constructor(ripple) {
     this.ripple = ripple;
   }
+  /**
+   * Install the Launchpad orbit into PlanetCore.
+   * Registers the service provider and sets up webhook routes for deployment.
+   *
+   * @param core - The PlanetCore instance.
+   */
   async install(core) {
     core.register(new LaunchpadServiceProvider());
     core.router.post("/launch", async (c) => {
@@ -752,12 +758,7 @@ async function bootstrapLaunchpad() {
       PORT: 4e3,
       CACHE_DRIVER: "file"
     },
-    orbits: [
-      new OrbitCache(),
-      ripple,
-      new LaunchpadOrbit(ripple)
-      // 傳入實例
-    ]
+    orbits: [new OrbitCache(), ripple, new LaunchpadOrbit(ripple)]
   });
   await core.bootstrap();
   const liftoffConfig = core.liftoff();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravito/launchpad",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Container lifecycle management system for flash deployments",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/Application/MissionControl.ts

@@ -3,6 +3,15 @@ import type { Mission } from '../Domain/Mission'
 import type { PayloadInjector } from './PayloadInjector'
 import type { PoolManager } from './PoolManager'
 
+/**
+ * MissionControl orchestrates the high-level process of launching missions.
+ *
+ * it coordinates between the `PoolManager`, `PayloadInjector`, and `DockerAdapter`
+ * to deploy code into containers, assign domains, and monitor execution.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class MissionControl {
   constructor(
     private poolManager: PoolManager,

package/src/Application/PayloadInjector.ts

@@ -1,6 +1,15 @@
 import type { IDockerAdapter, IGitAdapter } from '../Domain/Interfaces'
 import type { Rocket } from '../Domain/Rocket'
 
+/**
+ * PayloadInjector is responsible for deploying application code into Rocket containers.
+ *
+ * It clones the repository, copies files into the container, installs
+ * dependencies (using Bun), and starts the application.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class PayloadInjector {
   constructor(
     private docker: IDockerAdapter,

package/src/Application/PoolManager.ts

@@ -3,6 +3,15 @@ import type { Mission } from '../Domain/Mission'
 import { Rocket } from '../Domain/Rocket'
 import type { RefurbishUnit } from './RefurbishUnit'
 
+/**
+ * PoolManager handles the lifecycle and pooling of Rocket containers.
+ *
+ * It manages a pool of pre-warmed containers to ensure fast deployment of
+ * new missions. It also handles rocket assignment and recycling (refurbishment).
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class PoolManager {
   constructor(
     private dockerAdapter: IDockerAdapter,
@@ -26,7 +35,7 @@ export class PoolManager {
 
     for (let i = 0; i < needed; i++) {
       const containerId = await this.dockerAdapter.createBaseContainer()
-      const rocketId = `rocket-${Math.random().toString(36).substring(2, 9)}`
+      const rocketId = `rocket-${crypto.randomUUID()}`
       const rocket = new Rocket(rocketId, containerId)
       await this.rocketRepository.save(rocket)
     }

package/src/Application/RefurbishUnit.ts

@@ -1,6 +1,16 @@
 import type { IDockerAdapter } from '../Domain/Interfaces'
 import type { Rocket } from '../Domain/Rocket'
 
+/**
+ * RefurbishUnit handles the cleaning and restoration of Rocket containers.
+ *
+ * After a mission is complete, this unit resets the container environment
+ * (clearing files, stopping processes) so the container can be returned
+ * to the idle pool for future reuse.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class RefurbishUnit {
   constructor(private docker: IDockerAdapter) {}
 

package/src/Domain/Events.ts

@@ -1,5 +1,11 @@
 import { DomainEvent } from '@gravito/enterprise'
 
+/**
+ * Event emitted when a mission is assigned to a rocket.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class MissionAssigned extends DomainEvent {
   constructor(
     public readonly rocketId: string,
@@ -9,18 +15,36 @@ export class MissionAssigned extends DomainEvent {
   }
 }
 
+/**
+ * Event emitted when a rocket starts its mission (application started).
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class RocketIgnited extends DomainEvent {
   constructor(public readonly rocketId: string) {
     super()
   }
 }
 
+/**
+ * Event emitted when a rocket mission is completed or terminated.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class RocketSplashedDown extends DomainEvent {
   constructor(public readonly rocketId: string) {
     super()
   }
 }
 
+/**
+ * Event emitted when a rocket has finished the refurbishment process.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class RefurbishmentCompleted extends DomainEvent {
   constructor(public readonly rocketId: string) {
     super()

package/src/Domain/Mission.ts

@@ -7,6 +7,15 @@ interface MissionProps {
   commitSha: string // Commit Hash
 }
 
+/**
+ * Mission represents a deployment task for a specific code version.
+ *
+ * It is a Value Object containing information about the source repository,
+ * branch, and commit to be deployed.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class Mission extends ValueObject<MissionProps> {
   get id() {
     return this.props.id

package/src/Domain/Rocket.ts

@@ -8,6 +8,16 @@ import {
 import type { Mission } from './Mission'
 import { RocketStatus } from './RocketStatus'
 
+/**
+ * Rocket represents a managed application container within Launchpad.
+ *
+ * It acts as an Aggregate Root in the domain, maintaining its lifecycle state
+ * (IDLE, PREPARING, ORBITING, etc.) and emitting domain events when
+ * state transitions occur.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class Rocket extends AggregateRoot<string> {
   private _status: RocketStatus = RocketStatus.IDLE
   private _currentMission: Mission | null = null

package/src/Infrastructure/Docker/DockerAdapter.ts

@@ -1,12 +1,21 @@
 import { getRuntimeAdapter } from '@gravito/core'
 import type { IDockerAdapter } from '../../Domain/Interfaces'
 
+/**
+ * DockerAdapter implements the `IDockerAdapter` interface using the Docker CLI.
+ *
+ * It manages the lifecycle of Docker containers used as "Rockets" in Launchpad,
+ * including creation, command execution, file copying, and metrics collection.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class DockerAdapter implements IDockerAdapter {
   private baseImage = 'oven/bun:1.0-slim'
   private runtime = getRuntimeAdapter()
 
   async createBaseContainer(): Promise<string> {
-    const rocketId = `rocket-${Math.random().toString(36).substring(2, 9)}`
+    const rocketId = `rocket-${crypto.randomUUID()}`
 
     const proc = this.runtime.spawn([
       'docker',

package/src/Infrastructure/Git/ShellGitAdapter.ts

@@ -2,11 +2,20 @@ import { mkdir } from 'node:fs/promises'
 import { getRuntimeAdapter } from '@gravito/core'
 import type { IGitAdapter } from '../../Domain/Interfaces'
 
+/**
+ * ShellGitAdapter implements the `IGitAdapter` interface using the Git CLI.
+ *
+ * It provides methods for cloning repositories to a temporary directory
+ * for deployment into Rocket containers.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class ShellGitAdapter implements IGitAdapter {
   private baseDir = '/tmp/gravito-launchpad-git'
 
   async clone(repoUrl: string, branch: string): Promise<string> {
-    const dirName = `${Date.now()}-${Math.random().toString(36).slice(2)}`
+    const dirName = `${Date.now()}-${crypto.randomUUID()}`
     const targetDir = `${this.baseDir}/${dirName}`
 
     await mkdir(this.baseDir, { recursive: true })

package/src/Infrastructure/GitHub/OctokitGitHubAdapter.ts

@@ -2,6 +2,15 @@ import { createHmac, timingSafeEqual } from 'node:crypto'
 import { Octokit } from '@octokit/rest'
 import type { IGitHubAdapter } from '../../Domain/Interfaces'
 
+/**
+ * OctokitGitHubAdapter implements the `IGitHubAdapter` interface using the Octokit library.
+ *
+ * It provides methods for verifying GitHub webhook signatures and interacting with
+ * the GitHub API, such as posting comments on Pull Requests.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class OctokitGitHubAdapter implements IGitHubAdapter {
   private octokit: Octokit
 

package/src/Infrastructure/Persistence/CachedRocketRepository.ts

@@ -2,6 +2,15 @@ import type { CacheService } from '@gravito/core'
 import type { IRocketRepository } from '../../Domain/Interfaces'
 import { Rocket } from '../../Domain/Rocket'
 
+/**
+ * CachedRocketRepository implements the `IRocketRepository` interface using Gravito's `CacheService`.
+ *
+ * It provides a persistent (depending on cache driver) storage for Rocket
+ * metadata, allowing Launchpad to track container states across requests.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class CachedRocketRepository implements IRocketRepository {
   private CACHE_KEY = 'launchpad:rockets'
 

package/src/Infrastructure/Persistence/InMemoryRocketRepository.ts

@@ -2,6 +2,15 @@ import type { IRocketRepository } from '../../Domain/Interfaces'
 import type { Rocket } from '../../Domain/Rocket'
 import { RocketStatus } from '../../Domain/RocketStatus'
 
+/**
+ * InMemoryRocketRepository implements the `IRocketRepository` interface using an in-memory Map.
+ *
+ * This repository is suitable for testing or development environments where
+ * persistence across restarts is not required.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class InMemoryRocketRepository implements IRocketRepository {
   private rockets = new Map<string, Rocket>()
 

package/src/Infrastructure/Router/BunProxyAdapter.ts

@@ -1,6 +1,15 @@
 import { getRuntimeAdapter } from '@gravito/core'
 import type { IRouterAdapter } from '../../Domain/Interfaces'
 
+/**
+ * BunProxyAdapter implements the `IRouterAdapter` interface using Bun's native HTTP server.
+ *
+ * It provides a dynamic reverse proxy that routes requests to specific Rocket
+ * containers based on the `Host` header.
+ *
+ * @public
+ * @since 3.0.0
+ */
 export class BunProxyAdapter implements IRouterAdapter {
   private routes = new Map<string, string>() // domain -> targetUrl
 

package/src/index.ts

@@ -26,10 +26,8 @@ export * from './Domain/RocketStatus'
 class LaunchpadServiceProvider extends ServiceProvider {
   register(container: Container): void {
     if (!container.has('cache')) {
-      const cacheFromServices = this.core?.services?.get('cache')
-      if (cacheFromServices) {
-        container.instance('cache', cacheFromServices)
-      }
+      // 在新的架構中，如果 core 有預設綁定，可以直接通過 container.make 獲取
+      // 這裡如果只是想從父容器繼承，通常不需要額外操作，除非是在不同的 instance 中。
     }
 
     container.singleton('launchpad.docker', () => new DockerAdapter())
@@ -101,11 +99,24 @@ class LaunchpadServiceProvider extends ServiceProvider {
 }
 
 /**
- * Gravito Launchpad Orbit
+ * LaunchpadOrbit provides automated deployment and preview capabilities for Gravito.
+ * It integrates with Docker and GitHub to provide "Preview Deployments" for Pull Requests.
+ *
+ * @public
  */
 export class LaunchpadOrbit implements GravitoOrbit {
+  /**
+   * Create a new LaunchpadOrbit instance.
+   * @param ripple - Ripple instance for real-time telemetry communication.
+   */
   constructor(private ripple: OrbitRipple) {}
 
+  /**
+   * Install the Launchpad orbit into PlanetCore.
+   * Registers the service provider and sets up webhook routes for deployment.
+   *
+   * @param core - The PlanetCore instance.
+   */
   async install(core: PlanetCore): Promise<void> {
     core.register(new LaunchpadServiceProvider())
 
@@ -139,7 +150,7 @@ export class LaunchpadOrbit implements GravitoOrbit {
 
           const ctrl = core.container.make<MissionControl>('launchpad.ctrl')
           const rocketId = await ctrl.launch(mission, (type, data) => {
-            // 修正：使用正確的 broadcast 方法
+            // Correctly broadcast telemetry data via Ripple
             this.ripple.getServer().broadcast('telemetry', 'telemetry.data', { type, data })
           })
 
@@ -188,7 +199,12 @@ export class LaunchpadOrbit implements GravitoOrbit {
 }
 
 /**
- * 一鍵啟動 Launchpad 應用程式
+ * Bootstrap the Launchpad application.
+ * Initializes PlanetCore with necessary orbits (Cache, Ripple, Launchpad)
+ * and returns the configuration for the server entry point.
+ *
+ * @returns Server configuration object including port and fetch handler.
+ * @public
  */
 export async function bootstrapLaunchpad() {
   const ripple = new OrbitRipple({ path: '/ws' })
@@ -199,11 +215,7 @@ export async function bootstrapLaunchpad() {
       PORT: 4000,
       CACHE_DRIVER: 'file',
     },
-    orbits: [
-      new OrbitCache(),
-      ripple,
-      new LaunchpadOrbit(ripple), // 傳入實例
-    ],
+    orbits: [new OrbitCache(), ripple, new LaunchpadOrbit(ripple)],
   })
 
   await core.bootstrap()