create-fhevm-example 1.2.3 → 1.3.1

package/dist/{prompts.d.ts → scripts/ui.d.ts}

@@ -1,8 +1,8 @@
 /**
- * Interactive Prompts
+ * User Interface - CLI Prompts and Interaction Logic.
  *
- * Category and example selection prompts for interactive mode.
- * Similar structure to main project's interactive flows.
+ * Provides centralized components for user input, selection menus,
+ * and standard command execution feedback for the CLI.
  */
 /**
  * Counts how many examples exist in each category
@@ -10,17 +10,18 @@
 export declare function countExamplesPerCategory(): Record<string, number>;
 /**
  * Prompts user to select a category
- * Returns the selected category name
  */
 export declare function promptSelectCategory(): Promise<string | symbol>;
 /**
  * Prompts user to select an example from a specific category
- * Returns the selected example name
  */
 export declare function promptSelectExampleFromCategory(category: string): Promise<string | symbol>;
 /**
  * Prompts user to select a category project
- * Returns the selected category key (lowercase)
  */
 export declare function promptSelectCategoryProject(): Promise<string | symbol>;
-//# sourceMappingURL=prompts.d.ts.map
+/**
+ * Runs npm install, compile, and test in the project directory
+ */
+export declare function runInstallAndTest(projectPath: string): Promise<void>;
+//# sourceMappingURL=ui.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../scripts/ui.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAiBH;;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

@@ -0,0 +1,170 @@
+"use strict";
+/**
+ * User Interface - CLI Prompts and Interaction Logic.
+ *
+ * Provides centralized components for user input, selection menus,
+ * and standard command execution feedback for the CLI.
+ */
+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 });
+exports.countExamplesPerCategory = countExamplesPerCategory;
+exports.promptSelectCategory = promptSelectCategory;
+exports.promptSelectExampleFromCategory = promptSelectExampleFromCategory;
+exports.promptSelectCategoryProject = promptSelectCategoryProject;
+exports.runInstallAndTest = runInstallAndTest;
+const p = __importStar(require("@clack/prompts"));
+const picocolors_1 = __importDefault(require("picocolors"));
+const config_1 = require("./config");
+const utils_1 = require("./utils");
+// =============================================================================
+// Category Helpers
+// =============================================================================
+/**
+ * Counts how many examples exist in each category
+ */
+function countExamplesPerCategory() {
+    const counts = {};
+    for (const config of Object.values(config_1.EXAMPLES)) {
+        counts[config.category] = (counts[config.category] || 0) + 1;
+    }
+    return counts;
+}
+// =============================================================================
+// Selection Prompts
+// =============================================================================
+/**
+ * Prompts user to select a category
+ */
+async function promptSelectCategory() {
+    const categoryCounts = countExamplesPerCategory();
+    const allCategories = Object.keys(categoryCounts);
+    const orderedCategories = [
+        ...utils_1.CATEGORY_ORDER.filter((cat) => allCategories.includes(cat)),
+        ...allCategories.filter((cat) => !utils_1.CATEGORY_ORDER.includes(cat)).sort(),
+    ];
+    return p.select({
+        message: "Select a category:",
+        options: orderedCategories.map((category) => ({
+            value: category,
+            label: `${utils_1.CATEGORY_ICON} ${category}`,
+            hint: `${categoryCounts[category] || 0} example${categoryCounts[category] !== 1 ? "s" : ""}`,
+        })),
+    });
+}
+/**
+ * Prompts user to select an example from a specific category
+ */
+async function promptSelectExampleFromCategory(category) {
+    const categoryExamples = Object.entries(config_1.EXAMPLES)
+        .filter(([, config]) => config.category === category)
+        .map(([key, config]) => ({
+        value: key,
+        label: key,
+        hint: config.description.slice(0, utils_1.MAX_DESCRIPTION_LENGTH) +
+            (config.description.length > utils_1.MAX_DESCRIPTION_LENGTH ? "..." : ""),
+    }));
+    return p.select({
+        message: `Select an example from ${category}:`,
+        options: categoryExamples,
+    });
+}
+/**
+ * Prompts user to select a category project
+ */
+async function promptSelectCategoryProject() {
+    return p.select({
+        message: "Select a category:",
+        options: Object.entries(config_1.CATEGORIES).map(([key, config]) => ({
+            value: key,
+            label: `${utils_1.CATEGORY_ICON} ${config.name}`,
+            hint: `${config.contracts.length} contracts`,
+        })),
+    });
+}
+// =============================================================================
+// Install & Test Commands
+// =============================================================================
+/**
+ * Runs npm install, compile, and test in the project directory
+ */
+async function runInstallAndTest(projectPath) {
+    const steps = [
+        {
+            name: "Installing dependencies",
+            cmd: "npm",
+            args: ["install"],
+            showOutput: false,
+        },
+        {
+            name: "Compiling contracts",
+            cmd: "npm",
+            args: ["run", "compile"],
+            showOutput: false,
+        },
+        {
+            name: "Running tests",
+            cmd: "npm",
+            args: ["run", "test"],
+            showOutput: true,
+        },
+    ];
+    for (const step of steps) {
+        const s = p.spinner();
+        s.start(step.name + "...");
+        try {
+            const output = await (0, utils_1.runCommand)(step.cmd, step.args, projectPath);
+            if (step.showOutput) {
+                const testResults = (0, utils_1.extractTestResults)(output);
+                s.stop(testResults
+                    ? picocolors_1.default.green(`✓ ${step.name} - ${testResults}`)
+                    : picocolors_1.default.green(`✓ ${step.name} completed`));
+            }
+            else {
+                s.stop(picocolors_1.default.green(`✓ ${step.name} completed`));
+            }
+        }
+        catch (error) {
+            s.stop(picocolors_1.default.red(`✗ ${step.name} failed`));
+            if (error instanceof Error) {
+                p.log.error(error.message);
+            }
+            throw new Error(`${step.name} failed`);
+        }
+    }
+    p.log.success(picocolors_1.default.green("🔐 All encryption tests passed!"));
+}

package/dist/scripts/utils.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Shared Utilities - 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.
+ */
+export type ProjectMode = "single" | "category";
+export declare const CATEGORY_ICON = "\uD83D\uDCC1";
+/** Template directory name within the cloned repo */
+export declare const TEMPLATE_DIR_NAME = "fhevm-hardhat-template";
+/** Maximum description length for UI display */
+export declare const MAX_DESCRIPTION_LENGTH = 80;
+/** Directories to exclude when copying template */
+export declare const EXCLUDE_DIRS: string[];
+/** FHEVM package versions for --add mode */
+export declare const FHEVM_DEPENDENCIES: {
+    dependencies: {
+        "encrypted-types": string;
+        "@fhevm/solidity": string;
+    };
+    devDependencies: {
+        "@fhevm/hardhat-plugin": string;
+        "@zama-fhe/relayer-sdk": string;
+    };
+};
+export declare const CATEGORY_ORDER: string[];
+export declare const TEST_TYPES_CONTENT = "import type { HardhatEthersSigner } from \"@nomicfoundation/hardhat-ethers/signers\";\n\n/**\n * Common signers interface used across test files\n */\nexport interface Signers {\n  owner: HardhatEthersSigner;\n  alice: HardhatEthersSigner;\n}\n";
+export declare const ERROR_MESSAGES: {
+    EXAMPLE_REQUIRED: string;
+    BOTH_SPECIFIED: string;
+    UNKNOWN_EXAMPLE: (name: string) => string;
+    UNKNOWN_CATEGORY: (name: string) => string;
+    DIR_EXISTS: (path: string) => string;
+    NOT_HARDHAT: string;
+    CONFIG_NOT_FOUND: string;
+    CONTRACT_NAME_FAILED: string;
+};
+export declare const log: {
+    success: (msg: string) => void;
+    error: (msg: string) => void;
+    info: (msg: string) => void;
+    dim: (msg: string) => void;
+    message: (msg: string) => void;
+};
+/**
+ * Standardized error handler for CLI - logs error and exits
+ */
+export declare function handleError(error: unknown, exitCode?: number): never;
+/** Resolves root directory of the project */
+export declare function getRootDir(): string;
+/** Resolves template directory path */
+export declare function getTemplateDir(): string;
+/** Copies directory recursively, excluding specified directories */
+export declare function copyDirectoryRecursive(source: string, destination: string, excludeDirs?: string[]): void;
+export declare function toKebabCase(str: string): string;
+export declare function contractNameToExampleName(contractName: string): string;
+export declare function contractNameToTitle(contractName: string): string;
+export declare function formatCategoryName(folderName: string): string;
+export declare function getContractName(contractPathOrContent: string): string | null;
+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/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../scripts/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAYH,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,6CAA6C;AAC7C,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;AAMD,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAiDvD;AAED,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAkCjE;AAED,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GACnB,MAAM,CA2BR;AAED,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACvC,IAAI,CAiBN;AAKD,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,CA+BjB;AAED,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CA2B/C;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAchE;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CA4B1D;AAMD;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAoBf;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAmCpE;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BnE"}