ship-em 0.1.0 → 0.2.1

package/dist/lib.d.ts

@@ -0,0 +1,252 @@
+type Framework = 'nextjs' | 'vite-react' | 'vite-vue' | 'vite-svelte' | 'astro' | 'sveltekit' | 'remix' | 'nuxt' | 'gatsby' | 'create-react-app' | 'hono' | 'static-html' | 'unknown';
+type DeployTarget = 'cloudflare-pages' | 'cloudflare-workers';
+type ServerType = 'static' | 'serverless' | 'server';
+interface EnvVar {
+    name: string;
+    description: string;
+    required: boolean;
+    autoProvision?: boolean;
+    value?: string;
+}
+interface ProjectConfig {
+    name: string;
+    framework: Framework;
+    buildCommand: string;
+    outputDirectory: string;
+    installCommand: string;
+    serverType: ServerType;
+    nodeVersion?: string;
+    pythonVersion?: string;
+    envVars: EnvVar[];
+    deployTarget: DeployTarget;
+    detectedAt: string;
+    aiAnalysis?: string;
+}
+interface DeploymentState {
+    projectName: string;
+    deploymentId: string;
+    url: string;
+    cloudflareProjectName?: string;
+    cloudflareAccountId?: string;
+    deployTarget: DeployTarget;
+    deployedAt: string;
+    status: 'success' | 'building' | 'failed';
+}
+interface DeployRecord {
+    timestamp: string;
+    url: string;
+    duration: number;
+    files: number;
+    size: string;
+    framework: string;
+}
+interface PreviewRecord {
+    branch: string;
+    url: string;
+    deploymentId: string;
+    createdAt: string;
+    status: 'success' | 'building' | 'failed';
+}
+interface ShipemConfig {
+    project?: ProjectConfig;
+    deployment?: DeploymentState;
+    deployments?: DeployRecord[];
+    previews?: PreviewRecord[];
+}
+interface CloudflareCredentials {
+    apiToken: string;
+    accountId: string;
+}
+interface AuthConfig {
+    cloudflare?: CloudflareCredentials;
+    sessionToken?: string;
+}
+
+interface MonorepoInfo {
+    type: 'turbo' | 'nx' | 'pnpm-workspaces' | 'npm-workspaces' | 'yarn-workspaces';
+    packages: string[];
+}
+interface ScanResult {
+    framework: Framework;
+    buildCommand: string;
+    outputDirectory: string;
+    installCommand: string;
+    serverType: ServerType;
+    deployTarget: DeployTarget;
+    nodeVersion?: string;
+    pythonVersion?: string;
+    envVars: EnvVar[];
+    projectName: string;
+    confidence: number;
+    files: string[];
+    notes?: string;
+    monorepo?: MonorepoInfo;
+}
+declare function scanProject(cwd?: string): ScanResult;
+/** Detect if this is a monorepo and list its packages. */
+declare function detectMonorepo(cwd: string): MonorepoInfo | undefined;
+
+declare const SHIPEM_API_URL: string;
+declare function getCloudflareCredentials(): {
+    apiToken: string;
+    accountId: string;
+} | null;
+declare function getSessionToken(): string | null;
+declare function readProjectConfig(cwd?: string): ShipemConfig;
+declare function writeProjectConfig(config: ShipemConfig, cwd?: string): void;
+
+interface BuildResult {
+    success: boolean;
+    outputDirectory: string;
+    durationMs: number;
+    error?: string;
+}
+declare function buildProject(config: ProjectConfig, cwd?: string): Promise<BuildResult>;
+
+interface CFProject {
+    id: string;
+    name: string;
+    subdomain: string;
+    domains: string[];
+    latest_deployment?: {
+        id: string;
+        url: string;
+        latest_stage: {
+            name: string;
+            status: string;
+        };
+    };
+}
+interface CFDeployment {
+    id: string;
+    url: string;
+    latest_stage: {
+        name: string;
+        status: string;
+    };
+    stages: Array<{
+        name: string;
+        status: string;
+        started_on: string | null;
+        ended_on: string | null;
+    }>;
+}
+declare class CloudflarePages {
+    private client;
+    private accountId;
+    constructor(apiToken: string, accountId: string);
+    getOrCreateProject(projectName: string, config: ProjectConfig): Promise<CFProject>;
+    setEnvironmentVariables(projectName: string, envVars: Record<string, string>): Promise<void>;
+    deployDirectory(projectName: string, outputDir: string, cwd?: string): Promise<{
+        deployment: CFDeployment;
+        fileCount: number;
+        totalBytes: number;
+    }>;
+    deployBranch(projectName: string, outputDir: string, branch: string, cwd?: string): Promise<{
+        deployment: CFDeployment;
+        fileCount: number;
+        totalBytes: number;
+    }>;
+    waitForDeployment(projectName: string, deploymentId: string, timeoutMs?: number): Promise<CFDeployment>;
+    getDeploymentStatus(projectName: string, deploymentId: string): Promise<CFDeployment | null>;
+    getDeploymentLogs(projectName: string, deploymentId: string): Promise<string[]>;
+    deleteProject(projectName: string): Promise<void>;
+    getProjectUrl(projectName: string): string;
+    getDashboardUrl(projectName: string): string;
+    validateCredentials(): Promise<{
+        valid: boolean;
+        accountName?: string;
+    }>;
+}
+declare function sanitizeProjectName(name: string): string;
+
+/**
+ * Error hierarchy for Shipem CLI.
+ *
+ * All Shipem errors extend ShipemError so callers can distinguish
+ * between expected operational errors and unexpected bugs.
+ */
+declare class ShipemError extends Error {
+    /** Machine-readable error code for programmatic consumers (--json mode). */
+    readonly code: string;
+    /** Suggested exit code: 1 = user error, 2 = system/infra error. */
+    readonly exitCode: number;
+    constructor(message: string, opts?: {
+        code: string;
+        exitCode?: number;
+        cause?: unknown;
+    });
+}
+/** Network-level failures (DNS, timeout, connection refused). */
+declare class NetworkError extends ShipemError {
+    constructor(message: string, opts?: {
+        cause?: unknown;
+    });
+}
+/** Authentication / authorization failures. */
+declare class AuthError extends ShipemError {
+    constructor(message: string, opts?: {
+        cause?: unknown;
+    });
+}
+/** Deployment failures (Cloudflare API, Fly.io, upload errors). */
+declare class DeployError extends ShipemError {
+    constructor(message: string, opts?: {
+        cause?: unknown;
+    });
+}
+/** Build-step failures (install or compile). */
+declare class BuildError extends ShipemError {
+    constructor(message: string, opts?: {
+        cause?: unknown;
+    });
+}
+/** Configuration errors (missing config, bad env vars, corrupt files). */
+declare class ConfigError extends ShipemError {
+    constructor(message: string, opts?: {
+        cause?: unknown;
+    });
+}
+
+/** Run the fix logic on a build error. Returns actions taken. */
+declare function runFixHeuristics(errorOutput: string, cwd: string, config: ProjectConfig): Promise<{
+    actions: string[];
+    fixed: boolean;
+}>;
+
+/** Scan source files for env var references. */
+declare function scanSourceForEnvVars(cwd: string): string[];
+/** Read env vars from .env file (keys only). */
+declare function readEnvFile(cwd: string): Set<string>;
+
+interface FrameworkChoice {
+    name: string;
+    value: string;
+    createCmd: string[];
+    keywords: string[];
+}
+declare const FRAMEWORKS: FrameworkChoice[];
+/** Match description to best framework using keyword scoring. */
+declare function matchFramework(description: string): FrameworkChoice;
+/** Generate a project name from description. */
+declare function generateProjectName(description: string): string;
+
+/** Detect the current git branch. */
+declare function getCurrentBranch(): Promise<string>;
+/** Sanitise a git branch name into a valid CF Pages branch slug. */
+declare function sanitizeBranchName(branch: string): string;
+
+interface Template {
+    name: string;
+    description: string;
+    framework: string;
+    createCmd: string[];
+    postScaffold?: string[];
+}
+declare const TEMPLATES: Template[];
+/** Look up a template by name (case-insensitive). */
+declare function getTemplate(name: string): Template | undefined;
+/** List all available template names. */
+declare function getTemplateNames(): string[];
+
+export { type AuthConfig, AuthError, BuildError, type BuildResult, type CloudflareCredentials, CloudflarePages, ConfigError, DeployError, type DeployRecord, type DeployTarget, type DeploymentState, type EnvVar, FRAMEWORKS, type Framework, type FrameworkChoice, type MonorepoInfo, NetworkError, type PreviewRecord, type ProjectConfig, SHIPEM_API_URL, type ServerType, type ShipemConfig, ShipemError, TEMPLATES, type Template, buildProject, detectMonorepo, generateProjectName, getCloudflareCredentials, getCurrentBranch, getSessionToken, getTemplate, getTemplateNames, matchFramework, readEnvFile, readProjectConfig, runFixHeuristics, sanitizeBranchName, sanitizeProjectName, scanProject, scanSourceForEnvVars, writeProjectConfig };