@farthershore/cli 0.3.7 → 0.3.8

package/dist/output.js

@@ -0,0 +1,28 @@
+// 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.js

@@ -0,0 +1,53 @@
+// ---------------------------------------------------------------------------
+// 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

@@ -33,6 +33,8 @@ export type Plan = BuilderPlan;
 export type CliConfig = {
     apiUrl: string;
     activeOrg?: string;
+    activeProductId?: string;
+    activeProductName?: string;
     defaultFormat?: "table" | "json" | "yaml";
 };
 export type Credentials = {

package/dist/types.js

@@ -0,0 +1,23 @@
+// 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;
+    }
+}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@farthershore/cli",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "FartherShore CLI — create and configure API products",
   "type": "module",
   "bin": {
-    "farthershore": "./dist/index.js"
+    "farthershore": "dist/index.js"
   },
   "files": [
     "dist"
@@ -17,13 +17,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/farther-shore/farthershore.git"
+    "url": "git+https://github.com/farther-shore/farthershore.git"
   },
   "scripts": {
     "dev": "tsx src/index.ts",
-    "build": "rm -rf dist && npm run build:types && npm run build:bundle",
-    "build:types": "tsc --emitDeclarationOnly",
-    "build:bundle": "esbuild src/index.ts --bundle --platform=node --format=esm --target=node22 --outfile=dist/index.js --external:chalk --external:commander --external:yaml --external:zod && chmod +x dist/index.js",
+    "build": "tsc",
     "prepublishOnly": "npm run build",
     "test": "vitest run",
     "lint": "prettier --check \"src/**/*.ts\" && eslint .",
@@ -41,15 +39,14 @@
   "author": "Farther Shore",
   "license": "MIT",
   "dependencies": {
+    "@farther-shore/shared-types": "^0.28.2",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
     "yaml": "^2.8.3",
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@farther-shore/shared-types": "^0.28.2",
     "@types/node": "^22.19.17",
-    "esbuild": "^0.28.0",
     "eslint": "^9.39.4",
     "eslint-plugin-sonarjs": "^4.0.3",
     "prettier": "^3.8.1",