@hotbunny/hackhub-content-sdk 0.5.2 → 0.6.0

package/build.mjs

@@ -4,6 +4,12 @@ import path from "node:path";
 const ASSET_EXTS = /\.(png|jpg|jpeg|gif|svg|ico|webp|css|js|cur|woff|woff2|ttf|eot|mp3|wav|ogg|mp4|webm|json|pdf)$/i;
 const SRC_ASSET_PATTERN = /["'](\.[^"']+?\.(png|jpg|jpeg|gif|svg|ico|webp|css|js|cur|woff|woff2|ttf|eot|mp3|wav|ogg|mp4|webm|json|pdf))["']/gi;
 
+// ─── SDK project schema version ─────────────────────────────────────
+// Bump this when the required project structure changes (new files,
+// new manifest fields, tsconfig options, etc.). buildMod() compares
+// it against the project's saved version and runs migrations.
+const PROJECT_SCHEMA_VERSION = 1;
+
 function copyDirSync(src, dest) {
     fs.mkdirSync(dest, { recursive: true });
     for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
@@ -40,11 +46,6 @@ function collectFilesRecursive(dir, ext, results = []) {
     return results;
 }
 
-/**
- * Scans all .ts/.tsx files in src/ for relative path strings that
- * reference asset files (images, scripts, styles, etc.) and copies
- * them into dist/ so they're available via mod-asset:// at runtime.
- */
 function scanSourceAssets() {
     const sourceFiles = collectFilesRecursive("src", [".ts", ".tsx"]);
     let copied = 0;
@@ -71,10 +72,112 @@ function scanSourceAssets() {
     return copied;
 }
 
+// ─── Required file templates ────────────────────────────────────────
+// Each entry defines a file that must exist in the mod project.
+// If missing, it's auto-created from the template.
+
+const REQUIRED_FILES = {
+    "src/types.d.ts": {
+        content: `declare module "*.html" {\n    const value: string;\n    export default value;\n}\n`,
+        description: "HTML import type declarations",
+    },
+};
+
+// Fields that must exist in manifest.json (with defaults)
+const REQUIRED_MANIFEST_FIELDS = {
+    apiVersion: "1.0",
+};
+
+// Required tsconfig.json compilerOptions
+const REQUIRED_TSCONFIG_OPTIONS = {
+    experimentalDecorators: true,
+    strict: true,
+};
+
 /**
- * esbuild plugin: scans HTML files for local asset references
- * (script src, link href, img src) and copies them into dist/.
+ * Validates project structure and auto-fixes missing/outdated files.
+ * Returns a list of actions taken.
  */
+function validateProject() {
+    const actions = [];
+
+    // 1. Check required files
+    for (const [filePath, spec] of Object.entries(REQUIRED_FILES)) {
+        if (!fs.existsSync(filePath)) {
+            fs.mkdirSync(path.dirname(filePath), { recursive: true });
+            fs.writeFileSync(filePath, spec.content, "utf-8");
+            actions.push(`Created missing file: ${filePath} (${spec.description})`);
+        }
+    }
+
+    // 2. Check manifest.json required fields
+    if (fs.existsSync("manifest.json")) {
+        const raw = fs.readFileSync("manifest.json", "utf-8");
+        const manifest = JSON.parse(raw);
+        let changed = false;
+
+        for (const [key, defaultValue] of Object.entries(REQUIRED_MANIFEST_FIELDS)) {
+            if (!(key in manifest)) {
+                manifest[key] = defaultValue;
+                changed = true;
+                actions.push(`Added missing manifest field: "${key}" = "${defaultValue}"`);
+            }
+        }
+
+        if (changed) {
+            fs.writeFileSync("manifest.json", JSON.stringify(manifest, null, 4) + "\n", "utf-8");
+        }
+    } else {
+        actions.push("WARNING: manifest.json not found!");
+    }
+
+    // 3. Check tsconfig.json required options
+    if (fs.existsSync("tsconfig.json")) {
+        const raw = fs.readFileSync("tsconfig.json", "utf-8");
+        let tsconfig;
+        try {
+            tsconfig = JSON.parse(raw);
+        } catch {
+            actions.push("WARNING: tsconfig.json has invalid JSON");
+            return actions;
+        }
+
+        if (!tsconfig.compilerOptions) tsconfig.compilerOptions = {};
+        let changed = false;
+
+        for (const [key, value] of Object.entries(REQUIRED_TSCONFIG_OPTIONS)) {
+            if (tsconfig.compilerOptions[key] !== value) {
+                tsconfig.compilerOptions[key] = value;
+                changed = true;
+                actions.push(`Fixed tsconfig option: "${key}" → ${value}`);
+            }
+        }
+
+        if (changed) {
+            fs.writeFileSync("tsconfig.json", JSON.stringify(tsconfig, null, 4) + "\n", "utf-8");
+        }
+    }
+
+    // 4. Check public/ directory exists
+    if (!fs.existsSync("public")) {
+        fs.mkdirSync("public", { recursive: true });
+        actions.push("Created missing public/ directory");
+    }
+
+    // 5. Update schema version stamp
+    const stampFile = "node_modules/.hackhub-schema-version";
+    const currentStamp = fs.existsSync(stampFile) ? parseInt(fs.readFileSync(stampFile, "utf-8").trim(), 10) : 0;
+    if (currentStamp < PROJECT_SCHEMA_VERSION) {
+        fs.mkdirSync(path.dirname(stampFile), { recursive: true });
+        fs.writeFileSync(stampFile, String(PROJECT_SCHEMA_VERSION), "utf-8");
+        if (currentStamp > 0) {
+            actions.push(`Project schema updated: v${currentStamp} → v${PROJECT_SCHEMA_VERSION}`);
+        }
+    }
+
+    return actions;
+}
+
 export function htmlAssetsPlugin() {
     const assetPattern = /(?:src|href)\s*=\s*["'](\.[^"']+)["']/g;
 
@@ -107,10 +210,10 @@ export function htmlAssetsPlugin() {
 
 function log(msg) { process.stdout.write(`\x1b[36m[HackHub]\x1b[0m ${msg}\n`); }
 function logSuccess(msg) { process.stdout.write(`\x1b[32m[HackHub]\x1b[0m ${msg}\n`); }
+function logWarn(msg) { process.stdout.write(`\x1b[33m[HackHub]\x1b[0m ${msg}\n`); }
 
 /**
  * Builds a HackHub mod project.
- * Call this from your esbuild.config.ts — all build logic is handled here.
  *
  * @param {object} [options]
  * @param {string} [options.entryPoint] - Entry file (default: "src/index.ts")
@@ -122,12 +225,18 @@ export async function buildMod(options = {}) {
     const isWatch = process.argv.includes("--watch");
     const start = Date.now();
 
-    log("Preparing dist...");
+    // Validate & auto-fix project structure
+    const fixes = validateProject();
+    for (const fix of fixes) {
+        if (fix.startsWith("WARNING")) logWarn(fix);
+        else logWarn(`Auto-fix: ${fix}`);
+    }
+
     prepareDist();
 
     const assetCount = scanSourceAssets();
     if (assetCount > 0) {
-        log(`Copied ${assetCount} asset(s) from source files`);
+        log(`Copied ${assetCount} asset(s)`);
     }
 
     const outfile = options.outfile || "dist/mod.js";
@@ -152,11 +261,13 @@ export async function buildMod(options = {}) {
                 {
                     name: "rebuild-notify",
                     setup(build) {
+                        let rebuildStart = Date.now();
+                        build.onStart(() => { rebuildStart = Date.now(); });
                         build.onEnd((result) => {
                             if (result.errors.length === 0) {
                                 prepareDist();
                                 scanSourceAssets();
-                                logSuccess(`Rebuilt in ${Date.now() - start}ms → ${outfile}`);
+                                logSuccess(`Rebuilt in ${Date.now() - rebuildStart}ms → ${outfile}`);
                             }
                         });
                     },

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.5.2",
+    "version": "0.6.0",
     "description": "Type definitions and build tools for HackHub mod development",
     "types": "index.d.ts",
     "exports": {