Skip to main content
Version: 1.x

Class: IntentError

Error subclass for SAP intent domain operation failures.

Example​

const error = new IntentError({
  message: 'Field not found',
  attempted: 'Fill supplier field',
  fieldName: 'supplier',
  sapDomain: 'procurement',
});

Sap Module​

MM/SD/FI/PP

Business Context​

SAP domain intent operations — field fill, button click, navigation, assertion

Failure Mode​

Field not found — intent target field does not exist in the current view

Failure Mode​

Action failed — SAP business action did not complete successfully

Extends​

Constructors​

Constructor​

new IntentError(options): IntentError

Creates a new IntentError instance.

Parameters​

options​

IntentErrorOptions

Intent error construction options including field name and SAP domain context for the failing operation.

Returns​

IntentError

Example​

import { IntentError } from '#core/errors/intent-error.js';

const error = new IntentError({
  message: 'Field selector not resolved: supplier',
  attempted: 'Fill field via vocabulary: supplier',
  fieldName: 'supplier',
  sapDomain: 'procurement',
  suggestions: [
    'Verify the field name exists in vocabulary/domains/procurement.json',
    'Provide a custom selector via options.selectors',
  ],
});

Overrides​

PramanError.constructor

Properties​

attempted​

readonly attempted: string

Inherited from​

PramanError.attempted

cause?​

optional cause?: unknown

Inherited from​

PramanError.cause

code​

readonly code: ErrorCode

Inherited from​

PramanError.code

details​

readonly details: Readonly<Record<string, unknown>>

Inherited from​

PramanError.details

fieldName​

readonly fieldName: string | undefined

message​

message: string

Inherited from​

PramanError.message

name​

name: string

Inherited from​

PramanError.name

retryable​

readonly retryable: boolean

Inherited from​

PramanError.retryable

sapDomain​

readonly sapDomain: string | undefined

severity​

readonly severity: "error" | "info" | "warning"

Inherited from​

PramanError.severity

stack?​

optional stack?: string

Inherited from​

PramanError.stack

suggestions​

readonly suggestions: readonly string[]

Inherited from​

PramanError.suggestions

timestamp​

readonly timestamp: string

Inherited from​

PramanError.timestamp

stackTraceLimit​

static stackTraceLimit: number

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​

PramanError.stackTraceLimit

Methods​

toAIContext()​

toAIContext(): AIErrorContext & object

Returns AI-agent-friendly context with intent-specific diagnostic fields.

Returns​

AIErrorContext & object

Base AI context extended with field name and SAP domain details.

Example​

const ctx = error.toAIContext();
// LLM can use ctx.fieldName to look up vocabulary alternatives
// and ctx.sapDomain to narrow the search scope

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

Serializes this error to a JSON-safe object with intent-specific fields.

Returns​

SerializedPramanError & object

Base serialization extended with fieldName and sapDomain.

Example​

const json = error.toJSON();
console.log(json.fieldName); // 'supplier'
console.log(json.sapDomain); // 'procurement'

Overrides​

PramanError.toJSON

toUserMessage()​

toUserMessage(): string

Formats the error for human-readable console output.

Returns​

string

Multi-line formatted string with all diagnostic sections.

Example​

console.error(error.toUserMessage());

Inherited from​

PramanError.toUserMessage

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

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​

PramanError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

PramanError.prepareStackTrace