npm package: @sdux-vault/core
Description: > Behavior runtime and pipeline execution layer for SDuX.
Latest version: 0.0.9

# @sdux-vault/core

> Behavior runtime and pipeline execution layer for SDuX.

`@sdux-vault/core` provides the **runtime implementation for behaviors and state pipeline execution**.

It builds on the contracts defined in `@sdux-vault/shared` and provides the **concrete execution layer that runs behaviors and applies state changes**.

---

## TL;DR

For full documentation, guides, and API references:  
https://www.sdux-vault.com

---

## Overview

SDuX is built as a layered system:

```plaintext
shared → engine → core → core-extensions → apps
           └─────────---------───────────→ devtools
```

- **apps** → end-user applications
- **core** → behavior runtime + execution layer (this package)
- **core-extensions** → framework integrations
- **devtools** → debugging and inspection
- **engine** → runtime engine and orchestration
- **shared** → contracts, types, utilities

---

## What This Package Does

Core is responsible for:

- executing **behavior pipelines**
- applying **state transformations**
- handling **state lifecycle updates**
- emitting **state changes**

It is the **bridge between contracts (shared)** and **actual runtime execution**.

---

## What This Package Provides

- **Behavior runtime** — executes behavior implementations
- **Pipeline execution** — runs ordered behavior stages
- **State commit logic** — applies updates to snapshots
- **State emission** — publishes state changes
- **Execution wrapper utilities** — glue between behaviors and runtime

---

## Installation

```bash
npm install @sdux-vault/core
```

---

## Execution Model

Core processes state updates through a behavior pipeline:

```plaintext
incoming → behaviors → state commit → emit
```

Key properties:

- ordered execution
- controlled mutation
- isolated state emission

---

## Behavior Pipeline

Core executes behaviors in defined stages such as:

```plaintext
resolve → filter → reduce → persist → emit
```

Each behavior:

- receives input from the previous stage
- may transform or short-circuit execution
- must not leak mutable references

---

## State Handling

Core manages:

- an **internal mutable snapshot**
- an **external read-only state view**

State updates:

- are applied via controlled mutation
- are emitted as isolated copies
- must preserve reference boundaries

---

## Side Effects

Core performs required runtime setup:

- behavior initialization
- pipeline wiring
- state emission

These are:

- deterministic
- environment-safe
- required for execution

---

## Development

### Build

```bash
npm run build:core
```

Output:

```plaintext
dist/core
```

---

### Test

```bash
npm run test:core
```

---

### Verify

```bash
npm run verify
```

Includes:

- linting
- formatting
- type checking
- tests

---

## Publishing

See [RELEASE.md](./RELEASE.md) for publishing instructions.

---

## Ecosystem

- `@sdux-vault/addons` — optional, composable extensions for runtime behavior ([README](../addons/README.md))
- `@sdux-vault/core-extensions/angular` — Angular integration layer (signals, DI, reactive bindings) ([README](../core-extensions/angular/README.md))
- `@sdux-vault/devtools` — observability and debugging layer for runtime inspection ([README](../devtools/tooling/README.md))
- `@sdux-vault/engine` — orchestration, conductor, decision engine
- `@sdux-vault/shared` — contracts, types, utilities([README](../shared/README.md))

---

## License

For full licensing details:  
https://www.sdux-vault.com/docs/welcome/license#license-texts

MIT © SDuX Vault