Skip to content
Cratis

Frontend proxies

Arc generates a TypeScript proxy for every command and query. Marquee ships them in two packages with no UI framework dependency, because the people who write announcements and the people who read them use different applications.

PackageProxiesBackend
@cratis/showrunner.marqueeAnnouncementsForMe, AcknowledgeAnnouncement, Display and ImportanceCratis.Showrunner.Marquee
@cratis/showrunner.marquee.authoringAuthorAnnouncement, AmendAnnouncement, RetargetAnnouncement, WithdrawAnnouncement, Announcement, Audience, AudienceKind, Display and ImportanceCratis.Showrunner.Marquee.Authoring
Terminal window
yarn add @cratis/showrunner.marquee @cratis/arc @cratis/arc.react @cratis/fundamentals

@cratis/arc, @cratis/arc.react and @cratis/fundamentals are peer dependencies, so the application decides their versions. Use the package version that matches the NuGet packages: everything in Showrunner is released together with one version.

import { AnnouncementsForMe, AcknowledgeAnnouncement } from '@cratis/showrunner.marquee';


const [announcements] = AnnouncementsForMe.use();
const acknowledge = new AcknowledgeAnnouncement();
acknowledge.announcementId = announcements.data[0].id;
await acknowledge.execute();

The proxies are generated from the C# code on a Debug build; never edit them. CI rebuilds in Debug and fails when the committed proxies differ.

The components that use the receiving proxies are in @cratis/showrunner.marquee.react; see Add announcements to a product.

Community: Discord