Schema Studio Utils: Reusable TypeScript Utilities for Schema Studio JSON Schema Packages, Manifests, and Schema-Version Data Migration
Abstract
@hzb-rdm/schema-studio-utils is an open-source TypeScript utility package for working with versioned JSON Schema packages created with Schema Studio. The package provides reusable, framework-neutral functionality for research metadata applications that need to validate, index, compare, publish, and evolve JSON Schema-based metadata models. It was extracted from schema-management functionality developed in the SEPIA ecosystem at Helmholtz-Zentrum Berlin für Materialien und Energie GmbH (HZB). Schema Studio Utils supports: Validation of JSON Schema objects with required schema title and version metadata Generation and reindexing of Schema Studio-compatible manifest.json files Interpretation of the Schema Studio schema-status lifecycle extension Schema-family management, where all versions sharing a schema title receive one family identifier Latest-version and related-version calculation Schema-package health checks for missing, malformed, and unindexed schema files UUID filename validation, collision detection, and safe schema replacement decisions Search, status filtering, and pagination data for schema registries Framework-neutral JSON comparison data for visual schema-diff interfaces Optional Node.js filesystem utilities for reading, writing, and reindexing local schema packages The package does not depend on React, Next.js, database systems, authentication providers, or a fixed storage implementation. Its platform-neutral core can be integrated into web applications, backend services, command-line tools, and other research-data infrastructures. Schema migration roadmap Schema definitions evolve over time, while persisted metadata may remain associated with older schema versions. Schema Studio Utils establishes the foundation for future migration functionality that will explicitly map and transform metadata from an old schema version to a target schema version. Planned migration capabilities include field renaming, moving, splitting, merging, default values, removals, controlled-vocabulary value conversion, nested object and array transformations, target-schema validation, dry-run migration reports, explicit confirmation workflows, and migration history for auditability and reproducibility. Relationship to the SEPIA ecosystem Schema Studio Utils is intended for use with: Schema Studio, for creating and publishing versioned metadata schemas SEPIA, for managing sample metadata and dynamic schema-specific descriptions Dynamic JSON Form Renderer, for rendering schema-driven forms and read-only metadata views Source code:https://codebase.helmholtz.cloud/hzb/research_data_management/schema-studio-utils Helmholtz Software Directory:https://helmholtz.software/software/schema-studio-utils License This software is licensed under the MIT License.
Publication details
- Journal / source
- Zenodo (CERN European Organization for Nuclear Research)
- Publication date
- 20 August 2026
- Language
- EN