Ctrl K

schema-studio-utils

Reusable TypeScript Utilities for Schema Studio JSON Schema Packages, Manifests, and Schema-Version Data Migration

1
contributor
6 commitsLast commit ≈ 4 days ago0 stars0 forks

Description

Schema Studio Utils is an open-source, framework-neutral TypeScript package for managing versioned JSON Schema packages in FAIR research data management applications.

It supports JSON Schema packages exported by Schema Studio, including UUID-named schema files and a generated manifest.json. The package provides schema validation, manifest generation and reindexing, lifecycle-status handling, schema-family and version management, schema health checks, safe upload and replacement decisions, search and pagination data, JSON comparison data, and optional Node.js filesystem helpers.

A schema title defines a schema family, allowing all versions of the same metadata model to share one family identifier. The package recalculates latest-version and related-version information and derives manifest status from Schema Studio’s schema-status extension.

Schema Studio Utils is designed for reuse in SEPIA and other research data management systems. It has no dependency on React, Next.js, a database, or a specific authentication or storage system.

The package also provides the foundation for a planned schema migration workflow. Future releases will support explicit mappings and transformations to upgrade persisted metadata from an old schema version to a newer version, including validation, dry-run reports, and traceable migration history.

Participating organisations

Helmholtz-Zentrum Berlin für Materialien und Energie

Contributors

Mojeeb Rahman Sedeqi
Author/Developer/Maintainer
Helmholtz-Zentrum Berlin für Materialien und Energie

Related software

Schema Studio

SC

Schema Studio is an open-source visual platform for creating, validating, previewing, versioning, and publishing JSON Schema-based metadata models for FAIR research data.

Updated 6 days ago
1