propresenter-php/doc/reference_samples
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
..
all-songs refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
ExamplePlaylists refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
Media refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
pp-config feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
pp-themes/sample feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
probundle/pro-format-difference 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 feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CCLI feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
ClearGroups feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
CommunicationDevices feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Groups feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
KeyMappings feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Labels feat(labels): add reader for global Labels file 2026-05-03 20:53:45 +02:00
Macros feat(macros): add reader for global Macros file 2026-05-03 20:38:47 +02:00
Messages feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Props feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
RestBildExportFromPP.probundle 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 feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Test.pro refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
TestBild.probundle refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
TestMitBildernUndMakro.pro refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
TestMitMakro.pro refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
TestPatterns feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
TestPlaylist.proplaylist refactor: make repo Composer-compatible by moving php/ to root and ref/ to doc/reference_samples 2026-03-30 13:26:29 +02:00
TestTranslated.pro 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 feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00
Workspace feat(library): add readers + writers for all ProPresenter global libraries and theme bundles 2026-05-03 21:40:09 +02:00