writr 4.1.0 → 4.1.2

package/README.md

@@ -28,11 +28,12 @@
 * Github Flavor Markdown (remark-gfm).
 * Emoji Support (remark-emoji).
 * MDX Support (remark-mdx).
-* ESM and Node 20+
 
-## Getting Started 
+## ESM and Node Version Support
+
+This package is ESM only and tested on the current lts version and its previous. Please don't open issues for questions regarding CommonJS / ESM or previous Nodejs versions. To learn more about using ESM please read this from `sindresorhus`: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
-## Install Writr
+## Getting Started 
 
 ```bash
 > npm install writr

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "writr",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "description": "Markdown Rendering Simplified",
   "type": "module",
-  "main": "./dist/writr.cjs",
-  "module": "./dist/writr.js",
+  "main": "./dist/writr.js",
   "types": "./dist/writr.d.ts",
   "exports": {
     ".": {
-      "require": "./dist/writr.cjs",
       "import": "./dist/writr.js"
     }
   },
@@ -48,19 +46,19 @@
   ],
   "scripts": {
     "clean": "rimraf ./dist ./coverage ./node_modules ./package-lock.json ./yarn.lock ./site/README.md ./site/dist",
-    "build": "rimraf ./dist && tsup src/writr.ts --format cjs,esm --dts --clean",
+    "build": "rimraf ./dist && tsup src/writr.ts --format esm --dts --clean",
     "prepare": "npm run build",
     "test": "xo --fix && vitest run --coverage",
     "website:build": "rimraf ./site/README.md ./site/dist && npx docula build -s ./site -o ./site/dist",
     "website:serve": "rimraf ./site/README.md ./site/dist && npx docula serve -s ./site -o ./site/dist"
   },
   "dependencies": {
-    "cacheable": "^1.7.1",
+    "cacheable": "^1.8.0",
     "crypto": "^1.0.1",
     "fs": "^0.0.1-security",
-    "html-react-parser": "^5.1.16",
+    "html-react-parser": "^5.1.18",
     "js-yaml": "^4.1.0",
-    "keyv": "^5.0.3",
+    "keyv": "^5.1.0",
     "react": "^18.3.1",
     "rehype-highlight": "^7.0.0",
     "rehype-katex": "^7.0.1",
@@ -78,15 +76,15 @@
   "devDependencies": {
     "@keyv/sqlite": "^4.0.1",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.7.4",
-    "@types/react": "^18.3.10",
-    "@vitest/coverage-v8": "^2.1.1",
+    "@types/node": "^22.7.5",
+    "@types/react": "^18.3.11",
+    "@vitest/coverage-v8": "^2.1.2",
     "docula": "^0.9.1",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
     "tsup": "^8.3.0",
     "typescript": "^5.6.2",
-    "vitest": "^2.1.1",
+    "vitest": "^2.1.2",
     "webpack": "^5.95.0",
     "xo": "^0.59.3"
   },

package/dist/writr.cjs

@@ -1,321 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/writr.ts
-var writr_exports = {};
-__export(writr_exports, {
-  Writr: () => Writr
-});
-module.exports = __toCommonJS(writr_exports);
-var import_node_fs = __toESM(require("fs"), 1);
-var import_node_path = require("path");
-var import_unified = require("unified");
-var import_remark_parse = __toESM(require("remark-parse"), 1);
-var import_remark_rehype = __toESM(require("remark-rehype"), 1);
-var import_rehype_slug = __toESM(require("rehype-slug"), 1);
-var import_rehype_highlight = __toESM(require("rehype-highlight"), 1);
-var import_rehype_stringify = __toESM(require("rehype-stringify"), 1);
-var import_remark_toc = __toESM(require("remark-toc"), 1);
-var import_remark_math = __toESM(require("remark-math"), 1);
-var import_rehype_katex = __toESM(require("rehype-katex"), 1);
-var import_remark_gfm = __toESM(require("remark-gfm"), 1);
-var import_remark_emoji = __toESM(require("remark-emoji"), 1);
-var import_remark_mdx = __toESM(require("remark-mdx"), 1);
-var import_html_react_parser = __toESM(require("html-react-parser"), 1);
-var yaml = __toESM(require("js-yaml"), 1);
-
-// src/writr-cache.ts
-var import_node_crypto = require("crypto");
-var import_cacheable = require("cacheable");
-var WritrCache = class {
-  _markdownStore = new import_cacheable.Cacheable();
-  _markdownStoreSync = new import_cacheable.CacheableMemory();
-  _hashStore = new import_cacheable.CacheableMemory();
-  get markdownStore() {
-    return this._markdownStore;
-  }
-  get markdownStoreSync() {
-    return this._markdownStoreSync;
-  }
-  get hashStore() {
-    return this._hashStore;
-  }
-  async getMarkdown(markdown, options) {
-    const key = this.hash(markdown, options);
-    return this.get(key);
-  }
-  getMarkdownSync(markdown, options) {
-    const key = this.hash(markdown, options);
-    return this.getSync(key);
-  }
-  async setMarkdown(markdown, value, options) {
-    const key = this.hash(markdown, options);
-    return this.set(key, value);
-  }
-  setMarkdownSync(markdown, value, options) {
-    const key = this.hash(markdown, options);
-    this.setSync(key, value);
-    return true;
-  }
-  async get(key) {
-    return this._markdownStore.get(key);
-  }
-  getSync(key) {
-    return this._markdownStoreSync.get(key);
-  }
-  async set(key, value) {
-    return this._markdownStore.set(key, value);
-  }
-  setSync(key, value) {
-    this._markdownStoreSync.set(key, value);
-    return true;
-  }
-  async clear() {
-    await this._markdownStore.clear();
-    this._markdownStoreSync.clear();
-    this._hashStore.clear();
-  }
-  setStorageAdapter(adapter) {
-    this._markdownStore = new import_cacheable.Cacheable({ primary: adapter });
-  }
-  hash(markdown, options) {
-    const key = JSON.stringify({ markdown, options });
-    let result = this._hashStore.get(key);
-    if (result) {
-      return result;
-    }
-    result = (0, import_node_crypto.createHash)("sha256").update(key).digest("hex");
-    this._hashStore.set(key, result);
-    return result;
-  }
-};
-
-// src/writr.ts
-var Writr = class {
-  engine = (0, import_unified.unified)().use(import_remark_parse.default).use(import_remark_gfm.default).use(import_remark_toc.default).use(import_remark_emoji.default).use(import_remark_rehype.default).use(import_rehype_slug.default).use(import_remark_math.default).use(import_rehype_katex.default).use(import_rehype_highlight.default).use(import_remark_mdx.default).use(import_rehype_stringify.default);
-  // Stringify HTML
-  _options = {
-    openai: void 0,
-    renderOptions: {
-      emoji: true,
-      toc: true,
-      slug: true,
-      highlight: true,
-      gfm: true,
-      math: true,
-      mdx: true,
-      caching: true
-    }
-  };
-  _content = "";
-  _cache = new WritrCache();
-  constructor(arguments1, arguments2) {
-    if (typeof arguments1 === "string") {
-      this._content = arguments1;
-    } else if (arguments1) {
-      this._options = { ...this._options, ...arguments1 };
-      if (this._options.renderOptions) {
-        this.engine = this.createProcessor(this._options.renderOptions);
-      }
-    }
-    if (arguments2) {
-      this._options = { ...this._options, ...arguments2 };
-      if (this._options.renderOptions) {
-        this.engine = this.createProcessor(this._options.renderOptions);
-      }
-    }
-  }
-  get options() {
-    return this._options;
-  }
-  get content() {
-    return this._content;
-  }
-  set content(value) {
-    this._content = value;
-  }
-  get cache() {
-    return this._cache;
-  }
-  get frontMatterRaw() {
-    const start = this._content.indexOf("---\n");
-    if (start === -1) {
-      return "";
-    }
-    const end = this._content.indexOf("\n---\n", start + 4);
-    if (end === -1) {
-      return "";
-    }
-    return this._content.slice(start, end + 5);
-  }
-  get body() {
-    const start = this._content.indexOf("---\n");
-    if (start === -1) {
-      return this._content;
-    }
-    const end = this._content.indexOf("\n---\n", start + 4);
-    if (end === -1) {
-      return this._content;
-    }
-    return this._content.slice(Math.max(0, end + 5)).trim();
-  }
-  get markdown() {
-    return this.body;
-  }
-  get frontMatter() {
-    const frontMatter = this.frontMatterRaw;
-    const match = /^---\s*([\s\S]*?)\s*---\s*/.exec(frontMatter);
-    if (match) {
-      return yaml.load(match[1].trim());
-    }
-    return {};
-  }
-  set frontMatter(data) {
-    const frontMatter = this.frontMatterRaw;
-    const yamlString = yaml.dump(data);
-    const newFrontMatter = `---
-${yamlString}---
-`;
-    this._content = this._content.replace(frontMatter, newFrontMatter);
-  }
-  getFrontMatterValue(key) {
-    return this.frontMatter[key];
-  }
-  async render(options) {
-    try {
-      let result = "";
-      if (this.isCacheEnabled(options)) {
-        const cached = await this._cache.getMarkdown(this._content, options);
-        if (cached) {
-          return cached;
-        }
-      }
-      let { engine } = this;
-      if (options) {
-        options = { ...this._options.renderOptions, ...options };
-        engine = this.createProcessor(options);
-      }
-      const file = await engine.process(this.body);
-      result = String(file);
-      if (this.isCacheEnabled(options)) {
-        await this._cache.setMarkdown(this._content, result, options);
-      }
-      return result;
-    } catch (error) {
-      throw new Error(`Failed to render markdown: ${error.message}`);
-    }
-  }
-  renderSync(options) {
-    try {
-      let result = "";
-      if (this.isCacheEnabled(options)) {
-        const cached = this._cache.getMarkdownSync(this._content, options);
-        if (cached) {
-          return cached;
-        }
-      }
-      let { engine } = this;
-      if (options) {
-        options = { ...this._options.renderOptions, ...options };
-        engine = this.createProcessor(options);
-      }
-      const file = engine.processSync(this.body);
-      result = String(file);
-      if (this.isCacheEnabled(options)) {
-        this._cache.setMarkdownSync(this._content, result, options);
-      }
-      return result;
-    } catch (error) {
-      throw new Error(`Failed to render markdown: ${error.message}`);
-    }
-  }
-  async renderReact(options, reactParseOptions) {
-    const html = await this.render(options);
-    return (0, import_html_react_parser.default)(html, reactParseOptions);
-  }
-  renderReactSync(options, reactParseOptions) {
-    const html = this.renderSync(options);
-    return (0, import_html_react_parser.default)(html, reactParseOptions);
-  }
-  async loadFromFile(filePath) {
-    const { readFile } = import_node_fs.default.promises;
-    this._content = await readFile(filePath, "utf8");
-  }
-  loadFromFileSync(filePath) {
-    this._content = import_node_fs.default.readFileSync(filePath, "utf8");
-  }
-  async saveToFile(filePath) {
-    const { writeFile, mkdir } = import_node_fs.default.promises;
-    const directoryPath = (0, import_node_path.dirname)(filePath);
-    await mkdir(directoryPath, { recursive: true });
-    await writeFile(filePath, this._content, "utf8");
-  }
-  saveToFileSync(filePath) {
-    const directoryPath = (0, import_node_path.dirname)(filePath);
-    import_node_fs.default.mkdirSync(directoryPath, { recursive: true });
-    import_node_fs.default.writeFileSync(filePath, this._content, "utf8");
-  }
-  isCacheEnabled(options) {
-    if (options?.caching !== void 0) {
-      return options.caching;
-    }
-    return this._options?.renderOptions?.caching ?? false;
-  }
-  createProcessor(options) {
-    const processor = (0, import_unified.unified)().use(import_remark_parse.default);
-    if (options.gfm) {
-      processor.use(import_remark_gfm.default);
-    }
-    if (options.toc) {
-      processor.use(import_remark_toc.default, { heading: "toc|table of contents" });
-    }
-    if (options.emoji) {
-      processor.use(import_remark_emoji.default);
-    }
-    processor.use(import_remark_rehype.default);
-    if (options.slug) {
-      processor.use(import_rehype_slug.default);
-    }
-    if (options.highlight) {
-      processor.use(import_rehype_highlight.default);
-    }
-    if (options.math) {
-      processor.use(import_remark_math.default).use(import_rehype_katex.default);
-    }
-    if (options.mdx) {
-      processor.use(import_remark_mdx.default);
-    }
-    processor.use(import_rehype_stringify.default);
-    return processor;
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Writr
-});

package/dist/writr.d.cts

@@ -1,71 +0,0 @@
-import * as unified from 'unified';
-import * as hast from 'hast';
-import * as mdast from 'mdast';
-import React from 'react';
-import { HTMLReactParserOptions } from 'html-react-parser';
-import { Cacheable, CacheableMemory } from 'cacheable';
-import { KeyvStoreAdapter } from 'keyv';
-
-declare class WritrCache {
-    private _markdownStore;
-    private readonly _markdownStoreSync;
-    private readonly _hashStore;
-    get markdownStore(): Cacheable;
-    get markdownStoreSync(): CacheableMemory;
-    get hashStore(): CacheableMemory;
-    getMarkdown(markdown: string, options?: RenderOptions): Promise<string | undefined>;
-    getMarkdownSync(markdown: string, options?: RenderOptions): string | undefined;
-    setMarkdown(markdown: string, value: string, options?: RenderOptions): Promise<boolean>;
-    setMarkdownSync(markdown: string, value: string, options?: RenderOptions): boolean;
-    get(key: string): Promise<string | undefined>;
-    getSync(key: string): string | undefined;
-    set(key: string, value: string): Promise<boolean>;
-    setSync(key: string, value: string): boolean;
-    clear(): Promise<void>;
-    setStorageAdapter(adapter: KeyvStoreAdapter): void;
-    hash(markdown: string, options?: RenderOptions): string;
-}
-
-type WritrOptions = {
-    openai?: string;
-    renderOptions?: RenderOptions;
-};
-type RenderOptions = {
-    emoji?: boolean;
-    toc?: boolean;
-    slug?: boolean;
-    highlight?: boolean;
-    gfm?: boolean;
-    math?: boolean;
-    mdx?: boolean;
-    caching?: boolean;
-};
-declare class Writr {
-    engine: unified.Processor<mdast.Root, mdast.Root, hast.Root, hast.Root, string>;
-    private readonly _options;
-    private _content;
-    private readonly _cache;
-    constructor(arguments1?: string | WritrOptions, arguments2?: WritrOptions);
-    get options(): WritrOptions;
-    get content(): string;
-    set content(value: string);
-    get cache(): WritrCache;
-    get frontMatterRaw(): string;
-    get body(): string;
-    get markdown(): string;
-    get frontMatter(): Record<string, any>;
-    set frontMatter(data: Record<string, any>);
-    getFrontMatterValue<T>(key: string): T;
-    render(options?: RenderOptions): Promise<string>;
-    renderSync(options?: RenderOptions): string;
-    renderReact(options?: RenderOptions, reactParseOptions?: HTMLReactParserOptions): Promise<string | React.JSX.Element | React.JSX.Element[]>;
-    renderReactSync(options?: RenderOptions, reactParseOptions?: HTMLReactParserOptions): string | React.JSX.Element | React.JSX.Element[];
-    loadFromFile(filePath: string): Promise<void>;
-    loadFromFileSync(filePath: string): void;
-    saveToFile(filePath: string): Promise<void>;
-    saveToFileSync(filePath: string): void;
-    private isCacheEnabled;
-    private createProcessor;
-}
-
-export { type RenderOptions, Writr, type WritrOptions };