ThePalaceProject / web-patron / 25001739971

88%

push

github

Add runtime config module with ArkType validation (PP-4124) (#124)

## Description

**Note:** This is the first in a series of PRs to move fully to runtime
configuration. Other associated PRs will stack on this one.

Adds the server-side runtime config module and supporting pieces that
subsequent PRs will wire into the app. No existing code is changed;
nothing imports these new files yet.

Specifically, this PR adds:
- A server-side config loader that reads and parses `CONFIG_FILE` at
runtime on first request and caches the result for the process lifetime.
`ArkType` validates the raw YAML structure upfront so malformed configs
produce a clear error rather than a confusing downstream failure.
Per-slug library-entry errors are handled separately so their messages
can include the offending slug in the path.
- A React context and `useAppConfig()` hook for components to consume
config values, and a safe fallback config for use before `pageProps` is
available (e.g. during SSR).
- Support for the `staticLibraries` "shape" in `AppConfig` —
object-format `libraries` entries mapping slugs directly to auth
document URLs.
- A config file reference in the README (options table and media support
explanation), so the deprecation warning for the legacy string
`libraries` format has somewhere concrete to point.

## Motivation and Context

The long-term goal is to read configuration at server startup rather
than baking its contents into the build artifact, so that config changes
don't require a full rebuild and redeploy.

This PR adds the new module without activating it; a follow-on PR will
switch consumers over.

[JIRA PP-4124]

## How Has This Been Tested?

- Includes unit tests for the new functionality.
- All check pass locally.
- [CI
checks](https://github.com/ThePalaceProject/web-patron/actions/runs/24856257601)
pass.

## Checklist:

- [x] I have updated the documentation accordingly.
- [x] All new and existing tests passed.

227 of 267 branches covered (85.02%)

Branch coverage included in aggregate %.

68 of 68 new or added lines in 2 files covered. (100.0%)

351 of 413 relevant lines covered (84.99%)

14.47 hits per line