Skip to main content
Version: 1.x

Class: AuthError

Error subclass for authentication failures.

Sap Module​

BC-SEC

Business Context​

SAP authentication lifecycle — login, session refresh, SSO token handling

Example​

const error = new AuthError({
  message: 'Auth failed',
  attempted: 'Login to SAP',
  strategy: 'btp-saml',
});

Extends​

Constructors​

Constructor​

new AuthError(options): AuthError

Creates a new AuthError instance.

Parameters​

options​

AuthErrorOptions

Auth error construction options including strategy and login URL.

Returns​

AuthError

Example​

import { AuthError } from '#core/errors/auth-error.js';

const error = new AuthError({
  message: 'SAML authentication failed',
  attempted: 'Login to SAP BTP',
  strategy: 'btp-saml',
  loginUrl: 'https://accounts.sap.com/login',
});

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

loginUrl​

readonly loginUrl: string | undefined

message​

message: string

Inherited from​

PramanError.message

name​

name: string

Inherited from​

PramanError.name

retryable​

readonly retryable: boolean

Inherited from​

PramanError.retryable

severity​

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

Inherited from​

PramanError.severity

stack?​

optional stack?: string

Inherited from​

PramanError.stack

strategy​

readonly strategy: string | undefined

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 structured context for AI agents with authentication diagnostics.

Returns​

AIErrorContext & object

Base AI context plus strategy and loginUrl fields to help diagnose authentication configuration issues.

Example​

const context = error.toAIContext();
// context.strategy, context.loginUrl available
// Send to LLM for auth troubleshooting suggestions

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

Serializes the error to a JSON-safe object with authentication fields.

Returns​

SerializedPramanError & object

Base fields plus strategy and loginUrl.

Example​

const json = error.toJSON();
// json.strategy === 'btp-saml'
// json.loginUrl === 'https://accounts.sap.com/login'

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