Docs/API Reference

Public export inventory

This inventory maps package entry points to the source barrels that feed them in the recorded source snapshot. It helps you locate an API without importing internal src/* paths.…

4 min read

This inventory maps package entry points to the source barrels that feed them in the recorded source snapshot. It helps you locate an API without importing internal src/* paths. For package versions and exact source identifiers, see source-map.json →.

@veap/kernel#

  • . — cache, application composition, config, errors, events, HTTP, IoC, logging.
  • /events — event contracts and bus.
  • /ioc — container, decorators, service provider and tokens.
  • /errors — application errors, HTTP status helpers, result utilities and error types.
  • /logging — logger contracts and console logger.
  • /http — HTTP contracts/adapters/security helpers.
  • /cache — cache contracts and in-memory cache.
  • /config — config loader/service/contracts/index.
  • /server — server config loader/provider, root exports and KernelServiceProvider.

@veap/database#

  • . — casts, composition augmentation, connection, errors/events, factories, logger, migration provider, migrations, models, provider, query builder, relations, scopes, seeders, tokens, types and utilities.
  • /migrations — generator, runner and schema builder.
  • /relations — relation classes and eager-loading helpers.

@veap/mail#

  • . — composition, communication context, send helpers, message types, mailer port/tokens, service provider, console and Nodemailer transports, translator integration.

@veap/intl#

  • . — common message/config types, client React exports and translation utility exports.
  • /client — client constants/types, React provider/hooks and translator.
  • /server — config/constants/detection/types, provider, server I18nProvider, translation getter, IntlService and message loader.

@veap/settings#

  • . — composition augmentation, contracts, migrations, models, providers, repositories and services.
  • /models — setting model exports.
  • /server — root server exports.
  • /migrations — settings migration exports.

@veap/storage#

  • . — storage provider, local driver, service and types.
  • /providers/local — local filesystem provider.
  • /types — storage result/provider/service contracts and tokens.

@veap/plugins#

  • . — common contracts, builder composition augmentation, migrations, navigation, providers and registry.
  • /client — client widget and extension components (see client).
  • /router — route tree, discovery, matching, middleware and rendering utilities (see router).
  • /models — plugin persistence models (see actions and models).
  • /actions — plugin server actions (see actions and models).
  • /server — root/server exports, router, registry, navigation aliases and server UI components (see server).
  • /migrations — plugin migration exports.

@veap/auth#

  • . — auth actions, client hooks, common types, crypto, password reset, providers, RBAC, sessions, users, validation and email verification.
  • /client — React auth context and hooks.
  • /server — root exports and server crypto/action APIs.
  • /actions — auth Server Actions.
  • /validation — Zod schemas and inferred input types.
  • /models — auth model exports.
  • /migrations — auth migration exports.

@veap/ui#

  • . — components, useIsMobile, shared helpers, mdxComponents, ThemeProvider, cn, Logo, Icon, toast.
  • /components/* — individual component modules.
  • /shared/* — AccessDenied, PageLoader, ScrollFadeEffect.
  • /providers — ThemeProvider.
  • /logo — Logo and variants.
  • /globals.css — the Tailwind stylesheet.

create-veap#

  • . — initProject and the PackageManager type.
  • The executable is exposed through the bin field (create-veap).

@veap/translatable#

  • . — locale manager, Translation model, TranslatableModel/Translatable and the translatable query builder.
  • /migrations — the translations table migration.
  • /ui — TranslatableField, TranslatableFormCard, TranslatableTabs.

@veap/taggable#

  • . — Tag model, factory and seeder, TaggableModel/Taggable and the taggable query builder.
  • /migrations — the tags and taggables migrations.
  • /ui — TagInput.

@veap/categorizable#

  • . — Category model, factory and seeder, CategorizableModel/Categorizable, MorphOneCategory and the categorizable query builder.
  • /migrations — the categories and categorizables migrations.
  • /ui — CategoryTreeSelect.

@veap/commentable#

  • . — Comment model and factory, CommentableModel/Commentable and the commentable query builder.
  • /migrations — the comments table migration.
  • /ui — CommentSection, CommentForm.

Public export versus implementation detail#

The package exports map is the supported import contract. A source file existing in Git does not automatically make its path a public npm import. Use the documented package/subpath imports and verify the exact declaration file for your installed version.

veap
Preparing0%