Expand description
§ppoppo-pcs-session-proto
Wire contract for the PCS public session face. The .proto files are the SSOT and live
in this crate — the server and every client compile the same files, so the
contract cannot drift between them, and the crates.io tarball doubles as the
contract artifact for non-Rust codegen. The generated gRPC types are what you
depend on.
Package: pcs.session.v1, derived from the crate name (ppoppo-pcs-session-proto ⇔ pcs.session.v1 ⇔
proto/pcs/session/v1/).
Its messages carry the identity enums (EntityType, LifecycleState) of the
vocab wire ppoppo-identity-proto
(ppoppo.identity.v1), re-exported at this crate’s root, so a crate speaking
this face names them through its one wire. A non-Rust client adds that crate’s
proto/ directory to its include path.
[dependencies]
ppoppo-pcs-session-proto = "0.17"§You probably want the SDK instead
This crate is the raw contract: messages and client stubs, no transport policy,
no auth, no retry. Depend on ppoppo-pcs-session
— it wraps this crate with the bearer token source, the scope markers, and the server-streaming lifecycle.
Reach for this crate directly only when you are implementing the server side of the contract, or building tooling that speaks the wire format without the SDK’s policy.
§Services
| Service | Surface |
|---|---|
MessageService | send, and the receive stream |
ChannelService | channel membership and metadata |
WatermarkService | read-position advance |
ContactService | contact records |
AgentService | agent participants |
DelegationService | delegated-actor sessions |
ReactionService | reactions |
TemplateService | message templates |
TransactionService | transactional messages |
InfoItemService | the caller’s own info items |
§Features
default = []— message structs, codecs, and the generated client stubs, generic over any tonic service (noconnecthelpers, no server stubs). This is what the SDK and other clients build against.server— adds the server stubs and tonic’s transport layer. PCS (chat-api) enables it.
§Versioning
Semver on its own, independent of every other ppoppo crate. A breaking change to
the package is a new package, hence a new -v<N>-proto crate; a major of this
crate can come only from the codegen substrate (the tonic / prost pins).
§License
MIT OR Apache-2.0
Modules§
- fire_
spec - The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. Nested message and enum types inFireSpec. - pcs
- Module nesting mirrors the proto package (
pcs.session.v1). - recurrence
- The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. Nested message and enum types inRecurrence.
Structs§
- Civil
Date Time - The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. A civil (wall-clock) date-time to the minute — the minute is the subset’s smallest unit. Which instant it names depends on a zone and on the zone’s rules, and is the server’s to answer. - Fire
- The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. One occurrence of a schedule, as the server’s evaluator resolves it now: which occurrence, and when. - Fire
Spec - The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. When a trigger fires. - Pending
Fire - The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. The occurrence an active trigger fires next. A trigger that is not active has none: a paused or suspended one chooses its next occurrence when it is resumed. - Recurrence
- The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. A recurrence rule anchored in civil time: RFC 5545 DTSTART;TZID= + RRULE + EXDATE, restricted to the PCS subset. “Every Monday 09:00 Europe/Berlin” stays 09:00 across DST and time-zone database changes. - Timestamp
- Timestamp re-export so consumers don’t need a separate
prost-typespin. A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. - Weekday
Num - The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. A BYDAY value: MO, 1MO, -1FR.
Enums§
- Entity
Type - The identity enums this face’s messages carry, from the
ppoppo.identity.v1vocabulary wire. What the principal IS — one question, one answer per principal. - Frequency
- The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. RFC 5545 FREQ, minus SECONDLY and MINUTELY. - Lifecycle
State - The identity enums this face’s messages carry, from the
ppoppo.identity.v1vocabulary wire. Where a number stands in its lifecycle. A number past its terminal state is not reported on any face. - Trigger
State - The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. Where a trigger stands. - Weekday
- The temporal-trigger vocabulary this face’s
TriggerServicemessages carry, from theppoppo.chat.v1vocabulary wire — with the twooneofmodules (fire_spec::Kind,recurrence::End) a client builds them with. A day of the week.
Constants§
- FILE_
DESCRIPTOR_ SET FileDescriptorSetbytes forpcs.session.v1, emitted bybuild.rs. Consumed by descriptor-driven drift canaries (chat-api’s scope-map drift, ppoppo-chat-realtime-proto’s schema inventory) and available for gRPC reflection.