create-fhevm-example 1.3.1 → 1.4.0

package/dist/scripts/{utils.js → shared/generators.js}

@@ -1,9 +1,9 @@
 "use strict";
 /**
- * Shared Utilities - Helper functions for the FHEVM Example Factory.
+ * Generators - Template processing and code generation utilities.
  *
- * Contains common logic for file system operations, string formatting,
- * error handling, and terminal logging used throughout the project.
+ * Contains functions for scaffolding templates, generating deploy scripts,
+ * and creating documentation.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -38,23 +38,7 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.log = exports.ERROR_MESSAGES = exports.TEST_TYPES_CONTENT = exports.CATEGORY_ORDER = exports.FHEVM_DEPENDENCIES = exports.EXCLUDE_DIRS = exports.MAX_DESCRIPTION_LENGTH = exports.TEMPLATE_DIR_NAME = exports.CATEGORY_ICON = void 0;
-exports.handleError = handleError;
-exports.getRootDir = getRootDir;
-exports.getTemplateDir = getTemplateDir;
-exports.copyDirectoryRecursive = copyDirectoryRecursive;
-exports.toKebabCase = toKebabCase;
-exports.contractNameToExampleName = contractNameToExampleName;
-exports.contractNameToTitle = contractNameToTitle;
-exports.formatCategoryName = formatCategoryName;
-exports.getContractName = getContractName;
-exports.validateExample = validateExample;
-exports.validateCategory = validateCategory;
-exports.validateDirectoryNotExists = validateDirectoryNotExists;
 exports.cleanupTemplate = cleanupTemplate;
 exports.generateDeployScript = generateDeployScript;
 exports.generateGitBookMarkdown = generateGitBookMarkdown;
@@ -63,184 +47,16 @@ exports.runCommand = runCommand;
 exports.runCommandWithStatus = runCommandWithStatus;
 exports.extractTestResults = extractTestResults;
 exports.extractErrorMessage = extractErrorMessage;
-exports.downloadFileFromGitHub = downloadFileFromGitHub;
-exports.cloneTemplate = cloneTemplate;
-exports.initSubmodule = initSubmodule;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const child_process_1 = require("child_process");
-const picocolors_1 = __importDefault(require("picocolors"));
-const config_1 = require("./config");
-exports.CATEGORY_ICON = "📁";
-/** Template directory name within the cloned repo */
-exports.TEMPLATE_DIR_NAME = "fhevm-hardhat-template";
-/** Maximum description length for UI display */
-exports.MAX_DESCRIPTION_LENGTH = 80;
-/** Directories to exclude when copying template */
-exports.EXCLUDE_DIRS = [
-    "node_modules",
-    "artifacts",
-    "cache",
-    "coverage",
-    "types",
-    "dist",
-    ".git",
-];
-/** FHEVM package versions for --add mode */
-exports.FHEVM_DEPENDENCIES = {
-    dependencies: {
-        "encrypted-types": "^0.0.4",
-        "@fhevm/solidity": "^0.9.1",
-    },
-    devDependencies: {
-        "@fhevm/hardhat-plugin": "^0.3.0-1",
-        "@zama-fhe/relayer-sdk": "^0.3.0-5",
-    },
-};
-exports.CATEGORY_ORDER = [
-    "Basic - Encryption",
-    "Basic - Decryption",
-    "Basic - FHE Operations",
-    "Concepts",
-    "Gaming",
-    "Openzeppelin",
-    "Advanced",
-];
-exports.TEST_TYPES_CONTENT = `import type { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers";
-
-/**
- * Common signers interface used across test files
- */
-export interface Signers {
-  owner: HardhatEthersSigner;
-  alice: HardhatEthersSigner;
-}
-`;
-exports.ERROR_MESSAGES = {
-    EXAMPLE_REQUIRED: "Error: Either --example or --category is required",
-    BOTH_SPECIFIED: "Error: Cannot use both --example and --category",
-    UNKNOWN_EXAMPLE: (name) => `Error: Unknown example "${name}"`,
-    UNKNOWN_CATEGORY: (name) => `Error: Unknown category "${name}"`,
-    DIR_EXISTS: (path) => `Error: Directory already exists: ${path}`,
-    NOT_HARDHAT: "This directory does not contain a valid Hardhat project.",
-    CONFIG_NOT_FOUND: "hardhat.config.ts or hardhat.config.js not found",
-    CONTRACT_NAME_FAILED: "Could not extract contract name",
-};
+const utils_1 = require("./utils");
 // =============================================================================
-// Logging Utility
+// Template & Scaffolding Utilities
 // =============================================================================
-exports.log = {
-    success: (msg) => console.log(picocolors_1.default.green(msg)),
-    error: (msg) => console.error(picocolors_1.default.red(msg)),
-    info: (msg) => console.log(picocolors_1.default.cyan(msg)),
-    dim: (msg) => console.log(picocolors_1.default.dim(msg)),
-    message: (msg) => console.log(msg),
-};
 /**
- * Standardized error handler for CLI - logs error and exits
+ * Cleans up the template directory after copying
  */
-function handleError(error, exitCode = 1) {
-    const message = error instanceof Error ? error.message : String(error);
-    exports.log.error(message);
-    process.exit(exitCode);
-}
-// =============================================================================
-// File System Utilities
-// =============================================================================
-/** Resolves root directory of the project */
-function getRootDir() {
-    return path.resolve(__dirname, "..");
-}
-/** Resolves template directory path */
-function getTemplateDir() {
-    return path.join(getRootDir(), exports.TEMPLATE_DIR_NAME);
-}
-/** Copies directory recursively, excluding specified directories */
-function copyDirectoryRecursive(source, destination, excludeDirs = exports.EXCLUDE_DIRS) {
-    if (!fs.existsSync(destination)) {
-        fs.mkdirSync(destination, { recursive: true });
-    }
-    const items = fs.readdirSync(source);
-    items.forEach((item) => {
-        const sourcePath = path.join(source, item);
-        const destPath = path.join(destination, item);
-        const stat = fs.statSync(sourcePath);
-        if (stat.isDirectory()) {
-            if (excludeDirs.includes(item)) {
-                return;
-            }
-            copyDirectoryRecursive(sourcePath, destPath, excludeDirs);
-        }
-        else {
-            fs.copyFileSync(sourcePath, destPath);
-        }
-    });
-}
-// =============================================================================
-// Naming Utilities
-// =============================================================================
-function toKebabCase(str) {
-    return str
-        .replace(/([a-z])([A-Z])/g, "$1-$2")
-        .replace(/([0-9])([A-Z])/g, "$1-$2")
-        .replace(/([A-Z]+)([A-Z][a-z])/g, "$1-$2")
-        .toLowerCase();
-}
-function contractNameToExampleName(contractName) {
-    return toKebabCase(contractName);
-}
-function contractNameToTitle(contractName) {
-    return contractName
-        .replace(/([a-z])([A-Z])/g, "$1 $2")
-        .replace(/([0-9])([A-Z])/g, "$1 $2")
-        .replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2");
-}
-function formatCategoryName(folderName) {
-    return folderName
-        .replace(/\bfhe\b/gi, "FHE")
-        .replace(/-/g, " ")
-        .replace(/\b\w/g, (char) => char.toUpperCase());
-}
-function getContractName(contractPathOrContent) {
-    let content;
-    if (contractPathOrContent.includes("contract ") ||
-        contractPathOrContent.includes("pragma solidity")) {
-        content = contractPathOrContent;
-    }
-    else {
-        const fullPath = contractPathOrContent.startsWith("/")
-            ? contractPathOrContent
-            : path.join(getRootDir(), contractPathOrContent);
-        if (!fs.existsSync(fullPath)) {
-            const match = contractPathOrContent.match(/([^/]+)\.sol$/);
-            return match ? match[1] : null;
-        }
-        content = fs.readFileSync(fullPath, "utf-8");
-    }
-    const match = content.match(/^\s*contract\s+(\w+)(?:\s+is\s+|\s*\{)/m);
-    return match ? match[1] : null;
-}
-// =============================================================================
-// Validation Functions
-// =============================================================================
-function validateExample(name) {
-    if (!config_1.EXAMPLES[name]) {
-        throw new Error(exports.ERROR_MESSAGES.UNKNOWN_EXAMPLE(name));
-    }
-}
-function validateCategory(name) {
-    if (!config_1.CATEGORIES[name]) {
-        throw new Error(exports.ERROR_MESSAGES.UNKNOWN_CATEGORY(name));
-    }
-}
-function validateDirectoryNotExists(dirPath) {
-    if (fs.existsSync(dirPath)) {
-        throw new Error(exports.ERROR_MESSAGES.DIR_EXISTS(dirPath));
-    }
-}
-// =============================================================================
-// Template & Scaffolding Utilities
-// =============================================================================
 function cleanupTemplate(outputDir) {
     const gitDir = path.join(outputDir, ".git");
     if (fs.existsSync(gitDir)) {
@@ -276,8 +92,14 @@ function cleanupTemplate(outputDir) {
     if (fs.existsSync(oldTaskFile)) {
         fs.unlinkSync(oldTaskFile);
     }
-    fs.writeFileSync(path.join(outputDir, "test", "types.ts"), exports.TEST_TYPES_CONTENT);
+    fs.writeFileSync(path.join(outputDir, "test", "types.ts"), utils_1.TEST_TYPES_CONTENT);
 }
+// =============================================================================
+// Code Generators
+// =============================================================================
+/**
+ * Generates a deploy script for a contract
+ */
 function generateDeployScript(contractName) {
     return `import { DeployFunction } from "hardhat-deploy/types";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
@@ -313,6 +135,9 @@ func.id = "deploy_${contractName.toLowerCase()}";
 func.tags = ["${contractName}"];
 `;
 }
+/**
+ * Generates GitBook-compatible markdown documentation
+ */
 function generateGitBookMarkdown(description, contractContent, testContent, contractName, testFileName) {
     let markdown = `${description}\n\n`;
     markdown += `{% hint style="info" %}\n`;
@@ -335,6 +160,12 @@ function generateGitBookMarkdown(description, contractContent, testContent, cont
     markdown += `{% endtabs %}\n`;
     return markdown;
 }
+// =============================================================================
+// Package.json Utilities
+// =============================================================================
+/**
+ * Updates package.json with project name and dependencies
+ */
 function updateProjectPackageJson(outputDir, projectName, description, npmDependencies) {
     const packageJsonPath = path.join(outputDir, "package.json");
     const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
@@ -353,6 +184,9 @@ function updateProjectPackageJson(outputDir, projectName, description, npmDepend
 // =============================================================================
 // Command Execution Utilities
 // =============================================================================
+/**
+ * Runs a command and returns the output
+ */
 function runCommand(cmd, args, cwd) {
     return new Promise((resolve, reject) => {
         const child = (0, child_process_1.spawn)(cmd, args, {
@@ -379,6 +213,9 @@ function runCommand(cmd, args, cwd) {
         child.on("error", reject);
     });
 }
+/**
+ * Runs a command and returns success status with output
+ */
 function runCommandWithStatus(cmd, args, cwd) {
     return new Promise((resolve) => {
         let output = "";
@@ -402,6 +239,9 @@ function runCommandWithStatus(cmd, args, cwd) {
         });
     });
 }
+/**
+ * Extracts test results from command output
+ */
 function extractTestResults(output) {
     const passingMatch = output.match(/(\d+)\s+passing/);
     const failingMatch = output.match(/(\d+)\s+failing/);
@@ -417,6 +257,9 @@ function extractTestResults(output) {
     }
     return null;
 }
+/**
+ * Extracts error messages from command output
+ */
 function extractErrorMessage(output) {
     const lines = output.split("\n");
     const errorLines = [];
@@ -443,83 +286,3 @@ function extractErrorMessage(output) {
     const nonEmptyLines = lines.filter((l) => l.trim().length > 0);
     return nonEmptyLines.slice(-5).join("\n");
 }
-// =============================================================================
-// GitHub Repository Utilities
-// =============================================================================
-/**
- * Downloads a file from GitHub repository
- */
-async function downloadFileFromGitHub(filePath, outputPath) {
-    const urlParts = config_1.REPO_URL.replace("https://github.com/", "").split("/");
-    const owner = urlParts[0];
-    const repo = urlParts[1];
-    const url = `https://raw.githubusercontent.com/${owner}/${repo}/${config_1.REPO_BRANCH}/${filePath}`;
-    const response = await fetch(url);
-    if (!response.ok) {
-        throw new Error(`Failed to download ${filePath}: ${response.statusText}`);
-    }
-    const content = await response.text();
-    const dir = path.dirname(outputPath);
-    if (!fs.existsSync(dir)) {
-        fs.mkdirSync(dir, { recursive: true });
-    }
-    fs.writeFileSync(outputPath, content);
-}
-/**
- * Clones the template repository to temp directory
- */
-async function cloneTemplate(tempDir) {
-    const templatePath = path.join(tempDir, "template");
-    return new Promise((resolve, reject) => {
-        const cloneUrl = `${config_1.REPO_URL}.git`;
-        const args = [
-            "clone",
-            "--depth=1",
-            "--branch",
-            config_1.REPO_BRANCH,
-            "--single-branch",
-            cloneUrl,
-            templatePath,
-        ];
-        const child = (0, child_process_1.spawn)("git", args, {
-            stdio: "pipe",
-        });
-        let stderr = "";
-        child.stderr?.on("data", (data) => {
-            stderr += data.toString();
-        });
-        child.on("close", (code) => {
-            if (code === 0) {
-                resolve(templatePath);
-            }
-            else {
-                reject(new Error(`Git clone failed: ${stderr}`));
-            }
-        });
-        child.on("error", reject);
-    });
-}
-/**
- * Initializes git submodule for the template
- */
-async function initSubmodule(repoPath) {
-    return new Promise((resolve, reject) => {
-        const child = (0, child_process_1.spawn)("git", ["submodule", "update", "--init", "--recursive", exports.TEMPLATE_DIR_NAME], {
-            cwd: repoPath,
-            stdio: "pipe",
-        });
-        let stderr = "";
-        child.stderr?.on("data", (data) => {
-            stderr += data.toString();
-        });
-        child.on("close", (code) => {
-            if (code === 0) {
-                resolve();
-            }
-            else {
-                reject(new Error(`Submodule init failed: ${stderr}`));
-            }
-        });
-        child.on("error", reject);
-    });
-}

package/dist/scripts/shared/ui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../scripts/shared/ui.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAYH;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAMjE;AAMD;;GAEG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAmBrE;AAED;;GAEG;AACH,wBAAsB,+BAA+B,CACnD,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAe1B;AAED;;GAEG;AACH,wBAAsB,2BAA2B,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAS5E;AAMD;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAiD1E"}

package/dist/scripts/{ui.js → shared/ui.js}

@@ -51,6 +51,7 @@ const p = __importStar(require("@clack/prompts"));
 const picocolors_1 = __importDefault(require("picocolors"));
 const config_1 = require("./config");
 const utils_1 = require("./utils");
+const generators_1 = require("./generators");
 // =============================================================================
 // Category Helpers
 // =============================================================================
@@ -147,9 +148,9 @@ async function runInstallAndTest(projectPath) {
         const s = p.spinner();
         s.start(step.name + "...");
         try {
-            const output = await (0, utils_1.runCommand)(step.cmd, step.args, projectPath);
+            const output = await (0, generators_1.runCommand)(step.cmd, step.args, projectPath);
             if (step.showOutput) {
-                const testResults = (0, utils_1.extractTestResults)(output);
+                const testResults = (0, generators_1.extractTestResults)(output);
                 s.stop(testResults
                     ? picocolors_1.default.green(`✓ ${step.name} - ${testResults}`)
                     : picocolors_1.default.green(`✓ ${step.name} completed`));

package/dist/scripts/{utils.d.ts → shared/utils.d.ts}

@@ -1,8 +1,8 @@
 /**
- * Shared Utilities - Helper functions for the FHEVM Example Factory.
+ * Core Utilities - Essential helper functions for the FHEVM Example Factory.
  *
- * Contains common logic for file system operations, string formatting,
- * error handling, and terminal logging used throughout the project.
+ * Contains constants, types, logging, file system operations,
+ * naming utilities, and validation functions.
  */
 export type ProjectMode = "single" | "category";
 export declare const CATEGORY_ICON = "\uD83D\uDCC1";
@@ -46,7 +46,7 @@ export declare const log: {
  * Standardized error handler for CLI - logs error and exits
  */
 export declare function handleError(error: unknown, exitCode?: number): never;
-/** Resolves root directory of the project */
+/** Resolves root directory of the project (from scripts/shared/) */
 export declare function getRootDir(): string;
 /** Resolves template directory path */
 export declare function getTemplateDir(): string;
@@ -60,27 +60,4 @@ export declare function getContractName(contractPathOrContent: string): string |
 export declare function validateExample(name: string): void;
 export declare function validateCategory(name: string): void;
 export declare function validateDirectoryNotExists(dirPath: string): void;
-export declare function cleanupTemplate(outputDir: string): void;
-export declare function generateDeployScript(contractName: string): string;
-export declare function generateGitBookMarkdown(description: string, contractContent: string, testContent: string, contractName: string, testFileName: string): string;
-export declare function updateProjectPackageJson(outputDir: string, projectName: string, description?: string, npmDependencies?: Record<string, string>): void;
-export declare function runCommand(cmd: string, args: string[], cwd: string): Promise<string>;
-export declare function runCommandWithStatus(cmd: string, args: string[], cwd: string): Promise<{
-    success: boolean;
-    output: string;
-}>;
-export declare function extractTestResults(output: string): string | null;
-export declare function extractErrorMessage(output: string): string;
-/**
- * Downloads a file from GitHub repository
- */
-export declare function downloadFileFromGitHub(filePath: string, outputPath: string): Promise<void>;
-/**
- * Clones the template repository to temp directory
- */
-export declare function cloneTemplate(tempDir: string): Promise<string>;
-/**
- * Initializes git submodule for the template
- */
-export declare function initSubmodule(repoPath: string): Promise<void>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/scripts/shared/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../scripts/shared/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEhD,eAAO,MAAM,aAAa,iBAAO,CAAC;AAElC,qDAAqD;AACrD,eAAO,MAAM,iBAAiB,2BAA2B,CAAC;AAE1D,gDAAgD;AAChD,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,mDAAmD;AACnD,eAAO,MAAM,YAAY,UAQxB,CAAC;AAEF,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB;;;;;;;;;CAS9B,CAAC;AAEF,eAAO,MAAM,cAAc,UAQ1B,CAAC;AAEF,eAAO,MAAM,kBAAkB,yPAS9B,CAAC;AAEF,eAAO,MAAM,cAAc;;;4BAGD,MAAM;6BACL,MAAM;uBACZ,MAAM;;;;CAI1B,CAAC;AAMF,eAAO,MAAM,GAAG;mBACC,MAAM;iBACR,MAAM;gBACP,MAAM;eACP,MAAM;mBACF,MAAM;CACtB,CAAC;AAEF;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,SAAI,GAAG,KAAK,CAI/D;AAMD,oEAAoE;AACpE,wBAAgB,UAAU,IAAI,MAAM,CAEnC;AAED,uCAAuC;AACvC,wBAAgB,cAAc,IAAI,MAAM,CAEvC;AAED,oEAAoE;AACpE,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,WAAW,GAAE,MAAM,EAAiB,GACnC,IAAI,CAoBN;AAMD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM/C;AAED,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAEtE;AAED,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAKhE;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAK7D;AAED,wBAAgB,eAAe,CAAC,qBAAqB,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAqB5E;AAMD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAInD;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAIhE"}