Reactive state for the consentful-permits offer flow.
Maintains one offer cache keyed by id, seeded by the RPC list/history
actions and kept live by the six permit-offer WebSocket notifications.
incoming (recipient-side pending) and outgoing (grantor-side pending)
are derived views; history is the full cache ordered newest-first for
the grantor/admin history view.
Wiring is transport-agnostic: the ctor accepts a narrow RPC interface
the consumer adapts from their typed client, plus an account_id /
actor_id getter pair (typically bound to auth_state). Notification
delivery is pull-only via subscribe() — the consumer plumbs their
FrontendWebsocketClient / ActionPeer receiver to apply_notification.
6 declarations
ui/permit_offers_state.svelte.ts view source
{ get: (error_message?: string | undefined) => PermitOffersState; get_maybe: () => PermitOffersState | undefined; set: (value: PermitOffersState) => PermitOffersState; } Svelte context for PermitOffersState.
Use permit_offers_state_context.set(state) in the provider and
permit_offers_state_context.get() to access.
ui/permit_offers_state.svelte.ts view source
PermitOfferNotification Narrow WS notification envelope — method + params, matching JsonrpcNotification.
methodstringparamsunknownui/permit_offers_state.svelte.ts view source
PermitOffersRpc Narrow RPC surface consumed by PermitOffersState. Consumers adapt their
typed client (e.g. a create_rpc_client Proxy) to this shape — the state
class stays decoupled from the client's Result return type so tests can
inject plain-function stubs.
list() => Promise<{offers: Array<PermitOfferJson>}>history(options?: {
limit?: number;
offset?: number;
}) => Promise<{offers: Array<PermitOfferJson>}>create(params: {
to_account_id: string;
role: string;
scope_id?: string | null;
message?: string | null;
}) => Promise<{offer: PermitOfferJson}>accept(offer_id: string) => Promise<{
permit_id: string;
offer: PermitOfferJson;
superseded_offer_ids: Array<string>;
}>decline(offer_id: string, reason?: string | null) => Promise<{ok: true}>retract(offer_id: string) => Promise<{ok: true}>ui/permit_offers_state.svelte.ts view source
incomingPending offers for the current account, soonest-expiring first.
type Array<PermitOfferJson>
outgoingPending offers from the current actor, newest-created first.
type Array<PermitOfferJson>
historyEvery offer known to this state, newest-created first. Feeds the history view.
type Array<PermitOfferJson>
incoming_counttype number
constructortype new (options: PermitOffersStateOptions): PermitOffersState
optionsfetchSeed the cache with the recipient-side pending inbox.
type (): Promise<void>
Promise<void>fetch_historySeed both-directions history (includes terminal rows).
type (options?: { limit?: number | undefined; offset?: number | undefined; } | undefined): Promise<void>
options?{ limit?: number | undefined; offset?: number | undefined; } | undefinedPromise<void>createIssue a new offer; merges the returned offer into the cache on success.
type (params: { to_account_id: string; role: string; scope_id?: string | null | undefined; message?: string | null | undefined; }): Promise<{ id: string & $brand<"Uuid">; from_actor_id: string & $brand<...>; ... 11 more ...; resulting_permit_id: (string & $brand<...>) | null; } | undefined>
params{ to_account_id: string; role: string; scope_id?: string | null | undefined; message?: string | null | undefined; }Promise<{ id: string & $brand<"Uuid">; from_actor_id: string & $brand<"Uuid">; to_account_id: string & $brand<"Uuid">; role: string; scope_id: (string & $brand<...>) | null; ... 8 more ...; resulting_permit_id: (string & $brand<...>) | null; } | undefined>acceptAccept an offer; stamps it terminal in the cache and drops any siblings the server superseded.
type (offer_id: string): Promise<void>
offer_idstringPromise<void>declinetype (offer_id: string, reason?: string | null | undefined): Promise<void>
offer_idstringreason?string | null | undefinedPromise<void>retracttype (offer_id: string): Promise<void>
offer_idstringPromise<void>subscribeWire a notification subscription. The handler dispatches each matching
notification into apply_notification; the returned disposer unwires.
type (subscribe_fn: PermitOfferSubscribe): () => void
subscribe_fn() => voidapply_notificationReduce a single WS notification into the cache. Exposed so consumers
wiring their WS receiver directly (without subscribe) and tests can
drive the reducer without allocating a subscription.
type (notification: PermitOfferNotification): void
notificationvoidresetClear the cache and reset loading/error state.
type (): void
voidui/permit_offers_state.svelte.ts view source
PermitOffersStateOptions rpcaccount_idReactive accessor for the current account id; returns null when logged out.
() => string | nullactor_idReactive accessor for the current actor id — required to classify
offers as outgoing. Returns null when unknown.
() => string | nullui/permit_offers_state.svelte.ts view source
PermitOfferSubscribe Subscription primitive — consumer wires their WS receiver; returns a disposer.