@nikovirtala/projen-constructs 0.1.7 → 0.2.0

package/lib/project-generator.d.ts

@@ -1,62 +1,55 @@
-import type { Property } from "@jsii/spec";
 import type { Project, SourceCodeOptions } from "projen";
-import { Component } from "projen";
-type ProjenModule = "typescript" | "cdk" | "awscdk";
-type ProjenBaseClass<M extends ProjenModule> = `${M}.${string}`;
+import * as projen from "projen";
+import type { ProjectType } from "./project-type";
 /**
  * Configuration for a component to be integrated into a generated project
- *
- * @example
- * ```typescript
- * const config: ComponentConfig = {
- *   component: Vitest,
- *   optionsProperty: "vitestOptions"
- * };
- * ```
  */
-interface ComponentConfig<T extends Component = Component> {
+export interface Component {
+    /**
+     * Component class reference
+     *
+     * @jsii ignore
+     */
+    readonly componentClass: any;
     /**
-     * Component class constructor
+     * Fully qualified name of the component class
+     *
+     * Optional - auto-detected by searching JSII manifests.
      */
-    readonly component: new (project: never, options?: never) => T;
+    readonly fqn?: string;
     /**
      * Options property configuration for the generated options interface
      *
-     * When specified, adds an options property to the interface allowing
-     * users to configure the component.
-     */
-    readonly optionsProperty?: {
-        /**
-         * Name of the options property (e.g., "vitestOptions")
-         */
-        readonly name: string;
-        /**
-         * Fully qualified type name (e.g., "@nikovirtala/projen-constructs.VitestOptions")
-         */
-        readonly type: string;
-        /**
-         * Documentation summary
-         */
-        readonly docs?: string;
-    };
+     * Optional - auto-detected from component constructor.
+     * Set to false to disable options property generation.
+     * Set to string or object to customize the property name.
+     */
+    readonly optionsProperty?: string | ComponentOptions | false;
+}
+/**
+ * Options property configuration
+ */
+export interface ComponentOptions {
+    /**
+     * Name of the options property
+     */
+    readonly name: string;
+    /**
+     * Fully qualified type name (optional, auto-detected from component constructor)
+     */
+    readonly type?: string;
+    /**
+     * Documentation summary (optional, auto-detected from component constructor)
+     */
+    readonly docs?: string;
 }
 /**
  * Options for ProjectGenerator component
  *
  * Configures the generation of a TypeScript project class that extends a Projen base class
  * with standard configuration and component integration.
- *
- * @example
- * ```typescript
- * new ProjectGenerator(project, {
- *   name: "TypeScriptProject",
- *   baseClass: "typescript.TypeScriptProject",
- *   filePath: "src/projects/typescript.generated.ts",
- *   components: [{ component: Vitest, optionsProperty: "vitestOptions" }]
- * });
- * ```
  */
-export interface ProjectGeneratorOptions<M extends ProjenModule = ProjenModule> extends SourceCodeOptions {
+export interface ProjectGeneratorOptions extends SourceCodeOptions {
     /**
      * Name of the generated class (e.g., "TypeScriptProject")
      *
@@ -64,15 +57,14 @@ export interface ProjectGeneratorOptions<M extends ProjenModule = ProjenModule>
      */
     readonly name: string;
     /**
-     * Fully qualified base class to extend in format "module.ClassName"
+     * Project type identifier
      *
-     * Must be a valid Projen class reference like "typescript.TypeScriptProject",
-     * "cdk.JsiiProject", or "awscdk.AwsCdkTypeScriptApp".
+     * Specifies which Projen base class to extend and which default configuration to apply.
      *
-     * @example "typescript.TypeScriptProject"
-     * @example "cdk.JsiiProject"
+     * @example ProjectType.TYPESCRIPT
+     * @example ProjectType.JSII
      */
-    readonly baseClass: ProjenBaseClass<M>;
+    readonly projectType: ProjectType;
     /**
      * Output file path for the generated class
      *
@@ -90,14 +82,16 @@ export interface ProjectGeneratorOptions<M extends ProjenModule = ProjenModule>
      *
      * @default [{ component: Mise }, { component: Vitest, optionsProperty: { name: "vitestOptions", type: "...", docs: "..." } }]
      */
-    readonly components?: ComponentConfig[];
+    readonly components?: Component[];
     /**
      * Additional properties to add to the generated options interface
      *
      * Use this to extend the base options with custom properties specific to
      * your project type.
+     *
+     * @jsii ignore
      */
-    readonly additionalOptions?: Property[];
+    readonly additionalOptions?: any[];
     /**
      * Property names to omit from the base options interface
      *
@@ -110,34 +104,17 @@ export interface ProjectGeneratorOptions<M extends ProjenModule = ProjenModule>
  * Projen component that generates TypeScript project classes with standard configuration
  *
  * This component automates the creation of project classes that extend Projen base classes
- * with opinionated defaults and component integration. It generates both:
- * 1. An options interface (via ProjenStruct) that extends the base Projen options
- * 2. A project class that applies default configuration and instantiates components
- *
- * The generated code follows a consistent pattern:
- * - Imports required modules and components
- * - Re-exports the generated options interface
- * - Defines a class extending the Projen base class
- * - Constructor merges defaults with user options and applies components
- *
- * @example
- * ```typescript
- * new ProjectGenerator(project, {
- *   name: "TypeScriptProject",
- *   baseClass: "typescript.TypeScriptProject",
- *   filePath: "src/projects/typescript.generated.ts",
- *   components: [{ component: Vitest, optionsProperty: "vitestOptions" }]
- * });
- * ```
+ * with opinionated defaults and component integration.
  */
-export declare class ProjectGenerator extends Component {
+export declare class ProjectGenerator extends projen.Component {
     private readonly options;
     private renderer;
+    private static enumGenerated;
     /**
      * @param project - Projen project instance
      * @param options - Generator configuration
      */
-    constructor(project: Project, options: ProjectGeneratorOptions<ProjenModule>);
+    constructor(project: Project, options: ProjectGeneratorOptions);
     /**
      * Casts project to TypeScript project type
      *
@@ -169,5 +146,50 @@ export declare class ProjectGenerator extends Component {
      * The file is marked as readonly to prevent manual editing.
      */
     preSynthesize(): void;
+    /**
+     * Checks if an FQN is available in any JSII manifest
+     */
+    private isFqnAvailable;
+    /**
+     * Resolves component options type from JSII manifest
+     *
+     * Auto-detects options from JSII manifest when optionsProperty is undefined.
+     * Returns null only when optionsProperty is explicitly set to false.
+     */
+    private resolveComponentOptionsType;
+    /**
+     * Finds component FQN by searching all JSII manifests
+     */
+    private findComponentFqn;
+    /**
+     * Finds all JSII packages in node_modules
+     */
+    private findJsiiPackages;
+    /**
+     * Loads JSII manifest for a given FQN
+     *
+     * Extracts package name from FQN. For scoped packages like @scope/package.ClassName,
+     * the package name is everything before the first dot (i.e., @scope/package).
+     */
+    private loadManifestForFqn;
+    /**
+     * Loads JSII manifest from a package directory
+     */
+    private loadManifestFromPackage;
+    /**
+     * Loads this package's JSII manifest
+     */
+    private loadOwnManifest;
+    /**
+     * Generates ProjectType enum from Projen's JSII manifest
+     */
+    private generateProjectTypeEnum;
+    /**
+     * Discovers all project types that extend projen.Project
+     */
+    private discoverProjectTypes;
+    /**
+     * Checks if a class extends the base class
+     */
+    private extendsBase;
 }
-export {};