@decantr/essence-spec

Support status: core-supported
Release channel: stable

Schemas, validation, migration, guard evaluation, and TypeScript types for decantr.essence.json.

Install

npm install @decantr/essence-spec

What It Exports

• validateEssence() for schema validation
• evaluateGuard() for contract/guard checks
• normalizeEssence() for version normalization
• migrateV2ToV3() and migrateV30ToV31() for structured migrations
• Decantr essence TypeScript types

Example

import { evaluateGuard, validateEssence } from '@decantr/essence-spec';

const result = validateEssence(essence);
if (!result.valid) {
  console.error(result.errors);
}

const violations = evaluateGuard(essence, {});

Schema Exports

• @decantr/essence-spec/schema/essence.v2.json
• @decantr/essence-spec/schema/essence.v3.json

Compatibility

@decantr/essence-spec now defines a stable public contract for Decantr essence validation and migration in the 1.x line.

• additive schema fields may be introduced in compatible minor releases
• breaking schema or migration behavior changes require a major version
• deprecation and migration guidance should be documented before removing or replacing a supported essence path

Stability Note

This package is the lowest-level public Decantr contract and is intended to remain boring and dependable for downstream consumers.

• patch releases should stay documentation-only or behaviorally compatible
• schema export paths are part of the supported public surface
• coordinated downstream releases should only be needed when a package explicitly adopts a newer essence-spec version

License

MIT