API Reference

Complete API reference for Unspec'd framework components, functions, and utilities.

Core APIs

UnspecdUI Class

The main class for creating Unspec'd applications in Library Mode.

import { UnspecdUI } from '@glyphtek/unspecd';

const app = new UnspecdUI({
  title: 'My Application',
  tools: [/* ... */]
});

Tool Specification

Complete specification for defining tools and their components.

interface Tool {
  id: string;
  title: string;
  content: ComponentContent;
  functions?: Record<string, Function>;
  inputs?: Record<string, InputConfig>;
}

Component Types

All available component types and their configuration options.

• displayRecord - Display structured data
• editableTable - CRUD data tables
• editForm - Form editing interfaces
• streamingTable - Real-time data streams
• actionButton - Interactive buttons

Component APIs

Display Record API

API reference for the Display Record component.

Editable Table API

API reference for the Editable Table component.

Edit Form API

API reference for the Edit Form component.

Streaming Table API

API reference for the Streaming Table component.

Action Button API

API reference for the Action Button component.

Utility APIs

Data Handlers

Utilities for data processing and validation.

Type Definitions

Complete TypeScript type definitions.

Error Handling

Error types and handling patterns.

CLI APIs

CLI Commands

Complete reference for CLI commands and options.

Configuration Files

Configuration file formats and options.

Integration APIs

Server Integration

APIs for integrating with web servers and frameworks.

Database Integration

Patterns for database integration and data persistence.

Authentication

Authentication and authorization patterns.

Advanced APIs

Custom Components

Creating custom component types.

Plugins

Plugin system and extension APIs.

Theming

Theming and customization APIs.

---

Quick Links:

• Getting Started Guide
• Component Guide
• Examples