Documentation Index
Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
veryfront/extensions
Public extension API surface. Types used when authoring extensions (the scaffold template generated by veryfront extension init imports from this module), plus the runtime helpers consumers need to load, validate, and orchestrate extensions.
Import
import {
auditCapabilities,
detectConflicts,
discoverLocalExtensions,
discoverPackageExtensions,
discoverProjectExtensions,
formatCapabilities,
} from "veryfront/extensions";
Examples
import { orchestrateExtensions } from "veryfront/extensions";
const loader = await orchestrateExtensions({
projectDir: Deno.cwd(),
config,
logger,
});
// Later, on shutdown:
await loader.teardownAll();
Exports
Components
| Name | Description | Source |
|---|
CIRCULAR_DEPENDENCY_ERROR | Shared circular dependency error value. | source |
EXTENSION_CONFLICT_ERROR | Shared extension conflict error value. | source |
EXTENSION_VALIDATION_ERROR | Shared extension validation error value. | source |
MISSING_EXTENSION_ERROR | Shared missing extension error value. | source |
SandboxShellToolsProviderName | Render sandbox shell tools provider name. | source |
Functions
| Name | Description | Source |
|---|
auditCapabilities | Log capabilities for a named extension at startup. | source |
detectConflicts | Detect contract conflicts between resolved extensions. | source |
discoverLocalExtensions | Find *.extension.ts files in the project root. | source |
discoverPackageExtensions | Scan node_modules (including @scoped packages) for packages that declare veryfront extension metadata in their package.json. | source |
discoverProjectExtensions | Discover project extensions living under extensions/ in the project root. | source |
formatCapabilities | Format capabilities as human-readable strings for logging. | source |
getRecommendation | Return recommendation. | source |
loadExtensionFactory | Dynamically import an extension factory from path and resolve it. | source |
mapToDenoPermissions | Map capabilities to Deno CLI permission flags. Skips capabilities without a Deno permission mapping. | source |
mergeExtensions | Merge extensions from all four sources in priority order. | source |
orchestrateExtensions | Run the full extension pipeline against a resolved project config. | source |
parsePackageMetadata | Parse veryfront extension metadata from a package.json-like object. | source |
resolve | Resolve path segments to an absolute path. | source |
tryResolve | Try to resolve. | source |
validateExtension | Validate the shape of an extension object. Returns an array of issue descriptions (empty array = valid). | source |
Classes
| Name | Description | Source |
|---|
ExtensionLoader | Implement extension loader. | source |
Types
| Name | Description | Source |
|---|
Capability | Declares a system capability an extension requires. Object-based for extensibility — scoping fields vary by type. | source |
ConflictInfo | Information about a contract conflict between extensions. | source |
CreateSandboxShellToolsInput | Input payload for create sandbox shell tools. | source |
Extension | Public API contract for extension. | source |
ExtensionConfigEntry | Entry shape for extension config. | source |
ExtensionContext | Context for extension. | source |
ExtensionContractMetadata | Public API contract for extension contract metadata. | source |
ExtensionFactory | Public API contract for extension factory. | source |
ExtensionLogger | Public API contract for extension logger. | source |
ExtensionSource | Public API contract for extension source. | source |
OrchestrateOptions | Options for orchestrateExtensions. | source |
PackageMetadata | Metadata extracted from a package.json that declares itself as a veryfront extension. | source |
ResolvedExtension | Public API contract for resolved extension. | source |
SandboxShellClient | Public API contract for sandbox shell client. | source |
SandboxShellToolDefinition | Definition for sandbox shell tool. | source |
SandboxShellToolExecute | Public API contract for sandbox shell tool execute. | source |
SandboxShellToolSet | Public API contract for sandbox shell tool set. | source |
SandboxShellToolsProvider | Public API contract for sandbox shell tools provider. | source |
Deep imports
These import paths group focused functionality under this module. Each is a separate barrel; import only what you need.
veryfront/extensions/auth
Auth category barrel — AuthProvider contract and token shapes.
import "veryfront/extensions/auth";
Types
| Name | Description | Source |
|---|
AuthProvider | AuthProvider contract interface. | source |
SignOptions | Options for signing a token. | source |
TokenHeader | The parsed, unverified header of a JWT. | source |
TokenPayload | Payload data stored within a signed token. | source |
VerifyOptions | Options for verifying a token. | source |
veryfront/extensions/bundler
Bundler category barrel — Bundler contract, module lexer, and resolver helper.
import { build, context, getBundler } from "veryfront/extensions/bundler";
Functions
| Name | Description | Source |
|---|
build | Convenience wrapper: bundler.bundle(opts). | source |
context | Create an incremental build context (watch/rebuild mode). | source |
getBundler | Resolve the registered Bundler contract. Throws if no extension provides it. | source |
stop | Stop the bundler. Optional - extension teardown will also call this. Provided so tests that previously called esbuild.stop() keep working. | source |
transform | Convenience wrapper that mirrors esbuild’s transform(code, options) positional signature so call-sites migrating off esbuild keep their shape. | source |
Types
| Name | Description | Source |
|---|
BuildContext | Incremental/rebuild context produced by Bundler.context. | source |
BuildFailure | Failure thrown by Bundler.bundle or Bundler.transform. | source |
BundleOptions | Options passed to Bundler.bundle. | source |
BundleOutput | A single output file produced by a bundle operation. | source |
Bundler | Bundler contract interface. | source |
BundleResult | Result returned from Bundler.bundle. | source |
BundlerMessage | A diagnostic message (error or warning) from a bundler. | source |
BundlerMessageLocation | Location of an error or warning in source. | source |
BundlerPlugin | A bundler plugin that hooks into the build pipeline. | source |
BundlerPluginBuild | Build context exposed to bundler plugins. | source |
ImportSpecifier | A single import specifier position record, matching the shape produced by es-module-lexer. | source |
Loader | Loader hint for source files. Mirrors esbuild’s Loader type. | source |
Metafile | Dependency-graph metadata produced by a bundler when metafile: true. | source |
MetafileInput | Input file entry in a Metafile. | source |
MetafileOutput | Output file entry in a Metafile. | source |
ModuleLexer | Module lexer contract interface. | source |
OnLoadArgs | Arguments passed to an onLoad callback. | source |
OnLoadResult | Result returned from an onLoad callback. | source |
OnResolveArgs | Arguments passed to an onResolve callback. | source |
OnResolveResult | Result returned from an onResolve callback. | source |
StdinOptions | In-memory source input for BundleOptions.stdin. | source |
TransformOptions | Options passed to Bundler.transform. | source |
TransformResult | Result returned from Bundler.transform. | source |
veryfront/extensions/cache
Cache category barrel — generic cache and proxy-grade token cache.
import "veryfront/extensions/cache";
Types
| Name | Description | Source |
|---|
CacheStore | CacheStore contract interface. | source |
TokenCacheEntry | A cache entry stored by TokenCacheStore. | source |
TokenCacheStats | Aggregate usage statistics for a TokenCacheStore. | source |
TokenCacheStore | TokenCacheStore contract interface. | source |
veryfront/extensions/compat
Compat category barrel — optional native runtime services.
import "veryfront/extensions/compat";
Types
| Name | Description | Source |
|---|
DocumentExtractor | Document extraction contract. | source |
KreuzbergExtractor | Shape returned by the kreuzberg document-extraction module. | source |
SqliteDatabase | Minimal interface for a SQLite database connection, compatible with better-sqlite3’s Database shape as consumed by SqliteKv. | source |
SqliteStatement | Minimal interface for a prepared SQLite statement, compatible with better-sqlite3’s Statement shape. | source |
SqliteStore | SQLite-backed storage contract. | source |
veryfront/extensions/content
Content category barrel for the MDX/Markdown content processor contract.
import "veryfront/extensions/content";
Types
| Name | Description | Source | |
|---|
CompilationMode | Compilation mode. Dev surfaces extra diagnostics. | source | |
CompilationTarget | Where the output is destined: server-side RSC or browser bundle. | source | |
ContentCompileOptions | Options for ContentProcessor.compileMdx and ContentProcessor.compileMarkdown. | source | |
ContentPlugin | Opaque unified-compatible plugin entry. Kept as `unknown[] | unknownso the contract surface doesn't require consumers to depend on theunified` package directly. Callers cast to the plugin-list shape they need. | source |
ContentProcessingResult | Processing result returned by the content pipeline. | source | |
ContentProcessor | ContentProcessor contract for MDX/Markdown processing. | source | |
veryfront/extensions/contracts
Contract registry — runtime resolution of extension-provided implementations.
import { register, reset, resolve } from "veryfront/extensions/contracts";
Functions
| Name | Description | Source |
|---|
register | Register. | source |
reset | Reset. | source |
resolve | Resolve path segments to an absolute path. | source |
tryResolve | Try to resolve. | source |
unregister | Unregister. | source |
veryfront/extensions/css
CSS category barrel — CSS processor and compiler contracts.
import "veryfront/extensions/css";
Types
| Name | Description | Source |
|---|
CSSCompileOptions | Options passed to CSSProcessor.compile. | source |
CSSCompiler | Stateful compiler returned by CSSProcessor.compile. | source |
CSSModuleSource | A loaded module (Tailwind plugin). module is the plugin’s default export. | source |
CSSProcessor | CSSProcessor contract interface. | source |
CSSStylesheetSource | A loaded stylesheet body with the base path used to resolve relative imports. | source |
veryfront/extensions/database
Database category barrel — DatabaseClient contract.
import "veryfront/extensions/database";
Types
| Name | Description | Source |
|---|
DatabaseClient | DatabaseClient contract interface. | source |
QueryResult | Result returned from DatabaseClient.query. | source |
veryfront/extensions/llm
LLM category barrel — provider, embedding, and registry contracts. Interfaces re-exported with export type { ... } because Deno --no-check transpiles each file in isolation and would otherwise emit a runtime value re-export that fails ESM resolution. Reserve plain export { ... } for runtime values.
import { createLLMProviderRegistry, LLMProviderRegistryName } from "veryfront/extensions/llm";
Components
| Name | Description | Source |
|---|
LLMProviderRegistryName | Contract name used for resolve() / provide(). | source |
Functions
| Name | Description | Source |
|---|
createLLMProviderRegistry | Create llmprovider registry. | source |
Types
| Name | Description | Source |
|---|
EmbeddingOptions | Options passed to EmbeddingProvider.embed. | source |
EmbeddingProvider | EmbeddingProvider contract interface. | source |
EmbeddingResult | Result returned from EmbeddingProvider.embed. | source |
LLMProvider | An LLM provider implementation. Extensions register one of these with the LLMProviderRegistry during setup(). createModel is required; createEmbedding and createResponses are optional and absent on providers that don’t support them. | source |
LLMProviderConfig | Config passed to any provider’s create* method. | source |
LLMProviderRegistry | Registry contract. Single impl created at bootstrap. | source |
veryfront/extensions/observability
Observability category barrel: tracing and Node telemetry contracts.
import { NodeTelemetryProviderName } from "veryfront/extensions/observability";
Components
| Name | Description | Source |
|---|
NodeTelemetryProviderName | Contract interface for Node.js OpenTelemetry runtime bootstrap. | source |
Types
| Name | Description | Source |
|---|
NodeTelemetryInitializeOptions | Options accepted by node telemetry initialize. | source |
NodeTelemetryInstrumentationConfig | Configuration used by node telemetry instrumentation. | source |
NodeTelemetryLogger | Public API contract for node telemetry logger. | source |
NodeTelemetryProcessTarget | Public API contract for node telemetry process target. | source |
NodeTelemetryProvider | Initializes Node-specific OpenTelemetry SDK behavior. | source |
SpanData | Data describing a single trace span. | source |
TracerProvider | Minimal TracerProvider interface for the contract. Structurally compatible with both the core shim and the real OTel SDK. | source |
TracingExporter | TracingExporter contract interface. | source |
veryfront/extensions/parser
Parser category barrel — CodeParser (AST traversal) contract.
import "veryfront/extensions/parser";
Types
| Name | Description | Source |
|---|
ASTNode | A single node in an abstract syntax tree. | source |
CodeParser | Public API contract for code parser. | source |
GenerateOptions | Options passed to CodeParser.generate. | source |
GenerateResult | Result returned from CodeParser.generate. | source |
InjectJsxNodePositionsOptions | Options for CodeParser.injectJsxNodePositions. | source |
NodePath | Wrapper providing traversal context for a visited node. | source |
ParseOptions | Options passed to CodeParser.parse. | source |
TraverseVisitor | Visitor callbacks keyed by node type. | source |
veryfront/extensions/sandbox
Sandbox category barrel.
import { SandboxShellToolsProviderName } from "veryfront/extensions/sandbox";
Components
| Name | Description | Source |
|---|
SandboxShellToolsProviderName | Render sandbox shell tools provider name. | source |
Types
| Name | Description | Source |
|---|
CreateSandboxShellToolsInput | Input payload for create sandbox shell tools. | source |
SandboxShellClient | Public API contract for sandbox shell client. | source |
SandboxShellToolDefinition | Definition for sandbox shell tool. | source |
SandboxShellToolExecute | Public API contract for sandbox shell tool execute. | source |
SandboxShellToolSet | Public API contract for sandbox shell tool set. | source |
SandboxShellToolsProvider | Public API contract for sandbox shell tools provider. | source |
veryfront/extensions/schema
Schema category barrel — SchemaValidator contract and inference helpers.
import "veryfront/extensions/schema";
Types
| Name | Description | Source |
|---|
InferInput | Extracts the inferred input type from a Schema<T>. | source |
InferSchema | Extracts the inferred output type T from a Schema<T>. | source |
InferShape | Maps a raw object shape to its inferred object type, preserving optionality. | source |
JsonSchema | Minimal JSON Schema type used by the SchemaValidator contract for toJsonSchema(). Kept in the extensions/schema category so the contract can reference it without depending on any non-leaf module. | source |
RefinementCtx | Context passed to a superRefine callback. Provides addIssue to emit one or more validation issues and path to locate the current value. | source |
Schema | An opaque schema definition that validates and infers type T. | source |
SchemaFactory | Factory type accepted by defineSchema. | source |
SchemaValidator | SchemaValidator contract interface. | source |
SchemaValidatorCoerce | Namespace for coerce.* constructors - accepts input in any form and coerces to the target type before validation. | source |
ValidationFailure | Failed validation outcome. | source |
ValidationIssue | A single validation issue with location context. | source |
ValidationResult | Discriminated union of validation outcomes. | source |
ValidationSuccess | Successful validation outcome. | source |
User guides:
Architecture: