Dışa açık API

Bu sayfa @kavtuai/guildgate@1.1.0 paketinin yayımlanan yüzeyini özetler. Tam parametre ve dönüş tipleri için kurulu paketin .d.ts dosyalarını ve IDE otomatik tamamlamasını esas al.

Sözleşme işaretleri

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

Sözleşme	Sürüm
Adapter	1.1
Action	1.0
Realtime	1.0

16 public export yolu

Import yolu	Ana kullanım
@kavtuai/guildgate	Çekirdek, action, store tipleri, memory, cache, session, transaction, lock, operator ve telemetri yardımcıları
@kavtuai/guildgate/discord	Discord OAuth, yetki ve authorizer yardımcıları
@kavtuai/guildgate/fastify	fastifyActionHandler
@kavtuai/guildgate/express	expressActionHandler
@kavtuai/guildgate/redis	Redis ephemeral stores ve istemci dönüştürücüleri
@kavtuai/guildgate/realtime	Hub, WebSocket, Socket.IO, SSE, sequence, replay, revocation ve outbox worker
@kavtuai/guildgate/testing	createGuildGateTestHarness
@kavtuai/guildgate/analytics	Store, monitor, collector, query ve SVG chart yardımcıları
@kavtuai/guildgate/contracts	Contract sürümleri ve runStoreContract
@kavtuai/guildgate/discordjs	createDiscordJsGuildAdapter
@kavtuai/guildgate/hono	honoActionHandler
@kavtuai/guildgate/operator	Operator service/action ve RatePolicyRegistry
@kavtuai/guildgate/postgres	createPostgresAdapter, buildPostgresMigration
@kavtuai/guildgate/telemetry	createOpenTelemetryHooks, noopTelemetry
@kavtuai/guildgate/transactions	Adapter, scope, hook, revision ve post-commit tipleri
@kavtuai/guildgate/locks	DistributedLockManager, lease tipleri ve isLeaseLockStore

Dahili dist/... veya src/... yolundan import yapma. Semver güvencesi yalnızca exports alanındaki yollar için geçerlidir.

Çekirdek

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

GuildGateKernel ana üyeleri:

Üye	Görev
config	Doğrulanmış yapılandırma
sessions	SessionManager
cache	CacheManager
cookie	Çözülen cookie ayarı
csrf.issue/verify	Session-bound token üretme/doğrulama
action	Action tanımı oluşturma
execute	Request envelope yürütme
createSession	Session, token, CSRF ve cookie üretme
revokeSession	Tek session iptali
revokeUserSessions	Kullanıcının tüm session'larını iptal
owner	Bakım ve blok politikaları

Store yüzeyi

GuildGateStores on üye içerir:

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

1.1.0 ile önemli ek yetenekler:

• SessionStore.create(record, maximumSessionsPerUser)
• reservation owner alanı ve idempotency renew/complete/fail sonucu
• AuditStore.listPage()
• OutboxStore.claim()
• lease ve fencing token desteği

PostgreSQL

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

Adapter bundle, stores, transactions, migration işlevleri ve backend'e özgü yardımcıları sunar.

Redis

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

createRedisEphemeralStores doğrudan Redis command adapter ve isteğe bağlı { prefix } alır.

Realtime

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

Operator ve analytics

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

Analytics modülü process/Discord collector, health probe, bucket query, tablo modeli ve güvenli SVG chart üreticilerini içerir.

Test yardımcıları

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

Test harness memory store ve varsayılan güvenli config ile çekirdeği hızlı kurar. Production davranışını kanıtlamak için gerçek adapter service testleri ayrıca gereklidir.

CLI komutları

Paket üç bin yayımlar:

guildgate-doctor
guildgate-writing-check
guildgate-migration