Skip to main content
The Package type represents an immutable snapshot of components at a specific version. Packages follow semantic versioning and include all dependencies needed to render content.

Type Definition

Fields

Field Details

version

Packages use semantic versioning (semver):
  • Major (1.0.0 → 2.0.0): Breaking changes
  • Minor (1.0.0 → 1.1.0): New features, backward compatible
  • Patch (1.0.0 → 1.0.1): Bug fixes

compiled

JSON object mapping component names to their compiled code:

resolved vs resolvedRef

Choose based on your use case:
  • resolved: Full package data inline (larger payload, simpler client)
  • resolvedRef: IDs only for normalized caching (smaller payload, requires additional queries)
See Resolved Package for details.

PackageDependency

Example Query

Full Package Data

With Caching References

Response: