@syncafricabs/kernspark-nuxt

Nuxt adapter for the SyncAfrica KernSpark ecosystem. This package provides production-ready Nuxt server route handlers, error handlers, and response utilities that integrate the framework-independent @syncafricabs/kernspark-core with Nuxt 3.

Table of Contents

• What is it?
• Why it exists
• Features
• Installation
• Quick Start
• Comprehensive Usage
  • Server Routes
  • Error Handling
  • Response Adapter
  • With Error Handler Wrapper
• API Reference
• Error Handling Reference
• TypeScript Support
• Compatibility Matrix
• Contributing
• License
• Author

What is it?

@syncafricabs/kernspark-nuxt is a framework adapter that bridges the SyncAfrica KernSpark Core with Nuxt 3. It provides:

• NuxtIntegration - Maps ApplicationError instances to standardized JSON API responses for Nuxt server routes
• NuxtResponseAdapter - Helper methods for sending consistent success and error responses
• withNuxtErrorHandler - Higher-order function for wrapping server route handlers with error handling
• Correlation ID support - Automatic x-correlation-id header management via Nitro

The adapter follows the adapter pattern: it depends on @syncafricabs/kernspark-core (the framework-independent layer) and Nuxt only in the adapter layer. The core has zero framework dependencies.

Why it exists

Modern web applications benefit from a KernSpark - a common set of contracts, types, and behaviors shared across bounded contexts. The SyncAfrica KernSpark provides:

1. Standardized API envelopes (ApiSuccess / ApiError)
2. Rich domain error hierarchy (ValidationError, BusinessError, AuthenticationError, etc.)
3. Result types (Result, Ok, Err)
4. Domain primitives (UUID, Money, Entity, ValueObject)

Without adapters, each team would reimplement framework-specific plumbing to use these core types. This adapter eliminates that duplication by providing Nuxt-specific bindings.

Features

• Server Routes support - Drop-in Nuxt server route error handling
• Standardized JSON responses - All responses follow the ApiSuccess / ApiError envelope
• Zero-configuration error handling - Wraps server route handlers automatically
• Full TypeScript support - Comprehensive type definitions included
• Production-ready - Proper error handling, stack traces, cause chains
• Framework isolation - Core has no Nuxt dependencies

Installation

npm install @syncafricabs/kernspark-nuxt @syncafricabs/kernspark-core nuxt

Or with your preferred package manager:

yarn add @syncafricabs/kernspark-nuxt @syncafricabs/kernspark-core nuxt

pnpm add @syncafricabs/kernspark-nuxt @syncafricabs/kernspark-core nuxt

Quick Start

// server/api/users.get.ts
import { withNuxtErrorHandler, NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';
import { NotFoundError, ValidationError } from '@syncafricabs/kernspark-core';

export default withNuxtErrorHandler(async (event) => {
  const id = getRouterParam(event, 'id');
  const user = findUser(id);

  if (!user) {
    throw new NotFoundError('User not found');
  }

  return NuxtResponseAdapter.ok(event, user, 'User retrieved successfully');
});

// server/api/users.post.ts
import { withNuxtErrorHandler, NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';
import { ValidationError, ConflictError } from '@syncafricabs/kernspark-core';

export default withNuxtErrorHandler(async (event) => {
  const body = await readBody(event);

  if (!body.name || !body.email) {
    throw new ValidationError('MISSING_FIELDS', 'Name and email are required');
  }

  if (findUserByEmail(body.email)) {
    throw new ConflictError('User with this email already exists');
  }

  const user = createUser(body);
  return NuxtResponseAdapter.created(event, user, 'User created successfully');
});

Comprehensive Usage

Server Routes

GET with Error Handling

// server/api/users/[id].get.ts
import { withNuxtErrorHandler, NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';
import { NotFoundError } from '@syncafricabs/kernspark-core';

export default withNuxtErrorHandler(async (event) => {
  const id = getRouterParam(event, 'id');
  const user = findUser(id);

  if (!user) {
    throw new NotFoundError(`User with id ${id} not found`);
  }

  return NuxtResponseAdapter.ok(event, user, 'User retrieved successfully');
});

POST with Validation

// server/api/users.post.ts
import { withNuxtErrorHandler, NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';
import { ValidationError, ConflictError, BusinessError } from '@syncafricabs/kernspark-core';

export default withNuxtErrorHandler(async (event) => {
  const body = await readBody(event);

  if (!body.name || !body.email) {
    throw new ValidationError('MISSING_FIELDS', 'Name and email are required');
  }

  if (!isValidEmail(body.email)) {
    throw new ValidationError('INVALID_EMAIL', 'Email format is invalid');
  }

  const existingUser = findUserByEmail(body.email);
  if (existingUser) {
    throw new ConflictError('User with this email already exists');
  }

  if (body.balance < 0) {
    throw new BusinessError('INVALID_BALANCE', 400, 'Balance cannot be negative');
  }

  const user = createUser(body);
  return NuxtResponseAdapter.created(event, user, 'User created successfully');
});

DELETE with Authorization

// server/api/users/[id].delete.ts
import { withNuxtErrorHandler, NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';
import { InvalidTokenError, PermissionDeniedError, NotFoundError } from '@syncafricabs/kernspark-core';

export default withNuxtErrorHandler(async (event) => {
  const token = getHeader(event, 'authorization');
  if (!token || !isValidToken(token)) {
    throw new InvalidTokenError('Invalid or expired token');
  }

  const user = findUser(getRouterParam(event, 'id'));
  if (!user) {
    throw new NotFoundError('User not found');
  }

  if (!canDeleteUser(token, user.id)) {
    throw new PermissionDeniedError('You do not have permission to delete this user');
  }

  deleteUser(user.id);
  return NuxtResponseAdapter.noContent(event, 'User deleted successfully');
});

Error Handling

Custom Error Handler Configuration

import { createNuxtErrorHandler, NuxtErrorHandlerOptions } from '@syncafricabs/kernspark-nuxt';

const options: NuxtErrorHandlerOptions = {
  logErrors: true,
  logStack: true,
  includeCause: true,
  includeStack: process.env.NODE_ENV === 'development',
  defaultStatusCode: 500,
  logger: (error, event) => {
    console.error({
      correlationId: event.node?.req?.headers?.['x-correlation-id'],
      method: event.method,
      path: event.path,
      error: error.message,
      stack: error.stack,
    });
  },
};

export default withNuxtErrorHandler(handler, options);

Response Adapter

Success Responses

import { NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';

// 200 OK with data
NuxtResponseAdapter.ok(event, user, 'User retrieved');

// 201 Created with data
NuxtResponseAdapter.created(event, user, 'User created');

// 204 No Content
NuxtResponseAdapter.noContent(event);

Error Responses

import { NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';

NuxtResponseAdapter.badRequest(event, 'MISSING_FIELDS', 'Email and password are required');
NuxtResponseAdapter.unauthorized(event, 'INVALID_CREDENTIALS', 'Invalid email or password');
NuxtResponseAdapter.forbidden(event, 'PERMISSION_DENIED', 'You do not have permission');
NuxtResponseAdapter.notFound(event, 'NOT_FOUND', 'User not found');
NuxtResponseAdapter.conflict(event, 'CONFLICT', 'Resource already exists');
NuxtResponseAdapter.unprocessableEntity(event, 'INVALID_DATA', 'Invalid request data');
NuxtResponseAdapter.tooManyRequests(event, 'RATE_LIMIT_EXCEEDED', 'Too many requests');
NuxtResponseAdapter.internalServerError(event, 'INTERNAL_ERROR', 'An unexpected error occurred');
NuxtResponseAdapter.badGateway(event, 'BAD_GATEWAY', 'Upstream service error');
NuxtResponseAdapter.serviceUnavailable(event, 'SERVICE_UNAVAILABLE', 'Service temporarily unavailable');
NuxtResponseAdapter.gatewayTimeout(event, 'GATEWAY_TIMEOUT', 'Upstream service timeout');

With Error Handler Wrapper

The withNuxtErrorHandler function wraps server route handlers and automatically catches ApplicationError instances:

import { withNuxtErrorHandler, NuxtResponseAdapter } from '@syncafricabs/kernspark-nuxt';
import { NotFoundError, ValidationError } from '@syncafricabs/kernspark-core';

export default withNuxtErrorHandler(async (event) => {
  const id = getRouterParam(event, 'id');
  const user = findUser(id);

  if (!user) {
    throw new NotFoundError('User not found');
  }

  return NuxtResponseAdapter.ok(event, user);
});

API Reference

nuxtErrorHandler

Nuxt error handling handler. Catches all errors and maps them to standardized JSON responses.

function nuxtErrorHandler(error: Error, event: H3Event): void;

createNuxtErrorHandler(options?: NuxtErrorHandlerOptions)

Creates a customized error handler.

| Option | Type | Default | Description | |--------|------|---------|-------------| | logErrors | boolean | true | Enable/disable error logging | | logStack | boolean | false | Include stack traces in logs | | includeCause | boolean | true | Include error cause in response | | includeStack | boolean | false | Include stack traces in response (dev only) | | defaultStatusCode | number | 500 | Default status for unknown errors | | logger | function | console.error | Custom logger function |

NuxtResponseAdapter

Static utility class for sending responses.

| Method | HTTP Status | Description | |--------|-------------|-------------| | ok(event, data?, message?) | 200 | Send success response with data | | created(event, data?, message?) | 201 | Send created response with data | | noContent(event, message?) | 204 | Send no content response | | sendSuccess(event, apiSuccess) | varies | Send raw ApiSuccess | | sendError(event, apiError) | varies | Send raw ApiError | | badRequest(event, errorCode, message) | 400 | Send bad request error | | unauthorized(event, errorCode, message) | 401 | Send unauthorized error | | forbidden(event, errorCode, message) | 403 | Send forbidden error | | notFound(event, errorCode, message) | 404 | Send not found error | | conflict(event, errorCode, message) | 409 | Send conflict error | | unprocessableEntity(event, errorCode, message) | 422 | Send unprocessable entity error | | tooManyRequests(event, errorCode, message) | 429 | Send too many requests error | | internalServerError(event, errorCode, message) | 500 | Send internal server error | | badGateway(event, errorCode, message) | 502 | Send bad gateway error | | serviceUnavailable(event, errorCode, message) | 503 | Send service unavailable error | | gatewayTimeout(event, errorCode, message) | 504 | Send gateway timeout error |

withNuxtErrorHandler(handler, options?)

Wraps a server route handler with error handling.

function withNuxtErrorHandler<T extends NuxtServerRouteHandler>(
  handler: T,
  options?: NuxtErrorHandlerOptions
): NuxtServerRouteHandler;

Error Handling Reference

The error handler maps the following ApplicationError subclasses:

| Error Class | HTTP Status | Error Code | |-------------|-------------|------------| | ValidationError | 400 | Custom (e.g., INVALID, MISSING_FIELDS) | | MissingFieldsError | 400 | MISSING_FIELDS | | BusinessError | Varies | Custom | | ConflictError | 409 | CONFLICT | | InsufficientFundsError | 400 | INSUFFICIENT_FUNDS | | QuotaExceededError | 429 | QUOTA_EXCEEDED | | NotFoundError | 404 | NOT_FOUND | | ExpiredError | 410 | EXPIRED | | TooManyRequestsError | 429 | TOO_MANY_REQUESTS | | PaymentRequiredError | 402 | PAYMENT_REQUIRED | | LockedError | 423 | LOCKED | | AccountSuspendedError | 403 | ACCOUNT_SUSPENDED | | FeatureNotAvailableError | 501 | FEATURE_NOT_AVAILABLE | | DataIntegrityError | 422 | DATA_INTEGRITY_ERROR | | AuthenticationError | 401 | Custom (e.g., INVALID_TOKEN) | | InvalidTokenError | 401 | INVALID_TOKEN | | TokenExpiredError | 401 | TOKEN_EXPIRED | | SessionExpiredError | 401 | SESSION_EXPIRED | | AuthorizationError | Varies | Custom | | PermissionDeniedError | 403 | PERMISSION_DENIED | | NotAllowedError | 403 | NOT_ALLOWED | | InfrastructureError | Varies | Custom | | ExternalServiceError | 502 | EXTERNAL_SERVICE_ERROR | | BadGatewayError | 502 | BAD_GATEWAY | | GatewayTimeoutError | 504 | GATEWAY_TIMEOUT | | ServiceUnavailableError | 503 | SERVICE_UNAVAILABLE | | RequestFailedError | 500 | REQUEST_FAILED | | NotImplementedError | 501 | NOT_IMPLEMENTED | | MaintenanceModeError | 503 | MAINTENANCE_MODE |

Unknown ApplicationError instances use their embedded statusCode. Non-ApplicationError errors return HTTP 500 with INTERNAL_SERVER_ERROR code.

TypeScript Support

Full TypeScript support with strict mode enabled. The adapter extends Nuxt types:

import { H3Event } from 'h3';

// Nuxt server route handler type
interface ServerRouteHandler {
  (event: H3Event): Promise<any> | any;
}

Strict Mode

This package is compiled with strict: true. Enable strict mode in your project for full type safety:

{
  "compilerOptions": {
    "strict": true,
    "noImplicitAny": true,
    "strictNullChecks": true
  }
}

Compatibility Matrix

| Package Version | Node.js | Nuxt | @syncafricabs/kernspark-core | |----------------|---------|------|----------------------------------| | 1.0.0 | >=18.0.0 | ^3.0.0 | ^1.0.0 |

| Feature | Nuxt 3+ | |---------|-------------| | Server Routes | Supported | | Error handling | Supported | | Correlation ID propagation | Supported | | TypeScript 5.0+ | Supported |

Contributing

1. Fork the repository
2. Create your feature branch: git checkout -b feature/my-feature
3. Commit your changes: git commit -am 'Add my feature'
4. Push to the branch: git push origin feature/my-feature
5. Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/iamprovy-dev/kernspark-js.git
cd kernspark/packages/kernspark-nuxt

# Install dependencies
npm install

# Build
npm run build

# Run lint
npm run lint

# Run tests
npm test

Code Standards

• Use TypeScript with strict mode
• Follow the existing code style (2-space indentation, semicolons)
• Ensure all tests pass before submitting PR

License

Apache-2.0

Author

Providence Chikukwa

• Email: [email protected]
• GitHub: https://github.com/iamprovy-dev
• LinkedIn: https://www.linkedin.com/in/provychikukwa
• Organization: SyncAfrica Business Solutions