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.

​
Extension authoring

An extension should address one capability boundary. Keep the factory small, declare requirements explicitly, and expose contracts through provides or setup().

​
Prerequisites

  • A Veryfront project that imports veryfront/extensions.
  • A concrete capability gap to fill: write the extension that fills exactly that gap rather than a general-purpose toolkit.

​
Scaffold an extension

veryfront extension init my-cache
This creates a local extension package: 
extensions/
  my-cache/
    src/
      index.ts
      index.test.ts
    deno.json
Validate the extension shape: 
veryfront extension validate extensions/my-cache

​
Write a factory

import type { ExtensionFactory } from "veryfront/extensions";

const myExtension: ExtensionFactory = () => ({
  name: "my-extension",
  version: "1.0.0",
  capabilities: [],
});

export default myExtension;

​
Provide a contract

Use provides when the implementation does not need async initialization: 
import type { ExtensionFactory } from "veryfront/extensions";

interface CurrentUserProvider {
  getUser(): Promise<{ id: string } | null>;
}

const currentUserProvider: CurrentUserProvider = {
  async getUser() {
    return null;
  },
};

const authExtension: ExtensionFactory = () => ({
  name: "auth-extension",
  version: "1.0.0",
  capabilities: [],
  provides: {
    CurrentUserProvider: currentUserProvider,
  },
});

export default authExtension;
Use setup(ctx) when the implementation needs async initialization or dynamic contract registration.

​
Declare capabilities

Capabilities document what the extension needs: 
const extension: ExtensionFactory = () => ({
  name: "redis-cache",
  version: "1.0.0",
  capabilities: [
    { type: "network", hosts: ["redis.example.com"] },
    { type: "env", names: ["REDIS_URL"] },
  ],
});

​
Verify it worked

  1. Run veryfront extension validate extensions/my-cache. A passing extension prints no errors.
  2. Add the factory to veryfront.config.ts and restart veryfront dev. The dev log should list the extension under its declared name.
  3. Use the contract from another part of the app and confirm the extension’s provides value is what gets resolved.

​
Next