@salte-common/terraflow 0.1.0-alpha.1

package/dist/types/context.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Execution context type definitions
+ */
+/**
+ * Cloud provider information
+ */
+export interface CloudInfo {
+    /** Detected cloud provider: aws | azure | gcp | none */
+    provider: 'aws' | 'azure' | 'gcp' | 'none';
+    /** AWS account ID (if AWS) */
+    awsAccountId?: string;
+    /** AWS region */
+    awsRegion?: string;
+    /** Azure subscription ID (if Azure) */
+    azureSubscriptionId?: string;
+    /** Azure tenant ID (if Azure) */
+    azureTenantId?: string;
+    /** GCP project ID (if GCP) */
+    gcpProjectId?: string;
+}
+/**
+ * Git/VCS information
+ */
+export interface VcsInfo {
+    /** Current git branch */
+    branch?: string;
+    /** Current git tag */
+    tag?: string;
+    /** Full git commit SHA */
+    commitSha?: string;
+    /** Short git commit SHA */
+    shortSha?: string;
+    /** GitHub repository (owner/repo) */
+    githubRepository?: string;
+    /** GitLab project path */
+    gitlabProjectPath?: string;
+    /** Whether working directory is clean */
+    isClean?: boolean;
+}
+/**
+ * Execution context passed to plugins and commands
+ */
+export interface ExecutionContext {
+    /** Resolved workspace name */
+    workspace: string;
+    /** Working directory path */
+    workingDir: string;
+    /** Cloud provider information */
+    cloud: CloudInfo;
+    /** VCS information */
+    vcs: VcsInfo;
+    /** Machine hostname */
+    hostname: string;
+    /** Environment variables (sanitized, no secrets) */
+    env: Record<string, string>;
+    /** Template variables for config resolution */
+    templateVars: Record<string, string>;
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/types/context.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Execution context type definitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.js.map

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Type exports for Terraflow CLI
+ */
+export * from './config';
+export * from './context';
+export * from './plugins';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Type exports for Terraflow CLI
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config"), exports);
+__exportStar(require("./context"), exports);
+__exportStar(require("./plugins"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/plugins.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Plugin system interfaces for Terraflow CLI
+ */
+import type { ExecutionContext } from './context';
+import type { BackendConfig, SecretsConfig, AuthConfig } from './config';
+/**
+ * Backend plugin interface
+ * Handles Terraform backend configuration
+ */
+export interface BackendPlugin {
+    /** Plugin name (must match the plugin file name) */
+    name: string;
+    /**
+     * Validate backend configuration
+     * @param config - Backend configuration to validate
+     * @throws {Error} If configuration is invalid
+     */
+    validate(config: BackendConfig): Promise<void>;
+    /**
+     * Generate Terraform backend configuration arguments
+     * @param config - Backend configuration
+     * @param context - Execution context
+     * @returns Array of backend-config arguments for terraform init
+     */
+    getBackendConfig(config: BackendConfig, context: ExecutionContext): Promise<string[]>;
+    /**
+     * Optional setup hook for backend initialization
+     * Called before terraform init
+     * @param config - Backend configuration
+     * @param context - Execution context
+     */
+    setup?(config: BackendConfig, context: ExecutionContext): Promise<void>;
+}
+/**
+ * Secrets plugin interface
+ * Retrieves secrets and converts them to TF_VAR_* environment variables
+ */
+export interface SecretsPlugin {
+    /** Plugin name (must match the plugin file name) */
+    name: string;
+    /**
+     * Validate secrets configuration
+     * @param config - Secrets configuration to validate
+     * @throws {Error} If configuration is invalid
+     */
+    validate(config: SecretsConfig): Promise<void>;
+    /**
+     * Retrieve secrets and return as TF_VAR_* environment variables
+     * All keys are automatically prefixed with TF_VAR_
+     * @param config - Secrets configuration
+     * @param context - Execution context
+     * @returns Record of environment variable key-value pairs (already prefixed with TF_VAR_)
+     */
+    getSecrets(config: SecretsConfig, context: ExecutionContext): Promise<Record<string, string>>;
+}
+/**
+ * Auth plugin interface
+ * Handles authentication and returns temporary credentials as environment variables
+ */
+export interface AuthPlugin {
+    /** Plugin name (must match the plugin file name) */
+    name: string;
+    /**
+     * Validate auth configuration
+     * @param config - Auth configuration to validate
+     * @throws {Error} If configuration is invalid
+     */
+    validate(config: AuthConfig): Promise<void>;
+    /**
+     * Authenticate and return credentials as environment variables
+     * @param config - Auth configuration
+     * @param context - Execution context
+     * @returns Record of environment variable key-value pairs for credentials
+     */
+    authenticate(config: AuthConfig, context: ExecutionContext): Promise<Record<string, string>>;
+}
+//# sourceMappingURL=plugins.d.ts.map

package/dist/types/plugins.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Plugin system interfaces for Terraflow CLI
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=plugins.js.map

package/dist/utils/cloud.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Cloud provider detection utility
+ * Detects and retrieves cloud provider information
+ */
+import type { CloudInfo } from '../types/context.js';
+/**
+ * Cloud provider detection utilities
+ */
+export declare class CloudUtils {
+    /**
+     * Detect cloud provider from environment
+     * @returns Cloud information
+     */
+    static detectCloud(): Promise<CloudInfo>;
+    /**
+     * Get AWS account ID via `aws sts get-caller-identity`
+     * @returns AWS account ID or undefined
+     */
+    static getAwsAccountId(): Promise<string | undefined>;
+    /**
+     * Get AWS region from environment variables
+     * Syncs AWS_REGION and AWS_DEFAULT_REGION
+     * Defaults to us-east-1 if not set
+     * @returns AWS region
+     */
+    static getAwsRegion(): string;
+    /**
+     * Get Azure subscription ID via `az account show`
+     * @returns Azure subscription ID or undefined
+     */
+    static getAzureSubscriptionId(): Promise<string | undefined>;
+    /**
+     * Get Azure tenant ID via `az account show`
+     * @returns Azure tenant ID or undefined
+     */
+    static getAzureTenantId(): Promise<string | undefined>;
+    /**
+     * Get GCP project ID via `gcloud config get-value project`
+     * @returns GCP project ID or undefined
+     */
+    static getGcpProjectId(): Promise<string | undefined>;
+}
+//# sourceMappingURL=cloud.d.ts.map

package/dist/utils/cloud.js

@@ -0,0 +1,150 @@
+"use strict";
+/**
+ * Cloud provider detection utility
+ * Detects and retrieves cloud provider information
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudUtils = void 0;
+const child_process_1 = require("child_process");
+/**
+ * Cloud provider detection utilities
+ */
+class CloudUtils {
+    /**
+     * Detect cloud provider from environment
+     * @returns Cloud information
+     */
+    static async detectCloud() {
+        const cloud = {
+            provider: 'none',
+        };
+        // Check for AWS
+        if (process.env.AWS_ACCESS_KEY_ID || process.env.AWS_PROFILE || process.env.AWS_REGION) {
+            cloud.provider = 'aws';
+            cloud.awsRegion = CloudUtils.getAwsRegion();
+            try {
+                cloud.awsAccountId = await CloudUtils.getAwsAccountId();
+            }
+            catch {
+                // Account ID fetch failed, continue without it
+            }
+            return cloud;
+        }
+        // Check for Azure
+        if (process.env.AZURE_CLIENT_ID || process.env.ARM_CLIENT_ID) {
+            cloud.provider = 'azure';
+            try {
+                cloud.azureSubscriptionId = await CloudUtils.getAzureSubscriptionId();
+                cloud.azureTenantId = await CloudUtils.getAzureTenantId();
+            }
+            catch {
+                // Subscription/Tenant ID fetch failed, continue without it
+            }
+            return cloud;
+        }
+        // Check for GCP
+        if (process.env.GOOGLE_APPLICATION_CREDENTIALS || process.env.GCLOUD_PROJECT) {
+            cloud.provider = 'gcp';
+            try {
+                cloud.gcpProjectId = await CloudUtils.getGcpProjectId();
+            }
+            catch {
+                // Project ID fetch failed, continue without it
+            }
+            return cloud;
+        }
+        return cloud;
+    }
+    /**
+     * Get AWS account ID via `aws sts get-caller-identity`
+     * @returns AWS account ID or undefined
+     */
+    static async getAwsAccountId() {
+        try {
+            const result = (0, child_process_1.execSync)('aws sts get-caller-identity --output json', {
+                encoding: 'utf8',
+                stdio: ['pipe', 'pipe', 'pipe'],
+            });
+            const identity = JSON.parse(result);
+            return identity.Account;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    /**
+     * Get AWS region from environment variables
+     * Syncs AWS_REGION and AWS_DEFAULT_REGION
+     * Defaults to us-east-1 if not set
+     * @returns AWS region
+     */
+    static getAwsRegion() {
+        let region = process.env.AWS_REGION || process.env.AWS_DEFAULT_REGION;
+        // Sync AWS_REGION and AWS_DEFAULT_REGION
+        if (process.env.AWS_REGION && !process.env.AWS_DEFAULT_REGION) {
+            process.env.AWS_DEFAULT_REGION = process.env.AWS_REGION;
+        }
+        else if (process.env.AWS_DEFAULT_REGION && !process.env.AWS_REGION) {
+            process.env.AWS_REGION = process.env.AWS_DEFAULT_REGION;
+        }
+        // Default to us-east-1 if not set
+        if (!region) {
+            region = 'us-east-1';
+            process.env.AWS_REGION = region;
+            process.env.AWS_DEFAULT_REGION = region;
+        }
+        return region;
+    }
+    /**
+     * Get Azure subscription ID via `az account show`
+     * @returns Azure subscription ID or undefined
+     */
+    static async getAzureSubscriptionId() {
+        try {
+            const result = (0, child_process_1.execSync)('az account show --output json', {
+                encoding: 'utf8',
+                stdio: ['pipe', 'pipe', 'pipe'],
+            });
+            const account = JSON.parse(result);
+            return account.id;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    /**
+     * Get Azure tenant ID via `az account show`
+     * @returns Azure tenant ID or undefined
+     */
+    static async getAzureTenantId() {
+        try {
+            const result = (0, child_process_1.execSync)('az account show --output json', {
+                encoding: 'utf8',
+                stdio: ['pipe', 'pipe', 'pipe'],
+            });
+            const account = JSON.parse(result);
+            return account.tenantId;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    /**
+     * Get GCP project ID via `gcloud config get-value project`
+     * @returns GCP project ID or undefined
+     */
+    static async getGcpProjectId() {
+        try {
+            const result = (0, child_process_1.execSync)('gcloud config get-value project', {
+                encoding: 'utf8',
+                stdio: ['pipe', 'pipe', 'pipe'],
+            });
+            return result.trim() || undefined;
+        }
+        catch {
+            return undefined;
+        }
+    }
+}
+exports.CloudUtils = CloudUtils;
+//# sourceMappingURL=cloud.js.map

package/dist/utils/git.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Git operations utility
+ * Provides git-related functionality for workspace derivation
+ */
+/**
+ * Git utilities for workspace derivation and VCS information
+ */
+export declare class GitUtils {
+    /**
+     * Check if current directory is in a git repository
+     * @param cwd - Working directory to check
+     * @returns True if in a git repository
+     */
+    static isGitRepository(cwd?: string): boolean;
+    /**
+     * Get current git branch name
+     * @param cwd - Working directory
+     * @returns Branch name or undefined if not in git repo or not on a branch
+     */
+    static getBranch(cwd?: string): Promise<string | undefined>;
+    /**
+     * Get current git tag if HEAD is on a tag
+     * @param cwd - Working directory
+     * @returns Tag name or undefined if not on a tag
+     */
+    static getTag(cwd?: string): Promise<string | undefined>;
+    /**
+     * Get git commit SHA (full)
+     * @param cwd - Working directory
+     * @returns Full commit SHA or undefined
+     */
+    static getCommitSha(cwd?: string): Promise<string | undefined>;
+    /**
+     * Get short git commit SHA (7 characters)
+     * @param cwd - Working directory
+     * @returns Short commit SHA or undefined
+     */
+    static getShortSha(cwd?: string): Promise<string | undefined>;
+    /**
+     * Check if git working directory is clean (no uncommitted changes)
+     * @param cwd - Working directory
+     * @returns True if working directory is clean
+     */
+    static isClean(cwd?: string): Promise<boolean>;
+    /**
+     * Get GitHub repository name from git remote (format: owner/repo)
+     * @param cwd - Working directory
+     * @returns Repository name in format "owner/repo" or undefined
+     */
+    static getGithubRepository(cwd?: string): Promise<string | undefined>;
+    /**
+     * Get GitLab project path from git remote
+     * @param cwd - Working directory
+     * @returns GitLab project path or undefined
+     */
+    static getGitlabProjectPath(cwd?: string): Promise<string | undefined>;
+    /**
+     * Parse GitHub URL to extract owner/repo
+     * Supports https://, git@, and git:// formats
+     * @param url - Git remote URL
+     * @returns Repository name in format "owner/repo" or undefined
+     */
+    static parseGithubUrl(url: string): string | undefined;
+    /**
+     * Parse GitLab URL to extract project path
+     * Supports https:// and git@ formats
+     * @param url - Git remote URL
+     * @returns GitLab project path or undefined
+     */
+    static parseGitlabUrl(url: string): string | undefined;
+    /**
+     * Check if a branch name is ephemeral (has a prefix like "feature/")
+     * Uses regex: /^[^/]+\//
+     * @param branchName - Branch name to check
+     * @returns True if branch is ephemeral
+     */
+    static isEphemeralBranch(branchName: string): boolean;
+    /**
+     * Sanitize workspace name according to spec
+     * - Remove refs/heads/ or refs/tags/ prefix
+     * - Replace invalid characters (/ and spaces) with hyphens
+     * - Result must match /^[a-zA-Z0-9_-]+$/
+     * @param name - Workspace name to sanitize
+     * @returns Sanitized workspace name
+     */
+    static sanitizeWorkspaceName(name: string): string;
+}
+//# sourceMappingURL=git.d.ts.map