@hegoatek/config-schemas
v1.2.1
Published
Configuration schemas for HegoaTek Studio templates
Readme
@hegoatek/config-schemas
Shared configuration schemas and type definitions for HegoaTek Studio ecosystem.
This package serves as the single source of truth for configuration options, template definitions, and project structure schemas used by the CLI and templates.
Purpose
- Centralized Definitions: Ensures consistency across the CLI generator and the actual templates.
- Type Safety: Provides TypeScript interfaces for configuration objects.
- Validation: Defines valid options for providers (Auth, Storage, Mail, etc.).
Installation
npm install @hegoatek/config-schemasUsage
This package is primarily used by @hegoatek/cli to validate user inputs and generate project configurations.
import {
TemplateType,
AuthProvider,
StorageProvider,
ProjectConfig
} from '@hegoatek/config-schemas';
const config: ProjectConfig = {
name: 'my-project',
template: 'saas-single-tenant',
auth: 'supabase',
storage: 'cloudflare-r2'
};Definitions
Templates
saas-single-tenant: Angular + NestJS (Single Customer)saas-multitenant: Angular + NestJS (Multi-tenant with RLS)site-vitrine-nextjs: Next.js Marketing Site
Providers
Authentication:
custom: Local JWT + bcryptsupabase: Supabase Authauth0: Auth0 (OIDC)
Storage:
local: Local filesystem (uploads/)cloudflare-r2: S3-compatible object storageaws-s3: AWS S3
Mail:
resend: Resend APIsmtp: Standard SMTP
Architecture
This package has zero dependencies to ensure it remains lightweight and can be imported anywhere in the monorepo without causing circular dependencies or bloating builds.
It sits at the base of the dependency graph:
@hegoatek/config-schemas
▲
│
@hegoatek/cliLicense
MIT
