@zyrab/domo-ssg 0.4.0 → 0.5.0

package/README

@@ -5,18 +5,18 @@ Write JavaScript templates using [@zyrab/domo](https://www.npmjs.com/package/@zy
 
 ---
 
-## ✨ Features
+## Features
 
-- 🧱 Declarative page structure with `Domo` and `DomoSVG`
-- 🗺️ Simple nested route tree (`routes.js`)
-- 🎨 Custom layout wrapper (`layout.js`)
-- ⚡ Virtual DOM-like output (no DOM dependency during build)
-- 🧠 Hydration-ready: automatic inline scripts for events
-- 🧹 Built-in cleanup and sitemap generation
+- Declarative page structure with `Domo` and `DomoSVG`
+- Simple nested route tree (`routes.js`)
+- Custom layout wrapper (`layout.js`)
+- Virtual DOM-like output (no DOM dependency during build)
+- Hydration-ready: automatic inline scripts for events
+- Built-in cleanup and sitemap generation
 
 ---
 
-## 📦 Installation
+## Installation
 
 ```bash
 pnpm add -D @zyrab/domo-ssg
@@ -24,7 +24,7 @@ pnpm add -D @zyrab/domo-ssg
 
 Note: Use in a pnpm monorepo if you're working with other Domo packages like @zyrab/domo or @zyrab/domo-router.
 
-## 🛠 Usage
+## Usage
 
 ### 1. Scaffold basic structure
 
@@ -56,7 +56,7 @@ layout.js;
 pnpm build
 ```
 
-# 🧩 Project Structure
+# Project Structure
 
 | File             | Purpose                             |
 | ---------------- | ----------------------------------- |
@@ -64,10 +64,10 @@ pnpm build
 | `layout.js`      | Optional layout wrapper             |
 | `domo.config.js` | Customize output dir, base URL, etc |
 
-# 🧪 Example Route File
+# Example Route File
 
 ```js
-import { Domo } from "@zyrab/domo";
+import Domo from "@zyrab/domo";
 
 export const routes = {
   "/": () => Domo("div").txt("Hello Home"),
@@ -75,7 +75,7 @@ export const routes = {
 };
 ```
 
-# ⚙️ Configuration (domo.config.js)
+# Configuration (domo.config.js)
 
 ```js
 export default {
@@ -87,6 +87,6 @@ export default {
 };
 ```
 
-# 📜 License
+# License
 
 MIT — © Zyrab

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyrab/domo-ssg",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A Static Site Generator (SSG) for Domo-based projects.",
   "main": "src/index.js",
   "type": "module",
@@ -17,15 +17,16 @@
   "author": "Zyrab",
   "license": "MIT",
   "dependencies": {
-    "@zyrab/domo": "^1.2.0",
-    "@zyrab/domo-router": "^0.1.0"
+    "@zyrab/domo": "^1.3.0",
+    "@zyrab/domo-og": "0.1.0",
+    "@zyrab/domo-router": "^0.1.1"
   },
-  "devDependencies": {},
   "publishConfig": {
     "access": "public"
   },
   "files": [
-    "src/"
+    "src/",
+    "README"
   ],
   "scripts": {
     "build": "node src/index.js",

package/src/file-utils.js

@@ -25,7 +25,7 @@ export function writeHTML(outputDir, routePath, html) {
   const outPath = path.join(outputDir, fileName, "index.html");
   ensureDir(outPath);
   fs.writeFileSync(outPath, html, "utf8");
-  console.log(`Generated: ${path.relative(outputDir, outPath)}`);
+  // console.log(`Generated: ${path.relative(outputDir, outPath)}`);
 }
 
 /**

package/src/index.js

@@ -13,9 +13,9 @@ async function main() {
   const { renderLayout } = await import(pathToFileURL(config.layout).href);
 
   console.log("🚀 Starting Domo SSG build...");
-  console.log(`Output directory: ${config.outDir}`);
-  console.log(`Routes file: ${config.routesFile}`);
-  console.log(`Layout file: ${config.layout}`);
+  console.log(`📁 Output directory: ${config.outDir}`);
+  console.log(`🗺️ Routes file: ${config.routesFile}`);
+  console.log(`🧩 Layout file: ${config.layout}`);
 
   // 1. Clean the output directory
   cleanOutputDir(config.outDir, config.exclude);

package/src/route-handler.js

@@ -3,7 +3,7 @@ import Router from "@zyrab/domo-router";
 import { getConfig } from "./config.js";
 import { writeHTML } from "./file-utils.js";
 import { writeJs } from "./event-utils.js";
-import { normalizeAssets } from "./utils.js";
+import { normalizeAssets, tryGenerateOgImage } from "./utils.js";
 
 /**
  * Helper to join URL path segments correctly.
@@ -34,19 +34,19 @@ export async function handleRoute(params, renderLayout) {
   const { outDir, baseUrl, lang, author, theme, assets } = getConfig();
   const { path, props = {}, component, scripts = [], styles = [], fonts = [], meta = {} } = params;
   try {
-    // Set router info for server-side context
     Router.setInfo(path, props);
 
     // Render the component content
     const content = await component(props);
 
-    // --- Write JS file ---
     const embededScript = writeJs(content, outDir, path);
-    // console.log([...styles, ...assets.styles]);
+
+    const ogImage = await tryGenerateOgImage(meta, outDir, path);
+
     const fontPaths = normalizeAssets([fonts, assets.fonts]);
     const stylePaths = normalizeAssets([styles, assets.styles]);
     const scriptPaths = normalizeAssets([embededScript, scripts, assets.scripts]);
-    // Render the full HTML layout
+
     const html = await renderLayout(content, {
       scripts: scriptPaths,
       styles: stylePaths,
@@ -57,6 +57,7 @@ export async function handleRoute(params, renderLayout) {
       author,
       theme,
       ...meta,
+      ogImage: ogImage || meta.ogImage,
     });
 
     // Write the generated HTML to a file

package/src/route-traversal.js

@@ -1,6 +1,5 @@
 // src/route-traversal.js
 import { handleRoute, joinPaths } from "./route-handler.js";
-import { normalizeAssets } from "./utils.js";
 
 /**
  * Recursively builds HTML files for all defined routes, including nested and dynamic routes.

package/src/sitemap.js

@@ -76,5 +76,5 @@ ${urls
 </urlset>`;
 
   fs.writeFileSync(path.join(outputDir, "sitemap.xml"), xml, "utf8");
-  console.log(`Generated sitemap.xml at: ${path.join(outputDir, "sitemap.xml")}`);
+  console.log(`🧭 Generated sitemap.xml at: ${path.join(outputDir, "sitemap.xml")}`);
 }

package/src/utils.js

@@ -1,3 +1,4 @@
+import Router from "@zyrab/domo-router";
 export function normalizeAssets(arr) {
   if (!arr) return []; // Handle null/undefined safely
   const flatArray = Array.isArray(arr) ? arr.flat() : [arr]; // Support single string/object
@@ -17,3 +18,27 @@ export function normalizeAssets(arr) {
 
   return result;
 }
+
+export async function tryGenerateOgImage(routeMeta, outputDir, path) {
+  if (!routeMeta.generateOgImage) return;
+  const slug = Router.info().segments.at(-1).slice(1);
+
+  try {
+    const { generateOgImage: generate } = await import("@zyrab/domo-og");
+
+    const ogPath = generate({
+      ...routeMeta,
+      outputDir,
+      slug,
+      routeKey: path,
+    });
+
+    return ogPath;
+  } catch (err) {
+    if (err.code === "ERR_MODULE_NOT_FOUND" || err.message.includes("Cannot find module")) {
+      console.warn(`⚠️  OG image generation skipped for "${slug}" — install 'domo-og' to enable this feature.`);
+    } else {
+      console.warn(`⚠️  OG image generation failed for "${slug}":\n${err.stack}`);
+    }
+  }
+}