kadi-deploy 0.19.0

package/src/config/agent-loader.ts

@@ -0,0 +1,177 @@
+/**
+ * Agent Configuration Loader
+ *
+ * Handles loading and parsing agent.json files from the project directory.
+ * Provides validation and helpful error messages when agent.json is missing or invalid.
+ *
+ * @module config/agent-loader
+ */
+
+import path from 'node:path';
+import fsPromises from 'node:fs/promises';
+import type { AgentConfig } from '../types.js';
+import { validateProfile, type Profile } from '../schemas/profiles.js';
+
+/**
+ * Error thrown when agent.json cannot be loaded or parsed
+ */
+export class AgentConfigError extends Error {
+  constructor(
+    message: string,
+    public readonly cause?: Error
+  ) {
+    super(message);
+    this.name = 'AgentConfigError';
+  }
+}
+
+/**
+ * Loads and parses agent.json from the specified project directory
+ *
+ * @param projectRoot - Absolute path to project directory containing agent.json
+ * @returns Parsed agent configuration
+ * @throws {AgentConfigError} If file cannot be read or parsed
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const config = await loadAgentConfig('/path/to/project');
+ *   console.log(`Loaded agent: ${config.name} v${config.version}`);
+ * } catch (error) {
+ *   if (error instanceof AgentConfigError) {
+ *     console.error('Failed to load agent.json:', error.message);
+ *   }
+ * }
+ * ```
+ */
+export async function loadAgentConfig(projectRoot: string): Promise<AgentConfig> {
+  const agentJsonPath = path.join(projectRoot, 'agent.json');
+
+  try {
+    const raw = await fsPromises.readFile(agentJsonPath, 'utf8');
+    const config = JSON.parse(raw);
+
+    // Basic validation
+    if (!config.name) {
+      throw new AgentConfigError(
+        'agent.json is missing required field: "name"'
+      );
+    }
+
+    return config;
+  } catch (error) {
+    if (error instanceof AgentConfigError) {
+      throw error;
+    }
+
+    if ((error as NodeJS.ErrnoException).code === 'ENOENT') {
+      throw new AgentConfigError(
+        `agent.json not found in ${projectRoot}\n` +
+        'Make sure you are in a KADI agent project directory.'
+      );
+    }
+
+    if (error instanceof SyntaxError) {
+      throw new AgentConfigError(
+        `agent.json contains invalid JSON: ${error.message}`,
+        error
+      );
+    }
+
+    throw new AgentConfigError(
+      `Failed to load agent.json: ${(error as Error).message}`,
+      error as Error
+    );
+  }
+}
+
+/**
+ * Gets list of available deploy profiles from agent configuration
+ *
+ * Filters out special keys like 'services' and 'networks' that are not profiles.
+ *
+ * @param config - Loaded agent configuration
+ * @returns Array of profile names
+ *
+ * @example
+ * ```typescript
+ * const config = await loadAgentConfig('./');
+ * const profiles = getDeployProfiles(config);
+ * console.log('Available profiles:', profiles.join(', '));
+ * ```
+ */
+export function getDeployProfiles(config: AgentConfig): string[] {
+  if (!config.deploy) return [];
+
+  return Object.keys(config.deploy).filter(
+    (key) => key !== 'services' && key !== 'networks'
+  );
+}
+
+/**
+ * Validates that a profile exists in the agent configuration
+ *
+ * @param config - Loaded agent configuration
+ * @param profileName - Profile name to validate
+ * @returns True if profile exists
+ *
+ * @example
+ * ```typescript
+ * if (!hasProfile(config, 'production')) {
+ *   console.error('Production profile not found');
+ * }
+ * ```
+ */
+export function hasProfile(config: AgentConfig, profileName: string): boolean {
+  return getDeployProfiles(config).includes(profileName);
+}
+
+/**
+ * Gets and validates a specific deploy profile from agent configuration
+ *
+ * Validates the profile structure using Zod schemas to ensure all required
+ * fields are present and correctly typed. Throws descriptive errors if
+ * validation fails.
+ *
+ * @param config - Loaded agent configuration
+ * @param profileName - Profile name to retrieve
+ * @returns Validated profile configuration or undefined if not found
+ * @throws Error if profile exists but fails validation
+ *
+ * @example
+ * ```typescript
+ * const prodProfile = getProfile(config, 'production');
+ * if (prodProfile) {
+ *   // prodProfile is fully typed and validated
+ *   console.log('Target:', prodProfile.target);
+ * }
+ * ```
+ */
+export function getProfile(config: AgentConfig, profileName: string): Profile | undefined {
+  const rawProfile = config.deploy?.[profileName];
+  if (!rawProfile) {
+    return undefined;
+  }
+
+  // Validate profile structure with Zod
+  return validateProfile(rawProfile, profileName);
+}
+
+/**
+ * Gets the first available profile from agent configuration
+ *
+ * Useful when user doesn't specify a profile and we want to use a sensible default.
+ *
+ * @param config - Loaded agent configuration
+ * @returns First profile name or undefined if no profiles exist
+ *
+ * @example
+ * ```typescript
+ * const defaultProfile = getFirstProfile(config);
+ * console.log('Using profile:', defaultProfile || 'none');
+ * ```
+ */
+export function getFirstProfile(config: AgentConfig): string | undefined {
+  const profiles = getDeployProfiles(config);
+  return profiles.length > 0 ? profiles[0] : undefined;
+}

package/src/config/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration Layer Barrel Export
+ *
+ * Centralized export point for all configuration utilities.
+ *
+ * @module config
+ */
+
+export * from './agent-loader.js';

package/src/display/deployment-info.ts

@@ -0,0 +1,220 @@
+/**
+ * Deployment Information Display
+ *
+ * Formats and displays comprehensive deployment information from deploy-ability's
+ * AkashDeploymentData type. Provides a beautiful, informative summary of deployments.
+ *
+ * @module display/deployment-info
+ */
+
+import type { AkashDeploymentData } from '@kadi.build/deploy-ability/types';
+import {
+  bold,
+  dim,
+  success,
+  info,
+  highlight,
+  formatKeyValue,
+  formatUrl,
+  formatHeader
+} from '../cli/colors.js';
+import { displayLeasePrice, displayLeasePriceWithUsd } from './pricing.js';
+import { displayServiceResources, displayServicesTable } from './resources.js';
+
+/**
+ * Displays comprehensive deployment information
+ *
+ * Shows all relevant deployment details including:
+ * - Deployment ID and status
+ * - Provider information
+ * - Lease pricing
+ * - Service resources
+ * - Endpoints (if available)
+ * - Quick access links
+ *
+ * @param data - Deployment data from deploy-ability
+ * @param aktPriceUsd - Optional AKT market price for USD conversion
+ *
+ * @example
+ * ```typescript
+ * const result = await deployToAkash(options);
+ * if (result.success) {
+ *   displayDeploymentInfo(result.data);
+ * }
+ * ```
+ */
+export function displayDeploymentInfo(
+  data: AkashDeploymentData,
+  aktPriceUsd?: number
+): void {
+  const separator = '─'.repeat(70);
+
+  console.log('');
+  console.log(success('✓ Deployment Successful!'));
+  console.log('');
+  console.log(separator);
+  console.log(formatHeader('Deployment Information'));
+  console.log(separator);
+  console.log('');
+
+  // Core deployment details
+  console.log(formatKeyValue('Deployment ID (DSEQ)', bold(data.dseq.toString())));
+  console.log(formatKeyValue('Owner', data.owner));
+  console.log(formatKeyValue('Provider', data.provider));
+  console.log(formatKeyValue('Network', highlight(data.network)));
+  console.log(formatKeyValue('Status', data.status === 'active' ? success('Active') : dim('Closed')));
+  console.log(formatKeyValue('Deployed At', data.deployedAt.toLocaleString()));
+  console.log('');
+
+  // Provider information
+  console.log(formatHeader('Provider Details'));
+  console.log(separator);
+  console.log('');
+  console.log(formatKeyValue('Provider URI', data.providerUri));
+  console.log(formatKeyValue('Group Sequence', data.gseq.toString()));
+  console.log(formatKeyValue('Order Sequence', data.oseq.toString()));
+  console.log('');
+
+  // Lease pricing
+  console.log(formatHeader('Lease Pricing'));
+  console.log(separator);
+  console.log('');
+  console.log(formatKeyValue('Created At', data.leaseCreatedAt));
+
+  if (aktPriceUsd) {
+    displayLeasePriceWithUsd(data.leasePrice, aktPriceUsd);
+  } else {
+    displayLeasePrice(data.leasePrice);
+  }
+  console.log('');
+
+  // Service resources
+  if (data.services && data.services.length > 0) {
+    console.log(formatHeader('Services'));
+    console.log(separator);
+    console.log('');
+    displayServiceResources(data.services);
+  }
+
+  // Endpoints (if available)
+  if (data.endpoints && Object.keys(data.endpoints).length > 0) {
+    console.log(formatHeader('Service Endpoints'));
+    console.log(separator);
+    console.log('');
+    for (const [serviceName, endpoint] of Object.entries(data.endpoints)) {
+      console.log(formatKeyValue(serviceName, formatUrl(endpoint)));
+    }
+    console.log('');
+  }
+
+  // Quick access links
+  console.log(formatHeader('Quick Access'));
+  console.log(separator);
+  console.log('');
+
+  const consoleUrl = data.network === 'mainnet'
+    ? `https://console.akash.network/deployments/${data.dseq}`
+    : `https://console-sandbox.akash.network/deployments/${data.dseq}`;
+
+  console.log(formatKeyValue('Akash Console', formatUrl(consoleUrl)));
+  console.log(formatKeyValue('Provider Dashboard', formatUrl(data.providerUri)));
+  console.log('');
+
+  console.log(dim('💡 Your deployment is now live on the Akash Network!'));
+  console.log('');
+}
+
+/**
+ * Displays a compact deployment summary
+ *
+ * Shows only the most important information in a concise format.
+ * Useful for quick confirmations or when displaying multiple deployments.
+ *
+ * @param data - Deployment data from deploy-ability
+ * @param aktPriceUsd - Optional AKT market price for USD conversion
+ *
+ * @example
+ * ```typescript
+ * displayDeploymentSummary(result.data, 0.52);
+ * // Output:
+ * // ✓ Deployed DSEQ 12345 to testnet
+ * //   Provider: akash1...
+ * //   Cost: 320.55 AKT/month ($166.69/month)
+ * ```
+ */
+export function displayDeploymentSummary(data: AkashDeploymentData, aktPriceUsd?: number): void {
+  console.log('');
+  console.log(success(`✓ Deployed DSEQ ${bold(data.dseq.toString())} to ${highlight(data.network)}`));
+  console.log(`  Provider: ${dim(data.provider)}`);
+
+  // Display cost with USD if price available
+  const aktCost = data.leasePrice.akt.perMonth.toFixed(2);
+  if (aktPriceUsd) {
+    const usdCost = data.leasePrice.toUSD(aktPriceUsd).perMonth.toFixed(2);
+    console.log(`  Cost: ${info(`${aktCost} AKT/month`)} ${dim(`($${usdCost}/month)`)}`);
+  } else {
+    console.log(`  Cost: ${info(`${aktCost} AKT/month`)}`);
+  }
+
+  if (data.services && data.services.length > 0) {
+    const serviceCount = data.services.length;
+    const replicaCount = data.services.reduce((sum, s) => sum + s.replicaCount, 0);
+    console.log(`  Services: ${info(serviceCount.toString())} (${replicaCount} total replicas)`);
+  }
+
+  console.log('');
+}
+
+/**
+ * Displays deployment profile information
+ *
+ * Shows which profile was used for deployment and its key settings.
+ *
+ * @param profileName - Profile name that was used
+ * @param data - Deployment data
+ *
+ * @example
+ * ```typescript
+ * displayProfileInfo('production', result.data);
+ * ```
+ */
+export function displayProfileInfo(profileName: string, data: AkashDeploymentData): void {
+  console.log(formatHeader('Deployment Profile'));
+  console.log(`  ${formatKeyValue('Profile Name', bold(profileName))}`);
+  console.log(`  ${formatKeyValue('Network', data.network)}`);
+  console.log(`  ${formatKeyValue('Target', 'akash')}`);
+  console.log('');
+}
+
+/**
+ * Displays dry-run information
+ *
+ * Shows what would be deployed without actually executing the deployment.
+ *
+ * @param profileName - Profile name
+ * @param sdl - Generated SDL content
+ *
+ * @example
+ * ```typescript
+ * displayDryRunInfo('production', sdlContent);
+ * ```
+ */
+export function displayDryRunInfo(profileName: string, sdl: string): void {
+  console.log('');
+  console.log(formatHeader('Dry Run - Deployment Preview'));
+  console.log(`  ${formatKeyValue('Profile', bold(profileName))}`);
+  console.log('');
+  console.log(dim('Generated SDL:'));
+  console.log('─'.repeat(70));
+  console.log(sdl);
+  console.log('─'.repeat(70));
+  console.log('');
+  console.log(dim('ℹ️  This is a dry run - no deployment was created'));
+  console.log('');
+}
+
+/**
+ * Barrel export
+ */
+export * from './pricing.js';
+export * from './resources.js';

package/src/display/pricing.ts

@@ -0,0 +1,137 @@
+/**
+ * Lease Pricing Display Utilities
+ *
+ * Formats and displays lease pricing information from deploy-ability's LeasePrice type.
+ * Provides multiple views: per-block, per-hour, per-month in both uAKT and AKT.
+ *
+ * @module display/pricing
+ */
+
+import type { LeasePrice } from '@kadi.build/deploy-ability/akash';
+import { formatKeyValue, success, dim } from '../cli/colors.js';
+
+/**
+ * Displays lease pricing in a formatted, human-readable manner
+ *
+ * Shows pricing in multiple time units (block, hour, month) and denominations (uAKT, AKT).
+ *
+ * @param leasePrice - Lease price object from deploy-ability
+ * @param indent - Indentation level (default: 0)
+ *
+ * @example
+ * ```typescript
+ * displayLeasePrice(deploymentData.leasePrice);
+ * // Output:
+ * // Price per block: 450 uAKT (0.000450 AKT)
+ * // Price per hour:  443,705 uAKT (0.443705 AKT)
+ * // Price per month: 320,548,800 uAKT (320.548800 AKT)
+ * ```
+ */
+export function displayLeasePrice(leasePrice: LeasePrice, indent: number = 0): void {
+  const prefix = ' '.repeat(indent);
+
+  console.log(`${prefix}${formatKeyValue('Price per block', `${leasePrice.uakt.perBlock} uAKT (${leasePrice.akt.perBlock} AKT)`)}`);
+  console.log(`${prefix}${formatKeyValue('Price per hour', `${leasePrice.uakt.perHour.toLocaleString()} uAKT (${leasePrice.akt.perHour} AKT)`)}`);
+  console.log(`${prefix}${formatKeyValue('Price per month', `${leasePrice.uakt.perMonth.toLocaleString()} uAKT (${success(leasePrice.akt.perMonth + ' AKT')})`)}`)
+;
+}
+
+/**
+ * Displays lease pricing with USD conversion
+ *
+ * Shows pricing in uAKT, AKT, and USD when AKT market price is provided.
+ *
+ * @param leasePrice - Lease price object from deploy-ability
+ * @param aktPriceUsd - Current AKT market price in USD (optional)
+ * @param indent - Indentation level (default: 0)
+ *
+ * @example
+ * ```typescript
+ * // With USD conversion
+ * displayLeasePriceWithUsd(deploymentData.leasePrice, 0.50);
+ * // Output includes USD amounts:
+ * // Price per month: 320.55 AKT ($160.27 USD)
+ * ```
+ */
+export function displayLeasePriceWithUsd(
+  leasePrice: LeasePrice,
+  aktPriceUsd?: number,
+  indent: number = 0
+): void {
+  const prefix = ' '.repeat(indent);
+
+  if (aktPriceUsd) {
+    const usdPrices = leasePrice.toUSD(aktPriceUsd);
+
+    console.log(`${prefix}${formatKeyValue('Price per block', `${leasePrice.uakt.perBlock} uAKT ($${usdPrices.perBlock.toFixed(6)} USD)`)}`);
+    console.log(`${prefix}${formatKeyValue('Price per hour', `${leasePrice.akt.perHour} AKT ($${usdPrices.perHour.toFixed(4)} USD)`)}`);
+    console.log(`${prefix}${formatKeyValue('Price per month', `${success(leasePrice.akt.perMonth + ' AKT')} (${success('$' + usdPrices.perMonth.toFixed(2) + ' USD')})`)}`)
+;
+  } else {
+    // No USD price available, use standard display
+    displayLeasePrice(leasePrice, indent);
+  }
+}
+
+/**
+ * Gets a compact one-line pricing summary
+ *
+ * Useful for displaying in summaries or lists.
+ *
+ * @param leasePrice - Lease price object from deploy-ability
+ * @returns Formatted price string
+ *
+ * @example
+ * ```typescript
+ * const summary = getPricingSummary(leasePrice);
+ * console.log(`Monthly cost: ${summary}`);
+ * // Output: "Monthly cost: 320.55 AKT/month"
+ * ```
+ */
+export function getPricingSummary(leasePrice: LeasePrice): string {
+  return `${leasePrice.akt.perMonth} AKT/month`;
+}
+
+/**
+ * Gets a compact one-line pricing summary with USD
+ *
+ * @param leasePrice - Lease price object from deploy-ability
+ * @param aktPriceUsd - Current AKT market price in USD
+ * @returns Formatted price string with USD
+ *
+ * @example
+ * ```typescript
+ * const summary = getPricingSummaryWithUsd(leasePrice, 0.50);
+ * console.log(`Monthly cost: ${summary}`);
+ * // Output: "Monthly cost: 320.55 AKT ($160.27 USD)/month"
+ * ```
+ */
+export function getPricingSummaryWithUsd(leasePrice: LeasePrice, aktPriceUsd: number): string {
+  const usdPrices = leasePrice.toUSD(aktPriceUsd);
+  return `${leasePrice.akt.perMonth} AKT ($${usdPrices.perMonth.toFixed(2)} USD)/month`;
+}
+
+/**
+ * Displays pricing calculation methodology
+ *
+ * Shows the formulas and constants used for price calculations.
+ * Useful for transparency and debugging.
+ *
+ * @example
+ * ```typescript
+ * displayPricingMethodology();
+ * // Output:
+ * // Pricing Calculation:
+ * //   - Average block time: 6.098 seconds
+ * //   - Blocks per hour: 590.3...
+ * //   - Average month: 30.437 days
+ * ```
+ */
+export function displayPricingMethodology(): void {
+  console.log(dim('\nPricing Calculation Methodology:'));
+  console.log(dim('  • Average block time: 6.098 seconds'));
+  console.log(dim('  • Blocks per hour: 590.36 (3600 / 6.098)'));
+  console.log(dim('  • Hours per month: 730.48 (30.437 days)'));
+  console.log(dim('  • Per month = per block × blocks/hour × hours/month'));
+  console.log(dim('  • Source: Akash Console pricing logic\n'));
+}