@msishamim/create-next-monorepo 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,221 @@
+/**
+ * ProjectConfig — Immutable configuration model holding all user choices.
+ * Auto-derives package names, case variants, and computed properties.
+ * Mirrors flutter_monorepo's ProjectConfig pattern.
+ */
+declare const Backend: {
+    readonly nestjs: "nestjs";
+    readonly express: "express";
+};
+type Backend = (typeof Backend)[keyof typeof Backend];
+declare const Styling: {
+    readonly tailwind: "tailwind";
+    readonly cssModules: "css-modules";
+    readonly styledComponents: "styled-components";
+};
+type Styling = (typeof Styling)[keyof typeof Styling];
+declare const ORM: {
+    readonly prisma: "prisma";
+    readonly drizzle: "drizzle";
+    readonly none: "none";
+};
+type ORM = (typeof ORM)[keyof typeof ORM];
+declare const Database: {
+    readonly postgres: "postgres";
+    readonly mysql: "mysql";
+    readonly sqlite: "sqlite";
+    readonly mongodb: "mongodb";
+};
+type Database = (typeof Database)[keyof typeof Database];
+declare const Auth: {
+    readonly nextAuth: "next-auth";
+    readonly custom: "custom";
+    readonly none: "none";
+};
+type Auth = (typeof Auth)[keyof typeof Auth];
+declare const StateManagement: {
+    readonly zustand: "zustand";
+    readonly jotai: "jotai";
+    readonly redux: "redux";
+    readonly tanstackQuery: "tanstack-query";
+    readonly none: "none";
+};
+type StateManagement = (typeof StateManagement)[keyof typeof StateManagement];
+declare const TestFramework: {
+    readonly vitest: "vitest";
+    readonly jest: "jest";
+};
+type TestFramework = (typeof TestFramework)[keyof typeof TestFramework];
+declare const PackageManager: {
+    readonly pnpm: "pnpm";
+    readonly npm: "npm";
+    readonly yarn: "yarn";
+    readonly bun: "bun";
+};
+type PackageManager = (typeof PackageManager)[keyof typeof PackageManager];
+declare const LicenseType: {
+    readonly MIT: "MIT";
+    readonly Apache2: "Apache-2.0";
+    readonly BSD2: "BSD-2-Clause";
+    readonly BSD3: "BSD-3-Clause";
+    readonly GPL2: "GPL-2.0";
+    readonly GPL3: "GPL-3.0";
+    readonly LGPL21: "LGPL-2.1";
+    readonly MPL2: "MPL-2.0";
+    readonly ISC: "ISC";
+    readonly Unlicense: "Unlicense";
+    readonly Proprietary: "proprietary";
+};
+type LicenseType = (typeof LicenseType)[keyof typeof LicenseType];
+interface ProjectConfigOptions {
+    name: string;
+    backend?: Backend;
+    styling?: Styling;
+    orm?: ORM;
+    db?: Database;
+    auth?: Auth;
+    state?: StateManagement;
+    testing?: TestFramework;
+    license?: LicenseType;
+    packageManager?: PackageManager;
+    gitInit?: boolean;
+    githubFiles?: boolean;
+}
+declare class ProjectConfig {
+    /** Project name in kebab-case (e.g. "my-app") */
+    readonly name: string;
+    readonly backend: Backend;
+    readonly styling: Styling;
+    readonly orm: ORM;
+    readonly db: Database;
+    readonly auth: Auth;
+    readonly state: StateManagement;
+    readonly testing: TestFramework;
+    readonly license: LicenseType;
+    readonly packageManager: PackageManager;
+    readonly gitInit: boolean;
+    readonly githubFiles: boolean;
+    /** Resolved npm package versions — set by Generator before template rendering */
+    versions: Record<string, string>;
+    constructor(options: ProjectConfigOptions);
+    /** PascalCase (e.g. "my-app" → "MyApp") */
+    get pascalCase(): string;
+    /** camelCase (e.g. "my-app" → "myApp") */
+    get camelCase(): string;
+    /** SCREAMING_SNAKE_CASE (e.g. "my-app" → "MY_APP") */
+    get screamingSnakeCase(): string;
+    get hasDatabase(): boolean;
+    get hasAuth(): boolean;
+    get hasState(): boolean;
+    get usesTailwind(): boolean;
+    /** Install command for the selected package manager */
+    get installCommand(): string;
+    /** Run command prefix for the selected package manager */
+    get runCommand(): string;
+    /** Workspace config file name */
+    get workspaceConfigFile(): string;
+    /** List of npm packages required based on current config */
+    get requiredPackages(): string[];
+}
+
+/**
+ * Generator — 16-step pipeline that creates a complete monorepo.
+ * Mirrors flutter_monorepo's Generator class architecture.
+ */
+
+declare class Generator {
+    private rootPath;
+    private config;
+    constructor(config: ProjectConfig, rootPath: string);
+    /** Run the full 16-step generation pipeline */
+    run(): Promise<void>;
+    private resolveVersions;
+    private createRootWorkspace;
+    private createDirectories;
+    private writeRootFiles;
+    private writeGithubFiles;
+    private writeConfigPackage;
+    private writeLibPackage;
+    private writeUiPackage;
+    private writeDatabasePackage;
+    private writeNextjsApp;
+    private writeBackendApp;
+    private writeAuthLayer;
+    private writeSkills;
+    private installDependencies;
+    private initializeGit;
+    private printSummary;
+    private write;
+}
+
+/**
+ * VersionResolver — Fetches latest compatible versions from npm registry.
+ * Falls back to hardcoded tested versions when offline.
+ */
+declare class VersionResolver {
+    private resolved;
+    /**
+     * Resolve versions for the given package names.
+     * Attempts to fetch latest from npm registry; falls back to hardcoded versions.
+     */
+    resolve(packageNames: string[]): Promise<Record<string, string>>;
+    /** Get the fallback version for a package */
+    getFallback(packageName: string): string;
+    /** Fetch the latest version of a package from the npm registry */
+    private fetchLatestVersion;
+    /** Get all resolved versions */
+    getVersions(): Record<string, string>;
+    /** Get all fallback versions (for testing/reference) */
+    static getFallbacks(): Record<string, string>;
+}
+
+/**
+ * Doctor — Validates monorepo structure integrity and auto-fixes missing items.
+ * Mirrors flutter_monorepo's Doctor class.
+ */
+declare class Doctor {
+    private rootPath;
+    constructor(rootPath: string);
+    /** Run the doctor validation */
+    run(fix: boolean): Promise<void>;
+    /** Build the restorable files map using templates */
+    private buildRestorableFiles;
+}
+
+/**
+ * Workflow — Step-by-step development guides for building features.
+ * Three flows: A (Component), B (Page/Route), C (API Feature).
+ * Adapts output based on detected project configuration.
+ * Mirrors flutter_monorepo's Workflow class.
+ */
+declare class Workflow {
+    private rootPath;
+    constructor(rootPath: string);
+    /** Run the specified workflow (or show overview) */
+    run(flow?: string): void;
+    private printOverview;
+    private printComponentFlow;
+    private printPageFlow;
+    private printApiFlow;
+}
+
+/**
+ * ConfigDetector — Reverse-engineers a ProjectConfig from an existing
+ * generated monorepo by reading files on disk.
+ * Mirrors flutter_monorepo's config_detector.dart.
+ */
+
+/** Attempt to detect project configuration from existing files */
+declare function detectProjectConfig(rootPath: string): ProjectConfig | null;
+
+/**
+ * Expected directories and files for a generated monorepo.
+ * Shared by Generator (creation) and Doctor (validation).
+ */
+
+/** All directories that should exist in a generated monorepo */
+declare function getExpectedDirectories(config: ProjectConfig): string[];
+/** All files that should exist in a generated monorepo */
+declare function getExpectedFiles(config: ProjectConfig): string[];
+
+export { Auth, Backend, Database, Doctor, Generator, LicenseType, ORM, PackageManager, ProjectConfig, type ProjectConfigOptions, StateManagement, Styling, TestFramework, VersionResolver, Workflow, detectProjectConfig, getExpectedDirectories, getExpectedFiles };