@scenaro/sdk/client

Framework-agnostic HTTP client for the Scenaro public API. No React or Transport dependencies.

import {
  createScenaroClient,
  ScenaroClient,
  isTokenExpired,
  getJWTExpiry,
  getCompanyIdFromToken,
} from '@scenaro/sdk/client';

createScenaroClient

function createScenaroClient(config: ScenaroClientConfig): ScenaroClient

ScenaroClientConfig

Field	Type	Default	Description
`apiUrl`	`string`	required	API base URL (no trailing slash)
`apiPathPrefix`	`string`	`'/v1'`	Prepended to all endpoints
`storagePrefix`	`string`	`''`	Prefix for localStorage keys
`storage`	`StorageAdapter \| null`	`localStorage`	Custom storage adapter

ScenaroClient methods

identifyUser

identifyUser(
  scenarioUUID: string,
  externalId?: string | null,
): Promise<IdentityResponse>

POST /public/token — returns JWT identity. Idempotent if valid token exists in storage.

startSession

startSession(
  scenarioUUID: string,
  options?: {
    inputMode?: string;      // default 'audio'
    outputMode?: string;     // default 'audio'
    language?: string;       // omit to use the scenario's configured language
    sessionOptions?: SessionOptions;
  },
): Promise<PublicSessionResponse>

POST /public/session — returns Transport credentials (LiveKit today: livekit_token, livekit_url — see Transport). Requires stored JWT. When language is omitted, the backend applies the language configured on the scenario.

getValidUserToken

getValidUserToken(): Promise<string | null>

Returns stored token if valid, otherwise silently re-identifies.

getStoredUserToken

getStoredUserToken(
  scenarioUUID?: string | null,
  applicationId?: number | null,
): string | null

Synchronous read from storage.

clearStoredSession

clearStoredSession(scenarioUUID?: string | null): void

Clears identity blob and scenario pointer.

getSessionUserId / getSessionApplicationId

getSessionUserId(): number | null
getSessionApplicationId(): number | null

Read from stored identity blob.

JWT utilities

isTokenExpired(token: string): boolean     // 90s buffer
getJWTExpiry(token: string): number | null  // Unix timestamp
getCompanyIdFromToken(token: string): number | null

Storage exports

import {
  buildStorageKeys,
  persistIdentity,
  type StorageAdapter,
  type SessionStoreKeys,
} from '@scenaro/sdk/client';

See Session storage for key format details.

Types

Re-exported from @scenaro/sdk/protocol:

IdentityResponse
PublicTokenRequest / PublicTokenResponse
PublicSessionRequest / PublicSessionResponse
SessionOptions

​createScenaroClient

​ScenaroClientConfig

​ScenaroClient methods

​identifyUser

​startSession

​getValidUserToken

​getStoredUserToken

​clearStoredSession

​getSessionUserId / getSessionApplicationId

​JWT utilities

​Storage exports

​Types