Skip to content
← Public packages

@kentcdodds/quiet-hours

Quiet hours for Kent's bots: 10 PM to 8 AM MT (DST-aware) clock, shared overnight queue, override, and the 8 AM digest of finished work and open decisions.

FollowFork

Files

digest.ts

64 lines · 2.5 KB · TypeScript
import { LAST_DIGEST_KEY, listUndelivered, markDelivered, setState, type LastDigest } from './store.ts'
import { digestCounts, formatDigestText, orderDigest } from './digest-core.ts'
import { parseNow } from './status-core.ts'
import type { QueueItem } from './types.ts'

export type DigestInput = {
	/** Preview only: do not mark anything delivered. */
	dryRun?: boolean
	/** Who delivered it (e.g. 'kody-routine', 'discord-fallback'). Default 'digest'. */
	via?: string
	/** Optional ISO instant to treat as now (tests). */
	now?: string
}

export async function buildDigest(now: Date) {
	const items = await listUndelivered()
	const groups = orderDigest(items, now)
	return {
		groups,
		items: groups.flatMap((g) => g.items),
		counts: digestCounts(items),
		text: formatDigestText(groups),
	}
}

export async function recordDelivery(items: QueueItem[], via: string, now: Date) {
	const record: LastDigest = {
		id: crypto.randomUUID(),
		at: now.toISOString(),
		via,
		count: items.length,
	}
	await markDelivered(items.map((i) => i.id), record.id, record.at)
	await setState(LAST_DIGEST_KEY, record)
	return record
}

/**
 * The 8 AM digest: a report of finished work (done) and open decisions
 * (needs-decision) since the last digest, ordered urgent-but-resolved,
 * hard deadlines today, decisions blocking a bot, then FYI/done. Not a
 * backlog to kick off. Marks every returned item delivered (unless
 * `dryRun`), even when empty, so the 8:15 fallback stays quiet.
 *
 * @param input.dryRun - Preview without marking delivered
 * @param input.via - Delivery channel label recorded with the digest
 * @returns `{ digestId, deliveredAt, counts, buckets, items, text }`
 *
 * @example
 * import digest from 'kody:@kentcdodds/quiet-hours/digest'
 * const d = await digest({ via: 'kody-routine' })
 * // d.text => 'Morning. Overnight: 9 done, 3 need you. ...'
 */
export default async function digest(input: DigestInput = {}) {
	const now = parseNow(input?.now)
	const built = await buildDigest(now)
	const buckets = built.groups.map((g) => ({ bucket: g.bucket, label: g.label, items: g.items }))
	if (input?.dryRun === true) {
		return { dryRun: true as const, digestId: null, deliveredAt: null, counts: built.counts, buckets, items: built.items, text: built.text }
	}
	const via = typeof input?.via === 'string' && input.via.trim() ? input.via.trim() : 'digest'
	const record = await recordDelivery(built.items, via, now)
	return { digestId: record.id, deliveredAt: record.at, counts: built.counts, buckets, items: built.items, text: built.text }
}