API Reference

This section documents the public package surfaces observed in the manifests and source exports. It is organized by package and by supported subpath, not by internal source-file layout.

Packages#

• @veap/kernel: application lifecycle, IoC, config, events, errors, HTTP and cache.
• @veap/database: Knex initialization, models, query builder, relations, migrations and seeders.
• @veap/auth: server actions, validation, users, sessions, password reset, verification and RBAC.
• @veap/plugins: plugin manifests, lifecycle, registry, route trees, navigation and UI extension points.
• @veap/intl: server/client translation APIs and locale negotiation.
• @veap/mail: message contracts, transports and send helpers.
• @veap/settings: persisted key/value settings.
• @veap/storage: storage service and provider contract.
• @veap/ui: shared React component library, theme provider, styles and helpers.
• create-veap: CLI that scaffolds a Next.js + Veap application.
• @veap/translatable: multilingual fields in one polymorphic translations table.
• @veap/taggable: polymorphic tags with a translatable name/slug.
• @veap/categorizable: hierarchical, polymorphic categories.
• @veap/commentable: polymorphic threaded comments and reviews.

Package families#

The published runtime and service packages (kernel, database, auth, plugins, intl, mail, settings, storage) are documented from their repository snapshots recorded in source-map.json →. @veap/ui, create-veap and the @veap/translatable, @veap/taggable, @veap/categorizable and @veap/commentable ORM traits are private packages that live inside the veap-repo monorepo; their pages describe the source in this repository.

How to read these pages#

Each package page lists its manifest-declared entry points and the main public contracts identified in source. This is not a substitute for the .d.ts files shipped by a specific npm release: TypeScript overloads and transitive type dependencies may change between releases.

Use the package version and source tree SHA in source-map.json → to identify the inspected snapshot. For exact signatures in your application, navigate to the installed declaration files or the package source for your pinned version.