Skip to main content

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

NameDescriptionSource
CIRCULAR_DEPENDENCY_ERRORShared circular dependency error value.source
EXTENSION_CONFLICT_ERRORShared extension conflict error value.source
EXTENSION_VALIDATION_ERRORShared extension validation error value.source
MISSING_EXTENSION_ERRORShared missing extension error value.source
SandboxShellToolsProviderNameRender sandbox shell tools provider name.source

Functions

NameDescriptionSource
auditCapabilitiesLog capabilities for a named extension at startup.source
detectConflictsDetect contract conflicts between resolved extensions.source
discoverLocalExtensionsFind *.extension.ts files in the project root.source
discoverPackageExtensionsScan node_modules (including @scoped packages) for packages that declare veryfront extension metadata in their package.json.source
discoverProjectExtensionsDiscover project extensions living under extensions/ in the project root.source
formatCapabilitiesFormat capabilities as human-readable strings for logging.source
getRecommendationReturn recommendation.source
loadExtensionFactoryDynamically import an extension factory from path and resolve it.source
mapToDenoPermissionsMap capabilities to Deno CLI permission flags. Skips capabilities without a Deno permission mapping.source
mergeExtensionsMerge extensions from all four sources in priority order.source
orchestrateExtensionsRun the full extension pipeline against a resolved project config.source
parsePackageMetadataParse veryfront extension metadata from a package.json-like object.source
resolveResolve path segments to an absolute path.source
tryResolveTry to resolve.source
validateExtensionValidate the shape of an extension object. Returns an array of issue descriptions (empty array = valid).source

Classes

NameDescriptionSource
ExtensionLoaderImplement extension loader.source

Types

NameDescriptionSource
CapabilityDeclares a system capability an extension requires. Object-based for extensibility — scoping fields vary by type.source
ConflictInfoInformation about a contract conflict between extensions.source
CreateSandboxShellToolsInputInput payload for create sandbox shell tools.source
ExtensionPublic API contract for extension.source
ExtensionConfigEntryEntry shape for extension config.source
ExtensionContextContext for extension.source
ExtensionContractMetadataPublic API contract for extension contract metadata.source
ExtensionFactoryPublic API contract for extension factory.source
ExtensionLoggerPublic API contract for extension logger.source
ExtensionSourcePublic API contract for extension source.source
OrchestrateOptionsOptions for orchestrateExtensions.source
PackageMetadataMetadata extracted from a package.json that declares itself as a veryfront extension.source
ResolvedExtensionPublic API contract for resolved extension.source
SandboxShellClientPublic API contract for sandbox shell client.source
SandboxShellToolDefinitionDefinition for sandbox shell tool.source
SandboxShellToolExecutePublic API contract for sandbox shell tool execute.source
SandboxShellToolSetPublic API contract for sandbox shell tool set.source
SandboxShellToolsProviderPublic 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

NameDescriptionSource
AuthProviderAuthProvider contract interface.source
SignOptionsOptions for signing a token.source
TokenHeaderThe parsed, unverified header of a JWT.source
TokenPayloadPayload data stored within a signed token.source
VerifyOptionsOptions 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

NameDescriptionSource
buildConvenience wrapper: bundler.bundle(opts).source
contextCreate an incremental build context (watch/rebuild mode).source
getBundlerResolve the registered Bundler contract. Throws if no extension provides it.source
stopStop the bundler. Optional - extension teardown will also call this. Provided so tests that previously called esbuild.stop() keep working.source
transformConvenience wrapper that mirrors esbuild’s transform(code, options) positional signature so call-sites migrating off esbuild keep their shape.source

Types

NameDescriptionSource
BuildContextIncremental/rebuild context produced by Bundler.context.source
BuildFailureFailure thrown by Bundler.bundle or Bundler.transform.source
BundleOptionsOptions passed to Bundler.bundle.source
BundleOutputA single output file produced by a bundle operation.source
BundlerBundler contract interface.source
BundleResultResult returned from Bundler.bundle.source
BundlerMessageA diagnostic message (error or warning) from a bundler.source
BundlerMessageLocationLocation of an error or warning in source.source
BundlerPluginA bundler plugin that hooks into the build pipeline.source
BundlerPluginBuildBuild context exposed to bundler plugins.source
ImportSpecifierA single import specifier position record, matching the shape produced by es-module-lexer.source
LoaderLoader hint for source files. Mirrors esbuild’s Loader type.source
MetafileDependency-graph metadata produced by a bundler when metafile: true.source
MetafileInputInput file entry in a Metafile.source
MetafileOutputOutput file entry in a Metafile.source
ModuleLexerModule lexer contract interface.source
OnLoadArgsArguments passed to an onLoad callback.source
OnLoadResultResult returned from an onLoad callback.source
OnResolveArgsArguments passed to an onResolve callback.source
OnResolveResultResult returned from an onResolve callback.source
StdinOptionsIn-memory source input for BundleOptions.stdin.source
TransformOptionsOptions passed to Bundler.transform.source
TransformResultResult returned from Bundler.transform.source

veryfront/extensions/cache

Cache category barrel — generic cache and proxy-grade token cache.
import "veryfront/extensions/cache";

Types

NameDescriptionSource
CacheStoreCacheStore contract interface.source
TokenCacheEntryA cache entry stored by TokenCacheStore.source
TokenCacheStatsAggregate usage statistics for a TokenCacheStore.source
TokenCacheStoreTokenCacheStore contract interface.source

veryfront/extensions/compat

Compat category barrel — optional native runtime services.
import "veryfront/extensions/compat";

Types

NameDescriptionSource
DocumentExtractorDocument extraction contract.source
KreuzbergExtractorShape returned by the kreuzberg document-extraction module.source
SqliteDatabaseMinimal interface for a SQLite database connection, compatible with better-sqlite3’s Database shape as consumed by SqliteKv.source
SqliteStatementMinimal interface for a prepared SQLite statement, compatible with better-sqlite3’s Statement shape.source
SqliteStoreSQLite-backed storage contract.source

veryfront/extensions/content

Content category barrel for the MDX/Markdown content processor contract.
import "veryfront/extensions/content";

Types

NameDescriptionSource
CompilationModeCompilation mode. Dev surfaces extra diagnostics.source
CompilationTargetWhere the output is destined: server-side RSC or browser bundle.source
ContentCompileOptionsOptions for ContentProcessor.compileMdx and ContentProcessor.compileMarkdown.source
ContentPluginOpaque 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
ContentProcessingResultProcessing result returned by the content pipeline.source
ContentProcessorContentProcessor 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

NameDescriptionSource
registerRegister.source
resetReset.source
resolveResolve path segments to an absolute path.source
tryResolveTry to resolve.source
unregisterUnregister.source

veryfront/extensions/css

CSS category barrel — CSS processor and compiler contracts.
import "veryfront/extensions/css";

Types

NameDescriptionSource
CSSCompileOptionsOptions passed to CSSProcessor.compile.source
CSSCompilerStateful compiler returned by CSSProcessor.compile.source
CSSModuleSourceA loaded module (Tailwind plugin). module is the plugin’s default export.source
CSSProcessorCSSProcessor contract interface.source
CSSStylesheetSourceA 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

NameDescriptionSource
DatabaseClientDatabaseClient contract interface.source
QueryResultResult 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

NameDescriptionSource
LLMProviderRegistryNameContract name used for resolve() / provide().source

Functions

NameDescriptionSource
createLLMProviderRegistryCreate llmprovider registry.source

Types

NameDescriptionSource
EmbeddingOptionsOptions passed to EmbeddingProvider.embed.source
EmbeddingProviderEmbeddingProvider contract interface.source
EmbeddingResultResult returned from EmbeddingProvider.embed.source
LLMProviderAn 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
LLMProviderConfigConfig passed to any provider’s create* method.source
LLMProviderRegistryRegistry 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

NameDescriptionSource
NodeTelemetryProviderNameContract interface for Node.js OpenTelemetry runtime bootstrap.source

Types

NameDescriptionSource
NodeTelemetryInitializeOptionsOptions accepted by node telemetry initialize.source
NodeTelemetryInstrumentationConfigConfiguration used by node telemetry instrumentation.source
NodeTelemetryLoggerPublic API contract for node telemetry logger.source
NodeTelemetryProcessTargetPublic API contract for node telemetry process target.source
NodeTelemetryProviderInitializes Node-specific OpenTelemetry SDK behavior.source
SpanDataData describing a single trace span.source
TracerProviderMinimal TracerProvider interface for the contract. Structurally compatible with both the core shim and the real OTel SDK.source
TracingExporterTracingExporter contract interface.source

veryfront/extensions/parser

Parser category barrel — CodeParser (AST traversal) contract.
import "veryfront/extensions/parser";

Types

NameDescriptionSource
ASTNodeA single node in an abstract syntax tree.source
CodeParserPublic API contract for code parser.source
GenerateOptionsOptions passed to CodeParser.generate.source
GenerateResultResult returned from CodeParser.generate.source
InjectJsxNodePositionsOptionsOptions for CodeParser.injectJsxNodePositions.source
NodePathWrapper providing traversal context for a visited node.source
ParseOptionsOptions passed to CodeParser.parse.source
TraverseVisitorVisitor callbacks keyed by node type.source

veryfront/extensions/sandbox

Sandbox category barrel.
import { SandboxShellToolsProviderName } from "veryfront/extensions/sandbox";

Components

NameDescriptionSource
SandboxShellToolsProviderNameRender sandbox shell tools provider name.source

Types

NameDescriptionSource
CreateSandboxShellToolsInputInput payload for create sandbox shell tools.source
SandboxShellClientPublic API contract for sandbox shell client.source
SandboxShellToolDefinitionDefinition for sandbox shell tool.source
SandboxShellToolExecutePublic API contract for sandbox shell tool execute.source
SandboxShellToolSetPublic API contract for sandbox shell tool set.source
SandboxShellToolsProviderPublic API contract for sandbox shell tools provider.source

veryfront/extensions/schema

Schema category barrel — SchemaValidator contract and inference helpers.
import "veryfront/extensions/schema";

Types

NameDescriptionSource
InferInputExtracts the inferred input type from a Schema<T>.source
InferSchemaExtracts the inferred output type T from a Schema<T>.source
InferShapeMaps a raw object shape to its inferred object type, preserving optionality.source
JsonSchemaMinimal 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
RefinementCtxContext passed to a superRefine callback. Provides addIssue to emit one or more validation issues and path to locate the current value.source
SchemaAn opaque schema definition that validates and infers type T.source
SchemaFactoryFactory type accepted by defineSchema.source
SchemaValidatorSchemaValidator contract interface.source
SchemaValidatorCoerceNamespace for coerce.* constructors - accepts input in any form and coerces to the target type before validation.source
ValidationFailureFailed validation outcome.source
ValidationIssueA single validation issue with location context.source
ValidationResultDiscriminated union of validation outcomes.source
ValidationSuccessSuccessful validation outcome.source
User guides: Architecture: