Eve library

ISIS v2 JSON-MANIFEST Output Schema and Metadata Contract

Guide

Revision 1

On this page

Generated: 2026-03-06T09:49:52.281Z Checklist: MXD-0061 (ISIS2-01251) Format: json-manifest (application/json) Phase: Phase 4 | Milestone: M3 Launch (2026-07-27 to 2026-10-30)

Objective#

Define a canonical schema and metadata contract for standalone JSON manifest outputs with manifest-role validation, deterministic ordering guarantees, integrity/provenance signaling, and workflow provenance suitable for package, continuity, delivery, and metadata handoff.

Canonical Schema#

  • Schema ID: isis.v2.output.json-manifest.package
  • Schema Version: 1.0.0
  • Binary signature: 7B 22 / 5B 7B
  • Required top-level fields:
    • schemaVersion
    • format
    • manifestKind
    • manifestVersion
    • recordCount
    • primaryEntityType
    • includesChecksums
    • includesProvenance
    • includesDependencies
    • deterministicKeyOrder
    • manifest
  • Manifest fields:
    • filename
    • mimeType
    • checksumAlgorithm
    • checksum
    • generatedAt
    • provenance
  • Provenance fields:
    • assetFamilyId
    • workflowId
    • workflowVariant
    • promptFingerprint
    • seed
    • modelId
    • dependencyManifestRef

Supported Package Classes#

Package Class Storage Tier Required Artifacts
manifest WARM manifest/package-manifest.json, manifest/checksums.sha256

Supported Output Classes#

Output Class Package Classes
audio_master manifest
dcc_bundle manifest
engine_bundle manifest
image_sequence manifest
mesh_package manifest
metadata_manifest manifest
preview_image manifest
project_archive manifest
source_frames manifest
sprite_sheet manifest
texture_set manifest
video_master manifest

Applicable Asset Families#

Asset Family Output Classes Naming Rules
animatic-shot-set metadata_manifest FN-003
architecture-kitbash-pack metadata_manifest FN-003
audio-sfx-pack metadata_manifest FN-002
character-concept-art metadata_manifest FN-003
character-costume-variant-pack metadata_manifest FN-003
character-expression-sheet metadata_manifest FN-003
character-prop-interaction-sheet metadata_manifest FN-003
character-turnaround-sheet metadata_manifest FN-003
cinematic-shot-sequence metadata_manifest FN-003
creature-concept-art metadata_manifest FN-003
decal-pack metadata_manifest FN-003
environment-concept-art metadata_manifest FN-003
environment-matte-painting metadata_manifest FN-003
environment-tileset-pack metadata_manifest FN-003
foliage-pack metadata_manifest FN-003
hud-element-pack metadata_manifest FN-003
interior-scene-pack metadata_manifest FN-003
marketing-key-art-pack metadata_manifest FN-003
material-pbr-pack metadata_manifest FN-003
music-cue-pack metadata_manifest FN-002
npc-crowd-variation-pack metadata_manifest FN-003
prop-pack-general metadata_manifest FN-003
sky-atmosphere-pack metadata_manifest FN-003
social-cutdown-pack metadata_manifest FN-003
storyboard-frame-set metadata_manifest FN-003
terrain-heightmap-pack metadata_manifest FN-003
ui-icon-pack metadata_manifest FN-003
vehicle-exterior-pack metadata_manifest FN-003
vehicle-interior-pack metadata_manifest FN-003
vfx-element-pack metadata_manifest FN-003
voice-line-pack metadata_manifest FN-002
weapon-pack metadata_manifest FN-003

Validation Invariants#

  • Package JSON manifests require embedded checksum coverage.
  • Metadata and continuity JSON manifests require provenance coverage.
  • Delivery JSON manifests must target the delivery primaryEntityType.
  • Shot JSON manifests must target the shot primaryEntityType.
  • JSON manifest outputs require deterministic key ordering.
  • RegisterOutputRequest mimeType must be application/json, type must be document or data, and storage.key must end with .json when jsonManifestPackage is supplied.
  • JSON manifest checksum uses sha256 and must preserve workflow/dependency provenance linkage.

Verification Commands#

  • pnpm --filter @isis/output-registry exec vitest run src/schemas/output.schema.spec.ts
  • node scripts/isis/validate-v2-json-manifest-output-schema-metadata-contract.mjs

Acceptance Criteria#

  • Output registry accepts first-class JSON manifest package metadata with strict validation over manifest role, primary entity type, deterministic ordering, and manifest checksum fields.
  • Canonical JSON manifest contract enumerates the package classes, output classes, and asset families that legitimately emit standalone manifest JSON artifacts under the shared output taxonomy.
  • JSON manifest provenance preserves workflow-variant and dependency-manifest linkage needed for deterministic downstream ingest of manifest-oriented artifacts.
  • Validator and schema tests catch invalid JSON manifest registrations and enforce the canonical metadata surface.

Traceability#

  • Checklist item: MXD-0061
  • Ticket key: ISIS2-01251
  • Source references:
    • docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_TICKETS.json
    • docs/domains/isis/remediation-v2/ISIS_V2_OUTPUT_PACKAGE_TAXONOMY.json
    • apps/isis/output-registry/src/schemas/output.schema.ts
    • apps/isis/output-registry/src/schemas/output.schema.spec.ts
    • apps/isis/output-registry/src/services/output.service.ts
    • apps/isis/output-registry/src/types.ts
    • docs/domains/isis/remediation-v2/ISIS_V2_ANIMATIC_SHOT_SET_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_ARCHITECTURE_KITBASH_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_AUDIO_SFX_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CHARACTER_CONCEPT_ART_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CHARACTER_COSTUME_VARIANT_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CHARACTER_EXPRESSION_SHEET_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CHARACTER_PROP_INTERACTION_SHEET_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CHARACTER_TURNAROUND_SHEET_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CINEMATIC_SHOT_SEQUENCE_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_CREATURE_CONCEPT_ART_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_DECAL_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_ENVIRONMENT_CONCEPT_ART_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_ENVIRONMENT_MATTE_PAINTING_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_ENVIRONMENT_TILESET_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_FOLIAGE_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_HUD_ELEMENT_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_INTERIOR_SCENE_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_MARKETING_KEY_ART_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_MATERIAL_PBR_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_MUSIC_CUE_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_NPC_CROWD_VARIATION_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_PROP_PACK_GENERAL_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_SKY_ATMOSPHERE_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_SOCIAL_CUTDOWN_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_STORYBOARD_FRAME_SET_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_TERRAIN_HEIGHTMAP_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_UI_ICON_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_VEHICLE_EXTERIOR_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_VEHICLE_INTERIOR_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_VFX_ELEMENT_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_VOICE_LINE_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • docs/domains/isis/remediation-v2/ISIS_V2_WEAPON_PACK_OUTPUT_PACKAGE_CONTRACT.json
    • ISIS_TODOS_2.md