npm - @lexho111/plainblog - Versions diffs - 0.5.10 → 0.5.12 - Mend

@lexho111/plainblog 0.5.10 → 0.5.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

package/Blog.js +242 -157
package/Formatter.js +20 -3
package/build-styles.js +24 -17
package/eslint.config.js +27 -45
package/knip.json +10 -0
package/model/FileAdapter.js +5 -5
package/model/FileModel.js +4 -0
package/model/PostgresAdapter.js +2 -2
package/model/SequelizeAdapter.js +25 -20
package/model/SqliteAdapter.js +2 -2
package/package.json +10 -14
package/public/styles.min.css +2 -2
package/test/blog.test.js +120 -6
package/test/simpleServer.js +0 -2
package/.eslintignore +0 -0
package/.eslintrc.json +0 -0
package/articles.txt +0 -11
package/blog.db +0 -0
package/blog.json +0 -110
package/bloginfo.json +0 -3
package/lexho111-plainblog-0.4.1.tgz +0 -0
package/lexho111-plainblog-0.5.7.tgz +0 -0

package/Formatter.js CHANGED Viewed

@@ -1,3 +1,8 @@
+/**
+ * generates the header of the generated html file
+ * @param {*} title title of the blog
+ * @returns the header for the generated html file
+ */
 export function header(title) {
   return `<!DOCTYPE html>
 <html lang="de">
@@ -11,10 +16,12 @@ export function header(title) {
   </head>`;
 }
-/** format content to html */
+/**
+ * renders content like articles into a browser-ready HTML string.
+ * @param {*} data blog data like blogtitle, articles, login information
+ * @returns valid html code with article data implanted
+ */
 export function formatHTML(data) {
-  //console.log(`${data} ${script} ${style}`);
-  //export function formatHTML(data) {
   //const button = `<button type="button" onClick="fillWithContent();" style="margin: 4px;">generate random text</button>`;
   const button = "";
   let form1 = "";
@@ -59,6 +66,11 @@ export function formatHTML(data) {
 </html>`;
 }
+/**
+ * format content like articles to markdown
+ * @param {*} data blog data like blogtitle and articles
+ * @returns valid markdown
+ */
 export function formatMarkdown(data) {
   let markdown = "";
   markdown += `# ${data.title}\n`;
@@ -70,6 +82,11 @@ export function formatMarkdown(data) {
   return markdown;
 }
+/**
+ * html validator
+ * @param {*} html
+ * @returns true if param html is valid html
+ */
 export function validate(html) {
   let test = true; // all tests passed
   if (!(html.includes("<html") && html.includes("</html"))) {

package/build-styles.js CHANGED Viewed

@@ -1,37 +1,35 @@
 import path from "path";
-import { pathToFileURL } from "url";
 import postcss from "postcss";
 import autoprefixer from "autoprefixer";
 import cssnano from "cssnano";
-// array of files or a single file
+/**
+ * Compiles CSS styles from file content objects.
+ * @param {Array<{path: string, content: string}>} fileData - An array of objects containing file paths and content.
+ * @returns {Promise<string>} The compiled and minified CSS.
+ */
 export async function compileStyles(fileData) {
   try {
     let combinedCss = "";
+    // 1. filter out css files
     if (fileData) {
       const scssFiles = fileData.filter(
         (f) =>
           f.path.endsWith(".scss") && !path.basename(f.path).startsWith("_")
       );
+      if (scssFiles.length > 0) console.error("sass files are not supported.");
-      for (const file of scssFiles) {
-        console.error("sass files are not supported.");
-      }
+      // make one big css file
       const cssFiles = fileData.filter((f) => f.path.endsWith(".css"));
       for (const file of cssFiles) {
         combinedCss += file.content + "\n";
       }
     }
-    // 2. PostCSS (Autoprefixer + CSSNano)
+    // 2. minify and uglify with PostCSS
     if (combinedCss) {
-      const plugins = [autoprefixer(), cssnano()];
-      const result = await postcss(plugins).process(combinedCss, {
-        from: undefined,
-      });
-      return result.css;
+      return postcss2(combinedCss);
     }
     return "";
   } catch (error) {
@@ -40,16 +38,25 @@ export async function compileStyles(fileData) {
   }
 }
+async function postcss2(css) {
+  const plugins = [autoprefixer(), cssnano()];
+  const result = await postcss(plugins).process(css, {
+    from: undefined, // do not print source map warning
+  });
+  return result.css; // final result
+}
+/**
+ * Merges and minifies multiple CSS content strings.
+ * @param {...string} cssContents - CSS strings to merge.
+ * @returns {Promise<string>} The merged and minified CSS.
+ */
 export async function mergeStyles(...cssContents) {
   try {
     const combinedCss = cssContents.join("\n");
     if (combinedCss) {
-      const plugins = [autoprefixer(), cssnano()];
-      const result = await postcss(plugins).process(combinedCss, {
-        from: undefined,
-      });
-      return result.css;
+      return postcss2(combinedCss);
     }
     return "";
   } catch (error) {

package/eslint.config.js CHANGED Viewed

@@ -1,45 +1,27 @@
-import globals from "globals";
-import pluginJs from "@eslint/js";
-import pluginJest from "eslint-plugin-jest";
-export default [
-  {
-    // Configuration for all JavaScript files
-    files: ["**/*.js"],
-    languageOptions: {
-      ecmaVersion: 2022, // Supports modern JavaScript features
-      sourceType: "module",
-      globals: {
-        ...globals.node, // Defines Node.js global variables (e.g., `process`, `require`)
-      },
-    },
-    // ESLint's recommended rules for general JavaScript
-    rules: {
-      ...pluginJs.configs.recommended.rules,
-      // Add or override general JavaScript rules here.
-      // Example: Enforce semicolons at the end of statements
-      semi: ["error", "always"],
-      // Example: Prefer `const` over `let` where variables are not reassigned
-      "prefer-const": "error",
-      // Example: Prevent unused variables (can be configured further)
-      "no-unused-vars": ["warn", { args: "none" }],
-    },
-  },
-  {
-    // Configuration specifically for Jest test files
-    files: ["**/*.test.js", "**/*.spec.js"],
-    languageOptions: {
-      globals: {
-        ...globals.jest, // Defines Jest global variables (e.g., `describe`, `it`, `expect`)
-      },
-    },
-    plugins: {
-      jest: pluginJest,
-    },
-    // Recommended Jest rules from `eslint-plugin-jest`
-    rules: {
-      ...pluginJest.configs.recommended.rules,
-      // Add or override Jest-specific rules here.
-    },
-  },
-];
+import js from "@eslint/js";
+import globals from "globals";
+import { defineConfig } from "eslint/config";
+import pluginJest from "eslint-plugin-jest";
+export default defineConfig([
+  {
+    // Must be in a separate object to apply globally
+    ignores: ["public/scripts.min.js", "dist/**/*"],
+  },
+  {
+    files: ["**/*.{js,mjs,cjs}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: { globals: globals.browser },
+  },
+  {
+    files: ["**/*.test.js", "**/*.spec.js"],
+    plugins: { jest: pluginJest },
+    languageOptions: {
+      globals: pluginJest.environments.globals.globals, // Loads all Jest globals
+    },
+    rules: {
+      ...pluginJest.configs["flat/recommended"].rules,
+    },
+  },
+]);

package/knip.json ADDED Viewed

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://unpkg.com/knip@5/schema.json",
+  "ignoreExportsUsedInFile": {
+    "interface": true,
+    "type": true
+  },
+  "tags": [
+    "-lintignore"
+  ]
+}

package/model/FileAdapter.js CHANGED Viewed

@@ -8,9 +8,9 @@ import {
 export default class FileAdapter {
   dbtype = "file";
-  constructor(options) {
-    this.infoFile = "bloginfo.json";
-    this.articlesFile = "articles.txt";
+  constructor(options = {}) {
+    this.infoFile = options.infoFilename || "bloginfo.json";
+    this.articlesFile = options.articlesFilename || "articles.txt";
   }
   async initialize() {
@@ -41,8 +41,8 @@ export default class FileAdapter {
   async findAll(
     limit = 4,
     offset = 0,
-    startId = null,
-    endId = null,
+    //startId = null,
+    //endId = null,
     order = "DESC"
   ) {
     let dbArticles = [];

package/model/FileModel.js CHANGED Viewed

@@ -11,6 +11,7 @@ export async function loadInfo(filename) {
     const data = await fs.readFile(filename, "utf8");
     return JSON.parse(data);
   } catch (err) {
+    console.error(err);
     return { title: "Blog" };
   }
 }
@@ -29,6 +30,7 @@ export async function loadArticles(filename) {
       .filter((line) => line.trim() !== "")
       .map((line) => JSON.parse(line));
   } catch (err) {
+    console.error(err);
     return [];
   }
 }
@@ -38,12 +40,14 @@ export async function initFiles(infoFilename, articlesFilename) {
   try {
     await fs.access(infoFilename);
   } catch (err) {
+    console.error(err);
     await saveInfo(infoFilename, { title: "Blog" });
   }
   try {
     await fs.access(articlesFilename);
   } catch (err) {
+    console.error(err);
     await fs.writeFile(articlesFilename, "");
   }
 }

package/model/PostgresAdapter.js CHANGED Viewed

@@ -1,4 +1,3 @@
-import { Sequelize, DataTypes, Op } from "sequelize";
 import SequelizeAdapter from "./SequelizeAdapter.js";
 export default class PostgresAdapter extends SequelizeAdapter {
@@ -22,6 +21,7 @@ export default class PostgresAdapter extends SequelizeAdapter {
   async initialize() {
     console.log("initialize database");
+    await this.loadSequelize();
     const maxRetries = 10;
     const retryDelay = 3000;
@@ -31,7 +31,7 @@ export default class PostgresAdapter extends SequelizeAdapter {
           `postgres://${this.username}:${this.password}@${this.host}:${this.dbport}/${this.dbname}`
         );
-        this.sequelize = new Sequelize(
+        this.sequelize = new this.Sequelize(
           `postgres://${this.username}:${this.password}@${this.host}:${this.dbport}/${this.dbname}`,
           { logging: false }
         );

package/model/SequelizeAdapter.js CHANGED Viewed

@@ -1,5 +1,3 @@
-import { Sequelize, DataTypes, Op } from "sequelize";
 export default class SequelizeAdapter {
   username;
   password;
@@ -11,38 +9,44 @@ export default class SequelizeAdapter {
   Article;
   BlogInfo;
+  // Dynamic properties
+  Sequelize;
+  DataTypes;
+  Op;
   constructor(options = {}) {
     console.log(JSON.stringify(options));
+  }
-    //let Sequelize, DataTypes, Op;
-    /*try {
+  async loadSequelize() {
+    if (this.Sequelize) return;
+    try {
       const sequelizePkg = await import("sequelize");
-      Sequelize = sequelizePkg.Sequelize;
-      DataTypes = sequelizePkg.DataTypes;
-      //Op = sequelizePkg.Op;
-      //this.#Op = Op;
+      this.Sequelize = sequelizePkg.Sequelize;
+      this.DataTypes = sequelizePkg.DataTypes;
+      this.Op = sequelizePkg.Op;
     } catch (err) {
+      console.error(err);
       throw new Error(
         "Sequelize is not installed. Please install it to use PostgresAdapter: npm install sequelize"
       );
-    }*/
-    // throw new Error(`Error! ${databasetype} is an unknown database type.`);
+    }
   }
   async initializeModels() {
+    await this.loadSequelize();
     this.Article = this.sequelize.define(
       "Article",
       {
-        title: DataTypes.STRING,
-        content: DataTypes.TEXT,
+        title: this.DataTypes.STRING,
+        content: this.DataTypes.TEXT,
         createdAt: {
-          type: DataTypes.DATE,
-          defaultValue: DataTypes.NOW,
+          type: this.DataTypes.DATE,
+          defaultValue: this.DataTypes.NOW,
         },
         updatedAt: {
-          type: DataTypes.DATE,
-          defaultValue: DataTypes.NOW,
+          type: this.DataTypes.DATE,
+          defaultValue: this.DataTypes.NOW,
         },
       },
       {
@@ -53,7 +57,7 @@ export default class SequelizeAdapter {
     this.BlogInfo = this.sequelize.define(
       "BlogInfo",
       {
-        title: DataTypes.STRING,
+        title: this.DataTypes.STRING,
       },
       {
         timestamps: false,
@@ -80,13 +84,14 @@ export default class SequelizeAdapter {
     endId = null,
     order = "DESC"
   ) {
+    await this.loadSequelize();
     const where = {};
     if (startId !== null && endId !== null) {
       where.id = {
-        [Op.between]: [Math.min(startId, endId), Math.max(startId, endId)],
+        [this.Op.between]: [Math.min(startId, endId), Math.max(startId, endId)],
       };
     } else if (startId !== null) {
-      where.id = { [order === "DESC" ? Op.lte : Op.gte]: startId };
+      where.id = { [order === "DESC" ? this.Op.lte : this.Op.gte]: startId };
     }
     const options = {
       where,

package/model/SqliteAdapter.js CHANGED Viewed

@@ -1,4 +1,3 @@
-import { Sequelize } from "sequelize";
 import SequelizeAdapter from "./SequelizeAdapter.js";
 export default class SqliteAdapter extends SequelizeAdapter {
@@ -11,8 +10,9 @@ export default class SqliteAdapter extends SequelizeAdapter {
   }
   async initialize() {
+    await this.loadSequelize();
     try {
-      this.sequelize = new Sequelize({
+      this.sequelize = new this.Sequelize({
         dialect: "sqlite",
         storage: this.dbname + ".db",
         logging: false,

package/package.json CHANGED Viewed

@@ -1,13 +1,14 @@
 {
   "name": "@lexho111/plainblog",
-  "version": "0.5.10",
+  "version": "0.5.12",
   "description": "A tool for creating and serving a minimalist, single-page blog.",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "dev": "node index.js",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "knip": "knip"
   },
   "keywords": [
     "blog",
@@ -18,26 +19,21 @@
   "license": "ISC",
   "dependencies": {
     "autoprefixer": "^10.4.23",
-    "child_process": "^1.0.2",
     "cssnano": "^7.1.2",
-    "fs": "^0.0.1-security",
-    "http": "^0.0.1-security",
     "node-fetch": "^3.3.2",
-    "path": "^0.12.7",
-    "postcss": "^8.5.6",
-    "postcss-preset-env": "^10.6.0",
-    "sass": "^1.97.1",
-    "url": "^0.11.4",
-    "util": "^0.12.5"
+    "postcss": "^8.5.6"
   },
   "devDependencies": {
-    "dom-parser": "^1.1.5",
-    "eslint": "^9.8.0",
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^25.0.3",
+    "eslint": "^9.39.2",
     "eslint-plugin-jest": "^28.6.0",
+    "globals": "^17.0.0",
     "jest": "^29.7.0",
-    "sqlite3": "^5.1.7"
+    "typescript": "^5.9.3"
   },
   "optionalDependencies": {
+    "sqlite3": "^5.1.7",
     "pg": "^8.16.3",
     "pg-hstore": "^2.3.4",
     "sequelize": "^6.37.7"

package/public/styles.min.css CHANGED Viewed

@@ -1,2 +1,2 @@
-body{font-family:Arial;font-family:Arial,sans-serif}h1{color:#333}.grid{border:0 solid #000;display:grid;gap:.25rem;grid-template-columns:1fr}.grid article{border:0 solid #ccc;border-radius:4px;min-width:0;overflow-wrap:break-word;padding:.25rem}.grid article h2{color:#353535;margin-bottom:5px}.grid article .datetime{color:#757575;margin:0}.grid article p{margin-bottom:0;margin-top:10px}article a,article a:visited,h1{color:#696969}nav a{color:#3b40c1;font-size:20px;text-decoration:underline}nav a:visited{color:#3b40c1;text-decoration-color:#3b40c1}#wrapper{max-width:500px;width:100%}@media screen and (max-width:1000px){*{font-size:4vw}#wrapper{box-sizing:border-box;max-width:100%;padding:0 10px;width:100%}}
-/* source-hash: a07f631befba4b6bc703f8709f5ef455faafeff4e5f00b62f835576eea7fb529 */
+body{background-color:#fdfdfd;font-family:Arial}nav a{color:#3b40c1;font-size:20px;text-decoration:underline}.datetime{color:#434343;font-style:normal}h2{color:#a9a9a9;margin:0 0 5px}p{margin-top:10px}span{margin:0}
+/* source-hash: fa9deb7a7f0781f463cd3e8fd3c3ceddec518535b0a6d13af7309ef9a2f76c32 */

package/test/blog.test.js CHANGED Viewed

@@ -4,8 +4,49 @@ import fs from "node:fs";
 import Blog from "../Blog.js";
 import Article from "../Article.js";
 import { jest } from "@jest/globals";
+import DatabaseModel from "../model/DatabaseModel.js";
 describe("test blog", () => {
+  test("blog bootstrap stage 1", () => {
+    const myblog = new Blog();
+    const json = myblog.json();
+    expect(json.version).toContain(".");
+    const database = json.database;
+    expect(database.type).toBe("file");
+    expect(database.username).toBe("user");
+    expect(database.password).toBe("password");
+    expect(database.host).toBe("localhost");
+    expect(database.dbname).toBe("articles.txt"); //TODO switch blog.json to articles.txt, bloginfo.json
+    expect(json.password).toBe("admin");
+    expect(json.styles).toContain("body { font-family: Arial; }");
+    expect(json.reloadStylesOnGET).not.toBeTruthy();
+  });
+  test("blog bootstrap stage 2", async () => {
+    const myblog = new Blog();
+    await myblog.init();
+    const json = myblog.json();
+    console.log(json);
+    expect(json.title).toBe("Test Blog Title");
+    expect(json.articles.length).toBeGreaterThan(2);
+    expect(json.server).toBeNull();
+  });
+  test("blog bootstrap stage 3", async () => {
+    const myblog = new Blog();
+    await myblog.init();
+    try {
+      await myblog.startServer(8080);
+      const json = myblog.json();
+      console.log(json);
+      expect(json.title).toBe("Test Blog Title"); // from bloginfo.json
+      expect(json.articles.length).toBeGreaterThan(2);
+      expect(json.server.listening).toBeTruthy();
+      expect(json.server.address.address).toBe("127.0.0.1");
+      expect(json.server.address.family).toBe("IPv4");
+      expect(json.server.address.port).toBe(8080);
+    } finally {
+      await myblog.closeServer();
+    }
+  });
   test("is valid html", async () => {
     const myblog = new Blog();
     const html = await myblog.toHTML();
@@ -35,21 +76,27 @@ describe("test blog", () => {
     const article = new Article("", "");
     myblog.addArticle(article);
     const html = await myblog.toHTML();
+    const json = myblog.json();
     expect(html).toContain("<article");
-    expect(myblog.articles.length).toBe(1);
+    expect(json.articles).toHaveLength(1);
   });
   test("add articles", async () => {
     const myblog = new Blog();
-    expect(myblog.articles.length).toBe(0);
+    const json = myblog.json();
+    expect(json.articles).toHaveLength(0);
     const size = 10;
     for (let i = 1; i <= size; i++) {
       const article = new Article("", "");
       myblog.addArticle(article);
-      expect(myblog.articles.length).toBe(i);
+      const json = myblog.json();
+      expect(json.articles).toHaveLength(i);
+    }
+    {
+      const html = await myblog.toHTML();
+      expect(html).toContain("<article");
+      const json = myblog.json();
+      expect(json.articles).toHaveLength(size);
     }
-    const html = await myblog.toHTML();
-    expect(html).toContain("<article");
-    expect(myblog.articles.length).toBe(size);
   });
   const __filename = fileURLToPath(import.meta.url);
   const __dirname = path.dirname(__filename);
@@ -101,6 +148,73 @@ describe("test blog", () => {
     // Clean up the spy to restore the original console.log
     consoleSpy.mockRestore();
   });
+  test("json() returns a deep copy (immutability check)", () => {
+    const myblog = new Blog();
+    const article = new Article("Original Title", "Content", new Date());
+    myblog.addArticle(article);
+    const json = myblog.json();
+    // Attempt to modify the returned JSON
+    json.title = "Modified Title";
+    json.articles[0].title = "Modified Article";
+    json.database.host = "evil.com";
+    // Verify the internal state is unchanged
+    const newJson = myblog.json();
+    expect(newJson.title).not.toBe("Modified Title");
+    expect(newJson.articles[0].title).toBe("Original Title");
+    expect(newJson.database.host).toBe("localhost");
+  });
+  test("closeServer handles non-running server gracefully", async () => {
+    const myblog = new Blog();
+    // Should not throw even if server was never started
+    await expect(myblog.closeServer()).resolves.not.toThrow();
+  });
+  test("init() runs database operations concurrently", async () => {
+    const myblog = new Blog();
+    // Avoid file operations to isolate database timing
+    myblog.stylesheetPath = [];
+    const delay = 100;
+    // Mock DatabaseModel methods to simulate slow DB operations
+    const getTitleSpy = jest
+      .spyOn(DatabaseModel.prototype, "getBlogTitle")
+      .mockImplementation(async () => {
+        await new Promise((resolve) => setTimeout(resolve, delay));
+        return "Mock Title";
+      });
+    const findAllSpy = jest
+      .spyOn(DatabaseModel.prototype, "findAll")
+      .mockImplementation(async () => {
+        await new Promise((resolve) => setTimeout(resolve, delay));
+        return [];
+      });
+    // Mock initialize to avoid side effects
+    const initSpy = jest
+      .spyOn(DatabaseModel.prototype, "initialize")
+      .mockResolvedValue();
+    const start = Date.now();
+    await myblog.init();
+    const end = Date.now();
+    const duration = end - start;
+    // If sequential: delay + delay = 200ms. If concurrent: ~100ms.
+    expect(duration).toBeLessThan(delay * 1.8);
+    expect(getTitleSpy).toHaveBeenCalled();
+    expect(findAllSpy).toHaveBeenCalled();
+    // Cleanup
+    getTitleSpy.mockRestore();
+    findAllSpy.mockRestore();
+    initSpy.mockRestore();
+  });
 });
 /*

package/test/simpleServer.js CHANGED Viewed

@@ -1,7 +1,5 @@
 import http from "http";
-const port = 8081;
 export const server = http.createServer((req, res) => {
   // Set CORS headers to allow requests from different origins if needed
   res.setHeader("Access-Control-Allow-Origin", "*");

package/.eslintignore DELETED Viewed

File without changes

package/.eslintrc.json DELETED Viewed

File without changes

package/articles.txt DELETED Viewed

@@ -1,11 +0,0 @@
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T13:19:39.939Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T13:34:38.866Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T13:43:32.343Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T18:48:23.123Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T18:50:06.993Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T18:56:28.369Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T18:57:53.780Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T18:58:54.261Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T19:01:02.613Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T19:01:30.473Z"}
-{"title":"Test Title from Jest","content":"This is the content of the test article.","createdAt":"2026-01-08T19:03:33.773Z"}

package/blog.db DELETED Viewed

Binary file