Public API

This page summarizes the published surface of @kavtuai/guildgate@1.1.0. Use the installed package declarations and IDE completion for complete parameter and return types.

Contract markers

import {
  adapterContractVersion,
  actionContractVersion,
  realtimeContractVersion,
} from "@kavtuai/guildgate/contracts";

Contract	Version
Adapter	1.1
Action	1.0
Realtime	1.0

16 public export paths

Import path	Main use
@kavtuai/guildgate	Kernel, actions, store types, memory, cache, sessions, transactions, locks, operator, and telemetry helpers
@kavtuai/guildgate/discord	Discord OAuth, permissions, and authorization helpers
@kavtuai/guildgate/fastify	fastifyActionHandler
@kavtuai/guildgate/express	expressActionHandler
@kavtuai/guildgate/redis	Redis ephemeral stores and client adapters
@kavtuai/guildgate/realtime	Hub, WebSocket, Socket.IO, SSE, sequence, replay, revocation, and outbox worker
@kavtuai/guildgate/testing	createGuildGateTestHarness
@kavtuai/guildgate/analytics	Store, monitor, collector, query, and SVG chart helpers
@kavtuai/guildgate/contracts	Contract versions and runStoreContract
@kavtuai/guildgate/discordjs	createDiscordJsGuildAdapter
@kavtuai/guildgate/hono	honoActionHandler
@kavtuai/guildgate/operator	Operator service/actions and RatePolicyRegistry
@kavtuai/guildgate/postgres	createPostgresAdapter, buildPostgresMigration
@kavtuai/guildgate/telemetry	createOpenTelemetryHooks, noopTelemetry
@kavtuai/guildgate/transactions	Adapter, scope, hook, revision, and post-commit types
@kavtuai/guildgate/locks	DistributedLockManager, lease types, and isLeaseLockStore

Do not import internal dist/... or src/... paths. Semver guarantees apply only to paths in the package exports field.

Kernel

import {
  createGuildGate,
  createMemoryStoreBundle,
  composeStores,
  createMemoryTransactionAdapter,
} from "@kavtuai/guildgate";

Main GuildGateKernel members:

Member	Purpose
config	Validated configuration
sessions	SessionManager
cache	CacheManager
cookie	Resolved cookie settings
csrf.issue/verify	Session-bound token creation and verification
action	Create an action definition
execute	Execute a request envelope
createSession	Create session, token, CSRF, and cookie
revokeSession	Revoke one session
revokeUserSessions	Revoke all sessions for a user
owner	Maintenance and block policies

Store surface

GuildGateStores has ten members:

interface GuildGateStores {
  sessions: SessionStore;
  oauthStates: OAuthStateStore;
  credentials: OAuthCredentialStore;
  rateLimits: RateLimitStore;
  cache: CacheStore;
  idempotency: IdempotencyStore;
  locks: LockStore;
  audit: AuditStore;
  outbox: OutboxStore;
  policies: PolicyStore;
}

Important 1.1.0 capabilities:

• SessionStore.create(record, maximumSessionsPerUser)
• reservation ownership and idempotency renew/complete/fail results
• AuditStore.listPage()
• OutboxStore.claim()
• leases and fencing tokens

PostgreSQL

import {
  createPostgresAdapter,
  buildPostgresMigration,
} from "@kavtuai/guildgate/postgres";

The adapter bundle provides stores, transactions, migration functions, and backend-specific helpers.

Redis

import {
  createRedisEphemeralStores,
  fromNodeRedis,
  fromIoRedis,
} from "@kavtuai/guildgate/redis";

createRedisEphemeralStores accepts a Redis command adapter directly and an optional { prefix } object.

Realtime

import {
  createRealtimeHub,
  attachWebSocket,
  attachSocketIo,
  createServerSentEventStream,
  createSequencedPublisher,
  createOutboxWorker,
  MemoryRealtimeEventLog,
  MemorySessionRevocationBus,
} from "@kavtuai/guildgate/realtime";

Operator and analytics

import {
  createOperatorService,
  createOperatorActions,
  RatePolicyRegistry,
} from "@kavtuai/guildgate/operator";

The analytics module includes process and Discord collectors, health probes, bucket queries, table models, and safe SVG chart renderers.

Testing helpers

import { createGuildGateTestHarness } from "@kavtuai/guildgate/testing";
import { runStoreContract } from "@kavtuai/guildgate/contracts";

The test harness creates a kernel with memory stores and safe defaults. Real adapter service tests are still required to verify production behavior.

CLI commands

The package publishes three bins:

guildgate-doctor
guildgate-writing-check
guildgate-migration