Function createInviteIntent

createInviteIntent(
    options: CreateInviteIntentOptions,
): {
    actorPubkey: string;
    extraProposals?: (
        | Proposal
        | ProposalAction<Proposal>
        | (Proposal | ProposalAction<Proposal>)[]
    )[];
    kind: "commit";
    proposalRefs?: string[];
    welcomeRecipients?: WelcomeRecipient[];
}
Builds a commit session intent that adds a user from their KeyPackage event and delivers a Welcome to them after the commit acks.

Validates that the event is a KeyPackage (kind 30443), passes the trust boundary (SEC-01: signature; WIRE-02: d/i/mls_protocol_version cardinality; WIRE-01: Lifetime cap/current), and that the embedded credential identity matches the event author, before constructing the Add proposal. Pair the result with GroupSession.send / GroupsManager.send; GroupsManager.invite wraps this helper and resolves actorPubkey from the signer.
Parameters
- options: CreateInviteIntentOptions
Returns {
    actorPubkey: string;
    extraProposals?: (
        | Proposal
        | ProposalAction<Proposal>
        | (Proposal | ProposalAction<Proposal>)[]
    )[];
    kind: "commit";
    proposalRefs?: string[];
    welcomeRecipients?: WelcomeRecipient[];
}

Throws
Error if the event is not a KeyPackage kind, fails signature verification, has invalid required-tag cardinality, has an over-long or not-current Lifetime, or the credential identity does not match the event author.
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/group/invite.ts:62

Function createInviteIntent

Parameters

Returns { actorPubkey: string; extraProposals?: ( | Proposal | ProposalAction<Proposal> | (Proposal | ProposalAction<Proposal>)[] )[]; kind: "commit"; proposalRefs?: string[]; welcomeRecipients?: WelcomeRecipient[];}

Throws

Settings

Returns {
actorPubkey: string;
extraProposals?: (
| Proposal
| ProposalAction<Proposal>
| (Proposal | ProposalAction<Proposal>)[]
)[];
kind: "commit";
proposalRefs?: string[];
welcomeRecipients?: WelcomeRecipient[];
}