refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wyattjoh merged 10 commits into from
May 21, 2026
Merged

refactor(errors): expose structured Clerk error fields on ApiError subclasses #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
df59e61
refactor(errors): parse Clerk error envelope into structured ApiError…
wyattjoh May 13, 2026
d815e83
feat(errors): add fromResponse factories to ApiError subclasses
wyattjoh May 13, 2026
018074c
refactor(plapi): construct PlapiError via fromResponse
wyattjoh May 13, 2026
add37f3
refactor(fapi): construct FapiError via fromResponse
wyattjoh May 13, 2026
e8054a4
refactor(keyless): construct BapiError via fromResponse
wyattjoh May 13, 2026
1361bbb
refactor(bapi): construct BapiError via fromResponse
wyattjoh May 13, 2026
ccd7381
refactor(users): construct BapiError via fromResponse
wyattjoh May 13, 2026
a1356dc
test: construct ApiError subclasses via fromBody in fixtures
wyattjoh May 13, 2026
162f269
refactor(cli): read structured ApiError fields in the global handler
wyattjoh May 13, 2026
4ab06d7
fix(errors): guard parseApiBody against null/non-object JSON bodies
wyattjoh May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 31 additions & 30 deletions packages/cli-core/src/cli-program.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Your plan does not support these features");
expect(result).toContain("Unsupported features: saml, custom_roles");
});
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Unknown config key: sesion");
expect(result).toContain("Did you mean: session");
expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("This feature is not enabled on this instance");
expect(result).toContain("Feature: organizations");
});
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Invalid value for session.lifetime");
expect(result).toContain("Parameter: session.lifetime");
});
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Cannot clear this key");
expect(result).toContain("Parameter: sign_up.mode");
});
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Value is not in the allowed set");
expect(result).toContain("Parameter: branding.logo_url");
});

// --- Multiple errors ---
// The structured path reads from the first parsed error only.

test("formats multiple errors joined by newlines", () => {
test("formats multiple errors: surfaces first error with its meta", () => {
const body = JSON.stringify({
errors: [
{
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toContain("Invalid session lifetime");
expect(result).toContain("Unknown key: bogus");
expect(result).toContain("Did you mean: session");
// Two errors separated by newline
const lines = result.split("\n");
expect(lines.length).toBeGreaterThanOrEqual(2);
expect(result).toContain("Parameter: session.lifetime");
});

// --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
const body = JSON.stringify({
errors: [{ code: "resource_not_found", message: "Instance not found" }],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("Instance not found");
});

// --- Fallback paths ---
// --- Bodies without a Clerk errors array ---
// parseApiBody falls back to truncateBody(body) as the message when there
// is no errors[0], so formatStructuredError returns the truncated body string.

test("falls back to parsed.error when no errors array", () => {
test("returns truncated body when no errors array (error field only)", () => {
const body = JSON.stringify({ error: "Something went wrong" });
const result = formatApiBody(body, false);
expect(result).toBe("Something went wrong");
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe(body);
});

test("falls back to parsed.message when no errors array or error field", () => {
test("returns truncated body when no errors array (message field only)", () => {
const body = JSON.stringify({ message: "Bad request" });
const result = formatApiBody(body, false);
expect(result).toBe("Bad request");
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe(body);
});

test("truncates non-JSON body over 200 chars", () => {
const body = "x".repeat(300);
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("x".repeat(200) + "...");
});

test("returns short non-JSON body as-is", () => {
const result = formatApiBody("Bad Request", false);
const result = formatApiBody(new ApiError(400, "Bad Request"), false);
expect(result).toBe("Bad Request");
});

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
test("verbose mode returns full pretty-printed JSON", () => {
const obj = { errors: [{ code: "test", message: "test msg" }] };
const body = JSON.stringify(obj);
const result = formatApiBody(body, true);
const result = formatApiBody(new ApiError(400, body), true);
expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
});

test("verbose mode returns raw body for non-JSON", () => {
const result = formatApiBody("not json", true);
const result = formatApiBody(new ApiError(400, "not json"), true);
expect(result).toBe("\nnot json");
});

// --- Edge cases ---

test("handles empty errors array by falling through", () => {
test("handles empty errors array by returning truncated body", () => {
const body = JSON.stringify({ errors: [], message: "fallback" });
const result = formatApiBody(body, false);
expect(result).toBe("fallback");
const result = formatApiBody(new ApiError(400, body), false);
// No errors[0] so parseApiBody falls back to truncateBody(body)
expect(result).toBe(body);
});

test("handles error with empty meta", () => {
const body = JSON.stringify({
errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("Bad value");
});

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
},
],
});
const result = formatApiBody(body, false);
const result = formatApiBody(new ApiError(400, body), false);
expect(result).toBe("Plan limitation");
});
});
Expand Down
82 changes: 23 additions & 59 deletions packages/cli-core/src/cli-program.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
if (verbose) {
try {
return "\n" + JSON.stringify(JSON.parse(body), null, 2);
return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
} catch {
return "\n" + body;
return "\n" + error.body;
}
}

try {
const parsed = JSON.parse(body);
if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
return parsed.errors.map(formatSingleError).join("\n");
}
if (parsed.error) return parsed.error;
if (parsed.message) return parsed.message;
} catch {
// not JSON
}

if (body.length > 200) return body.slice(0, 200) + "...";
return body;
return formatStructuredError(error);
}

function formatSingleError(err: {
message?: string;
code?: string;
meta?: Record<string, unknown>;
}): string {
let msg = err.message ?? "Unknown error";
const meta = err.meta;
function formatStructuredError(error: ApiError): string {
let msg = error.message;
const { meta, code } = error;
if (!meta) return msg;

switch (err.code) {
switch (code) {
case "unsupported_subscription_plan_features": {
const features = meta.unsupported_features;
if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
break;
}
}

return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
}

if (error instanceof ApiError) {
const detail = formatApiBody(error.body, verbose);
const detail = formatApiBody(error, verbose);
const prefix = error.context ?? "Request failed";
if (isAgent()) {
const apiCode = extractApiErrorCode(error.body);
const apiErrors = extractApiErrors(error.body);
const apiErrors: ApiErrorEntry[] | undefined =
error.code || error.meta
? [
{
...(error.code ? { code: error.code } : {}),
...(error.message ? { message: error.message } : {}),
...(error.meta ? { meta: error.meta } : {}),
},
]
: undefined;
outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
`${prefix} (${error.status}): ${detail}`,
undefined,
apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
log.error(` URL: ${error.url}`);
}
if (verbose && error.clerkTraceId) {
log.error(` Trace: ${error.clerkTraceId}`);
}
}
process.exit(EXIT_CODE.GENERAL);
}
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
if (errors?.length) payload.error.errors = errors;
log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
try {
const parsed = JSON.parse(body);
return parsed.errors?.[0]?.code;
} catch {
return undefined;
}
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
try {
const parsed = JSON.parse(body);
if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
return parsed.errors.map((e: ApiErrorEntry) => {
const entry: ApiErrorEntry = {};
if (e.code) entry.code = e.code;
if (e.message) entry.message = e.message;
if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
return entry;
});
}
} catch {
// not JSON
}
return undefined;
}
6 changes: 3 additions & 3 deletions packages/cli-core/src/commands/api/bapi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
body: options.body,
});

const rawBody = await response.text();

if (!response.ok) {
throw new BapiError(response.status, rawBody, response.headers);
throw await BapiError.fromResponse(response);
}

const rawBody = await response.text();

let body: unknown;
try {
body = JSON.parse(rawBody);
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-core/src/commands/config/pull.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
instances: { development: "ins_dev" },
});

await expect(runConfigPull()).rejects.toThrow("API error");
await expect(runConfigPull()).rejects.toThrow("Unauthorized");
});
});
2 changes: 1 addition & 1 deletion packages/cli-core/src/commands/config/push.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
instances: { development: "ins_dev" },
});

await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
});

test("shows success message after push", async () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-core/src/commands/config/schema.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
instances: { development: "ins_dev" },
});

await expect(runConfigSchema()).rejects.toThrow("API error");
await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
});
});
2 changes: 1 addition & 1 deletion packages/cli-core/src/commands/doctor/doctor.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
const ctx = createMockContext({
token: "test_token",
profile: mockProfile,
applicationError: new PlapiError(404, "Not found"),
applicationError: PlapiError.fromBody(404, "Not found"),
});
const result = await checkLinkedAppExists(ctx);
expectCheck(result, {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-core/src/commands/env/pull.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
instances: { development: "ins_dev" },
});

await expect(runEnvPull()).rejects.toThrow("API error");
await expect(runEnvPull()).rejects.toThrow("Unauthorized");
});

test("sends include_secret_keys=true in API request", async () => {
Expand Down
8 changes: 4 additions & 4 deletions packages/cli-core/src/commands/link/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
test("shows picker with only create option when listApplications fails with 500", async () => {
mockIsAgent.mockReturnValue(false);
mockGetToken.mockResolvedValue("token");
mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
mockSearch.mockImplementation(
async (config: {
source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
test("propagates listApplications errors that are not 5xx", async () => {
mockIsAgent.mockReturnValue(false);
mockGetToken.mockResolvedValue("token");
mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
});
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
mockListApplications.mockResolvedValue([mockApp]);
mockSearch.mockResolvedValue("__create_new__");
mockInput.mockResolvedValue("My App");
mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

await expect(link()).rejects.toBeInstanceOf(PlapiError);
expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
name: "My App",
instances: [],
});
mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

await expect(link()).rejects.toBeInstanceOf(PlapiError);
expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 10 commits into

from

May 21, 2026
 Merged


refactor(errors): expose structured Clerk error fields on ApiError subclasses
#288
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
df59e61

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
d815e83

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
018074c

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
add37f3

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
e8054a4

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
1361bbb

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
ccd7381

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
a1356dc

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
162f269

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
4ab06d7

fix(errors): guard parseApiBody against null/non-object JSON bodies


wyattjoh May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down

82 changes: 23 additions & 59 deletions
packages/cli-core/src/cli-program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
 return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
 if (verbose) {
 try {
 return "\n" + JSON.stringify(JSON.parse(body), null, 2);
 return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
 } catch {
 return "\n" + body;
 return "\n" + error.body;
 }
 }

 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map(formatSingleError).join("\n");
 }
 if (parsed.error) return parsed.error;
 if (parsed.message) return parsed.message;
 } catch {
 // not JSON
 }

 if (body.length > 200) return body.slice(0, 200) + "...";
 return body;
 return formatStructuredError(error);
}

function formatSingleError(err: {
 message?: string;
 code?: string;
 meta?: Record<string, unknown>;
}): string {
 let msg = err.message ?? "Unknown error";
 const meta = err.meta;
function formatStructuredError(error: ApiError): string {
 let msg = error.message;
 const { meta, code } = error;
 if (!meta) return msg;

 switch (err.code) {
 switch (code) {
 case "unsupported_subscription_plan_features": {
 const features = meta.unsupported_features;
 if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
 break;
 }
 }

 return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
 }

 if (error instanceof ApiError) {
 const detail = formatApiBody(error.body, verbose);
 const detail = formatApiBody(error, verbose);
 const prefix = error.context ?? "Request failed";
 if (isAgent()) {
 const apiCode = extractApiErrorCode(error.body);
 const apiErrors = extractApiErrors(error.body);
 const apiErrors: ApiErrorEntry[] | undefined =
 error.code || error.meta
 ? [
 {
 ...(error.code ? { code: error.code } : {}),
 ...(error.message ? { message: error.message } : {}),
 ...(error.meta ? { meta: error.meta } : {}),
 },
 ]
 : undefined;
 outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
 `${prefix} (${error.status}): ${detail}`,
 undefined,
 apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
 if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
 log.error(` URL: ${error.url}`);
 }
 if (verbose && error.clerkTraceId) {
 log.error(` Trace: ${error.clerkTraceId}`);
 }
 }
 process.exit(EXIT_CODE.GENERAL);
 }
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
 if (errors?.length) payload.error.errors = errors;
 log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
 try {
 const parsed = JSON.parse(body);
 return parsed.errors?.[0]?.code;
 } catch {
 return undefined;
 }
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map((e: ApiErrorEntry) => {
 const entry: ApiErrorEntry = {};
 if (e.code) entry.code = e.code;
 if (e.message) entry.message = e.message;
 if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
 return entry;
 });
 }
 } catch {
 // not JSON
 }
 return undefined;
}

6 changes: 3 additions & 3 deletions
packages/cli-core/src/commands/api/bapi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
 body: options.body,
 });

 const rawBody = await response.text();

 if (!response.ok) {
 throw new BapiError(response.status, rawBody, response.headers);
 throw await BapiError.fromResponse(response);
 }

 const rawBody = await response.text();

 let body: unknown;
 try {
 body = JSON.parse(rawBody);
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPull()).rejects.toThrow("API error");
 await expect(runConfigPull()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/push.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
 });

 test("shows success message after push", async () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/schema.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigSchema()).rejects.toThrow("API error");
 await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/doctor/doctor.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
 const ctx = createMockContext({
 token: "test_token",
 profile: mockProfile,
 applicationError: new PlapiError(404, "Not found"),
 applicationError: PlapiError.fromBody(404, "Not found"),
 });
 const result = await checkLinkedAppExists(ctx);
 expectCheck(result, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/env/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runEnvPull()).rejects.toThrow("API error");
 await expect(runEnvPull()).rejects.toThrow("Unauthorized");
 });

 test("sends include_secret_keys=true in API request", async () => {
Expand Down

8 changes: 4 additions & 4 deletions
packages/cli-core/src/commands/link/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
 test("shows picker with only create option when listApplications fails with 500", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
 mockSearch.mockImplementation(
 async (config: {
 source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
 test("propagates listApplications errors that are not 5xx", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

 await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
 });
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
 mockListApplications.mockResolvedValue([mockApp]);
 mockSearch.mockResolvedValue("__create_new__");
 mockInput.mockResolvedValue("My App");
 mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
 mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
 name: "My App",
 instances: [],
 });
 mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
 mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 10 commits into

from

May 21, 2026
 Merged


refactor(errors): expose structured Clerk error fields on ApiError subclasses
#288
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
df59e61

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
d815e83

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
018074c

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
add37f3

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
e8054a4

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
1361bbb

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
ccd7381

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
a1356dc

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
162f269

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
4ab06d7

fix(errors): guard parseApiBody against null/non-object JSON bodies


wyattjoh May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down

82 changes: 23 additions & 59 deletions
packages/cli-core/src/cli-program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
 return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
 if (verbose) {
 try {
 return "\n" + JSON.stringify(JSON.parse(body), null, 2);
 return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
 } catch {
 return "\n" + body;
 return "\n" + error.body;
 }
 }

 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map(formatSingleError).join("\n");
 }
 if (parsed.error) return parsed.error;
 if (parsed.message) return parsed.message;
 } catch {
 // not JSON
 }

 if (body.length > 200) return body.slice(0, 200) + "...";
 return body;
 return formatStructuredError(error);
}

function formatSingleError(err: {
 message?: string;
 code?: string;
 meta?: Record<string, unknown>;
}): string {
 let msg = err.message ?? "Unknown error";
 const meta = err.meta;
function formatStructuredError(error: ApiError): string {
 let msg = error.message;
 const { meta, code } = error;
 if (!meta) return msg;

 switch (err.code) {
 switch (code) {
 case "unsupported_subscription_plan_features": {
 const features = meta.unsupported_features;
 if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
 break;
 }
 }

 return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
 }

 if (error instanceof ApiError) {
 const detail = formatApiBody(error.body, verbose);
 const detail = formatApiBody(error, verbose);
 const prefix = error.context ?? "Request failed";
 if (isAgent()) {
 const apiCode = extractApiErrorCode(error.body);
 const apiErrors = extractApiErrors(error.body);
 const apiErrors: ApiErrorEntry[] | undefined =
 error.code || error.meta
 ? [
 {
 ...(error.code ? { code: error.code } : {}),
 ...(error.message ? { message: error.message } : {}),
 ...(error.meta ? { meta: error.meta } : {}),
 },
 ]
 : undefined;
 outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
 `${prefix} (${error.status}): ${detail}`,
 undefined,
 apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
 if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
 log.error(` URL: ${error.url}`);
 }
 if (verbose && error.clerkTraceId) {
 log.error(` Trace: ${error.clerkTraceId}`);
 }
 }
 process.exit(EXIT_CODE.GENERAL);
 }
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
 if (errors?.length) payload.error.errors = errors;
 log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
 try {
 const parsed = JSON.parse(body);
 return parsed.errors?.[0]?.code;
 } catch {
 return undefined;
 }
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map((e: ApiErrorEntry) => {
 const entry: ApiErrorEntry = {};
 if (e.code) entry.code = e.code;
 if (e.message) entry.message = e.message;
 if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
 return entry;
 });
 }
 } catch {
 // not JSON
 }
 return undefined;
}

6 changes: 3 additions & 3 deletions
packages/cli-core/src/commands/api/bapi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
 body: options.body,
 });

 const rawBody = await response.text();

 if (!response.ok) {
 throw new BapiError(response.status, rawBody, response.headers);
 throw await BapiError.fromResponse(response);
 }

 const rawBody = await response.text();

 let body: unknown;
 try {
 body = JSON.parse(rawBody);
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPull()).rejects.toThrow("API error");
 await expect(runConfigPull()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/push.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
 });

 test("shows success message after push", async () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/schema.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigSchema()).rejects.toThrow("API error");
 await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/doctor/doctor.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
 const ctx = createMockContext({
 token: "test_token",
 profile: mockProfile,
 applicationError: new PlapiError(404, "Not found"),
 applicationError: PlapiError.fromBody(404, "Not found"),
 });
 const result = await checkLinkedAppExists(ctx);
 expectCheck(result, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/env/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runEnvPull()).rejects.toThrow("API error");
 await expect(runEnvPull()).rejects.toThrow("Unauthorized");
 });

 test("sends include_secret_keys=true in API request", async () => {
Expand Down

8 changes: 4 additions & 4 deletions
packages/cli-core/src/commands/link/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
 test("shows picker with only create option when listApplications fails with 500", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
 mockSearch.mockImplementation(
 async (config: {
 source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
 test("propagates listApplications errors that are not 5xx", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

 await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
 });
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
 mockListApplications.mockResolvedValue([mockApp]);
 mockSearch.mockResolvedValue("__create_new__");
 mockInput.mockResolvedValue("My App");
 mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
 mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
 name: "My App",
 instances: [],
 });
 mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
 mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 10 commits into

from

May 21, 2026
 Merged


refactor(errors): expose structured Clerk error fields on ApiError subclasses
#288
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
df59e61

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
d815e83

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
018074c

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
add37f3

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
e8054a4

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
1361bbb

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
ccd7381

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
a1356dc

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
162f269

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
4ab06d7

fix(errors): guard parseApiBody against null/non-object JSON bodies


wyattjoh May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down

82 changes: 23 additions & 59 deletions
packages/cli-core/src/cli-program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
 return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
 if (verbose) {
 try {
 return "\n" + JSON.stringify(JSON.parse(body), null, 2);
 return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
 } catch {
 return "\n" + body;
 return "\n" + error.body;
 }
 }

 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map(formatSingleError).join("\n");
 }
 if (parsed.error) return parsed.error;
 if (parsed.message) return parsed.message;
 } catch {
 // not JSON
 }

 if (body.length > 200) return body.slice(0, 200) + "...";
 return body;
 return formatStructuredError(error);
}

function formatSingleError(err: {
 message?: string;
 code?: string;
 meta?: Record<string, unknown>;
}): string {
 let msg = err.message ?? "Unknown error";
 const meta = err.meta;
function formatStructuredError(error: ApiError): string {
 let msg = error.message;
 const { meta, code } = error;
 if (!meta) return msg;

 switch (err.code) {
 switch (code) {
 case "unsupported_subscription_plan_features": {
 const features = meta.unsupported_features;
 if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
 break;
 }
 }

 return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
 }

 if (error instanceof ApiError) {
 const detail = formatApiBody(error.body, verbose);
 const detail = formatApiBody(error, verbose);
 const prefix = error.context ?? "Request failed";
 if (isAgent()) {
 const apiCode = extractApiErrorCode(error.body);
 const apiErrors = extractApiErrors(error.body);
 const apiErrors: ApiErrorEntry[] | undefined =
 error.code || error.meta
 ? [
 {
 ...(error.code ? { code: error.code } : {}),
 ...(error.message ? { message: error.message } : {}),
 ...(error.meta ? { meta: error.meta } : {}),
 },
 ]
 : undefined;
 outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
 `${prefix} (${error.status}): ${detail}`,
 undefined,
 apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
 if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
 log.error(` URL: ${error.url}`);
 }
 if (verbose && error.clerkTraceId) {
 log.error(` Trace: ${error.clerkTraceId}`);
 }
 }
 process.exit(EXIT_CODE.GENERAL);
 }
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
 if (errors?.length) payload.error.errors = errors;
 log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
 try {
 const parsed = JSON.parse(body);
 return parsed.errors?.[0]?.code;
 } catch {
 return undefined;
 }
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map((e: ApiErrorEntry) => {
 const entry: ApiErrorEntry = {};
 if (e.code) entry.code = e.code;
 if (e.message) entry.message = e.message;
 if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
 return entry;
 });
 }
 } catch {
 // not JSON
 }
 return undefined;
}

6 changes: 3 additions & 3 deletions
packages/cli-core/src/commands/api/bapi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
 body: options.body,
 });

 const rawBody = await response.text();

 if (!response.ok) {
 throw new BapiError(response.status, rawBody, response.headers);
 throw await BapiError.fromResponse(response);
 }

 const rawBody = await response.text();

 let body: unknown;
 try {
 body = JSON.parse(rawBody);
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPull()).rejects.toThrow("API error");
 await expect(runConfigPull()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/push.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
 });

 test("shows success message after push", async () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/schema.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigSchema()).rejects.toThrow("API error");
 await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/doctor/doctor.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
 const ctx = createMockContext({
 token: "test_token",
 profile: mockProfile,
 applicationError: new PlapiError(404, "Not found"),
 applicationError: PlapiError.fromBody(404, "Not found"),
 });
 const result = await checkLinkedAppExists(ctx);
 expectCheck(result, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/env/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runEnvPull()).rejects.toThrow("API error");
 await expect(runEnvPull()).rejects.toThrow("Unauthorized");
 });

 test("sends include_secret_keys=true in API request", async () => {
Expand Down

8 changes: 4 additions & 4 deletions
packages/cli-core/src/commands/link/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
 test("shows picker with only create option when listApplications fails with 500", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
 mockSearch.mockImplementation(
 async (config: {
 source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
 test("propagates listApplications errors that are not 5xx", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

 await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
 });
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
 mockListApplications.mockResolvedValue([mockApp]);
 mockSearch.mockResolvedValue("__create_new__");
 mockInput.mockResolvedValue("My App");
 mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
 mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
 name: "My App",
 instances: [],
 });
 mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
 mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 10 commits into

from

May 21, 2026
 Merged


refactor(errors): expose structured Clerk error fields on ApiError subclasses
#288
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
df59e61

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
d815e83

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
018074c

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
add37f3

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
e8054a4

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
1361bbb

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
ccd7381

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
a1356dc

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
162f269

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
4ab06d7

fix(errors): guard parseApiBody against null/non-object JSON bodies


wyattjoh May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down

82 changes: 23 additions & 59 deletions
packages/cli-core/src/cli-program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
 return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
 if (verbose) {
 try {
 return "\n" + JSON.stringify(JSON.parse(body), null, 2);
 return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
 } catch {
 return "\n" + body;
 return "\n" + error.body;
 }
 }

 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map(formatSingleError).join("\n");
 }
 if (parsed.error) return parsed.error;
 if (parsed.message) return parsed.message;
 } catch {
 // not JSON
 }

 if (body.length > 200) return body.slice(0, 200) + "...";
 return body;
 return formatStructuredError(error);
}

function formatSingleError(err: {
 message?: string;
 code?: string;
 meta?: Record<string, unknown>;
}): string {
 let msg = err.message ?? "Unknown error";
 const meta = err.meta;
function formatStructuredError(error: ApiError): string {
 let msg = error.message;
 const { meta, code } = error;
 if (!meta) return msg;

 switch (err.code) {
 switch (code) {
 case "unsupported_subscription_plan_features": {
 const features = meta.unsupported_features;
 if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
 break;
 }
 }

 return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
 }

 if (error instanceof ApiError) {
 const detail = formatApiBody(error.body, verbose);
 const detail = formatApiBody(error, verbose);
 const prefix = error.context ?? "Request failed";
 if (isAgent()) {
 const apiCode = extractApiErrorCode(error.body);
 const apiErrors = extractApiErrors(error.body);
 const apiErrors: ApiErrorEntry[] | undefined =
 error.code || error.meta
 ? [
 {
 ...(error.code ? { code: error.code } : {}),
 ...(error.message ? { message: error.message } : {}),
 ...(error.meta ? { meta: error.meta } : {}),
 },
 ]
 : undefined;
 outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
 `${prefix} (${error.status}): ${detail}`,
 undefined,
 apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
 if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
 log.error(` URL: ${error.url}`);
 }
 if (verbose && error.clerkTraceId) {
 log.error(` Trace: ${error.clerkTraceId}`);
 }
 }
 process.exit(EXIT_CODE.GENERAL);
 }
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
 if (errors?.length) payload.error.errors = errors;
 log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
 try {
 const parsed = JSON.parse(body);
 return parsed.errors?.[0]?.code;
 } catch {
 return undefined;
 }
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map((e: ApiErrorEntry) => {
 const entry: ApiErrorEntry = {};
 if (e.code) entry.code = e.code;
 if (e.message) entry.message = e.message;
 if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
 return entry;
 });
 }
 } catch {
 // not JSON
 }
 return undefined;
}

6 changes: 3 additions & 3 deletions
packages/cli-core/src/commands/api/bapi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
 body: options.body,
 });

 const rawBody = await response.text();

 if (!response.ok) {
 throw new BapiError(response.status, rawBody, response.headers);
 throw await BapiError.fromResponse(response);
 }

 const rawBody = await response.text();

 let body: unknown;
 try {
 body = JSON.parse(rawBody);
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPull()).rejects.toThrow("API error");
 await expect(runConfigPull()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/push.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
 });

 test("shows success message after push", async () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/schema.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigSchema()).rejects.toThrow("API error");
 await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/doctor/doctor.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
 const ctx = createMockContext({
 token: "test_token",
 profile: mockProfile,
 applicationError: new PlapiError(404, "Not found"),
 applicationError: PlapiError.fromBody(404, "Not found"),
 });
 const result = await checkLinkedAppExists(ctx);
 expectCheck(result, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/env/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runEnvPull()).rejects.toThrow("API error");
 await expect(runEnvPull()).rejects.toThrow("Unauthorized");
 });

 test("sends include_secret_keys=true in API request", async () => {
Expand Down

8 changes: 4 additions & 4 deletions
packages/cli-core/src/commands/link/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
 test("shows picker with only create option when listApplications fails with 500", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
 mockSearch.mockImplementation(
 async (config: {
 source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
 test("propagates listApplications errors that are not 5xx", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

 await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
 });
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
 mockListApplications.mockResolvedValue([mockApp]);
 mockSearch.mockResolvedValue("__create_new__");
 mockInput.mockResolvedValue("My App");
 mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
 mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
 name: "My App",
 instances: [],
 });
 mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
 mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 10 commits into

from

May 21, 2026
 Merged


refactor(errors): expose structured Clerk error fields on ApiError subclasses
#288
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
df59e61

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
d815e83

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
018074c

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
add37f3

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
e8054a4

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
1361bbb

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
ccd7381

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
a1356dc

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
162f269

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
4ab06d7

fix(errors): guard parseApiBody against null/non-object JSON bodies


wyattjoh May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down

82 changes: 23 additions & 59 deletions
packages/cli-core/src/cli-program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
 return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
 if (verbose) {
 try {
 return "\n" + JSON.stringify(JSON.parse(body), null, 2);
 return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
 } catch {
 return "\n" + body;
 return "\n" + error.body;
 }
 }

 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map(formatSingleError).join("\n");
 }
 if (parsed.error) return parsed.error;
 if (parsed.message) return parsed.message;
 } catch {
 // not JSON
 }

 if (body.length > 200) return body.slice(0, 200) + "...";
 return body;
 return formatStructuredError(error);
}

function formatSingleError(err: {
 message?: string;
 code?: string;
 meta?: Record<string, unknown>;
}): string {
 let msg = err.message ?? "Unknown error";
 const meta = err.meta;
function formatStructuredError(error: ApiError): string {
 let msg = error.message;
 const { meta, code } = error;
 if (!meta) return msg;

 switch (err.code) {
 switch (code) {
 case "unsupported_subscription_plan_features": {
 const features = meta.unsupported_features;
 if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
 break;
 }
 }

 return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
 }

 if (error instanceof ApiError) {
 const detail = formatApiBody(error.body, verbose);
 const detail = formatApiBody(error, verbose);
 const prefix = error.context ?? "Request failed";
 if (isAgent()) {
 const apiCode = extractApiErrorCode(error.body);
 const apiErrors = extractApiErrors(error.body);
 const apiErrors: ApiErrorEntry[] | undefined =
 error.code || error.meta
 ? [
 {
 ...(error.code ? { code: error.code } : {}),
 ...(error.message ? { message: error.message } : {}),
 ...(error.meta ? { meta: error.meta } : {}),
 },
 ]
 : undefined;
 outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
 `${prefix} (${error.status}): ${detail}`,
 undefined,
 apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
 if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
 log.error(` URL: ${error.url}`);
 }
 if (verbose && error.clerkTraceId) {
 log.error(` Trace: ${error.clerkTraceId}`);
 }
 }
 process.exit(EXIT_CODE.GENERAL);
 }
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
 if (errors?.length) payload.error.errors = errors;
 log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
 try {
 const parsed = JSON.parse(body);
 return parsed.errors?.[0]?.code;
 } catch {
 return undefined;
 }
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map((e: ApiErrorEntry) => {
 const entry: ApiErrorEntry = {};
 if (e.code) entry.code = e.code;
 if (e.message) entry.message = e.message;
 if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
 return entry;
 });
 }
 } catch {
 // not JSON
 }
 return undefined;
}

6 changes: 3 additions & 3 deletions
packages/cli-core/src/commands/api/bapi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
 body: options.body,
 });

 const rawBody = await response.text();

 if (!response.ok) {
 throw new BapiError(response.status, rawBody, response.headers);
 throw await BapiError.fromResponse(response);
 }

 const rawBody = await response.text();

 let body: unknown;
 try {
 body = JSON.parse(rawBody);
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPull()).rejects.toThrow("API error");
 await expect(runConfigPull()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/push.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
 });

 test("shows success message after push", async () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/schema.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigSchema()).rejects.toThrow("API error");
 await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/doctor/doctor.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
 const ctx = createMockContext({
 token: "test_token",
 profile: mockProfile,
 applicationError: new PlapiError(404, "Not found"),
 applicationError: PlapiError.fromBody(404, "Not found"),
 });
 const result = await checkLinkedAppExists(ctx);
 expectCheck(result, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/env/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runEnvPull()).rejects.toThrow("API error");
 await expect(runEnvPull()).rejects.toThrow("Unauthorized");
 });

 test("sends include_secret_keys=true in API request", async () => {
Expand Down

8 changes: 4 additions & 4 deletions
packages/cli-core/src/commands/link/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
 test("shows picker with only create option when listApplications fails with 500", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
 mockSearch.mockImplementation(
 async (config: {
 source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
 test("propagates listApplications errors that are not 5xx", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

 await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
 });
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
 mockListApplications.mockResolvedValue([mockApp]);
 mockSearch.mockResolvedValue("__create_new__");
 mockInput.mockResolvedValue("My App");
 mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
 mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
 name: "My App",
 instances: [],
 });
 mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
 mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 10 commits into

from

May 21, 2026
 Merged


refactor(errors): expose structured Clerk error fields on ApiError subclasses
#288
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
df59e61

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
d815e83

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
018074c

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
add37f3

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
e8054a4

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
1361bbb

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
ccd7381

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
a1356dc

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
162f269

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
4ab06d7

fix(errors): guard parseApiBody against null/non-object JSON bodies


wyattjoh May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down

82 changes: 23 additions & 59 deletions
packages/cli-core/src/cli-program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
 return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
 if (verbose) {
 try {
 return "\n" + JSON.stringify(JSON.parse(body), null, 2);
 return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
 } catch {
 return "\n" + body;
 return "\n" + error.body;
 }
 }

 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map(formatSingleError).join("\n");
 }
 if (parsed.error) return parsed.error;
 if (parsed.message) return parsed.message;
 } catch {
 // not JSON
 }

 if (body.length > 200) return body.slice(0, 200) + "...";
 return body;
 return formatStructuredError(error);
}

function formatSingleError(err: {
 message?: string;
 code?: string;
 meta?: Record<string, unknown>;
}): string {
 let msg = err.message ?? "Unknown error";
 const meta = err.meta;
function formatStructuredError(error: ApiError): string {
 let msg = error.message;
 const { meta, code } = error;
 if (!meta) return msg;

 switch (err.code) {
 switch (code) {
 case "unsupported_subscription_plan_features": {
 const features = meta.unsupported_features;
 if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
 break;
 }
 }

 return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
 }

 if (error instanceof ApiError) {
 const detail = formatApiBody(error.body, verbose);
 const detail = formatApiBody(error, verbose);
 const prefix = error.context ?? "Request failed";
 if (isAgent()) {
 const apiCode = extractApiErrorCode(error.body);
 const apiErrors = extractApiErrors(error.body);
 const apiErrors: ApiErrorEntry[] | undefined =
 error.code || error.meta
 ? [
 {
 ...(error.code ? { code: error.code } : {}),
 ...(error.message ? { message: error.message } : {}),
 ...(error.meta ? { meta: error.meta } : {}),
 },
 ]
 : undefined;
 outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
 `${prefix} (${error.status}): ${detail}`,
 undefined,
 apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
 if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
 log.error(` URL: ${error.url}`);
 }
 if (verbose && error.clerkTraceId) {
 log.error(` Trace: ${error.clerkTraceId}`);
 }
 }
 process.exit(EXIT_CODE.GENERAL);
 }
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
 if (errors?.length) payload.error.errors = errors;
 log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
 try {
 const parsed = JSON.parse(body);
 return parsed.errors?.[0]?.code;
 } catch {
 return undefined;
 }
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map((e: ApiErrorEntry) => {
 const entry: ApiErrorEntry = {};
 if (e.code) entry.code = e.code;
 if (e.message) entry.message = e.message;
 if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
 return entry;
 });
 }
 } catch {
 // not JSON
 }
 return undefined;
}

6 changes: 3 additions & 3 deletions
packages/cli-core/src/commands/api/bapi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
 body: options.body,
 });

 const rawBody = await response.text();

 if (!response.ok) {
 throw new BapiError(response.status, rawBody, response.headers);
 throw await BapiError.fromResponse(response);
 }

 const rawBody = await response.text();

 let body: unknown;
 try {
 body = JSON.parse(rawBody);
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPull()).rejects.toThrow("API error");
 await expect(runConfigPull()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/push.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
 });

 test("shows success message after push", async () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/schema.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigSchema()).rejects.toThrow("API error");
 await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/doctor/doctor.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
 const ctx = createMockContext({
 token: "test_token",
 profile: mockProfile,
 applicationError: new PlapiError(404, "Not found"),
 applicationError: PlapiError.fromBody(404, "Not found"),
 });
 const result = await checkLinkedAppExists(ctx);
 expectCheck(result, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/env/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runEnvPull()).rejects.toThrow("API error");
 await expect(runEnvPull()).rejects.toThrow("Unauthorized");
 });

 test("sends include_secret_keys=true in API request", async () => {
Expand Down

8 changes: 4 additions & 4 deletions
packages/cli-core/src/commands/link/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
 test("shows picker with only create option when listApplications fails with 500", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
 mockSearch.mockImplementation(
 async (config: {
 source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
 test("propagates listApplications errors that are not 5xx", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

 await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
 });
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
 mockListApplications.mockResolvedValue([mockApp]);
 mockSearch.mockResolvedValue("__create_new__");
 mockInput.mockResolvedValue("My App");
 mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
 mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
 name: "My App",
 instances: [],
 });
 mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
 mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
refactor(errors): expose structured Clerk error fields on ApiError subclasses#288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wyattjoh
merged 10 commits into

from

May 21, 2026
 Merged


refactor(errors): expose structured Clerk error fields on ApiError subclasses
#288
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
df59e61

refactor(errors): parse Clerk error envelope into structured ApiError…


wyattjoh May 13, 2026
d815e83

feat(errors): add fromResponse factories to ApiError subclasses


wyattjoh May 13, 2026
018074c

refactor(plapi): construct PlapiError via fromResponse


wyattjoh May 13, 2026
add37f3

refactor(fapi): construct FapiError via fromResponse


wyattjoh May 13, 2026
e8054a4

refactor(keyless): construct BapiError via fromResponse


wyattjoh May 13, 2026
1361bbb

refactor(bapi): construct BapiError via fromResponse


wyattjoh May 13, 2026
ccd7381

refactor(users): construct BapiError via fromResponse


wyattjoh May 13, 2026
a1356dc

test: construct ApiError subclasses via fromBody in fixtures


wyattjoh May 13, 2026
162f269

refactor(cli): read structured ApiError fields in the global handler


wyattjoh May 13, 2026
4ab06d7

fix(errors): guard parseApiBody against null/non-object JSON bodies


wyattjoh May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
packages/cli-core/src/cli-program.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join } from "node:path";
import { createProgram, formatApiBody } from "./cli-program.ts";
import { ApiError } from "./lib/errors.ts";
import { STANDARD_AGENT_DIRS, EXTRA_REL_PATHS } from "./lib/skill-detection.ts";

test("registers users as a top-level command", () => {
Expand DownExpand Up@@ -140,7 +141,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Your plan does not support these features");
 expect(result).toContain("Unsupported features: saml, custom_roles");
 });
Expand All@@ -155,7 +156,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Unknown config key: sesion");
 expect(result).toContain("Did you mean: session");
 expect(result).toContain("Parameter: sesion");
Expand All@@ -171,7 +172,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("This feature is not enabled on this instance");
 expect(result).toContain("Feature: organizations");
 });
Expand All@@ -186,7 +187,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid value for session.lifetime");
 expect(result).toContain("Parameter: session.lifetime");
 });
Expand All@@ -201,7 +202,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Cannot clear this key");
 expect(result).toContain("Parameter: sign_up.mode");
 });
Expand All@@ -216,14 +217,15 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Value is not in the allowed set");
 expect(result).toContain("Parameter: branding.logo_url");
 });

 // --- Multiple errors ---
 // The structured path reads from the first parsed error only.

 test("formats multiple errors joined by newlines", () => {
 test("formats multiple errors: surfaces first error with its meta", () => {
 const body = JSON.stringify({
 errors: [
 {
Expand All@@ -238,13 +240,9 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toContain("Invalid session lifetime");
 expect(result).toContain("Unknown key: bogus");
 expect(result).toContain("Did you mean: session");
 // Two errors separated by newline
 const lines = result.split("\n");
 expect(lines.length).toBeGreaterThanOrEqual(2);
 expect(result).toContain("Parameter: session.lifetime");
 });

 // --- Error without meta ---
Expand All@@ -253,32 +251,34 @@ describe("formatApiBody", () => {
 const body = JSON.stringify({
 errors: [{ code: "resource_not_found", message: "Instance not found" }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Instance not found");
 });

 // --- Fallback paths ---
 // --- Bodies without a Clerk errors array ---
 // parseApiBody falls back to truncateBody(body) as the message when there
 // is no errors[0], so formatStructuredError returns the truncated body string.

 test("falls back to parsed.error when no errors array", () => {
 test("returns truncated body when no errors array (error field only)", () => {
 const body = JSON.stringify({ error: "Something went wrong" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Something went wrong");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("falls back to parsed.message when no errors array or error field", () => {
 test("returns truncated body when no errors array (message field only)", () => {
 const body = JSON.stringify({ message: "Bad request" });
 const result = formatApiBody(body, false);
 expect(result).toBe("Bad request");
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe(body);
 });

 test("truncates non-JSON body over 200 chars", () => {
 const body = "x".repeat(300);
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("x".repeat(200) + "...");
 });

 test("returns short non-JSON body as-is", () => {
 const result = formatApiBody("Bad Request", false);
 const result = formatApiBody(new ApiError(400, "Bad Request"), false);
 expect(result).toBe("Bad Request");
 });

Expand All@@ -287,28 +287,29 @@ describe("formatApiBody", () => {
 test("verbose mode returns full pretty-printed JSON", () => {
 const obj = { errors: [{ code: "test", message: "test msg" }] };
 const body = JSON.stringify(obj);
 const result = formatApiBody(body, true);
 const result = formatApiBody(new ApiError(400, body), true);
 expect(result).toBe("\n" + JSON.stringify(obj, null, 2));
 });

 test("verbose mode returns raw body for non-JSON", () => {
 const result = formatApiBody("not json", true);
 const result = formatApiBody(new ApiError(400, "not json"), true);
 expect(result).toBe("\nnot json");
 });

 // --- Edge cases ---

 test("handles empty errors array by falling through", () => {
 test("handles empty errors array by returning truncated body", () => {
 const body = JSON.stringify({ errors: [], message: "fallback" });
 const result = formatApiBody(body, false);
 expect(result).toBe("fallback");
 const result = formatApiBody(new ApiError(400, body), false);
 // No errors[0] so parseApiBody falls back to truncateBody(body)
 expect(result).toBe(body);
 });

 test("handles error with empty meta", () => {
 const body = JSON.stringify({
 errors: [{ code: "config_validation_error", message: "Bad value", meta: {} }],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Bad value");
 });

Expand All@@ -322,7 +323,7 @@ describe("formatApiBody", () => {
 },
 ],
 });
 const result = formatApiBody(body, false);
 const result = formatApiBody(new ApiError(400, body), false);
 expect(result).toBe("Plan limitation");
 });
});
Expand Down

82 changes: 23 additions & 59 deletions
packages/cli-core/src/cli-program.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -926,40 +926,23 @@ Tutorial — enable completions for your shell:
 return program;
}

export function formatApiBody(body: string, verbose: boolean): string {
export function formatApiBody(error: ApiError, verbose: boolean): string {
 if (verbose) {
 try {
 return "\n" + JSON.stringify(JSON.parse(body), null, 2);
 return "\n" + JSON.stringify(JSON.parse(error.body), null, 2);
 } catch {
 return "\n" + body;
 return "\n" + error.body;
 }
 }

 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map(formatSingleError).join("\n");
 }
 if (parsed.error) return parsed.error;
 if (parsed.message) return parsed.message;
 } catch {
 // not JSON
 }

 if (body.length > 200) return body.slice(0, 200) + "...";
 return body;
 return formatStructuredError(error);
}

function formatSingleError(err: {
 message?: string;
 code?: string;
 meta?: Record<string, unknown>;
}): string {
 let msg = err.message ?? "Unknown error";
 const meta = err.meta;
function formatStructuredError(error: ApiError): string {
 let msg = error.message;
 const { meta, code } = error;
 if (!meta) return msg;

 switch (err.code) {
 switch (code) {
 case "unsupported_subscription_plan_features": {
 const features = meta.unsupported_features;
 if (Array.isArray(features) && features.length > 0) {
Expand DownExpand Up@@ -990,7 +973,6 @@ function formatSingleError(err: {
 break;
 }
 }

 return msg;
}

Expand DownExpand Up@@ -1045,13 +1027,21 @@ export async function runProgram(
 }

 if (error instanceof ApiError) {
 const detail = formatApiBody(error.body, verbose);
 const detail = formatApiBody(error, verbose);
 const prefix = error.context ?? "Request failed";
 if (isAgent()) {
 const apiCode = extractApiErrorCode(error.body);
 const apiErrors = extractApiErrors(error.body);
 const apiErrors: ApiErrorEntry[] | undefined =
 error.code || error.meta
 ? [
 {
 ...(error.code ? { code: error.code } : {}),
 ...(error.message ? { message: error.message } : {}),
 ...(error.meta ? { meta: error.meta } : {}),
 },
 ]
 : undefined;
 outputJsonError(
apiCode ?? "api_error",
error.code ?? "api_error",
 `${prefix} (${error.status}): ${detail}`,
 undefined,
 apiErrors,
Expand All@@ -1061,6 +1051,9 @@ export async function runProgram(
 if (verbose && (error instanceof PlapiError || error instanceof FapiError) && error.url) {
 log.error(` URL: ${error.url}`);
 }
 if (verbose && error.clerkTraceId) {
 log.error(` Trace: ${error.clerkTraceId}`);
 }
 }
 process.exit(EXIT_CODE.GENERAL);
 }
Expand DownExpand Up@@ -1110,32 +1103,3 @@ function outputJsonError(
 if (errors?.length) payload.error.errors = errors;
 log.raw(JSON.stringify(payload));
}

/** Extract the error code from a Clerk API JSON response body, if present. */
function extractApiErrorCode(body: string): string | undefined {
 try {
 const parsed = JSON.parse(body);
 return parsed.errors?.[0]?.code;
 } catch {
 return undefined;
 }
}

/** Extract the full errors array from a Clerk API JSON response body, if present. */
function extractApiErrors(body: string): ApiErrorEntry[] | undefined {
 try {
 const parsed = JSON.parse(body);
 if (Array.isArray(parsed.errors) && parsed.errors.length > 0) {
 return parsed.errors.map((e: ApiErrorEntry) => {
 const entry: ApiErrorEntry = {};
 if (e.code) entry.code = e.code;
 if (e.message) entry.message = e.message;
 if (e.meta && Object.keys(e.meta).length > 0) entry.meta = e.meta;
 return entry;
 });
 }
 } catch {
 // not JSON
 }
 return undefined;
}

6 changes: 3 additions & 3 deletions
packages/cli-core/src/commands/api/bapi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,12 +43,12 @@ export async function bapiRequest(options: {
 body: options.body,
 });

 const rawBody = await response.text();

 if (!response.ok) {
 throw new BapiError(response.status, rawBody, response.headers);
 throw await BapiError.fromResponse(response);
 }

 const rawBody = await response.text();

 let body: unknown;
 try {
 body = JSON.parse(rawBody);
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,6 +310,6 @@ describe("config pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPull()).rejects.toThrow("API error");
 await expect(runConfigPull()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/push.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -632,7 +632,7 @@ describe("config push", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("API error");
 await expect(runConfigPatch({ json: '{"a":1}', yes: true })).rejects.toThrow("Bad Request");
 });

 test("shows success message after push", async () => {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/config/schema.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,6 +275,6 @@ describe("config schema", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runConfigSchema()).rejects.toThrow("API error");
 await expect(runConfigSchema()).rejects.toThrow("Unauthorized");
 });
});

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/doctor/doctor.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -346,7 +346,7 @@ describe("checkLinkedAppExists", () => {
 const ctx = createMockContext({
 token: "test_token",
 profile: mockProfile,
 applicationError: new PlapiError(404, "Not found"),
 applicationError: PlapiError.fromBody(404, "Not found"),
 });
 const result = await checkLinkedAppExists(ctx);
 expectCheck(result, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/cli-core/src/commands/env/pull.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -487,7 +487,7 @@ describe("env pull", () => {
 instances: { development: "ins_dev" },
 });

 await expect(runEnvPull()).rejects.toThrow("API error");
 await expect(runEnvPull()).rejects.toThrow("Unauthorized");
 });

 test("sends include_secret_keys=true in API request", async () => {
Expand Down

8 changes: 4 additions & 4 deletions
packages/cli-core/src/commands/link/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -587,7 +587,7 @@ describe("link", () => {
 test("shows picker with only create option when listApplications fails with 500", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(500, "Internal Server Error"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(500, "Internal Server Error"));
 mockSearch.mockImplementation(
 async (config: {
 source: (term: string | undefined) => { name: string; value: string }[];
Expand DownExpand Up@@ -622,7 +622,7 @@ describe("link", () => {
 test("propagates listApplications errors that are not 5xx", async () => {
 mockIsAgent.mockReturnValue(false);
 mockGetToken.mockResolvedValue("token");
 mockListApplications.mockRejectedValue(new PlapiError(401, "Unauthorized"));
 mockListApplications.mockRejectedValue(PlapiError.fromBody(401, "Unauthorized"));

 await expect(runLink()).rejects.toBeInstanceOf(PlapiError);
 });
Expand DownExpand Up@@ -1248,7 +1248,7 @@ describe("link", () => {
 mockListApplications.mockResolvedValue([mockApp]);
 mockSearch.mockResolvedValue("__create_new__");
 mockInput.mockResolvedValue("My App");
 mockCreateApplication.mockRejectedValue(new PlapiError(422, "Unprocessable Entity"));
 mockCreateApplication.mockRejectedValue(PlapiError.fromBody(422, "Unprocessable Entity"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand All@@ -1265,7 +1265,7 @@ describe("link", () => {
 name: "My App",
 instances: [],
 });
 mockFetchApplication.mockRejectedValue(new PlapiError(503, "Service Unavailable"));
 mockFetchApplication.mockRejectedValue(PlapiError.fromBody(503, "Service Unavailable"));

 await expect(link()).rejects.toBeInstanceOf(PlapiError);
 expect(mockSetProfile).not.toHaveBeenCalled();
Expand Down
Loading