public/propresenter-php
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
propresenter-php/proto
History
Thorsten Bus 9e3e719806 feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 
Add full IO support for every global ProPresenter library file plus
theme folders, and extend the existing Labels/Macros readers with
exporters and editable accessors so every supported document is now a
round-trippable, mutable object.

New library readers/writers (each: FileReader, FileWriter, Library
wrapper, element wrapper where applicable, CLI tool, tests, doc/api/*.md):

- Groups          (ProGroupsDocument)        + GroupDefinition
- ClearGroups     (ClearGroupsDocument)      + ClearGroupDefinition
- CCLI            (CCLIDocument)
- Messages        (MessageDocument)          + Message
- Timers          (TimersDocument + Clock)   + Timer
- Stage           (Stage.Document)           + StageLayout
- Workspace       (ProPresenterWorkspace)    + Screen
- Props           (PropDocument)             + Prop
- TestPatterns    (TestPatternDocument)
- Calendar        (new CalendarDocument)     + CalendarEvent
- KeyMappings     (new KeyMappingsDocument)  + KeyMapping
- CommunicationDevices (JSON file)           + CommunicationDevice
- Theme bundles   (Template.Document folder + Assets/) + ThemeBundle/Slide/Asset

Extensions to existing modules:

- LabelsFileWriter; Label and LabelLibrary gain setters, addLabel,
  removeLabel, setColor / setColorHex helpers
- MacrosFileWriter; Macro/MacroCollection/MacroLibrary gain UUID, name,
  color, image_type, image_data, trigger_on_startup setters plus
  add/remove for macros and collections

Two new minimal proto schemas were defined for documents that lacked
upstream definitions:

- proto/calendar.proto   - CalendarDocument with Event entries, raw
  bytes for the action/macro sub-messages so the schema can evolve
- proto/keyMappings.proto - KeyMappingsDocument with ApplicationInfo
  and a forward-looking Mapping message (sample only carries the info)

The Theme file turned out to be a regular Rv\Data\Template\Document, so
no new proto was required for theme content; ThemeBundle layers folder
+ Assets/ handling on top in the same spirit as PresentationBundle.

GroupDefinition is intentionally distinct from the existing Group class
(which wraps song-level CueGroup) to avoid breaking song APIs.

Verified with the full PHPUnit suite: 370 tests, 9200 assertions, all
green; LSP diagnostics clean across src/. The unmodified reference
samples for Labels, Groups, ClearGroups, TestPatterns, Calendar and
KeyMappings round-trip byte-for-byte; the others round-trip with the
same byte length (PHP protobuf is not canonically deterministic but
re-write-after-write stabilises).

doc/INDEX.md, doc/keywords.md and AGENTS.md updated so every new module
is discoverable from the top level.
2026-05-03 21:40:09 +02:00
..
google/protobuf refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
action.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
alignmentGuide.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
alphaType.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsApi.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsCapture.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsCreate.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsEvent.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsImport.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsMultiTracks.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsPlaybackMarker.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsProContent.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsStartup.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsSync.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsTimecode.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsTimeline.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsTrigger.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsTriggerMedia.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsUI.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsUpdate.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
analyticsWHMStore.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
applicationInfo.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
audio.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
background.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
calendar.proto feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ccli.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
clearGroups.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
collectionElementType.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
color.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
cue.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
digitalAudio.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
effects.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
fileProperties.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
font.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
graphicsData.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
groups.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
hotKey.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
input.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
intRange.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
keyMappings.proto feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
labels.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
layers.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
macros.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
messages.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
musicKeyScale.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
planningCenter.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
playlist.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
preferences.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
presentation.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
presentationSlide.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApi.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Announcement.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Audio.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Capture.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Clear.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Color.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1ContentType.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1ErrorResponse.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Groups.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Identifier.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1LayerType.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Library.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Link.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Looks.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Macro.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Masks.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Media.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1MediaPlaylistItem.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Message.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Miscellaneous.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Playlist.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Preroll.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Presentation.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1PresentationPlaylistItem.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Prop.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Size.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Stage.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Status.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Theme.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1TimelineOperation.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Timer.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Transport.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1Trigger.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proApiV1VideoInputs.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proAudienceLook.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proClockSource.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proCore.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proCoreTestPatterns.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proMask.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
propDocument.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
propresenter.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
propSlide.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proscreen.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
proworkspace.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
recording.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
registration.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
rv2d.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
rvtimestamp.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
screens.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
slide.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
stage.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
template.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
templateIdentification.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
testPattern.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
timedPlayback.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
timers.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
url.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
uuid.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
version.proto refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00