Emulator helpers

Read what the app did at a provider, or act as a provider's user, from a test or an invariant.

gmailMailCopy Anchor Link

function

gmailMail(emulator: Pick<Emulator, "store" | "outbox">): MailSource

Mail delivered to a Gmail mailbox of the Google emulator.

outlookMailCopy Anchor Link

function

outlookMail(emulator: Pick<Emulator, "store" | "outbox">): MailSource

Mail delivered to an Outlook mailbox of the Microsoft emulator.

resendMailCopy Anchor Link

function

resendMail(emulator: Pick<Emulator, "store">): MailSource

Mail the Resend emulator accepted from the app.

twilioSmsCopy Anchor Link

function

twilioSms(emulator: Pick<Emulator, "store">): MailSource

Texts the Twilio emulator sent to phones, by the app or by Verify, read like mail: the address is the phone number, so read_mail, mail.code(phone) and the recording of a typed code work for SMS just as for email, and a replay reads the new code from the new phone's texts.

auth0OtpAtCopy Anchor Link

function

otpAt(secret: string, time: Date): string

The one-time code an authenticator app shows for secret at time.

auth0TenantCopy Anchor Link

function

auth0Tenant(emulator: Pick<Emulator, "store">, domain?: string): Auth0Tenant

What domain's tenant holds and has done; the first tenant when no domain is given.

flutterwaveBankCopy Anchor Link

function

flutterwaveBank(emulator: Pick<Emulator, "store" | "outbox">): FlutterwaveBank

Money arriving at a Flutterwave emulator's virtual accounts.

flutterwaveLedgerCopy Anchor Link

function

flutterwaveLedger(emulator: Pick<Emulator, "store" | "outbox">): FlutterwaveLedger

The books of a Flutterwave emulator.

githubAppKeyCopy Anchor Link

function

githubAppKey(emulator: Pick<Emulator, "store">, slug: string): string

The private key (PEM) of a seeded GitHub App, for signing its JWTs.

githubRepoCopy Anchor Link

function

githubRepo(emulator: Pick<Emulator, "store">, fullName: string): GithubRepoView

Reads a repository's issues, comments, check runs and files from a GitHub emulator.

githubSignInsCopy Anchor Link

function

githubSignIns(emulator: Pick<Emulator, "store">): SignIns

Who signed in to which OAuth App or GitHub App, for tests.

gmailMailboxCopy Anchor Link

function

gmailMailbox( emulator: Pick<Emulator, "store" | "outbox">, email: string, ): GmailMailbox

Reads and changes email's Gmail mailbox from a test.

googleCalendarCopy Anchor Link

function

googleCalendar( emulator: Pick<Emulator, "store" | "outbox">, email: string, ): GoogleCalendar

A user's Google Calendar in the emulator: read events, and change them as if from elsewhere.

googleDriveCopy Anchor Link

function

googleDrive( emulator: Pick<Emulator, "store" | "outbox">, email: string, ): GoogleDrive

A user's Google Drive in the emulator: read files, and change them as if from elsewhere.

googleSignInsCopy Anchor Link

function

googleSignIns(emulator: Pick<Emulator, "store">): SignIns

Who signed in to which client, for tests.

graphSubscriptionsCopy Anchor Link

function

graphSubscriptions(emulator: Pick<Emulator, "store">): GraphSubscriptionEntry[]

The subscriptions apps have made in a Microsoft emulator, live or expired.

installGithubAppCopy Anchor Link

function

installGithubApp( emulator: Pick<Emulator, "store" | "outbox">, installation: GithubSeedInstallation, ): number

Installs a seeded app on an account, as a person would on github.com, and sends the app its installation created webhook. Returns the installation id.

listeningPortCopy Anchor Link

function

listeningPort(server: Server): number

The TCP port a listening server is bound to. Throws when the server is not listening yet, or is bound to a pipe or socket path rather than a port.

microsoftSignInsCopy Anchor Link

function

microsoftSignIns(emulator: Pick<Emulator, "store">): SignIns

Who signed in to which app, for tests.

llmCallsCopy Anchor Link

function

llmCalls(emulator: Emulator): LlmCalls

The calls the app made to OpenAI, Anthropic and the AI Gateway, oldest first.

llmScriptsCopy Anchor Link

function

llmScripts(emulator: Emulator): LlmScripts

Scripts a test adds to the model API emulator while it runs.

oneDriveCopy Anchor Link

function

oneDrive(emulator: Pick<Emulator, "store" | "outbox">, email: string): OneDrive

One user's OneDrive in a Microsoft emulator.

outlookCalendarCopy Anchor Link

function

outlookCalendar( emulator: Pick<Emulator, "store" | "outbox">, email: string, ): OutlookCalendar

One user's Outlook calendar in a Microsoft emulator.

outlookMailboxCopy Anchor Link

function

outlookMailbox( emulator: Pick<Emulator, "store" | "outbox">, email: string, ): OutlookMailbox

One user's Outlook mailbox in a Microsoft emulator.

paystackBankCopy Anchor Link

function

paystackBank(emulator: Pick<Emulator, "store" | "outbox">): PaystackBank

A test's stand-in for a customer's bank, for paying into dedicated accounts.

paystackLedgerCopy Anchor Link

function

paystackLedger(emulator: Pick<Emulator, "store">): PaystackLedger

Reads back what a Paystack emulator holds: transactions, transfers, refunds, customers, subscriptions.

revokeGoogleAccessCopy Anchor Link

function

revokeGoogleAccess( emulator: Pick<Emulator, "store">, email: string, clientId?: string, ): void

Removes the app's access as the user would from their Google Account: every token email holds for clientId (or for every client) is revoked, so API calls get 401 and refreshes get invalid_grant.

revokeMicrosoftSessionsCopy Anchor Link

function

revokeMicrosoftSessions(emulator: Pick<Emulator, "store">, email: string): number

Signs a user out of every app, as when they change their password or an admin revokes their sessions: refresh tokens fail with invalid_grant and Graph refuses their access tokens.

resendInboxCopy Anchor Link

function

resendInbox(emulator: Pick<Emulator, "store">): ResendInbox

What the Resend emulator accepted, read the way a test reads a mailbox.

s3ObjectsCopy Anchor Link

function

s3Objects(emulator: Pick<Emulator, "store">): S3Objects

What the S3 emulator holds, read the way a test inspects a bucket.

slackWorkspaceCopy Anchor Link

function

slackWorkspace(emulator: Pick<Emulator, "store" | "outbox">): SlackWorkspace

The workspace of a Slack emulator, for tests.

twilioInboxCopy Anchor Link

function

twilioInbox(emulator: Pick<Emulator, "store">): TwilioInbox

The texts the Twilio emulator sent to phones, read the way a test reads a phone.

twilioPhoneCopy Anchor Link

function

twilioPhone(emulator: Pick<Emulator, "store" | "outbox">): TwilioPhone

A phone texting the app's Twilio numbers, as a person would.

uninstallGithubAppCopy Anchor Link

function

uninstallGithubApp( emulator: Pick<Emulator, "store" | "outbox">, installationId: number, ): void

Removes an installation and sends the app its installation deleted webhook.

bachsLedgerCopy Anchor Link

function

bachsLedger(emulator: Emulator): BachsLedger

Reads and drives a Bachs emulator from a test.

composioProjectCopy Anchor Link

function

composioProject(emulator: Pick<Emulator, "store" | "outbox">): ComposioProject

The project a Composio emulator stands in for: its accounts, tool runs, triggers and expiries.

composioToolsCopy Anchor Link

function

composioTools(emulator: Pick<Emulator, "store">): ComposioTools

The tool handlers of a Composio emulator, to answer tools from test code. A reset or restore drops them, so one test's handlers never answer the next test's calls.

nangoProjectCopy Anchor Link

function

nangoProject(emulator: Emulator): NangoProject

The Nango environment an emulator stands in for.

nylasApplicationCopy Anchor Link

function

nylasApplication(emulator: Emulator): NylasApplication

The Nylas application an emulator stands in for, for tests to read and act on.

unipileWorkspaceCopy Anchor Link

function

unipileWorkspace(emulator: Emulator): UnipileWorkspace

The Unipile workspace an emulator stands in for.

novuProjectCopy Anchor Link

function

novuProject(emulator: Pick<Emulator, "store">): NovuProject

A Novu emulator's project: subscribers, workflow runs, messages sent and open Inboxes.

pusherBeamsCopy Anchor Link

function

pusherBeams(emulator: Pick<Emulator, "store">): PusherBeams

The Beams side of a Pusher emulator: notifications published, and the devices registered.

pusherChannelsCopy Anchor Link

function

pusherChannels(emulator: Pick<Emulator, "store">): PusherChannels

The Channels side of a Pusher emulator: published events, live connections, test triggers.

tiptapCollabCopy Anchor Link

function

tiptapCollab(emulator: Pick<Emulator, "store">): TiptapCollabView

A Tiptap emulator's documents as JSON or text, who is editing them, and their faults.

clerkMailCopy Anchor Link

function

clerkMail(emulator: Pick<Emulator, "store">): MailSource

Emails the Clerk emulator sent: sign-in and sign-up verification codes, read like any mail, so mail.code(email) and a recorded typed code work for Clerk's <SignIn/> and Account Portal.

clerkInstanceCopy Anchor Link

function

clerkInstance(emulator: Pick<Emulator, "store">): ClerkInstanceView

The Clerk emulator's instance, users, sessions and sent codes, for tests.

stableClerkIdCopy Anchor Link

function

stableClerkId(prefix: string, name: string): string

A Clerk-style id derived from name, the same on every run and after every reset, e.g. stableClerkId("user", "ada@example.com"): seeded records keep the ids an app's own database was seeded with.