Skip to content
KismetKismetDevelopers
Beta accessllms.txt

TypeScript SDK beta

View .md

Build catalog, discovery, availability, and branded guest experiences with typed clients and explicit server/browser boundaries. The SDK build documented here targets Developer API v0.7.61 with reviewed contract extensions. The API reference lists the documented operations; REST-only exceptions are described below. Supported flows include Google guest sign-in, verified email signup, events and webhook destinations, software settings and account panels, content operations for editable pages, and Article imports for canonical drafts and reviewed staging publication. Early-access APIs require access to the matching service and SDK release.

Google guest sign-in uses the hosted authorization flow and same-origin SDK handlers. The older direct Google verification operation remains REST-only. Guest preferences use Kismet-hosted confirmation for TEST rehearsal and LIVE membership and email double opt-in; sign-in does not grant consent.

The repository currently builds @kismet-tech/sdk version 0.2.0-beta.1-search.20261102.3. This source version is separate from the historical installation examples below. Verify its registry artifact and release notes before adopting it; local changes such as the current-0.3 adapter still need their own versioned publication. After confirming publication, the exact-version install is:

Terminal window
npm install --save-exact @kismet-tech/[email protected]

The SDK package documented here is @kismet-tech/sdk version 0.2.0-beta.1-poppy02.20261019.2, for the dedicated poppy02 npm tag. Verify the exact version is available in npm before installing. The existing beta, latest, alpha, and cms-faq tags are unchanged. Package publication and API deployment remain separate. Older packages such as @kismet-tech/sdk version 0.2.0-beta.1 do not include the hosted Google sign-in or content operations documented here. Manager panels require the POST-body guard and the matching Kismet account host. Offer capture also requires the matching API deployment and configured TEST access. Source-date and media-import methods additionally require the reviewed CMS import extension; an existing registry release does not establish their availability. Alternative-stay search requires a new build containing that extension; this install command alone does not establish support for it.

Terminal window
npm install --save-exact @kismet-tech/[email protected]
npx kismet init

The complete search-flow extension (alternative stays, flexible windows, broadening selection and follow-up amendments) is included in @kismet-tech/sdk version 0.2.0-beta.1-search.20261025.3, released under beta after publication. Verify this exact version is available in npm before using the command below. The matching Developer API deployment is required. Subsequent source changes require their own release evidence; an existing immutable package does not acquire new fixes automatically.

Terminal window
npm install --save-exact @kismet-tech/[email protected]

For an unpublished source evaluation, build and verify a tarball and retain its source/version/checksum manifest. The older npm alpha and latest tags do not provide the build above. Package installation and scoped Developer API access are separate steps.

import { createKismetClient } from '@kismet-tech/sdk/server';
const client = createKismetClient({
apiKey: process.env.KISMET_DEVELOPER_API_KEY!,
collection: 'your-collection',
baseUrl: process.env.KISMET_API_BASE!,
});
const rentals = await client.vacationRental.list({ limit: 24 });
const availability = await client.vacationRental.availability.get({
checkIn: '2027-01-11',
checkOut: '2027-01-16',
guests: 4,
});

Use @kismet-tech/sdk/contracts for server-safe DTOs, @kismet-tech/sdk/server for the explicit API client, @kismet-tech/sdk/next for same-origin guest-account handlers, and @kismet-tech/sdk/react for credential-free browser clients.

For canonical group filters and dated or undated group estimates, use the Catalog API family and group pricing guide. Current pricing coverage is base-rate-only: lowestStay remains null, so a single lowest qualifying stay price is not yet available. Preserve the Check availability state instead of choosing an observed estimate yourself.

The SDK ships framework-neutral contracts, 17 complete developer recipes, exact field provenance, and a real-browser runner. Your components and routes remain custom; declarations tell the runner which component subtree owns each user outcome. Read Recipes, contracts, and implementation tests for the component pattern, plain-language rubric, save-triggered checks, and CI gate.

Guest auth is a same-origin BFF flow. Your site owns every visible screen and cookie presentation; the SDK owns the Kismet token exchange, sealed session envelope, CSRF contract, and request validation.

import {
createKismetGuestAuthNextHandlers,
createKismetGuestAuthServerClient,
} from '@kismet-tech/sdk/next';
const client = createKismetGuestAuthServerClient({
serverKey: process.env.KISMET_SERVER_KEY!,
baseUrl: process.env.KISMET_API_BASE!,
origin: process.env.NEXT_PUBLIC_SITE_URL!,
});
export const kismetGuest = createKismetGuestAuthNextHandlers({
client,
sessionSecret: process.env.KISMET_GUEST_SESSION_SECRET!,
allowedOrigins: [process.env.NEXT_PUBLIC_SITE_URL!],
});

The browser then calls only same-origin routes for challenge, verify, session, refresh, logout, /guest/me, saves, and signed-in TEST booking requests.

The SDK provides typed contracts, Node/Edge entry points, and server/browser auth boundaries. It is in account-scoped beta: installing the package does not grant Developer API access. Create a scoped installation and credential, then validate the operations your application uses against the intended environment. See platform status for integration boundaries and support.

See Install and test the SDK for setup and verification, and Developer API reference for the server contract.

Activity summaries are also available through REST; this SDK does not yet wrap that operation.