manifest.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/authoring_capsule/component.hpp>
#include <pulp/authoring_capsule/limits.hpp>
#include <pulp/authoring_capsule/status.hpp>
#include <pulp/runtime/result.hpp>
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace pulp::authoring_capsule {

inline constexpr std::string_view kFormatId = "org.pulp.audio-authoring-capsule";
inline constexpr std::uint32_t kFormatVersion = 1;
 
enum class Reproducibility : std::uint8_t {
    reproducible,
    best_effort,
    frozen_output_only,
};

struct Compatibility {
    std::string min_product_version;
    std::string min_runtime_version;
    std::string schema_version;
    std::string extra_json = "{}";
};
 
struct Manifest {
    std::string format = std::string(kFormatId);
    std::uint32_t format_version = kFormatVersion;
 
    // ── Routing. Authenticated, bounded, and the only routing input. ──
    std::string profile;
    std::uint32_t profile_version = 1;
    std::string product;
    std::string authoring_kind;
    std::vector<std::string> subtypes;
    std::string topology_json = "{}";
    std::vector<std::string> required_capabilities;
 
    // ── Identity. ──
    std::string project_id;
    std::string revision_id;
    std::string parent_revision;
 
    Reproducibility reproducibility = Reproducibility::best_effort;
    Compatibility compatibility;
    std::vector<FileEntry> files;
    std::vector<DependencyEntry> dependencies;
 
    // ── Descriptive. Excluded from the revision digest. ──
    std::string title;
    std::string created_at;
    std::string exported_at;
    std::string provenance_json = "{}";
    std::string attestations_json = "[]";
    std::string distribution_json = "{}";

    std::string unknown_optional_json = "{}";
};

runtime::Result<std::string, CapsuleError> to_canonical_json(const Manifest& manifest);

runtime::Result<Manifest, CapsuleError> parse_manifest(std::string_view json);

runtime::Result<std::string, CapsuleError> revision_digest(const Manifest& manifest);

Completeness derive_completeness(const Manifest& manifest);
 
}  // namespace pulp::authoring_capsule