create-fhevm-example 1.2.2 → 1.3.0

package/dist/scripts/index.d.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+/**
+ * create-fhevm-example - CLI for creating FHEVM example projects
+ *
+ * Usage:
+ *   npx create-fhevm-example                    # Interactive mode
+ *   npx create-fhevm-example --example <name>   # Create single example
+ *   npx create-fhevm-example --category <name>  # Create category project
+ *   npx create-fhevm-example --add              # Add to existing project
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/scripts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../scripts/index.ts"],"names":[],"mappings":";AAEA;;;;;;;;GAQG"}

package/dist/scripts/index.js

@@ -0,0 +1,360 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * create-fhevm-example - CLI for creating FHEVM example projects
+ *
+ * Usage:
+ *   npx create-fhevm-example                    # Interactive mode
+ *   npx create-fhevm-example --example <name>   # Create single example
+ *   npx create-fhevm-example --category <name>  # Create category project
+ *   npx create-fhevm-example --add              # Add to existing project
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const p = __importStar(require("@clack/prompts"));
+const picocolors_1 = __importDefault(require("picocolors"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const os = __importStar(require("os"));
+const config_1 = require("./config");
+const utils_1 = require("./utils");
+const builders_1 = require("./builders");
+const ui_1 = require("./ui");
+const add_mode_1 = require("./add-mode");
+const generate_docs_1 = require("./generate-docs");
+/** Prompts user to select mode and returns project configuration */
+async function getProjectConfig() {
+    // Build options - docs only available in local dev mode
+    const options = [
+        {
+            value: "single",
+            label: "Create a single example project",
+            hint: "One example contract with tests",
+        },
+        {
+            value: "category",
+            label: "Create a category-based project",
+            hint: "Bundle all examples from a category",
+        },
+    ];
+    // Add docs option only in local dev mode (npm run create)
+    if (process.env.LOCAL_DEV === "1") {
+        options.push({
+            value: "docs",
+            label: "Generate documentation",
+            hint: "Generate GitBook docs for examples",
+        });
+    }
+    const mode = await p.select({
+        message: "What would you like to create?",
+        options,
+    });
+    if (p.isCancel(mode)) {
+        p.cancel("Operation cancelled.");
+        return null;
+    }
+    let name;
+    if (mode === "single") {
+        const category = await (0, ui_1.promptSelectCategory)();
+        if (p.isCancel(category)) {
+            p.cancel("Operation cancelled.");
+            return null;
+        }
+        const example = await (0, ui_1.promptSelectExampleFromCategory)(category);
+        if (p.isCancel(example)) {
+            p.cancel("Operation cancelled.");
+            return null;
+        }
+        name = example;
+    }
+    else if (mode === "docs") {
+        // Handle docs mode - call generate-docs interactive
+        await (0, generate_docs_1.handleInteractiveDocs)();
+        return null; // Exit after docs generation
+    }
+    else {
+        const category = await (0, ui_1.promptSelectCategoryProject)();
+        if (p.isCancel(category)) {
+            p.cancel("Operation cancelled.");
+            return null;
+        }
+        name = category;
+    }
+    const projectName = await p.text({
+        message: "Project name:",
+        placeholder: `my-${name}-project`,
+        defaultValue: `my-${name}-project`,
+    });
+    if (p.isCancel(projectName)) {
+        p.cancel("Operation cancelled.");
+        return null;
+    }
+    const outputDir = await p.text({
+        message: "Output directory:",
+        placeholder: `./${projectName}`,
+        defaultValue: `./${projectName}`,
+    });
+    if (p.isCancel(outputDir)) {
+        p.cancel("Operation cancelled.");
+        return null;
+    }
+    return {
+        mode: mode,
+        name,
+        outputDir: outputDir,
+    };
+}
+/** Scaffolds project and shows completion message */
+async function scaffoldProject(config) {
+    const resolvedOutput = path.resolve(process.cwd(), config.outputDir);
+    if (fs.existsSync(resolvedOutput)) {
+        p.log.error(`Directory already exists: ${resolvedOutput}`);
+        process.exit(1);
+    }
+    const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "fhevm-"));
+    const s = p.spinner();
+    try {
+        s.start("Downloading template...");
+        const tempRepoPath = await (0, utils_1.cloneTemplate)(tempDir);
+        s.message("Initializing submodules...");
+        await (0, utils_1.initSubmodule)(tempRepoPath);
+        s.message("Scaffolding your confidential project...");
+        if (config.mode === "single") {
+            await (0, builders_1.createSingleExample)(config.name, resolvedOutput, tempRepoPath);
+        }
+        else {
+            await (0, builders_1.createCategoryProject)(config.name, resolvedOutput, tempRepoPath);
+        }
+        s.stop("🎉 Project scaffolded successfully!");
+        const relativePath = path.relative(process.cwd(), resolvedOutput);
+        p.log.success(`📁 Created: ${picocolors_1.default.cyan(relativePath)}`);
+        if (config.mode === "single") {
+            const exampleConfig = config_1.EXAMPLES[config.name];
+            p.log.info(`📝 Example: ${picocolors_1.default.yellow(exampleConfig?.title || config.name)}`);
+        }
+        else {
+            const categoryConfig = config_1.CATEGORIES[config.name];
+            p.log.info(`📦 Category: ${picocolors_1.default.yellow(categoryConfig?.name || config.name)}`);
+            p.log.info(`📄 Contracts: ${picocolors_1.default.green(String(categoryConfig?.contracts.length || 0))}`);
+        }
+        await (0, ui_1.askInstallAndTest)(resolvedOutput, relativePath);
+    }
+    catch (error) {
+        s.stop("Failed to create project");
+        p.log.error(error instanceof Error ? error.message : String(error));
+        process.exit(1);
+    }
+    finally {
+        if (fs.existsSync(tempDir)) {
+            fs.rmSync(tempDir, { recursive: true, force: true });
+        }
+    }
+    p.outro(picocolors_1.default.green("✅ Setup complete. Happy encrypting!"));
+}
+/** Main interactive mode entry point */
+async function runInteractiveMode() {
+    console.clear();
+    p.intro(picocolors_1.default.bgCyan(picocolors_1.default.black(" ⚡ FHEVM Example Factory ")));
+    const config = await getProjectConfig();
+    if (!config)
+        return;
+    await scaffoldProject(config);
+}
+// =============================================================================
+// QUICK MODE (CLI Arguments)
+// =============================================================================
+function showHelp() {
+    console.log(`
+${picocolors_1.default.bgCyan(picocolors_1.default.black(picocolors_1.default.bold(" 🔐 create-fhevm-example ")))}
+${picocolors_1.default.dim("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")}
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("📋 USAGE"))}
+
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")}                  ${picocolors_1.default.dim("→")} Interactive mode ${picocolors_1.default.yellow("(recommended)")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("<name>")}  ${picocolors_1.default.dim("→")} Create single example
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--category")} ${picocolors_1.default.yellow("<name>")} ${picocolors_1.default.dim("→")} Create category project
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--add")}               ${picocolors_1.default.dim("→")} Add to existing project
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("⚙️  OPTIONS"))}
+
+  ${picocolors_1.default.green("--example")} ${picocolors_1.default.dim("<name>")}      Create a single example project
+  ${picocolors_1.default.green("--category")} ${picocolors_1.default.dim("<name>")}     Create a category project
+  ${picocolors_1.default.green("--add")}                 Add FHEVM to existing Hardhat project
+  ${picocolors_1.default.green("--target")} ${picocolors_1.default.dim("<dir>")}        Target directory for --add mode
+  ${picocolors_1.default.green("--output")} ${picocolors_1.default.dim("<dir>")}        Output directory
+  ${picocolors_1.default.green("--install")}             Auto-install dependencies
+  ${picocolors_1.default.green("--test")}                Auto-run tests (requires --install)
+  ${picocolors_1.default.green("--help")}${picocolors_1.default.dim(", -h")}            Show this help message
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("⚡ EXAMPLES"))}
+
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("fhe-counter")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--category")} ${picocolors_1.default.yellow("basic")} ${picocolors_1.default.green("--output")} ${picocolors_1.default.blue("./my-project")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--add")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("fhe-counter")} ${picocolors_1.default.green("--install")} ${picocolors_1.default.green("--test")}
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("📦 AVAILABLE EXAMPLES"))}
+
+  ${picocolors_1.default.dim(Object.keys(config_1.EXAMPLES).slice(0, 10).join(", "))}
+  ${picocolors_1.default.dim("...")} and ${picocolors_1.default.yellow(String(Object.keys(config_1.EXAMPLES).length - 10))} more
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("📁 AVAILABLE CATEGORIES"))}
+
+  ${Object.keys(config_1.CATEGORIES)
+        .map((c) => picocolors_1.default.yellow(c))
+        .join(", ")}
+
+${picocolors_1.default.dim("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")}
+${picocolors_1.default.dim("📚 Documentation:")} ${picocolors_1.default.blue("https://github.com/NecipAkgz/fhevm-example-factory")}
+`);
+}
+function parseArgs(args) {
+    const parsed = {};
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg.startsWith("--")) {
+            const key = arg.slice(2);
+            const nextArg = args[i + 1];
+            if (nextArg && !nextArg.startsWith("--")) {
+                parsed[key] = nextArg;
+                i++;
+            }
+            else {
+                parsed[key] = true;
+            }
+        }
+        else if (arg === "-h") {
+            parsed["help"] = true;
+        }
+    }
+    return parsed;
+}
+async function runDirectMode(args) {
+    const parsedArgs = parseArgs(args);
+    if (parsedArgs["help"]) {
+        showHelp();
+        return;
+    }
+    if (parsedArgs["add"]) {
+        const targetDir = parsedArgs["target"];
+        await (0, add_mode_1.runAddMode)(targetDir);
+        return;
+    }
+    const exampleName = parsedArgs["example"];
+    const categoryName = parsedArgs["category"];
+    const outputDir = parsedArgs["output"];
+    const shouldInstall = parsedArgs["install"] === true;
+    if (!exampleName && !categoryName) {
+        utils_1.log.error(utils_1.ERROR_MESSAGES.EXAMPLE_REQUIRED);
+        showHelp();
+        (0, utils_1.handleError)("Missing required argument");
+    }
+    if (exampleName && categoryName) {
+        (0, utils_1.handleError)(utils_1.ERROR_MESSAGES.BOTH_SPECIFIED);
+    }
+    const mode = exampleName ? "example" : "category";
+    const name = (exampleName || categoryName);
+    try {
+        if (mode === "example") {
+            (0, utils_1.validateExample)(name);
+        }
+        else {
+            (0, utils_1.validateCategory)(name);
+        }
+    }
+    catch (error) {
+        utils_1.log.message("Available: " +
+            Object.keys(mode === "example" ? config_1.EXAMPLES : config_1.CATEGORIES).join(", "));
+        (0, utils_1.handleError)(error);
+    }
+    const defaultOutput = mode === "example" ? `./my-${name}-project` : `./my-${name}-examples`;
+    const output = outputDir || defaultOutput;
+    const resolved = path.resolve(process.cwd(), output);
+    try {
+        (0, utils_1.validateDirectoryNotExists)(resolved);
+    }
+    catch (error) {
+        (0, utils_1.handleError)(error);
+    }
+    const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "fhevm-"));
+    try {
+        utils_1.log.info(`Creating ${mode}: ${name}`);
+        utils_1.log.dim("Downloading template...");
+        const tempRepoPath = await (0, utils_1.cloneTemplate)(tempDir);
+        utils_1.log.dim("Initializing submodules...");
+        await (0, utils_1.initSubmodule)(tempRepoPath);
+        utils_1.log.dim("Creating project...");
+        if (mode === "example") {
+            await (0, builders_1.createSingleExample)(name, resolved, tempRepoPath);
+        }
+        else {
+            await (0, builders_1.createCategoryProject)(name, resolved, tempRepoPath);
+        }
+        utils_1.log.success(`✓ Created: ${output}`);
+        if (shouldInstall) {
+            utils_1.log.dim("\nInstalling dependencies...");
+            await (0, ui_1.runInstallAndTest)(resolved);
+        }
+        else {
+            utils_1.log.dim(`\nNext: cd ${output} && npm install && npm run compile && npm run test`);
+        }
+    }
+    catch (error) {
+        (0, utils_1.handleError)(error);
+    }
+    finally {
+        if (fs.existsSync(tempDir)) {
+            fs.rmSync(tempDir, { recursive: true, force: true });
+        }
+    }
+}
+// =============================================================================
+// MAIN ENTRY POINT
+// =============================================================================
+async function main() {
+    const args = process.argv.slice(2);
+    if (args.length > 0) {
+        await runDirectMode(args);
+    }
+    else {
+        await runInteractiveMode();
+    }
+}
+main().catch((error) => {
+    (0, utils_1.handleError)(error);
+});

package/dist/scripts/maintenance.d.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+/**
+ * FHEVM Example Factory - Maintenance Tools
+ *
+ * Test multiple examples efficiently in a single project.
+ *
+ * Usage:
+ *   npm run test:all                    # Interactive selection
+ *   npm run test:all fhe-counter,fhe-add # Direct CLI
+ */
+export declare function testAllExamples(cliExamples?: string[]): Promise<void>;
+//# sourceMappingURL=maintenance.d.ts.map

package/dist/scripts/maintenance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maintenance.d.ts","sourceRoot":"","sources":["../../scripts/maintenance.ts"],"names":[],"mappings":";AAEA;;;;;;;;GAQG;AA0SH,wBAAsB,eAAe,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAqC3E"}