Component Development Kit Stable

Overview

The Aevum CDK provides a unified interface to query, render, and manipulate structured knowledge. It's framework-agnostic but includes first-class adapters for React, Vue, and Svelte. All components are tree-shakeable and optimized for edge rendering.

Installation

Install the core package and optional framework adapters:

npm install @aevum/cdk-core @aevum/cdk-react
# or for Vue / Svelte
npm install @aevum/cdk-core @aevum/cdk-vue
npm install @aevum/cdk-core @aevum/cdk-svelte

Initialization

Configure the client with your project credentials. The SDK uses environment variables by default but accepts explicit overrides.

import { AevumClient, createAdapter } from '@aevum/cdk-core';

const client = new AevumClient({
  apiKey: process.env.AEVUM_API_KEY,
  region: 'us-east-1',
  cacheStrategy: 'aggressive', // 'none' | 'standard' | 'aggressive'
  fallbackLang: 'en'
});

// Initialize framework adapter
export const AevumProvider = createAdapter(client);

Core Components

Pre-built, accessible UI components that consume the knowledge graph directly. They handle loading states, pagination, and semantic fallbacks automatically.

<AevumSearch />

Autocomplete-enabled semantic search input with ranking by relevance, recency, and authority score.

import { AevumSearch } from '@aevum/cdk-react';

function SearchBar() {
  return (
    <AevumSearch
      placeholder="Explore knowledge..."
      maxResults=8
      onSelect={(entry) => navigate(`/article/${entry.id}`)}
      filters={{ disciplines: ['physics', 'history'] }}
    />
  );
}

<AevumArticle />

Render verified encyclopedia entries with inline citations, interactive media, and cross-reference links.

<AevumKnowledgeGraph />

Interactive force-directed visualization of concept relationships. Supports zoom, pan, and node filtering.

API Reference

Configuration

Advanced runtime configuration is passed during initialization or via a central config file (aevum.config.ts).

export default {
  telemetry: {
    enabled: false, // Opt out of anonymous usage stats
    endpoint: 'https://telemetry.aevum.io/v2'
  },
  rateLimiting: {
    strategy: 'leaky-bucket',
    requestsPerSecond: 15
  },
  rendering: {
    lazyHydration: true,
    imageOptimizer: 'sharp'
  }
};

TypeScript Support

Full type inference is included. Extend base types using generics:

type CustomArticle = AevumArticle<{
  metadata: { author: string; verified: boolean }
}>&{
  customField: number
};