@farthershore/cli 0.3.9 → 0.3.11

package/dist/commands/validate.js

@@ -1,216 +0,0 @@
-import { readFileSync, existsSync } from "node:fs";
-import { execSync } from "node:child_process";
-import { resolve } from "node:path";
-import YAML from "yaml";
-import { productSpecSchema, } from "@farther-shore/shared-types/plans";
-import * as output from "../output.js";
-const CI = !!process.env.CI || !!process.env.GITHUB_ACTIONS;
-/**
- * Read product.yaml from the main branch using git, without checking it out.
- * Returns null if not in a git repo or main doesn't have the file.
- */
-function readMainBranchProductName() {
-    for (const branch of ["main", "master"]) {
-        try {
-            const yaml = execSync(`git show ${branch}:product.yaml 2>/dev/null`, {
-                encoding: "utf-8",
-                stdio: ["pipe", "pipe", "pipe"],
-            });
-            const spec = YAML.parse(yaml);
-            const product = spec.product;
-            return product?.name ?? null;
-        }
-        catch {
-            continue;
-        }
-    }
-    return null;
-}
-/**
- * Validate a parsed YAML object against the canonical Zod schema.
- *
- * Errors are returned in the same `Plan "key": message` shape the previous
- * hand-rolled checks produced, so existing CI output stays grep-friendly.
- * Warnings cover product-quality nudges (no free plan, missing display name)
- * that don't fail the schema parse but are worth flagging.
- */
-export function validateProductYaml(spec) {
-    const result = productSpecSchema.safeParse(spec);
-    if (!result.success) {
-        return {
-            valid: false,
-            errors: result.error.issues.map((issue) => formatIssue(issue, spec)),
-            warnings: [],
-        };
-    }
-    const warnings = deriveWarnings(result.data);
-    // Schema doesn't enforce duplicate plan keys (it would conflict with the
-    // discriminated-union design). Detect here as a separate check so the CLI
-    // surfaces this footgun before the server rejects the apply.
-    const dupeKeys = findDuplicatePlanKeys(result.data);
-    if (dupeKeys.length > 0) {
-        return {
-            valid: false,
-            errors: [`Duplicate plan keys: ${dupeKeys.join(", ")}`],
-            warnings,
-        };
-    }
-    return { valid: true, errors: [], warnings };
-}
-function formatIssue(issue, spec) {
-    const path = issue.path;
-    // Plans are addressed positionally in path (e.g. ["plans", 0, "key"]). Look
-    // up the plan key from the spec so the error message reads
-    // `Plan "starter": pricing is required` instead of `plans.0.pricing: ...`.
-    if (path.length >= 2 && path[0] === "plans" && typeof path[1] === "number") {
-        const plans = spec?.plans ?? [];
-        const plan = plans[path[1]];
-        const planLabel = plan?.key ?? plan?.name ?? `#${path[1]}`;
-        const fieldPath = path.slice(2).join(".");
-        if (fieldPath) {
-            return `Plan "${planLabel}": ${fieldPath} — ${issue.message}`;
-        }
-        return `Plan "${planLabel}": ${issue.message}`;
-    }
-    const dotted = path.length > 0 ? path.join(".") : "(root)";
-    return `${dotted}: ${issue.message}`;
-}
-function deriveWarnings(parsed) {
-    const warnings = [];
-    if (parsed.plans.length === 0) {
-        // Schema accepts an empty plan list (default), but a product with no
-        // plans can't go live — surface as a warning so the builder sees the
-        // requirement before pushing.
-        warnings.push("No plans declared — product cannot accept signups yet");
-    }
-    else {
-        const hasFree = parsed.plans.some((plan) => {
-            const monthly = "monthlyPriceCents" in plan.pricing
-                ? plan.pricing.monthlyPriceCents
-                : undefined;
-            return monthly === 0;
-        });
-        if (!hasFree) {
-            warnings.push("No free plan — consider adding one for developer adoption");
-        }
-    }
-    if (!parsed.product.displayName ||
-        parsed.product.displayName === parsed.product.name) {
-        warnings.push("product.displayName not set — using product.name on the pricing page");
-    }
-    return warnings;
-}
-function findDuplicatePlanKeys(parsed) {
-    const seen = new Set();
-    const dupes = new Set();
-    for (const plan of parsed.plans) {
-        if (seen.has(plan.key)) {
-            dupes.add(plan.key);
-        }
-        else {
-            seen.add(plan.key);
-        }
-    }
-    return [...dupes];
-}
-/**
- * Read + parse a product.yaml file. Returns either the parsed spec or
- * a structured error result. Extracted from the validate command so
- * the action handler stays under the cognitive-complexity threshold.
- */
-export function loadProductYaml(filePath) {
-    if (!existsSync(filePath)) {
-        return { ok: false, reason: "missing", message: filePath };
-    }
-    try {
-        const content = readFileSync(filePath, "utf-8");
-        return { ok: true, spec: YAML.parse(content) };
-    }
-    catch (err) {
-        return {
-            ok: false,
-            reason: "parse",
-            message: err instanceof Error ? err.message : String(err),
-        };
-    }
-}
-/**
- * Print a ValidationResult to stdout, optionally emitting GitHub
- * Actions annotations. Sets `process.exitCode = 1` on validation
- * failure so the CLI exits non-zero.
- */
-function reportValidationResult(result) {
-    if (CI) {
-        for (const err of result.errors) {
-            console.log(`::error file=product.yaml::${err}`);
-        }
-        for (const w of result.warnings) {
-            console.log(`::warning file=product.yaml::${w}`);
-        }
-    }
-    if (result.errors.length === 0) {
-        output.success("product.yaml is valid");
-        for (const w of result.warnings) {
-            output.warn(w);
-        }
-        return;
-    }
-    output.error(`product.yaml has ${result.errors.length} error(s):\n`);
-    for (const err of result.errors) {
-        console.log(`  • ${err}`);
-    }
-    if (result.warnings.length > 0) {
-        console.log();
-        for (const w of result.warnings) {
-            output.warn(w);
-        }
-    }
-    process.exitCode = 1;
-}
-export function registerValidateCommand(program) {
-    program
-        .command("validate [file]")
-        .description("Validate a local product.yaml file without API calls")
-        .addHelpText("after", `
-Agent notes:
-  Use validate before committing product.yaml changes. This is local schema validation only.
-  Use apply --dry-run for remote compiler validation against pushed branch state.
-
-Examples:
-  farthershore validate
-  farthershore validate product.yaml
-  farthershore apply --dry-run --format json
-`)
-        // Action body is sync; commander only requires a thenable on
-        // .action when await is used. Drop `async` keyword.
-        .action((file) => {
-        const filePath = resolve(file ?? "product.yaml");
-        const loaded = loadProductYaml(filePath);
-        if (!loaded.ok) {
-            if (loaded.reason === "missing") {
-                if (CI)
-                    console.log(`::error file=product.yaml::File not found: ${loaded.message}`);
-                output.error(`File not found: ${loaded.message}`);
-            }
-            else {
-                if (CI)
-                    console.log(`::error file=product.yaml::YAML parse error: ${loaded.message}`);
-                output.error(`Failed to parse YAML: ${loaded.message}`);
-            }
-            process.exitCode = 1;
-            return;
-        }
-        const result = validateProductYaml(loaded.spec);
-        // Check product.name consistency against main branch
-        const currentName = loaded.spec
-            ?.product?.name;
-        if (currentName) {
-            const mainName = readMainBranchProductName();
-            if (mainName && mainName !== currentName) {
-                result.errors.push(`product.name "${currentName}" differs from main branch "${mainName}" — product name must not change`);
-                result.valid = false;
-            }
-        }
-        reportValidationResult(result);
-    });
-}

package/dist/config.d.ts

@@ -1,6 +0,0 @@
-import type { CliConfig, Credentials } from "./types.js";
-export declare function loadConfig(): CliConfig;
-export declare function saveConfig(config: Partial<CliConfig>): void;
-export declare function loadCredentials(): Credentials | null;
-export declare function saveCredentials(creds: Credentials): void;
-export declare function clearCredentials(): void;

package/dist/config.js

@@ -1,58 +0,0 @@
-// ~/.farthershore/ config management
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
-import { homedir } from "node:os";
-import { join } from "node:path";
-import { BUILD_API_URL } from "./build-info.js";
-const CONFIG_DIR = join(homedir(), ".farthershore");
-const CONFIG_FILE = join(CONFIG_DIR, "config.json");
-const CREDENTIALS_FILE = join(CONFIG_DIR, "credentials.json");
-function ensureDir(dir) {
-    if (!existsSync(dir))
-        mkdirSync(dir, { recursive: true, mode: 0o700 });
-}
-// --- Config ---
-const DEFAULT_CONFIG = {
-    apiUrl: BUILD_API_URL,
-    defaultFormat: "table",
-};
-export function loadConfig() {
-    ensureDir(CONFIG_DIR);
-    if (!existsSync(CONFIG_FILE))
-        return DEFAULT_CONFIG;
-    try {
-        // JSON.parse → `any`; cast to a partial of the typed shape so the
-        // spread doesn't propagate `any` into the returned union.
-        const parsed = JSON.parse(readFileSync(CONFIG_FILE, "utf-8"));
-        return { ...DEFAULT_CONFIG, ...parsed };
-    }
-    catch {
-        return DEFAULT_CONFIG;
-    }
-}
-export function saveConfig(config) {
-    ensureDir(CONFIG_DIR);
-    const current = loadConfig();
-    writeFileSync(CONFIG_FILE, JSON.stringify({ ...current, ...config }, null, 2) + "\n");
-}
-// --- Credentials ---
-export function loadCredentials() {
-    if (!existsSync(CREDENTIALS_FILE))
-        return null;
-    try {
-        return JSON.parse(readFileSync(CREDENTIALS_FILE, "utf-8"));
-    }
-    catch {
-        return null;
-    }
-}
-export function saveCredentials(creds) {
-    ensureDir(CONFIG_DIR);
-    writeFileSync(CREDENTIALS_FILE, JSON.stringify(creds, null, 2) + "\n", {
-        mode: 0o600,
-    });
-}
-export function clearCredentials() {
-    if (existsSync(CREDENTIALS_FILE)) {
-        writeFileSync(CREDENTIALS_FILE, "{}");
-    }
-}

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/output.d.ts

@@ -1,8 +0,0 @@
-export declare function json(data: unknown): string;
-export declare function success(msg: string): void;
-export declare function error(msg: string): void;
-export declare function warn(msg: string): void;
-export declare function info(msg: string): void;
-export declare function heading(msg: string): void;
-export declare function isTTY(): boolean;
-export declare function outputFormat(flagFormat: string | undefined): "table" | "json";

package/dist/output.js

@@ -1,28 +0,0 @@
-// Output formatting: tables, JSON, colors
-import chalk from "chalk";
-export function json(data) {
-    return JSON.stringify(data, null, 2);
-}
-export function success(msg) {
-    console.log(chalk.green(`✓ ${msg}`));
-}
-export function error(msg) {
-    console.error(chalk.red(`✗ ${msg}`));
-}
-export function warn(msg) {
-    console.warn(chalk.yellow(`⚠ ${msg}`));
-}
-export function info(msg) {
-    console.log(chalk.dim(msg));
-}
-export function heading(msg) {
-    console.log(chalk.bold(msg));
-}
-export function isTTY() {
-    return process.stdout.isTTY === true;
-}
-export function outputFormat(flagFormat) {
-    if (flagFormat === "json" || flagFormat === "table")
-        return flagFormat;
-    return isTTY() ? "table" : "json";
-}

package/dist/remediation.d.ts

@@ -1,6 +0,0 @@
-/**
- * Look up a one-line remediation hint for a server error code. Returns
- * `undefined` if no hint is registered — callers should treat that as
- * "show no hint" rather than a fallback string.
- */
-export declare function getRemediation(code: string | undefined): string | undefined;

package/dist/remediation.js

@@ -1,53 +0,0 @@
-// ---------------------------------------------------------------------------
-// Per-error-code remediation hints.
-//
-// When `core` returns a 4XX/5XX with a known `error.code`, the CLI prints
-// the code alongside the message AND a 1-line "next step" so users (and
-// agents) don't have to grep docs to figure out what to do.
-//
-// Codes are kept as raw strings — the CLI doesn't depend on the SDK, and
-// pulling in `@farther-shore/sdk` just for a string union would be more
-// coupling than this is worth. If a code is missing here, no remediation
-// is shown — fail-safe, never wrong.
-// ---------------------------------------------------------------------------
-const REMEDIATIONS = {
-    // --- Auth ---
-    UNAUTHORIZED: "Token is invalid or revoked. Run `farthershore set-key` to update it.",
-    FORBIDDEN: "Your token doesn't have access to this resource. Check the org / product scope.",
-    INVALID_ACCESS_KEY: "Token format is wrong. Generate a new one at https://farthershore.com/settings/tokens.",
-    MAKER_TOKEN_REVOKED: "This maker token was revoked. Mint a new one in the product settings.",
-    MAKER_TOKEN_NO_PRODUCT: "Maker token is not bound to a product. Re-create it from the product page.",
-    // --- Stripe ---
-    STRIPE_NOT_CONFIGURED: "Stripe isn't connected on this product. Connect it in the dashboard before running billing operations.",
-    STRIPE_BALANCE_OUTSTANDING: "Customer has an outstanding balance. Resolve the invoice in Stripe before retrying.",
-    CHECKOUT_SESSION_FAILED: "Stripe rejected the checkout request. Check that the plan exists and Stripe credentials are valid.",
-    // --- Product / config ---
-    PRODUCT_NOT_FOUND: "Check the product slug. Run `farthershore` (no args) for a list of products you can see.",
-    PRODUCT_REPO_NOT_LINKED: "Link a GitHub repo to this product before running `apply`.",
-    PRODUCT_YAML_NOT_FOUND: "No product.yaml on the target branch. Push a config file before running `apply`.",
-    YAML_PARSE_ERROR: "product.yaml is not valid YAML. Run `farthershore validate` locally to see the parse error.",
-    GITHUB_NOT_CONNECTED: "Connect GitHub on the org page before running `init` (it provisions the repo).",
-    BRANCH_NO_MATCHING_ENV: "The current branch isn't mapped to an environment. Add a branch rule in product settings or pass --branch explicitly.",
-    // --- Plans / pricing ---
-    PLAN_NOT_FOUND: "Plan key doesn't exist on this product. Check `plans:` in product.yaml.",
-    PLAN_HAS_ACTIVE_SUBSCRIPTIONS: "Plan has active subscribers and can't be deleted. Migrate them to another plan first.",
-    PLAN_SLUG_CONFLICT: "Another plan already uses this key. Pick a unique key in product.yaml.",
-    SLUG_CONFLICT: "This product slug is taken. Pick a different name.",
-    SLUG_BLOCKED: "This slug is reserved or blocked. Pick a different name.",
-    SLUG_RESERVED: "This slug is reserved by Farther Shore. Pick a different name.",
-    SLUG_INVALID_FORMAT: "Slug must be lowercase letters, digits, and hyphens (no leading/trailing hyphen).",
-    // --- Generic ---
-    RATE_LIMIT_EXCEEDED: "You've hit the rate limit. Wait a moment and retry.",
-    VALIDATION_ERROR: "Request is malformed. The `details` field has the field-level errors.",
-    CONFLICT: "The resource is in a state that conflicts with the request. Inspect `details` to learn more.",
-};
-/**
- * Look up a one-line remediation hint for a server error code. Returns
- * `undefined` if no hint is registered — callers should treat that as
- * "show no hint" rather than a fallback string.
- */
-export function getRemediation(code) {
-    if (!code)
-        return undefined;
-    return REMEDIATIONS[code];
-}

package/dist/types.d.ts

@@ -1,75 +0,0 @@
-import type { BuilderPlan } from "@farther-shore/shared-types/plans";
-/**
- * Diagnostic emitted by core's /compile endpoints. The `compiledPlanId` and
- * `planKey` fields (added in core v0.14.0) scope a diagnostic to a specific
- * plan; both stay optional so diagnostics from older core builds still
- * typecheck while the new shape rolls out.
- */
-export type CompileDiagnostic = {
-    code?: string;
-    message: string;
-    compiledPlanId?: string;
-    planKey?: string;
-};
-export type Product = {
-    id: string;
-    name: string;
-    displayName?: string | null;
-    description: string | null;
-    baseUrl: string;
-    status: "DRAFT" | "ACTIVE";
-    runtimeHostname?: string | null;
-    portalHostname?: string | null;
-    createdAt: string;
-    plans: Plan[];
-};
-/**
- * `Plan` here is the canonical shared-types `BuilderPlan` projection: a
- * `PlanSpec` extended with server-owned fields (id, productId, environmentId,
- * isActive, createdAt). Adding a field to `planSpecSchema` automatically
- * surfaces it on this type — drift between CLI and server is a compile error.
- */
-export type Plan = BuilderPlan;
-export type CliConfig = {
-    apiUrl: string;
-    activeOrg?: string;
-    activeProductId?: string;
-    activeProductName?: string;
-    defaultFormat?: "table" | "json" | "yaml";
-};
-export type Credentials = {
-    token: string;
-    orgId?: string;
-    userId?: string;
-};
-export type InitProductResponse = {
-    product: Product;
-    repo: {
-        fullName: string;
-        htmlUrl: string;
-        cloneUrl: string;
-    } | null;
-    agent: {
-        instructions: string;
-        agentsMdUrl: string | null;
-    };
-};
-/**
- * Error thrown by the CLI for any non-success path. Carries the canonical
- * `code` from core's `{ error: { code, message, details? } }` envelope so
- * the global error handler can print the code alongside the message and
- * dispatch a remediation hint when one is registered for that code.
- *
- * `code`/`details` are optional because the same class also gets thrown for
- * local (non-API) failures — e.g. "no token configured" — where there's no
- * server-side code to surface.
- */
-export declare class CliError extends Error {
-    status?: number | undefined;
-    readonly code?: string;
-    readonly details?: Record<string, unknown>;
-    constructor(message: string, status?: number | undefined, extra?: {
-        code?: string;
-        details?: Record<string, unknown>;
-    });
-}

package/dist/types.js

@@ -1,23 +0,0 @@
-// Shared types for the FartherShore CLI
-/**
- * Error thrown by the CLI for any non-success path. Carries the canonical
- * `code` from core's `{ error: { code, message, details? } }` envelope so
- * the global error handler can print the code alongside the message and
- * dispatch a remediation hint when one is registered for that code.
- *
- * `code`/`details` are optional because the same class also gets thrown for
- * local (non-API) failures — e.g. "no token configured" — where there's no
- * server-side code to surface.
- */
-export class CliError extends Error {
-    status;
-    code;
-    details;
-    constructor(message, status, extra) {
-        super(message);
-        this.status = status;
-        this.name = "CliError";
-        this.code = extra?.code;
-        this.details = extra?.details;
-    }
-}