Testing API

Tests import one entry, and a preset in the test setup:

import { renderWithTap, createTestClient } from "@tappify/extension-sdk/testing";

Each symbol’s page below is generated from the SDK’s own TypeScript declarations. The walkthrough is on Testing with the SDK.

Presets

@tappify/extension-sdk/testing/vitest and @tappify/extension-sdk/testing/jest are side-effect modules. Importing one installs the host CSS variables and registers the matchers.

Rendering

Symbol	Is
`renderWithTap`	Renders a component against a mock bridge
`RenderWithTapOptions`	`mock`, `queryClient`, `container`, plus every `createTapMock` option (`scopes`, `size`, `filters`, `project`, `server`, `handler`, …)
`RenderWithTapResult`	Testing Library’s result plus the `mock`

The mock bridge

Symbol	Is
`createTapMock`	The bridge on its own
`TapMock`	`tap`, `calls`, `portal`, `documents`, `emit`, `setFilters`, `setSize`, `setTheme`, `setParams`
`TapMockCalls`	Everything the component did: navigations, searches, toasts, confirms, actions, telemetry, chats, externals, downloads, copies, cards
`CreateTapMockOptions`	The same options `renderWithTap` takes

Matchers

tapMatchers and registerTapMatchers. The presets register them for you. Each one takes a MatcherTarget and returns a MatcherResult.

Matcher	Passes when
`toHaveNavigatedTo(path)`	The component navigated there
`toHaveToasted(message)`	A toast matched, exactly or by pattern
`toHaveRunAction(id, input?)`	An action ran with that input
`toHaveStored(collection, document)`	A document deep-equal to that one is in the collection

Testing your server

Symbol	Is
`createTestClient`	Drives a handler the way Tappify does
`TestClient`	`health`, `metrics`, `tool`, `mention`, `action`, `procedure`, `context`, `event`, `work`, `raw`
`TestClientDefaults`	`install`, `scopes`, `credentials`, `documents`, `filters`, `eventId`, `origin`
`signTestToken`	A signed install token for a test
`testJwks`	The matching key set

Validators

validateMetricsResponse checks a metrics response against your declared metric definitions; validateToolResponse checks a tool result against its declared shape. Both return the problems as strings, so a test fails the way doctor would.

Fixtures

fixtures, typed TapFixtures, is the sandbox data the portal preview also uses, so a component behaves the same in both. The pieces are fixtureProject, fixtureApps, fixtureReleases, fixtureKeywords, fixtureListings, fixtureReviews, fixtureCrashes, fixtureRevenue, fixtureSeries and answerFixtureQuery. installHostTheme puts the host’s CSS variables on a root, for a test that renders outside renderWithTap.

Start

Build

Test

Publish

Reference

Presets

Rendering

The mock bridge

Matchers

Testing your server

Validators

Fixtures

​Presets

​Rendering

​The mock bridge

​Matchers

​Testing your server

​Validators

​Fixtures

Presets

Rendering

The mock bridge

Matchers

Testing your server

Validators

Fixtures