@go-labs-sg/rsvp 0.10.2 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/dist/index.js +1267 -15212
- package/examples/event-page-template.json +65 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -67,6 +67,38 @@ automation can still record arguments independently of the CLI's error output.
|
|
|
67
67
|
|
|
68
68
|
Use `rsvp help` for the command catalogue. Every response is a JSON envelope on stdout; errors and diagnostics go to stderr. `rsvp manifest` emits the machine-readable command reference for tooling.
|
|
69
69
|
|
|
70
|
+
## Public event page and images
|
|
71
|
+
|
|
72
|
+
Use `rsvp event get --organization-id <id> --event-id <id>` to inspect the
|
|
73
|
+
current `configurationVersion`, page content in `metadataJson.detailsPage`, and
|
|
74
|
+
the separate `bannerImageKey` and `publicTheme.backgroundImageKey`. To update
|
|
75
|
+
the public details page, copy `examples/event-page-template.json`, replace the
|
|
76
|
+
organization ID, event ID, and version, then edit its rich text and timeline
|
|
77
|
+
items. The version must match the event's current `configurationVersion`.
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
rsvp event page update \
|
|
81
|
+
--allow-state-change \
|
|
82
|
+
--target evt_123 \
|
|
83
|
+
--payload "$(cat event-page.json)"
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
The command supplies `section: "DETAILS_PAGE"` to the revision-checked setup
|
|
87
|
+
API. One `TIMELINE` section contains many ordered `timelineItems`; each item
|
|
88
|
+
has a time, rich title, and optional rich details. Other sections use
|
|
89
|
+
`layout: "STANDARD"` and their own rich heading and content. The existing
|
|
90
|
+
`event setup step update` command can send the same data when its payload
|
|
91
|
+
includes `section: "DETAILS_PAGE"`.
|
|
92
|
+
|
|
93
|
+
Banner and background images are separate event assets. Use
|
|
94
|
+
`event banner upload create` or `event background upload create` to get the
|
|
95
|
+
corresponding upload URL and key, upload the image to that URL, then set the
|
|
96
|
+
key with `event banner update` or `event background update`. These update
|
|
97
|
+
commands also require the current configuration version and accept a null
|
|
98
|
+
key to clear the image. The public event guide reuses both assets. Campaign
|
|
99
|
+
HTML can link to the guide with `{{eventDetailsUrl}}`; `{{eventUrl}}` still
|
|
100
|
+
points to the registration page.
|
|
101
|
+
|
|
70
102
|
For a read-only registration-journey diagnosis, inspect the event, draft,
|
|
71
103
|
published versions, and event-owned resources together:
|
|
72
104
|
|