@shevky/core 0.0.3 → 0.0.5

package/engines/metaEngine.js

@@ -137,6 +137,7 @@ class MetaEngine {
       quote,
       home: this.resolveLanguageHomePath(lang),
       url: _cfg.identity.url,
+      ui: _cfg.ui ?? {},
       currentLanguage: lang,
       currentCulture: _i18n.culture(lang),
       currentCanonical: (() => {

package/engines/pluginEngine.js

@@ -87,6 +87,7 @@ export class PluginEngine {
       ...(hook === _plugin.hooks.CONTENT_LOAD
         ? {
             contentFiles: this.#_contentRegistry.files,
+            addContent: (input) => this.#_contentRegistry.addContent(input),
           }
         : {}),
       ...(hook === _plugin.hooks.CONTENT_READY && this.#_metaEngine

package/engines/renderEngine.js

@@ -517,7 +517,9 @@ export class RenderEngine {
       return;
     }
 
-    const configKeys = Object.keys(collectionsConfig);
+    const configKeys = Object.keys(collectionsConfig).filter(
+      (key) => key !== "includeContentFile",
+    );
     for (const configKey of configKeys) {
       const config = collectionsConfig[configKey];
       if (!config || typeof config !== "object") {

package/lib/contentFile.js

@@ -167,4 +167,16 @@ export class ContentFile {
   get isPostTemplate() {
     return this.template === "post";
   }
+
+  toObject() {
+    return {
+      header: this._header.raw,
+      body: {
+        content: this.content,
+      },
+      content: this.content,
+      isValid: this.isValid,
+      sourcePath: this.sourcePath,
+    };
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shevky/core",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "A minimal, dependency-light static site generator.",
   "type": "module",
   "main": "shevky.js",
@@ -36,7 +36,7 @@
   },
   "homepage": "https://github.com/shevky/core#readme",
   "dependencies": {
-    "@shevky/base": "^0.0.1",
+    "@shevky/base": "^0.0.3",
     "@types/node": "^20.11.30",
     "@types/mustache": "^4.2.6",
     "@types/html-minifier-terser": "^7.0.2",

package/registries/contentRegistry.js

@@ -1,4 +1,4 @@
-import { io as _io } from "@shevky/base";
+import { io as _io, config as _cfg } from "@shevky/base";
 import matter from "gray-matter";
 
 import { ContentFile } from "../lib/contentFile.js";
@@ -52,9 +52,7 @@ export class ContentRegistry {
       this.#_cache.push(contentFile);
     }
 
-    this.#_collectionsCache = null;
-    this.#_footerPoliciesCache = null;
-    this.#_contentIndexCache = null;
+    this.#_resetCaches();
   }
 
   get count() {
@@ -65,6 +63,39 @@ export class ContentRegistry {
     return this.#_cache;
   }
 
+  /**
+   * @param {import("../types/index.d.ts").ContentFileLike | ContentFile} input
+   */
+  addContent(input) {
+    if (!input) {
+      return;
+    }
+
+    if (input instanceof ContentFile) {
+      this.#_cache.push(input);
+      this.#_resetCaches();
+      return;
+    }
+
+    const header =
+      input.header && typeof input.header === "object" ? input.header : {};
+    const content =
+      typeof input.content === "string"
+        ? input.content
+        : typeof input.body?.content === "string"
+          ? input.body.content
+          : "";
+    const sourcePath =
+      typeof input.sourcePath === "string"
+        ? input.sourcePath
+        : "plugin://content/unknown.md";
+    const isValid = typeof input.isValid === "boolean" ? input.isValid : true;
+
+    const contentFile = new ContentFile(header, content, sourcePath, isValid);
+    this.#_cache.push(contentFile);
+    this.#_resetCaches();
+  }
+
   /**
    * @returns {Record<string, Array<{ key: string, label: string, url: string, lang: string }>>}
    */
@@ -171,6 +202,9 @@ export class ContentRegistry {
       return this.#_collectionsCache;
     }
 
+    const includeContentFile = Boolean(
+      _cfg?.content?.collections?.includeContentFile,
+    );
     /** @type {import("../types/index.d.ts").CollectionsByLang} */
     const pagesByLang = {};
     const contentFiles = this.files;
@@ -180,8 +214,10 @@ export class ContentRegistry {
       }
 
       const contentSummary = new ContentSummary(file);
+      const summaryBase = contentSummary.toObject();
       const summary = /** @type {import("../types/index.d.ts").CollectionEntry} */ ({
-        ...contentSummary.toObject(),
+        ...summaryBase,
+        ...(includeContentFile ? file.toObject() : {}),
         canonical: this.#_metaEngine.buildContentUrl(
           file.canonical,
           file.lang,
@@ -246,6 +282,12 @@ export class ContentRegistry {
     return new ContentFile(data, content, filePath, isValid);
   }
 
+  #_resetCaches() {
+    this.#_collectionsCache = null;
+    this.#_footerPoliciesCache = null;
+    this.#_contentIndexCache = null;
+  }
+
   /**
    * @param {Record<string, import("../types/index.d.ts").CollectionEntry[]>} store
    * @param {string} key

package/scripts/cli.js

@@ -65,10 +65,10 @@ function help() {
     },
     {
       header: "Project Details",
-      content: "Project Home: {underline https://tatoglu.net/project/shevky}",
+      content: "Project Home: {underline https://shevky.github.io}",
     },
     {
-      content: "GitHub: {underline https://github.com/fatihtatoglu/shevky}",
+      content: "GitHub: {underline https://github.com/shevky}",
     },
   ];
 

package/scripts/main.js

@@ -4,7 +4,7 @@ import _cli from "./cli.js";
 import _build from "./build.js";
 import _init from "./init.js";
 
-const VERSION = "0.0.1";
+const VERSION = "0.0.4";
 
 const __filename = _io.url.toPath(import.meta.url);
 const __dirname = _io.path.name(__filename);

package/types/index.d.ts

@@ -27,9 +27,28 @@ export type PluginInstance = {
 
 export type PluginLoadContext = BasePluginLoadContext;
 
+export type ContentHeaderLike = Record<string, any>;
+
+export type ContentBodyLike = {
+  content?: string;
+};
+
+export type ContentFileLike = {
+  header?: ContentHeaderLike;
+  body?: ContentBodyLike;
+  content?: string;
+  isValid?: boolean;
+  sourcePath?: string;
+};
+
 export interface PluginExecutionContext extends BasePluginContext {
   paths: ProjectPaths;
-  contentFiles?: import("@shevky/base").ContentFileLike[];
+  contentFiles?: ContentFileLike[];
+  addContent?: (
+    input:
+      | ContentFileLike
+      | import("../lib/contentFile.js").ContentFile
+  ) => void;
   pages?: CollectionsByLang;
   contentIndex?: Record<
     string,
@@ -72,6 +91,11 @@ export type CollectionEntry = ContentSummaryLike & {
   type?: string;
   seriesTitle?: string;
   canonical?: string;
+  header?: ContentHeaderLike;
+  body?: ContentBodyLike;
+  content?: string;
+  isValid?: boolean;
+  sourcePath?: string;
 };
 
 export type CollectionsByLang = Record<string, Record<string, CollectionEntry[]>>;