@kentcdodds/kit

Kit.com helpers for subscribers, tags, forms, sequences, and broadcasts.

src/smoke-test.d.ts

28 lines · 711 B · TypeScript

export type KitSmokeTestResult = {
	ok: true
	account: {
		id: unknown
		name: unknown
		plan_type: unknown
	}
	broadcastCount: number
	sampleBroadcast?: {
		id: number
		subject?: string
		status?: string
		editUrl: string
	} | null
}

/**
 * Read-only smoke: current account + one page of broadcasts.
 * Never creates or sends broadcasts/emails.
 * Run this first to confirm the `kitApiKey` secret and `api.kit.com` host
 * approval work before doing any writes.
 *
 * @example
 * import smokeTest from 'kody:@kentcdodds/kit/smoke-test'
 * const result = await smokeTest()
 * // => { ok: true, account: { name: '...' }, broadcastCount: 5 }
 */
export default function smokeTest(): Promise<KitSmokeTestResult>