Skip to content

SourceManifest

PropertyTypeDescription
auth?Record<string, unknown>A declared authorization strategy, for sources that hold one.
authorstringWho wrote the source.
available?booleanWhether the source is offered in the marketplace.
config?Record<string, ManifestConfigField>The preference fields shown in the setup wizard. Preferences only — no credentials.
cursor| "date" | "idSet" | "none" | "highWaterId" | "opaqueToken" | "snapshot" | "mtime" | "rowid"How the source remembers where it stopped — none, date, idSet, highWaterId.
descriptionstringOne-line directory description.
egressreadonly string[]The hosts this source may reach. Host-exact, and enforced at run time — a host absent here is unreachable, not merely undeclared.
egressNote?stringWhy the egress list looks the way it does, when that needs saying.
egressNotFetched?readonly string[]Hosts that appear in content but are never fetched.
fanOut?stringThe config field this source fans out over — one run covers every value in it. Names a key of SourceManifest.config, so fanOut: 'feeds' means the user’s feeds list is the unit of expansion. Declared as Record<string, unknown> until 3.3.0, which described nothing any catalog wrote: all seven uses are a bare key name.
formatting?"reformat" | "verbatim"Whether the platform reformats this source’s text, or leaves it verbatim.
generated?booleanMarks the file as an artifact of toSourceManifest, not a hand-written document. Every generated manifest carries it; nothing reads it but a person.
historyReach?HistoryReachHow far back the source can reach, when that is bounded by the upstream.
iconstringA single emoji or an HTTPS URL to a square icon.
idstringStable source-type id; pattern ^[a-z0-9-]+$.
ingest"append" | "upsert"How documents enter the library. Every source built so far is append.
kind"scheduled-sync" | "on-demand-fetch" | "on-demand-query"What kind of source this is. Every source built so far is scheduled-sync.
namestringHuman-readable display name.
needsBrowserbooleanWhether the source requires a Playwright browser.
runsIn"cloud" | "mac"Where the source runs by default — cloud or mac.
runtime?stringdeployed when the source runs on its own in the hosted runtime.
schedule| "every 30 minutes" | "every 1 hour" | "every 2 hours" | "every 4 hours" | "every 6 hours" | "every 12 hours" | "daily" | "weekly" | "monthly" | "yearly" | "on demand"Human-readable cadence, one of the recognised schedules.
secrets?readonly string[]Credential names the source reads through ctx.secret().
statusstringWhether the source is built (implemented) or still a declaration.
transport"feed" | "scrape" | "api" | "browser" | "local"How the source reaches upstream — feed, api, scrape, browser, local.
versionstringSemver version string.