create-fhevm-example 1.2.3 → 1.3.1

package/dist/scripts/builders.js

@@ -0,0 +1,211 @@
+"use strict";
+/**
+ * Project Builders - Core logic for scaffolding FHEVM projects.
+ *
+ * Handles the creation of single example projects, category-based
+ * project bundles, and specialized test environments.
+ */
+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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSingleExample = createSingleExample;
+exports.createCategoryProject = createCategoryProject;
+exports.createLocalTestProject = createLocalTestProject;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const config_1 = require("./config");
+const utils_1 = require("./utils");
+// =============================================================================
+// Helper Functions
+// =============================================================================
+/**
+ * Downloads contract dependencies to the output directory
+ */
+async function downloadDependencies(dependencies, outputDir) {
+    for (const depPath of dependencies) {
+        const relativePath = depPath.replace(/^contracts\//, "");
+        const depDestPath = path.join(outputDir, "contracts", relativePath);
+        const depDestDir = path.dirname(depDestPath);
+        if (!fs.existsSync(depDestDir)) {
+            fs.mkdirSync(depDestDir, { recursive: true });
+        }
+        await (0, utils_1.downloadFileFromGitHub)(depPath, depDestPath);
+    }
+}
+/**
+ * Initializes git repository (optional, fails silently)
+ */
+async function initGitRepo(outputDir) {
+    try {
+        await (0, utils_1.runCommand)("git", ["init"], outputDir);
+    }
+    catch (error) {
+        // Git init is optional
+    }
+}
+// =============================================================================
+// Project Scaffolding
+// =============================================================================
+/**
+ * Creates a single example project from the template
+ */
+async function createSingleExample(exampleName, outputDir, tempRepoPath) {
+    const example = config_1.EXAMPLES[exampleName];
+    if (!example) {
+        throw new Error(`Unknown example: ${exampleName}`);
+    }
+    const templateDir = path.join(tempRepoPath, utils_1.TEMPLATE_DIR_NAME);
+    const contractName = (0, utils_1.getContractName)(example.contract);
+    if (!contractName) {
+        throw new Error("Could not extract contract name");
+    }
+    // 1. Copy template and clean up
+    (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
+    (0, utils_1.cleanupTemplate)(outputDir);
+    // 2. Download example contract and dependencies
+    await (0, utils_1.downloadFileFromGitHub)(example.contract, path.join(outputDir, "contracts", `${contractName}.sol`));
+    if (example.dependencies) {
+        await downloadDependencies(example.dependencies, outputDir);
+    }
+    // 3. Download test file
+    await (0, utils_1.downloadFileFromGitHub)(example.test, path.join(outputDir, "test", path.basename(example.test)));
+    // 4. Update deploy script and package.json
+    fs.writeFileSync(path.join(outputDir, "deploy", "deploy.ts"), (0, utils_1.generateDeployScript)(contractName));
+    (0, utils_1.updateProjectPackageJson)(outputDir, `fhevm-example-${exampleName}`, example.description, example.npmDependencies);
+    await initGitRepo(outputDir);
+}
+/**
+ * Creates a category project with multiple examples
+ */
+async function createCategoryProject(categoryName, outputDir, tempRepoPath) {
+    const category = config_1.CATEGORIES[categoryName];
+    if (!category) {
+        throw new Error(`Unknown category: ${categoryName}`);
+    }
+    const templateDir = path.join(tempRepoPath, utils_1.TEMPLATE_DIR_NAME);
+    // 1. Copy template and clean up
+    (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
+    (0, utils_1.cleanupTemplate)(outputDir);
+    // 2. Download all contracts and tests
+    for (const item of category.contracts) {
+        const contractName = (0, utils_1.getContractName)(item.sol);
+        if (contractName) {
+            await (0, utils_1.downloadFileFromGitHub)(item.sol, path.join(outputDir, "contracts", `${contractName}.sol`));
+        }
+        if (item.test) {
+            await (0, utils_1.downloadFileFromGitHub)(item.test, path.join(outputDir, "test", path.basename(item.test)));
+        }
+    }
+    // 3. Collect and download dependencies
+    const allDependencies = new Set();
+    const allNpmDependencies = {};
+    for (const [exampleName, exampleConfig] of Object.entries(config_1.EXAMPLES)) {
+        // Check if example belongs to this category
+        const configCategoryLower = exampleConfig.category
+            .toLowerCase()
+            .replace(/\s+/g, "");
+        if (configCategoryLower === categoryName ||
+            exampleConfig.category === category.name.replace(" Examples", "")) {
+            if (exampleConfig.dependencies) {
+                exampleConfig.dependencies.forEach((dep) => allDependencies.add(dep));
+            }
+            if (exampleConfig.npmDependencies) {
+                Object.assign(allNpmDependencies, exampleConfig.npmDependencies);
+            }
+        }
+    }
+    if (allDependencies.size > 0) {
+        await downloadDependencies(Array.from(allDependencies), outputDir);
+    }
+    // 4. Update package.json
+    (0, utils_1.updateProjectPackageJson)(outputDir, `fhevm-examples-${categoryName}`, undefined, allNpmDependencies);
+    await initGitRepo(outputDir);
+}
+// =============================================================================
+// Specialized Builders
+// =============================================================================
+/**
+ * Creates a temporary test project using LOCAL files (used by maintenance.ts)
+ */
+async function createLocalTestProject(exampleNames, outputDir) {
+    const rootDir = (0, utils_1.getRootDir)();
+    const templateDir = (0, utils_1.getTemplateDir)();
+    // 1. Setup base project from local template
+    (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
+    (0, utils_1.cleanupTemplate)(outputDir);
+    const allNpmDeps = {};
+    const allContractDeps = new Set();
+    // 2. Copy local example files
+    for (const exampleName of exampleNames) {
+        const example = config_1.EXAMPLES[exampleName];
+        if (!example)
+            continue;
+        const contractPath = path.join(rootDir, example.contract);
+        const testPath = path.join(rootDir, example.test);
+        if (fs.existsSync(contractPath)) {
+            const contractName = (0, utils_1.getContractName)(example.contract);
+            if (contractName) {
+                fs.copyFileSync(contractPath, path.join(outputDir, "contracts", `${contractName}.sol`));
+            }
+        }
+        if (fs.existsSync(testPath)) {
+            fs.copyFileSync(testPath, path.join(outputDir, "test", path.basename(example.test)));
+        }
+        if (example.dependencies) {
+            example.dependencies.forEach((dep) => allContractDeps.add(dep));
+        }
+        if (example.npmDependencies) {
+            Object.assign(allNpmDeps, example.npmDependencies);
+        }
+    }
+    // 3. Copy dependencies
+    for (const depPath of allContractDeps) {
+        const depFullPath = path.join(rootDir, depPath);
+        if (fs.existsSync(depFullPath)) {
+            const relativePath = depPath.replace(/^contracts\//, "");
+            const depDestPath = path.join(outputDir, "contracts", relativePath);
+            const depDestDir = path.dirname(depDestPath);
+            if (!fs.existsSync(depDestDir)) {
+                fs.mkdirSync(depDestDir, { recursive: true });
+            }
+            fs.copyFileSync(depFullPath, depDestPath);
+        }
+    }
+    // 4. Finalize project
+    (0, utils_1.updateProjectPackageJson)(outputDir, "fhevm-test-project", `Testing ${exampleNames.length} examples`, Object.keys(allNpmDeps).length > 0 ? allNpmDeps : undefined);
+    const typesPath = path.join(outputDir, "test", "types.ts");
+    if (!fs.existsSync(typesPath)) {
+        fs.writeFileSync(typesPath, utils_1.TEST_TYPES_CONTENT);
+    }
+}

package/dist/{config.d.ts → scripts/config.d.ts}

@@ -1,8 +1,8 @@
 /**
  * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY ⚠️
  *
- * This file is auto-generated by scripts/update-config.ts
- * Run 'npm run update:config' to regenerate
+ * This file is auto-generated by cli/generate-config.ts
+ * Run 'npm run generate:config' to regenerate
  */
 export interface ExampleConfig {
     /** Path to the Solidity contract file */
@@ -17,6 +17,8 @@ export interface ExampleConfig {
     description: string;
     /** Category for grouping */
     category: string;
+    /** Output path for generated documentation */
+    docsOutput: string;
     /** Title for documentation */
     title: string;
 }
@@ -31,7 +33,26 @@ export interface CategoryConfig {
 }
 export declare const REPO_URL = "https://github.com/NecipAkgz/fhevm-example-factory";
 export declare const REPO_BRANCH = "main";
-export declare const TEMPLATE_SUBMODULE_PATH = "fhevm-hardhat-template";
 export declare const EXAMPLES: Record<string, ExampleConfig>;
 export declare const CATEGORIES: Record<string, CategoryConfig>;
+/**
+ * Get list of example names
+ */
+export declare function getExampleNames(): string[];
+/**
+ * Get list of category names
+ */
+export declare function getCategoryNames(): string[];
+/**
+ * Get example by name
+ */
+export declare function getExample(name: string): ExampleConfig | undefined;
+/**
+ * Get category by name
+ */
+export declare function getCategory(name: string): CategoryConfig | undefined;
+/**
+ * Generate consistent docs filename with fhe- prefix
+ */
+export declare function getDocsFileName(exampleName: string): string;
 //# sourceMappingURL=config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../scripts/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,MAAM,WAAW,aAAa;IAC5B,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,SAAS,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClD;AAMD,eAAO,MAAM,QAAQ,uDAAuD,CAAC;AAC7E,eAAO,MAAM,WAAW,SAAS,CAAC;AAMlC,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CA6RlD,CAAC;AAMF,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAoJrD,CAAC;AAMF;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,EAAE,CAE1C;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,EAAE,CAE3C;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAElE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAEpE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAE3D"}