trellis-svelte/src/index.ts - Trellis TypeScript API documentation

Classes

c

DeviceActivationController(config: DeviceActivationControllerConfig)

c

PortalFlowController(config: CreatePortalFlowConfig)

c

SvelteTrellisConnection(connection: TrellisConnection)

Svelte-reactive adapter around a framework-neutral Trellis connection.

close(): Promise<void>
Closes the underlying Trellis runtime connection.
status(): TrellisConnectionStatus
Latest connection status, reactive when read by Svelte effects or markup.

Functions

f

createDeviceActivationController(config: DeviceActivationControllerConfig): DeviceActivationController

f

createPortalFlow(config: CreatePortalFlowConfig): PortalFlowController

f

createTrellisApp<

TContract extends TrellisContractLike,

TClient extends TrellisContextClient = TrellisClientFor<TContract>

>(options: CreateTrellisAppOptions<TContract>): TrellisApp<TContract, TClient>

Creates an app-scoped typed Svelte context owner for a Trellis contract and URL.

f

resolveTrellisAppUrl(trellisUrl: TrellisAppUrlResolver): string | undefined

Resolves a Trellis app URL config to the string shape required by the client.

Interfaces

I

Public app-scoped typed Svelte context owner for a Trellis browser app.

contract: TContract
Contract used by this app context and by TrellisProvider connections.
getConnection(): SvelteTrellisConnection
Returns a Svelte-reactive adapter for the real Trellis connection.
getTrellis(): TClient
Returns the contract-typed connected Trellis client from Svelte context synchronously.
trellisUrl: TrellisAppUrlResolver
Trellis URL configuration used by TrellisProvider connections.

Type Aliases

T

CreatePortalFlowConfig = AuthConfig & { getUrl?: () => URL; }

T

CreateTrellisAppOptions<

TContract extends TrellisContractLike = TrellisContractLike

> = { contract: TContract; trellisUrl: TrellisAppUrlResolver; }

Options used to create a Trellis Svelte app owner.

contract: TContract
Contract used by this app context and by TrellisProvider connections.
trellisUrl: TrellisAppUrlResolver
Trellis URL, or a resolver for runtime-selected Trellis URLs.

T

DeviceActivationAuth = { init(): Promise<unknown>; handleCallback(callbackUrl: string): Promise<DeviceActivationBindResult | null>; signIn(options?: DeviceActivationSignInOptions): Promise<never>; }

T

DeviceActivationClient = { activateDevice(input: { flowId: string; }): Promise<DeviceActivationOperationRef>; }

activateDevice(input: { flowId: string; }): Promise<DeviceActivationOperationRef>

T

DeviceActivationControllerConfig = { authState: DeviceActivationAuth; getUrl?: () => URL; replaceUrl?: (url: string) => void; sessionStorage?: StorageLike; createCallbackToken?: () => string; createClient(authUrlState: DeviceActivationConnectAuthUrlState): Promise<DeviceActivationClient>; }

T

DeviceActivationOperationRef = { watch(): AsyncResult<

OperationEvent<

AuthResolveDeviceUserAuthoritiesProgress,

AuthResolveDeviceUserAuthoritiesOutput

>; wait(): AsyncResult<

TerminalOperation<

AuthResolveDeviceUserAuthoritiesProgress,

AuthResolveDeviceUserAuthoritiesOutput

T

TrellisAppOwner<

TContract extends TrellisContractLike = TrellisContractLike

> = { readonly contract: TContract; readonly trellisUrl: TrellisAppUrlResolver; readonly [trellisAppOwnerBrand]: true; }

Minimal branded app owner surface accepted by the Trellis Svelte provider.

T

TrellisAppUrl = string | URL

URL value accepted by a Trellis Svelte app owner.

T

TrellisAppUrlResolver = TrellisAppUrl | (() => TrellisAppUrl | undefined)

Trellis URL configuration for a Svelte app owner.

T

TrellisClientFor<TContract extends TrellisContractLike> = ClientTrellis<

TrellisApiFor<TContract>,

RuntimeStateStoresForContract<TContract>

Real connected Trellis client type exposed by a Svelte app context.

T

TrellisContextClient = { readonly connection: TrellisConnection; }

Minimal client surface required for Trellis Svelte context clients.

connection: TrellisConnection

T

TrellisContractLike<TA extends TrellisAPI = TrellisAPI> = { CONTRACT: TrellisContractV1; CONTRACT_DIGEST: string; API: { trellis?: TA; }; }

Minimal contract shape required to create a typed Trellis Svelte app context.

T

TrellisProviderProps<

TContract extends TrellisContractLike = TrellisContractLike

> = { trellisApp: TrellisAppOwner<TContract>; auth?: ClientAuthOptions; client?: ClientOpts; children: Snippet; loading?: Snippet; error?: Snippet<[unknown]>; onAuthRequired?: (

loginUrl: string,

context: ClientAuthRequiredContext

) => void | Promise<void>; }

Props accepted by the Svelte Trellis provider component.

Usage

import * as mod from "trellis-svelte/src/index.ts";