core

Namespaces

Classes

ControlledPromise

Defined in: packages/core/src/controlledPromise.ts:5

Lets lifecycle code outside the executor settle a promise exactly once.

Type Parameters

Constructors

Constructor

new ControlledPromise<T>(): ControlledPromise<T>;

Defined in: packages/core/src/controlledPromise.ts:11

Returns

ControlledPromise<T>

Properties

PayloadValidationError

Defined in: packages/core/src/errors.ts:8

Normalizes payload failures across supported validator styles.

Extends

• Error

Constructors

Constructor

new PayloadValidationError(issues, options?): PayloadValidationError;

Defined in: packages/core/src/errors.ts:10

Parameters

Returns

PayloadValidationError

Overrides

Error.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.4.0/node_modules/bun-types/globals.d.ts:1062

Create .stack property on a target object

Parameters

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

Error.prepareStackTrace

isError()

Call Signature

static isError(error): error is Error;

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Returns

error is Error

Inherited from

Error.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.4.0/node_modules/bun-types/globals.d.ts:1057

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

Error.isError

LayerKeyError

Defined in: packages/core/src/errors.ts:41

Thrown when a layer key is not JSON-safe (from assertLayerKey / hashKey).

Extends

• Error

Constructors

Constructor

new LayerKeyError(message, path?): LayerKeyError;

Defined in: packages/core/src/errors.ts:43

Parameters

Returns

LayerKeyError

Overrides

Error.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.4.0/node_modules/bun-types/globals.d.ts:1062

Create .stack property on a target object

Parameters

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

Error.prepareStackTrace

isError()

Call Signature

static isError(error): error is Error;

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Returns

error is Error

Inherited from

Error.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.4.0/node_modules/bun-types/globals.d.ts:1057

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

Error.isError

LayerCancelledError

Defined in: packages/core/src/errors.ts:88

Rejects open() when a stack is torn down without a completion response (cancelAll, parent dismiss child clear, group dispose, stackDisconnect).

Extends

• Error

Constructors

Constructor

new LayerCancelledError(reason?): LayerCancelledError;

Defined in: packages/core/src/errors.ts:91

Parameters

Returns

LayerCancelledError

Overrides

Error.constructor

Properties

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:51

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

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.bun/bun-types@1.4.0/node_modules/bun-types/globals.d.ts:1062

Create .stack property on a target object

Parameters

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:55

Parameters

Returns

any

See

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

Inherited from

Error.prepareStackTrace

isError()

Call Signature

static isError(error): error is Error;

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Returns

error is Error

Inherited from

Error.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/.bun/bun-types@1.4.0/node_modules/bun-types/globals.d.ts:1057

Check if a value is an instance of Error

Parameters

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

Error.isError

Layer

Defined in: packages/core/src/layer.ts:14

Runtime state and cancellation resources for one stack entry.

Type Parameters

Constructors

Constructor

new Layer<P, R, E, D>(opts): Layer<P, R, E, D>;

Defined in: packages/core/src/layer.ts:31

Parameters

Returns

Layer<P, R, E, D>

Properties

Accessors

state

Get Signature

get state(): LayerState<P, R, E, D>;

Defined in: packages/core/src/layer.ts:63

Returns

LayerState<P, R, E, D>

blockers

Get Signature

get blockers(): ReadonlySet<BlockerFn>;

Defined in: packages/core/src/layer.ts:67

Returns

ReadonlySet<BlockerFn>

Methods

addBlocker()

addBlocker(fn): () => void;

Defined in: packages/core/src/layer.ts:71

Parameters

Returns

() => void

setPartial()

setPartial(patch): boolean;

Defined in: packages/core/src/layer.ts:77

Returns true if the snapshot changed.

Parameters

Returns

boolean

setRunning()

setRunning(running): void;

Defined in: packages/core/src/layer.ts:87

Parameters

Returns

void

abort()

abort(): void;

Defined in: packages/core/src/layer.ts:92

Cancel any in-flight loadFn; subsequent resolutions are ignored.

Returns

void

resolve()

resolve(response): void;

Defined in: packages/core/src/layer.ts:97

Parameters

Returns

void

reject()

reject(error): void;

Defined in: packages/core/src/layer.ts:101

Parameters

Returns

void

LayerClient

Defined in: packages/core/src/layerClient.ts:34

Coordinates named layer stacks.

Constructors

Constructor

new LayerClient(opts?): LayerClient;

Defined in: packages/core/src/layerClient.ts:41

Parameters

Returns

LayerClient

Methods

ensureStack()

ensureStack(id, options?): LayerStack;

Defined in: packages/core/src/layerClient.ts:46

Returns a stack, applying options only when creating it.

Parameters

Returns

LayerStack

bindChildStack()

bindChildStack(parentLayerId, childStackId): () => void;

Defined in: packages/core/src/layerClient.ts:75

Parameters

Returns

() => void

open()

Call Signature

open<V, P, R, E, D, RootProps>(options): Promise<R>;

Defined in: packages/core/src/layerClient.ts:110

Accepts validator input while storing its parsed output as the payload.

Type Parameters

Parameters

Returns

Promise<R>

Call Signature

open<P, R, E, D, RootProps>(options): Promise<R>;

Defined in: packages/core/src/layerClient.ts:127

Infers response and error types from a DataTag key.

Type Parameters

Parameters

Returns

Promise<R>

Call Signature

open<P, R, E, D, RootProps>(options): Promise<R>;

Defined in: packages/core/src/layerClient.ts:136

Opens a layer and resolves with its dismissal response.

Type Parameters

Parameters

Returns

Promise<R>

getStack()

getStack(id?): LayerStack;

Defined in: packages/core/src/layerClient.ts:164

Parameters

Returns

LayerStack

getStackIds()

getStackIds(): string[];

Defined in: packages/core/src/layerClient.ts:168

Returns

string[]

subscribeStacks()

subscribeStacks(listener): () => void;

Defined in: packages/core/src/layerClient.ts:173

Subscribes to first-time stack materialization.

Parameters

Returns

() => void

subscribeNotify()

subscribeNotify(listener): () => void;

Defined in: packages/core/src/layerClient.ts:179

Subscribes to labeled stack snapshot transitions (devtools).

Parameters

Returns

() => void

seedNotify()

seedNotify(stackId?): void;

Defined in: packages/core/src/layerClient.ts:188

Re-emits the current snapshot as a register notify for one stack, or all materialized stacks when stackId is omitted (devtools seed).

Parameters

Returns

void

dismissAll()

dismissAll(
   stackId?, 
   response?, 
opts?): Promise<void>;

Defined in: packages/core/src/layerClient.ts:204

Bulk-dismisses a stack, completing every open() with response (including omitted/undefined for void layers). Honors DismissAllMode; does not reject — prefer cancelAll for teardown without a completion value.

Parameters

Returns

Promise<void>

cancelAll()

cancelAll(stackId?, opts?): Promise<void>;

Defined in: packages/core/src/layerClient.ts:222

Force-clears a stack and rejects every open/queued caller with LayerCancelledError. System teardown — prefer dismissAll when completing with a response.

Parameters

Returns

Promise<void>

Default

opts.reason "cancelAll"

LayerStack

Defined in: packages/core/src/layerStack.ts:44

Manages the ordered layers for one surface. Snapshots retain their references across batched notifications until their contents change.

Extends

• Subscribable

Type Parameters

Constructors

Constructor

new LayerStack<P, R, E, D>(id, options?): LayerStack<P, R, E, D>;

Defined in: packages/core/src/layerStack.ts:72

Parameters

Returns

LayerStack<P, R, E, D>

Overrides

Subscribable.constructor

Properties

Accessors

size

Get Signature

get size(): number;

Defined in: packages/core/src/subscribable.ts:32

Returns

number

Inherited from

Subscribable.size

Methods

getSnapshot()

getSnapshot(): LayerState<P, R, E, D>[];

Defined in: packages/core/src/layerStack.ts:79

Returns a referentially stable snapshot between mutations.

Returns

LayerState<P, R, E, D>[]

getQueuedSnapshot()

getQueuedSnapshot(): LayerState<P, R, E, D>[];

Defined in: packages/core/src/layerStack.ts:82

Returns serially queued layers, which are excluded from getSnapshot.

Returns

LayerState<P, R, E, D>[]

getLayer()

getLayer(id): 
  | Layer<P, R, E, D>
  | undefined;

Defined in: packages/core/src/layerStack.ts:89

Parameters

Returns

| Layer<P, R, E, D> | undefined

find()

find(key): 
  | Layer<P, R, E, D>
  | undefined;

Defined in: packages/core/src/layerStack.ts:93

Parameters

Returns

| Layer<P, R, E, D> | undefined

addBlocker()

addBlocker(fn): () => void;

Defined in: packages/core/src/layerStack.ts:98

Parameters

Returns

() => void

open()

open(opts): Layer<P, R, E, D>;

Defined in: packages/core/src/layerStack.ts:117

Parameters

Returns

Layer<P, R, E, D>

dismiss()

dismiss(layer, ...args): Promise<boolean>;

Defined in: packages/core/src/layerStack.ts:263

Resolves the caller and aborts in-flight loading. Exiting layers remain mounted until their transition settles. Response may be omitted when undefined extends R (EndArgs).

Parameters

Returns

Promise<boolean>

settle()

settle(layer): void;

Defined in: packages/core/src/layerStack.ts:359

Parameters

Returns

void

dismissAll()

dismissAll(...args): Promise<void>;

Defined in: packages/core/src/layerStack.ts:388

Bulk-dismisses active and queued layers, completing every open() with response (including omitted/undefined when undefined extends R — DismissAllArgs / EndArgs gate). Honors DismissAllMode; does not reject — use cancelAll for teardown without a completion value.

Parameters

Returns

Promise<void>

cancelAll()

cancelAll(opts?): Promise<void>;

Defined in: packages/core/src/layerStack.ts:437

Force-clears the stack and rejects every open/queued caller with LayerCancelledError. Skips blockers. System teardown path — use dismissAll when completing with a response.

Parameters

Returns

Promise<void>

Default

opts.reason "cancelAll"

cancelQueued()

cancelQueued(key, ...args): boolean;

Defined in: packages/core/src/layerStack.ts:493

Resolves and removes a serially queued layer without mounting it (skips blockers). No id → FIFO head for the key; { id } → exact queued match. Response may be omitted when undefined extends R (CancelQueuedArgs / EndArgs gate).

Parameters

Returns

boolean

update()

update(layer, patch): void;

Defined in: packages/core/src/layerStack.ts:523

Parameters

Returns

void

setRunning()

setRunning(layer, running): void;

Defined in: packages/core/src/layerStack.ts:532

Parameters

Returns

void

subscribe()

subscribe(listener): () => void;

Defined in: packages/core/src/subscribable.ts:13

Parameters

Returns

() => void

Inherited from

Subscribable.subscribe

notify()

protected notify(): void;

Defined in: packages/core/src/subscribable.ts:23

Returns

void

Inherited from

Subscribable.notify

onSubscribe()?

protected optional onSubscribe(): void;

Defined in: packages/core/src/subscribable.ts:29

Returns

void

Inherited from

Subscribable.onSubscribe

onUnsubscribe()?

protected optional onUnsubscribe(): void;

Defined in: packages/core/src/subscribable.ts:30

Returns

void

Inherited from

Subscribable.onUnsubscribe

Subscribable

Defined in: packages/core/src/subscribable.ts:10

Base for stores whose listeners participate in notifyManager batching. Wrapping occurs once at subscription, so repeated notifications in one batch coalesce for framework and bare subscribers alike.

Extended by

• LayerStack

Constructors

Constructor

new Subscribable(): Subscribable;

Returns

Subscribable

Properties

Accessors

size

Get Signature

get size(): number;

Defined in: packages/core/src/subscribable.ts:32

Returns

number

Methods

subscribe()

subscribe(listener): () => void;

Defined in: packages/core/src/subscribable.ts:13

Parameters

Returns

() => void

notify()

protected notify(): void;

Defined in: packages/core/src/subscribable.ts:23

Returns

void

onSubscribe()?

protected optional onSubscribe(): void;

Defined in: packages/core/src/subscribable.ts:29

Returns

void

onUnsubscribe()?

protected optional onUnsubscribe(): void;

Defined in: packages/core/src/subscribable.ts:30

Returns

void

Interfaces

LayerHandle

Defined in: packages/core/src/createLayer.ts:40

Identity-bound layer ops + escapes (stack / client / options / current). open/upsert take payload only; stack-level ops route via .stack.

Type Parameters

Properties

ValidatedLayerHandle

Defined in: packages/core/src/createLayer.ts:70

Validated handle: open/upsert take schema input (OpenValidatePayload); current/update use parsed output.

Extends

• Omit<LayerHandle<InferValidatorOutput<V>, R, E, D, RP>, "open" | "upsert">

Type Parameters

Properties

ValidationIssue

Defined in: packages/core/src/errors.ts:2

Provides validator-independent details for one payload failure.

Properties

LayerGroupOptions

Defined in: packages/core/src/layerGroup.ts:10

Customizes child-stack identity and lifecycle.

Properties

LayerGroupHandle

Defined in: packages/core/src/layerGroup.ts:21

Controls a child stack bound to its parent layer’s lifetime.

Properties

Methods

open()

open<P, R, E, D, RootProps>(options): Promise<R>;

Defined in: packages/core/src/layerGroup.ts:24

Opens a layer with the child stack pre-bound.

Type Parameters

Parameters

Returns

Promise<R>

dismissAll()

dismissAll(response?): void;

Defined in: packages/core/src/layerGroup.ts:27

Parameters

Returns

void

dispose()

dispose(): void;

Defined in: packages/core/src/layerGroup.ts:29

Removes the parent-lifetime binding when its owner unmounts.

Returns

void

StandardSchemaV1

Defined in: packages/core/src/standardSchema.ts:7

Minimal vendored Standard Schema v1 types. Vendoring keeps schema integration type-only and avoids a runtime dependency.

See

https://standardschema.dev

Type Parameters

Properties

DismissOptions

Defined in: packages/core/src/types.ts:43

Properties

DismissAllOptions

Defined in: packages/core/src/types.ts:47

Properties

LayerState

Defined in: packages/core/src/types.ts:52

Immutable layer snapshot consumed by selectors.

Type Parameters

Properties

LayerCallContext

Defined in: packages/core/src/types.ts:75

Imperative controls available to a rendered layer.

Type Parameters

Properties

LayerComponentProps

Defined in: packages/core/src/types.ts:93

Type Parameters

Properties

LayerOptions

Defined in: packages/core/src/types.ts:113

Type Parameters

Properties

StackOptions

Defined in: packages/core/src/types.ts:193

Properties

LayerClientOptions

Defined in: packages/core/src/types.ts:216

Properties

LayerNotifyView

Defined in: packages/core/src/types.ts:240

JSON-safe layer projection on StackNotifyEvent.

Properties

StackNotifyEvent

Defined in: packages/core/src/types.ts:257

Emitted when a stack snapshot changes after a labeled mutation.

Properties

Register

Defined in: packages/core/src/types.ts:275

Module-augmentation point for app-wide type defaults. Augment defaultError to set the library-wide error type once.

Example

declare module "@stainless-code/layers" {
  interface Register { defaultError: AppError }
}

Type Aliases

Resolve

type Resolve<T> = (value) => void;

Defined in: packages/core/src/controlledPromise.ts:1

Type Parameters

Parameters

Returns

void

Reject

type Reject = (reason?) => void;

Defined in: packages/core/src/controlledPromise.ts:2

Parameters

Returns

void

DataTag

type DataTag<Key, R, E> = Key extends object ? Key : Key & object;

Defined in: packages/core/src/dataTag.ts:12

Phantom-brands a LayerKey so response and error types survive inference without runtime metadata. Tagging is idempotent: the first tag wins, avoiding conflicting brands intersecting into never.

Type Parameters

InferDataTagResponse

type InferDataTagResponse<Key> = Key extends object ? R : never;

Defined in: packages/core/src/dataTag.ts:27

Lets generic APIs recover the response associated with a tagged key.

Type Parameters

InferDataTagError

type InferDataTagError<Key> = Key extends object ? E : never;

Defined in: packages/core/src/dataTag.ts:34

Lets generic APIs recover the error associated with a tagged key.

Type Parameters

ResponseOf

type ResponseOf<Key, Fallback> = Key extends object ? R : Fallback;

Defined in: packages/core/src/dataTag.ts:43

Preserves a response default when a generic key is untagged.

Type Parameters

ErrorOf

type ErrorOf<Key, Fallback> = Key extends object ? E : Fallback;

Defined in: packages/core/src/dataTag.ts:50

Preserves an error default when a generic key is untagged.

Type Parameters

LayerCancelReason

type LayerCancelReason = "parentDismiss" | "groupDispose" | "cancelAll" | "stackDisconnect";

Defined in: packages/core/src/errors.ts:78

Why LayerCancelledError rejected an open() promise.

• parentDismiss — child stack cancelAll’d when its parent layer dismissed
• groupDispose — adapter / host cleaned up a useLayerGroup owner
• cancelAll — explicit LayerStack#cancelAll / LayerClient#cancelAll
• stackDisconnect — host disconnect (e.g. Lit hostDisconnected)

LayerKey

type LayerKey = ReadonlyArray<unknown>;

Defined in: packages/core/src/types.ts:12

Logical identity for a layer (find / upsert / gcTime).

Must be JSON-safe: string | boolean | null | finite number, or plain objects / arrays of those. Compared via sorted JSON.stringify — two keys with the same values in a different object-property order are equal. Invalid keys throw LayerKeyError from any path that hashes the key (hashKey, open, find, cancelQueued, createLayer).

LayerPhase

type LayerPhase = "pending" | "queued" | "active" | "dismissed" | "error";

Defined in: packages/core/src/types.ts:14

LayerTransition

type LayerTransition = "entering" | "settled" | "exiting";

Defined in: packages/core/src/types.ts:22

Animation state, independent of resolution phase.

LayerActionStatus

type LayerActionStatus = "idle" | "running";

Defined in: packages/core/src/types.ts:24

BlockerFn

type BlockerFn = () => boolean | Promise<boolean>;

Defined in: packages/core/src/types.ts:27

Instance-scoped predicate — true allows dismissal.

Returns

boolean | Promise<boolean>

StackBlockerFn

type StackBlockerFn = (layer) => boolean | Promise<boolean>;

Defined in: packages/core/src/types.ts:30

Stack-scoped predicate — true allows dismissal.

Parameters

Returns

boolean | Promise<boolean>

DismissAllMode

type DismissAllMode = "skipBlocked" | "stopAtBlocked" | "force";

Defined in: packages/core/src/types.ts:41

How LayerStack#dismissAll treats blockers. All modes still resolve open() with the dismiss response — unlike LayerStack#cancelAll, which rejects with LayerCancelledError.

• skipBlocked — soft-dismiss each layer; leave blocked ones
• stopAtBlocked — soft-dismiss until the first veto, then stop
• force — bypass blockers; still completes with the response

LayerComponent

type LayerComponent = unknown;

Defined in: packages/core/src/types.ts:111

Framework adapters narrow this to their component type.

PayloadArg

type PayloadArg<P> = undefined extends P ? object : object;

Defined in: packages/core/src/types.ts:150

Makes payload optional only when P admits undefined. Optional object properties alone do not make the payload omittable.

Type Parameters

ResponseArgTuple

type ResponseArgTuple<R, Opts> = undefined extends R ? [R, Opts] : [R, Opts];

Defined in: packages/core/src/types.ts:155

Rest-tuple factory used by EndArgs and stack/handle variants.

Type Parameters

EndArgs

type EndArgs<R> = ResponseArgTuple<R, DismissOptions>;

Defined in: packages/core/src/types.ts:165

Rest-args for call.end / call.dismiss / LayerStack.dismiss. Response is optional only when R admits undefined — twin of PayloadArg. When response is optional, pass opts as the second arg (end(undefined, { force: true })); a lone object is treated as the response (not as opts).

Type Parameters

DismissAllArgs

type DismissAllArgs<R> = ResponseArgTuple<R, DismissAllOptions>;

Defined in: packages/core/src/types.ts:168

LayerStack.dismissAll rest-args (same gate as EndArgs).

Type Parameters

CancelQueuedArgs

type CancelQueuedArgs<R> = ResponseArgTuple<R, {
  id?: string;
}>;

Defined in: packages/core/src/types.ts:171

cancelQueued rest-args (same gate as EndArgs).

Type Parameters

HandleDismissArgs

type HandleDismissArgs<R> = ResponseArgTuple<R, DismissOptions & object>;

Defined in: packages/core/src/types.ts:174

LayerHandle.dismiss rest-args (same gate as EndArgs; opts may include id).

Type Parameters

OpenLayerOptions

type OpenLayerOptions<P, R, E, D, RootProps> = LayerOptions<P, R, E, D, RootProps> & PayloadArg<P>;

Defined in: packages/core/src/types.ts:179

Type Parameters

OmitKeyof

type OmitKeyof<T, K> = Omit<T, K>;

Defined in: packages/core/src/types.ts:188

Rejects keys that do not exist on T.

Type Parameters

SerialOnLoadError

type SerialOnLoadError = "block" | "advance";

Defined in: packages/core/src/types.ts:191

Serial policy when a mounted layer’s loadFn rejects.

StackDefaults

type StackDefaults = Record<string, StackOptions>;

Defined in: packages/core/src/types.ts:214

StackNotifyAction

type StackNotifyAction = 
  | "register"
  | "open"
  | "queue"
  | "update"
  | "setRunning"
  | "settle"
  | "dismiss"
  | "dismissVetoed"
  | "dismissAll"
  | "cancelAll"
  | "cancelQueued"
  | "phase"
  | "remove";

Defined in: packages/core/src/types.ts:224

Coarse mutation label for devtools / LayerClient#subscribeNotify. dismissAll = bulk completion; cancelAll = teardown that rejects open().

DefaultLayerError

type DefaultLayerError = Register extends object ? E : Error;

Defined in: packages/core/src/types.ts:278

App-wide error type configured through Register.

Validator

type Validator<Output> = 
  | StandardSchemaV1<unknown, Output>
  | ((input) => Output);

Defined in: packages/core/src/validators.ts:5

Unifies schema libraries and parser functions behind one validation contract.

Type Parameters

InferValidatorInput

type InferValidatorInput<V> = V extends StandardSchemaV1<infer I, unknown> ? I : V extends (input) => unknown ? I : never;

Defined in: packages/core/src/validators.ts:10

Preserves a validator’s pre-transform payload type in generic APIs.

Type Parameters

InferValidatorOutput

type InferValidatorOutput<V> = V extends StandardSchemaV1<unknown, infer O> ? O : V extends (input) => infer O ? O : never;

Defined in: packages/core/src/validators.ts:18

Preserves a validator’s post-transform payload type in generic APIs.

Type Parameters

OpenValidatePayload

type OpenValidatePayload<V> = V extends StandardSchemaV1 ? InferInput<V> : InferValidatorInput<V>;

Defined in: packages/core/src/validators.ts:26

Schema/parser input for validated open / ValidatedLayerHandle.

Type Parameters

Variables

notifyManager

const notifyManager: object;

Defined in: packages/core/src/notifyManager.ts:9

Coalesces listener calls by identity within a synchronous batch. Nested batches flush only when the outer batch completes; wrapped listeners called repeatedly during that interval run once.

Type Declaration

Functions

createCallContext()

function createCallContext<P, R, RootProps>(
   stack, 
   layer, 
   state, 
rootProps?): LayerCallContext<P, R, RootProps>;

Defined in: packages/core/src/callContext.ts:14

Creates the framework-neutral imperative context passed to a layer component. Adapters provide rendering; stack and layer instances retain lifecycle control.

Type Parameters

Parameters

Returns

LayerCallContext<P, R, RootProps>

createLayer()

Call Signature

function createLayer<V, R, E, D, RP>(options, client): ValidatedLayerHandle<V, R, E, D, RP>;

Defined in: packages/core/src/createLayer.ts:93

Wire layerOptions + a LayerClient into a headless LayerHandle.

Type Parameters

Parameters

Returns

ValidatedLayerHandle<V, R, E, D, RP>

Example

const c = createLayer(confirm, client);
const ok = await c.open({ title: "Remove?" });

Call Signature

function createLayer<P, R, E, D, RP>(options, client): LayerHandle<P, R, E, D, RP>;

Defined in: packages/core/src/createLayer.ts:107

Wire layerOptions + a LayerClient into a headless LayerHandle.

Type Parameters

Parameters

Returns

LayerHandle<P, R, E, D, RP>

Example

const c = createLayer(confirm, client);
const ok = await c.open({ title: "Remove?" });

layerKey()

function layerKey<R, E>(): <Key>(key) => DataTag<Key, R, E>;

Defined in: packages/core/src/dataTag.ts:69

Adds response and error inference to a key without changing it at runtime.

Type Parameters

Returns

<Key>(key) => DataTag<Key, R, E>

Example

import { LayerClient, layerKey } from "@stainless-code/layers";

const client = new LayerClient();
const removeKey = layerKey<boolean>()(["confirm", "remove"]);
const ok = await client.open({ key: removeKey, payload: { title: "Remove?" } });
//    ^? boolean

isPayloadValidationError()

function isPayloadValidationError(value): value is PayloadValidationError;

Defined in: packages/core/src/errors.ts:34

Narrows an unknown rejection to PayloadValidationError.

Parameters

Returns

value is PayloadValidationError

Example

import { isPayloadValidationError } from "@stainless-code/layers";

function validationMessages(error: unknown) {
  return isPayloadValidationError(error)
    ? error.issues.map((issue) => issue.message)
    : [];
}

isLayerKeyError()

function isLayerKeyError(value): value is LayerKeyError;

Defined in: packages/core/src/errors.ts:66

Narrows an unknown synchronous throw to LayerKeyError.

Parameters

Returns

value is LayerKeyError

Example

import { isLayerKeyError } from "@stainless-code/layers";

try {
  client.open({ key: [maybeId], payload });
} catch (error) {
  if (isLayerKeyError(error)) {
    console.error(error.path, error.message);
  }
}

isLayerCancelledError()

function isLayerCancelledError(value): value is LayerCancelledError;

Defined in: packages/core/src/errors.ts:115

Narrows an unknown rejection to LayerCancelledError. Treat any cancel reason as normal teardown unless you branch on LayerCancelledError#reason.

Parameters

Returns

value is LayerCancelledError

Example

import { isLayerCancelledError } from "@stainless-code/layers";

try {
  await confirm.open(payload);
} catch (error) {
  if (isLayerCancelledError(error)) return;
  throw error;
}

childStackId()

function childStackId(parent, name?): string;

Defined in: packages/core/src/layerGroup.ts:33

Derives a collision-free path id: ${parentStackId}~${parentLayerId}~${name}.

Parameters

Returns

string

createLayerGroup()

function createLayerGroup(
   client, 
   parent, 
   options?): LayerGroupHandle;

Defined in: packages/core/src/layerGroup.ts:61

Creates a child stack that is cancelAll’d (LayerCancelledError, reason parentDismiss) when its parent dismisses. Pass the LayerClient that owns parent; another client cannot observe the parent’s lifetime.

Parameters

Returns

LayerGroupHandle

Example

import {
  createLayerGroup,
  type LayerCallContext,
  type LayerClient,
} from "@stainless-code/layers";

declare const client: LayerClient;
declare const parent: LayerCallContext<unknown, unknown>;

const group = createLayerGroup(client, parent, { name: "nested" });
group.dismissAll();
group.dispose();

layerOptions()

function layerOptions<P, R, E, D, RootProps, Key>(options): LayerOptions<P, R, E, D, RootProps> & object;

Defined in: packages/core/src/layerOptions.ts:21

Preserves payload, response, error, and data inference for reusable layer options. Returns the same object at runtime; its DataTag-branded key lets LayerClient.open infer the response without an explicit generic.

Type Parameters

Parameters

Returns

LayerOptions<P, R, E, D, RootProps> & object

Example

import { LayerClient, layerOptions } from "@stainless-code/layers";

const client = new LayerClient();
const confirm = layerOptions<{ title: string }, boolean>({
  key: ["confirm", "remove"],
});
const ok = await client.open({ ...confirm, payload: { title: "Remove?" } });
//    ^? boolean

assertLayerKey()

function assertLayerKey(key): asserts key is LayerKey;

Defined in: packages/core/src/utils.ts:121

Ensures a layer key is JSON-safe for hashKey. Allowed: string | boolean | null | finite number | plain objects | arrays of those. Throws LayerKeyError when a segment is outside that domain.

Parameters

Returns

asserts key is LayerKey

Example

import { assertLayerKey } from "@stainless-code/layers";

assertLayerKey(["confirm", filterId ?? "none"]);

hashKey()

function hashKey(key): string;

Defined in: packages/core/src/utils.ts:132

Serializes a key deterministically by sorting object properties recursively. Throws LayerKeyError when the key is not JSON-safe.

Parameters

Returns

string

keySignature()

function keySignature(key): string;

Defined in: packages/core/src/utils.ts:143

Produces the canonical identity used to compare layer keys. Throws LayerKeyError when the key is not JSON-safe (via hashKey).

Parameters

Returns

string

shallowArrayEqual()

function shallowArrayEqual<T>(a, b): boolean;

Defined in: packages/core/src/utils.ts:152

Element-wise Object.is for arrays. Keeps key-filtered snapshot selections stable when filter() reallocates but the matched element refs are unchanged.

Type Parameters

Parameters