Sindri

Sindri is the build tool for the Valkyrja TypeScript framework.

Sindri reads your TypeScript source and generates pre-computed data files for faster runtime performance, handling build-time concerns across the Valkyrja ecosystem. Named after the dwarven smith in Norse mythology who forged Mjölnir and other divine artifacts, Sindri does for your Valkyrja app what his namesake did for the gods: crafts the artifacts that make it all work faster and better.

What Sindri Does

• Generates data files — reads your TypeScript source and produces pre-computed container, routing, and event data files so your application skips discovery work at runtime
• Optimizes runtime performance — the generated data lets Valkyrja boot without reflecting over providers and configuration on every invocation
• Handles build-time concerns — centralizes the code-generation steps across the Valkyrja ecosystem

Installation

Via npm

Add Sindri to an existing Valkyrja project as a dev dependency:

npm install --save-dev @valkyrjaio/sindri

Getting Started

Generating Data Files

Once your application's providers and configuration are in place, generate the pre-computed data files:

npx sindri data:generate

Run npx sindri with no command to see usage and the list of available commands.

Documentation

Full Sindri documentation is available on the Valkyrja website.

For framework-level questions about Valkyrja itself, see the Valkyrja framework repository.

Versioning and Release Process

Sindri follows semantic versioning with a major release every year, and support for each major version for 2 years from the date of release.

For more information see our Versioning and Release Process documentation.

Supported Versions

Bug fixes are provided until 3 months after the next major release. Security fixes are provided for 2 years after the initial release.

| Version | Node | Release | Bug Fixes Until | Security Fixes Until | | :------ | :--- | :------------- | :-------------- | :------------------- | | 26 | 22+ | March 31, 2026 | Q2 2027 | Q1 2028 |

Contributing

Sindri is an open-source, community-driven project. Thank you for your interest in helping develop, maintain, and release it.

See CONTRIBUTING.md for the submission process and VOCABULARY.md for the terminology used across Valkyrja.

Security Issues

If you discover a security vulnerability within Sindri, please follow our disclosure procedure.

License

Sindri is open-source software licensed under the MIT license. See LICENSE.md.