Class: ResponseShapeError

@kortexya/reasoninglayer / ResponseShapeError

Class: ResponseShapeError

Defined in: src/errors.ts:894

A successful (2xx) response the SDK could not read.

The engine, or a gateway in front of it, answered a status that means success with a body that does not have the shape the route publishes: a required field is missing, null or of the wrong kind ({} where { items: [...] } was promised), or the body is not JSON at all (an HTML error page served with 200). Nothing in the answer can be trusted, and the SDK does not return a partial result.

Remarks

It extends ReasoningLayerError, not ApiError: the status is a success, so retry and status-based handling that keys on ApiError must not see it. Retrying the same request usually gets the same body.

field is the dotted path of the first field, in the route’s published schema, that the body lacks or holds with the wrong kind (items, items[3].sort_suggestions). It is undefined when the body is not JSON, when the body itself is not the published object or array, and when every published field is present (the mapper failed on something the schema does not describe). The underlying failure (the TypeError, or the JSON parse error) is the cause.

The SDK checks the shape only after reading the body has failed. A body that omits a field the SDK has a default for (what an older engine sends) is still read.

Example

try {
  await client.reviews.listPending();
} catch (e) {
  if (e instanceof ResponseShapeError) {
    console.error(`${e.method} ${e.path} answered ${e.status} without ${e.field ?? 'a readable body'}`);
  }
}

Extends

ReasoningLayerError

Constructors

Constructor

new ResponseShapeError(message, details): ResponseShapeError

Defined in: src/errors.ts:911

Parameters

message

string

details

body

unknown

cause

Error

field

string | undefined

method

string

path

string

status

number

Returns

ResponseShapeError

Overrides

ReasoningLayerError.constructor

Properties

body

readonly body: unknown

Defined in: src/errors.ts:909

The response body as parsed, or null when it was not JSON.

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

ReasoningLayerError.cause

field

readonly field: string | undefined

Defined in: src/errors.ts:907

The dotted path of the first published field the body lacks or holds with the wrong kind, or undefined (see the class remarks).

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

ReasoningLayerError.message

method

readonly method: string

Defined in: src/errors.ts:900

The HTTP method of the request (GET, POST, …).

name

name: string = 'ResponseShapeError'

Defined in: src/errors.ts:895

Overrides

ReasoningLayerError.name

path

readonly path: string

Defined in: src/errors.ts:902

The request path, without the base URL and the query string.

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

ReasoningLayerError.stack

status

readonly status: number

Defined in: src/errors.ts:898

The HTTP status of the response: a 2xx.

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ReasoningLayerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ReasoningLayerError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ReasoningLayerError.prepareStackTrace