@lastshotlabs/slingshot-chat

npm install @lastshotlabs/slingshot-chat

Functions

`createChatPackage`

Chat package factory.

Creates a SlingshotPackageDefinition that mounts the 10 chat entities (Room, RoomMember, Message, ReadReceipt, MessageReaction, Pin, Block, FavoriteRoom, RoomInvite, Reminder), wires adapter-dependent middleware (archiveGuard, broadcastGuard, dmRoomGuard, roomCreatorGrant, memberGrant, messagePostCreate, messageNotify, memberInviteNotify, replyCountUpdate, replyCountDecrement), publishes the ChatInteractionsPeerCap capability, registers push formatters, opportunistically integrates with slingshot-embeds, and starts the two 30-second schedulers (reminders + scheduled messages) plus the WebSocket incoming-event dispatch.

Every adapter ref, middleware closure, scheduler timer, and lazy notification-builder reference is owned by the factory’s closure (Rule 3) — multiple package instances in the same process do not share state.

function createChatPackage(rawConfig: ChatPluginConfig): SlingshotPackageDefinition

Source: packages/slingshot-chat/src/plugin.ts

Constants

`Chat`

Source: packages/slingshot-chat/src/public.ts

`CHAT_PLUGIN_STATE_KEY`

Plugin state key for slingshot-chat.

Single-sourced constant — no magic string 'slingshot-chat' anywhere in cross-package contracts (cold-start invariant #7).

Source: packages/slingshot-chat/src/state.ts

`ChatEntities`

Public contract for slingshot-chat.

Two layers:

ChatEntities — the canonical adapter surface. Each ref names a read-only slice of an entity adapter (Room.getById, Message.list, etc.). Consumers resolve these via requireEntityAdapter(carrier, ref) from @lastshotlabs/slingshot-core. The adapters are published into pluginState by the framework’s package compiler during the package’s setupRoutes phase, so consumers must read in setupPost or per-request handlers.
ChatInteractionsPeerCap — the cross-package peer capability used by slingshot-interactions for component-tree resolution and updates. Resolved via ctx.capabilities.require(ChatInteractionsPeerCap).

Source: packages/slingshot-chat/src/public.ts

`ChatInteractionsPeerCap`

Source: packages/slingshot-chat/src/public.ts

`ChatModerationPeerCap`

Source: packages/slingshot-chat/src/public.ts

Classes

`ChatRepoNotImplementedError`

Thrown when a repository backend operation has not been implemented yet. Replace with actual implementation — do not catch and ignore.

Source: packages/slingshot-chat/src/factories/errors.ts

Interfaces

`Block`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`BlockAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatAesGcmEncryptionConfig`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatInteractionsPeer`

Public contract for slingshot-chat.

Two layers:

ChatEntities — the canonical adapter surface. Each ref names a read-only slice of an entity adapter (Room.getById, Message.list, etc.). Consumers resolve these via requireEntityAdapter(carrier, ref) from @lastshotlabs/slingshot-core. The adapters are published into pluginState by the framework’s package compiler during the package’s setupRoutes phase, so consumers must read in setupPost or per-request handlers.
ChatInteractionsPeerCap — the cross-package peer capability used by slingshot-interactions for component-tree resolution and updates. Resolved via ctx.capabilities.require(ChatInteractionsPeerCap).

Source: packages/slingshot-chat/src/public.ts

`ChatMessageDeletedPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatModerationPeer`

Public contract for slingshot-chat.

Two layers:

ChatEntities — the canonical adapter surface. Each ref names a read-only slice of an entity adapter (Room.getById, Message.list, etc.). Consumers resolve these via requireEntityAdapter(carrier, ref) from @lastshotlabs/slingshot-core. The adapters are published into pluginState by the framework’s package compiler during the package’s setupRoutes phase, so consumers must read in setupPost or per-request handlers.
ChatInteractionsPeerCap — the cross-package peer capability used by slingshot-interactions for component-tree resolution and updates. Resolved via ctx.capabilities.require(ChatInteractionsPeerCap).

Source: packages/slingshot-chat/src/public.ts

`ChatNoEncryptionConfig`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatPermissionsConfig`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatPingPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatPluginConfig`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatReadBroadcastPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatReadPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatTypingPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`CreateMemberInput`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`CreateMessageInput`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`CreateRoomInput`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`FavoriteRoom`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`FavoriteRoomAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`Message`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`MessageAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`MessageReaction`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`MessageReactionAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`Pin`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`PinAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ReactionCountPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ReadReceipt`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ReadReceiptAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ReadReceiptCreatedPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`Reminder`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ReminderAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`RoomInvite`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`RoomInviteAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`RoomMember`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`RoomMemberAdapter`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`UpdateMemberInput`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`UpdateMessageInput`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`UpdateRoomInput`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`UserKeyBundle`

Source: packages/slingshot-chat/src/encryption/stub.ts

Types

`AddMemberInput`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatEncryptionConfig`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`ChatMessageUpdatedPayload`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`MemberRole`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`MessageType`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`NotifyPreference`

A chat room.

Source: packages/slingshot-chat/src/types.ts

`RoomType`

A chat room.

Source: packages/slingshot-chat/src/types.ts