@gravito/scaffold 1.0.0-beta.1 → 1.1.0

package/dist/index.d.cts

@@ -1,9 +1,53 @@
 import Handlebars from 'handlebars';
 
+type ProfileType = 'core' | 'scale' | 'enterprise';
+interface ProfileConfig {
+    drivers: {
+        database: string;
+        cache: string;
+        queue: string;
+        storage: string;
+        session: string;
+    };
+    features: string[];
+}
+declare class ProfileResolver {
+    private static readonly DEFAULTS;
+    resolve(profile?: ProfileType, withFeatures?: string[]): ProfileConfig;
+    private applyFeature;
+    /**
+     * Validator for profile names
+     */
+    isValidProfile(profile: string): profile is ProfileType;
+    /**
+     * Validator for feature names
+     */
+    isValidFeature(feature: string): boolean;
+}
+
+interface DetectedEnvironment {
+    platform: 'aws' | 'gcp' | 'azure' | 'k8s' | 'vercel' | 'netlify' | 'unknown';
+    suggestedProfile: ProfileType;
+    confidence: 'high' | 'medium' | 'low';
+    reason: string;
+}
+declare class EnvironmentDetector {
+    detect(): DetectedEnvironment;
+}
+
+declare class FileMerger {
+    /**
+     * Merge content of two files based on their type.
+     */
+    merge(fileName: string, baseContent: string, overlayContent: string): string;
+    private mergeJson;
+    private mergeEnv;
+}
+
 /**
  * Architecture types supported by the scaffolding system.
  */
-type ArchitectureType = 'enterprise-mvc' | 'clean' | 'ddd';
+type ArchitectureType = 'enterprise-mvc' | 'clean' | 'ddd' | 'satellite' | 'action-domain';
 /**
  * Options for scaffolding a new project.
  */
@@ -35,6 +79,25 @@ interface ScaffoldOptions {
      * @default true
      */
     installDeps?: boolean;
+    /**
+     * Whether to include Spectrum debug dashboard
+     * @default false
+     */
+    withSpectrum?: boolean;
+    /**
+     * Whether this is an internal official satellite
+     * @default false
+     */
+    isInternal?: boolean;
+    /**
+     * Profile preset (Core, Scale, Enterprise)
+     * @default 'core'
+     */
+    profile?: 'core' | 'scale' | 'enterprise';
+    /**
+     * Feature add-ons (e.g. 'redis', 'queue', 'otel')
+     */
+    features?: string[];
     /**
      * Additional context variables for templates
      */
@@ -222,6 +285,7 @@ interface GeneratorConfig {
 declare abstract class BaseGenerator {
     protected config: GeneratorConfig;
     protected stubGenerator: StubGenerator;
+    protected fileMerger: FileMerger;
     protected filesCreated: string[];
     constructor(config: GeneratorConfig);
     /**
@@ -255,6 +319,18 @@ declare abstract class BaseGenerator {
      * Generate common files (package.json, .env, etc.)
      */
     protected generateCommonFiles(context: GeneratorContext): Promise<void>;
+    /**
+     * Apply profile-specific overlays
+     */
+    protected applyOverlays(context: GeneratorContext): Promise<void>;
+    /**
+     * Apply feature-specific overlays
+     */
+    protected applyFeatureOverlays(context: GeneratorContext): Promise<void>;
+    /**
+     * Helper to copy/merge an overlay directory into the target
+     */
+    protected copyOverlayDirectory(sourceDir: string, context: GeneratorContext): Promise<void>;
     /**
      * Write a file and track it.
      */
@@ -263,6 +339,14 @@ declare abstract class BaseGenerator {
      * Generate package.json content.
      */
     protected generatePackageJson(context: GeneratorContext): string;
+    /**
+     * Generate Dockerfile content.
+     */
+    protected generateDockerfile(context: GeneratorContext): string;
+    /**
+     * Generate .dockerignore content.
+     */
+    protected generateDockerIgnore(): string;
     /**
      * Generate .env.example content.
      */
@@ -280,6 +364,26 @@ declare abstract class BaseGenerator {
      * Override in subclasses for architecture-specific docs.
      */
     protected abstract generateArchitectureDoc(context: GeneratorContext): string;
+    /**
+     * Generate check scripts for project validation.
+     */
+    protected generateCheckScripts(context: GeneratorContext): Promise<void>;
+    /**
+     * Generate check-dependencies.ts script content.
+     */
+    protected generateCheckDependenciesScript(): string;
+    /**
+     * Generate check.sh script content.
+     */
+    protected generateCheckShellScript(): string;
+    /**
+     * Generate pre-commit.sh script content.
+     */
+    protected generatePreCommitScript(): string;
+    /**
+     * Generate CHECK_SYSTEM.md documentation.
+     */
+    protected generateCheckSystemDoc(context: GeneratorContext): string;
     /**
      * Log a message if verbose mode is enabled.
      */
@@ -310,12 +414,9 @@ declare class CleanArchitectureGenerator extends BaseGenerator {
     private generateAuthConfig;
     private generateCacheConfig;
     private generateLoggingConfig;
-    private generateBaseEntity;
     private generateUserEntity;
-    private generateBaseValueObject;
     private generateEmailValueObject;
     private generateUserRepositoryInterface;
-    private generateDomainException;
     private generateCreateUserUseCase;
     private generateGetUserUseCase;
     private generateUserDTO;
@@ -324,11 +425,15 @@ declare class CleanArchitectureGenerator extends BaseGenerator {
     private generateMailService;
     private generateAppServiceProvider;
     private generateRepositoryServiceProvider;
+    private generateProvidersIndex;
+    private generateMiddlewareProvider;
+    private generateRouteProvider;
     private generateUserController;
     private generateApiRoutes;
     private generateUserPresenter;
     private generateBootstrap;
     protected generateArchitectureDoc(context: GeneratorContext): string;
+    protected generatePackageJson(context: GeneratorContext): string;
 }
 
 /**
@@ -366,10 +471,6 @@ declare class DddGenerator extends BaseGenerator {
     private generateIdValueObject;
     private generateMoneyValueObject;
     private generateEmailValueObject;
-    private generateDomainEvent;
-    private generateAggregateRoot;
-    private generateEntity;
-    private generateValueObject;
     private generateEventDispatcher;
     private generateAggregate;
     private generateAggregateStatus;
@@ -411,12 +512,61 @@ declare class EnterpriseMvcGenerator extends BaseGenerator {
     private generateAuthMiddleware;
     private generateAppServiceProvider;
     private generateRouteServiceProvider;
+    private generateProvidersIndex;
+    private generateDatabaseProvider;
+    private generateMiddlewareProvider;
+    private generateRouteProvider;
     private generateExceptionHandler;
     private generateBootstrap;
     private generateRoutes;
     protected generateArchitectureDoc(context: GeneratorContext): string;
 }
 
+/**
+ * SatelliteGenerator - Scaffolds Gravito Satellites (Plugins)
+ *
+ * Implements DDD + Clean Architecture for plugins with built-in
+ * Dogfooding support (pre-configured with Gravito modules).
+ */
+
+declare class SatelliteGenerator extends BaseGenerator {
+    get architectureType(): "satellite";
+    get displayName(): string;
+    get description(): string;
+    getDirectoryStructure(context: GeneratorContext): DirectoryNode[];
+    private generateEntity;
+    private generateRepositoryInterface;
+    private generateUseCase;
+    private generateAtlasRepository;
+    private generateEntryPoint;
+    private generateManifest;
+    protected generatePackageJson(context: GeneratorContext): string;
+    protected generateArchitectureDoc(context: GeneratorContext): string;
+}
+
+interface LockFile {
+    profile: {
+        name: ProfileType;
+        version: string;
+    };
+    features: string[];
+    drivers: {
+        database: string;
+        cache: string;
+        queue: string;
+        storage: string;
+        session: string;
+    };
+    manifest: {
+        template: string;
+        version: string;
+    };
+    createdAt: string;
+}
+declare class LockGenerator {
+    generate(profileName: ProfileType, config: ProfileConfig, templateName?: string, templateVersion?: string): string;
+}
+
 /**
  * Scaffold - Main API for project scaffolding
  *
@@ -459,4 +609,4 @@ declare class Scaffold {
     generateProvider(_targetDir: string, _providerName: string): Promise<ScaffoldResult>;
 }
 
-export { type ArchitectureType, BaseGenerator, CleanArchitectureGenerator, DddGenerator, EnterpriseMvcGenerator, type GeneratorConfig, type GeneratorContext, Scaffold, type ScaffoldOptions, type StubConfig, StubGenerator, type StubVariables };
+export { type ArchitectureType, BaseGenerator, CleanArchitectureGenerator, DddGenerator, type DetectedEnvironment, EnterpriseMvcGenerator, EnvironmentDetector, FileMerger, type GeneratorConfig, type GeneratorContext, type LockFile, LockGenerator, type ProfileConfig, ProfileResolver, type ProfileType, SatelliteGenerator, Scaffold, type ScaffoldOptions, type StubConfig, StubGenerator, type StubVariables };

package/dist/index.d.ts

@@ -1,9 +1,53 @@
 import Handlebars from 'handlebars';
 
+type ProfileType = 'core' | 'scale' | 'enterprise';
+interface ProfileConfig {
+    drivers: {
+        database: string;
+        cache: string;
+        queue: string;
+        storage: string;
+        session: string;
+    };
+    features: string[];
+}
+declare class ProfileResolver {
+    private static readonly DEFAULTS;
+    resolve(profile?: ProfileType, withFeatures?: string[]): ProfileConfig;
+    private applyFeature;
+    /**
+     * Validator for profile names
+     */
+    isValidProfile(profile: string): profile is ProfileType;
+    /**
+     * Validator for feature names
+     */
+    isValidFeature(feature: string): boolean;
+}
+
+interface DetectedEnvironment {
+    platform: 'aws' | 'gcp' | 'azure' | 'k8s' | 'vercel' | 'netlify' | 'unknown';
+    suggestedProfile: ProfileType;
+    confidence: 'high' | 'medium' | 'low';
+    reason: string;
+}
+declare class EnvironmentDetector {
+    detect(): DetectedEnvironment;
+}
+
+declare class FileMerger {
+    /**
+     * Merge content of two files based on their type.
+     */
+    merge(fileName: string, baseContent: string, overlayContent: string): string;
+    private mergeJson;
+    private mergeEnv;
+}
+
 /**
  * Architecture types supported by the scaffolding system.
  */
-type ArchitectureType = 'enterprise-mvc' | 'clean' | 'ddd';
+type ArchitectureType = 'enterprise-mvc' | 'clean' | 'ddd' | 'satellite' | 'action-domain';
 /**
  * Options for scaffolding a new project.
  */
@@ -35,6 +79,25 @@ interface ScaffoldOptions {
      * @default true
      */
     installDeps?: boolean;
+    /**
+     * Whether to include Spectrum debug dashboard
+     * @default false
+     */
+    withSpectrum?: boolean;
+    /**
+     * Whether this is an internal official satellite
+     * @default false
+     */
+    isInternal?: boolean;
+    /**
+     * Profile preset (Core, Scale, Enterprise)
+     * @default 'core'
+     */
+    profile?: 'core' | 'scale' | 'enterprise';
+    /**
+     * Feature add-ons (e.g. 'redis', 'queue', 'otel')
+     */
+    features?: string[];
     /**
      * Additional context variables for templates
      */
@@ -222,6 +285,7 @@ interface GeneratorConfig {
 declare abstract class BaseGenerator {
     protected config: GeneratorConfig;
     protected stubGenerator: StubGenerator;
+    protected fileMerger: FileMerger;
     protected filesCreated: string[];
     constructor(config: GeneratorConfig);
     /**
@@ -255,6 +319,18 @@ declare abstract class BaseGenerator {
      * Generate common files (package.json, .env, etc.)
      */
     protected generateCommonFiles(context: GeneratorContext): Promise<void>;
+    /**
+     * Apply profile-specific overlays
+     */
+    protected applyOverlays(context: GeneratorContext): Promise<void>;
+    /**
+     * Apply feature-specific overlays
+     */
+    protected applyFeatureOverlays(context: GeneratorContext): Promise<void>;
+    /**
+     * Helper to copy/merge an overlay directory into the target
+     */
+    protected copyOverlayDirectory(sourceDir: string, context: GeneratorContext): Promise<void>;
     /**
      * Write a file and track it.
      */
@@ -263,6 +339,14 @@ declare abstract class BaseGenerator {
      * Generate package.json content.
      */
     protected generatePackageJson(context: GeneratorContext): string;
+    /**
+     * Generate Dockerfile content.
+     */
+    protected generateDockerfile(context: GeneratorContext): string;
+    /**
+     * Generate .dockerignore content.
+     */
+    protected generateDockerIgnore(): string;
     /**
      * Generate .env.example content.
      */
@@ -280,6 +364,26 @@ declare abstract class BaseGenerator {
      * Override in subclasses for architecture-specific docs.
      */
     protected abstract generateArchitectureDoc(context: GeneratorContext): string;
+    /**
+     * Generate check scripts for project validation.
+     */
+    protected generateCheckScripts(context: GeneratorContext): Promise<void>;
+    /**
+     * Generate check-dependencies.ts script content.
+     */
+    protected generateCheckDependenciesScript(): string;
+    /**
+     * Generate check.sh script content.
+     */
+    protected generateCheckShellScript(): string;
+    /**
+     * Generate pre-commit.sh script content.
+     */
+    protected generatePreCommitScript(): string;
+    /**
+     * Generate CHECK_SYSTEM.md documentation.
+     */
+    protected generateCheckSystemDoc(context: GeneratorContext): string;
     /**
      * Log a message if verbose mode is enabled.
      */
@@ -310,12 +414,9 @@ declare class CleanArchitectureGenerator extends BaseGenerator {
     private generateAuthConfig;
     private generateCacheConfig;
     private generateLoggingConfig;
-    private generateBaseEntity;
     private generateUserEntity;
-    private generateBaseValueObject;
     private generateEmailValueObject;
     private generateUserRepositoryInterface;
-    private generateDomainException;
     private generateCreateUserUseCase;
     private generateGetUserUseCase;
     private generateUserDTO;
@@ -324,11 +425,15 @@ declare class CleanArchitectureGenerator extends BaseGenerator {
     private generateMailService;
     private generateAppServiceProvider;
     private generateRepositoryServiceProvider;
+    private generateProvidersIndex;
+    private generateMiddlewareProvider;
+    private generateRouteProvider;
     private generateUserController;
     private generateApiRoutes;
     private generateUserPresenter;
     private generateBootstrap;
     protected generateArchitectureDoc(context: GeneratorContext): string;
+    protected generatePackageJson(context: GeneratorContext): string;
 }
 
 /**
@@ -366,10 +471,6 @@ declare class DddGenerator extends BaseGenerator {
     private generateIdValueObject;
     private generateMoneyValueObject;
     private generateEmailValueObject;
-    private generateDomainEvent;
-    private generateAggregateRoot;
-    private generateEntity;
-    private generateValueObject;
     private generateEventDispatcher;
     private generateAggregate;
     private generateAggregateStatus;
@@ -411,12 +512,61 @@ declare class EnterpriseMvcGenerator extends BaseGenerator {
     private generateAuthMiddleware;
     private generateAppServiceProvider;
     private generateRouteServiceProvider;
+    private generateProvidersIndex;
+    private generateDatabaseProvider;
+    private generateMiddlewareProvider;
+    private generateRouteProvider;
     private generateExceptionHandler;
     private generateBootstrap;
     private generateRoutes;
     protected generateArchitectureDoc(context: GeneratorContext): string;
 }
 
+/**
+ * SatelliteGenerator - Scaffolds Gravito Satellites (Plugins)
+ *
+ * Implements DDD + Clean Architecture for plugins with built-in
+ * Dogfooding support (pre-configured with Gravito modules).
+ */
+
+declare class SatelliteGenerator extends BaseGenerator {
+    get architectureType(): "satellite";
+    get displayName(): string;
+    get description(): string;
+    getDirectoryStructure(context: GeneratorContext): DirectoryNode[];
+    private generateEntity;
+    private generateRepositoryInterface;
+    private generateUseCase;
+    private generateAtlasRepository;
+    private generateEntryPoint;
+    private generateManifest;
+    protected generatePackageJson(context: GeneratorContext): string;
+    protected generateArchitectureDoc(context: GeneratorContext): string;
+}
+
+interface LockFile {
+    profile: {
+        name: ProfileType;
+        version: string;
+    };
+    features: string[];
+    drivers: {
+        database: string;
+        cache: string;
+        queue: string;
+        storage: string;
+        session: string;
+    };
+    manifest: {
+        template: string;
+        version: string;
+    };
+    createdAt: string;
+}
+declare class LockGenerator {
+    generate(profileName: ProfileType, config: ProfileConfig, templateName?: string, templateVersion?: string): string;
+}
+
 /**
  * Scaffold - Main API for project scaffolding
  *
@@ -459,4 +609,4 @@ declare class Scaffold {
     generateProvider(_targetDir: string, _providerName: string): Promise<ScaffoldResult>;
 }
 
-export { type ArchitectureType, BaseGenerator, CleanArchitectureGenerator, DddGenerator, EnterpriseMvcGenerator, type GeneratorConfig, type GeneratorContext, Scaffold, type ScaffoldOptions, type StubConfig, StubGenerator, type StubVariables };
+export { type ArchitectureType, BaseGenerator, CleanArchitectureGenerator, DddGenerator, type DetectedEnvironment, EnterpriseMvcGenerator, EnvironmentDetector, FileMerger, type GeneratorConfig, type GeneratorContext, type LockFile, LockGenerator, type ProfileConfig, ProfileResolver, type ProfileType, SatelliteGenerator, Scaffold, type ScaffoldOptions, type StubConfig, StubGenerator, type StubVariables };