@haroonwaves/blog-kit-core 0.0.4

package/README.md

@@ -0,0 +1,35 @@
+# @haroonwaves/blog-kit-core
+
+Core utilities for parsing markdown blog files with frontmatter. Extract metadata, calculate reading
+time, and manage blog content in Node and React applications.
+
+## Installation
+
+```bash
+npm install @haroonwaves/blog-kit-core
+# or
+pnpm add @haroonwaves/blog-kit-core
+# or
+yarn add @haroonwaves/blog-kit-core
+```
+
+## Documentation
+
+For complete documentation, API reference, and examples, please visit the
+[main documentation](https://github.com/haroonwaves/blog-kit).
+
+## Quick Links
+
+- [Core Package Usage](https://github.com/haroonwaves/blog-kit#core-package)
+- [API Reference](https://github.com/haroonwaves/blog-kit#api-reference)
+- [Blog File Format](https://github.com/haroonwaves/blog-kit#blog-file-format)
+- [Type Definitions](https://github.com/haroonwaves/blog-kit#types)
+
+## Related Packages
+
+- [@haroonwaves/blog-kit-react](https://www.npmjs.com/package/@haroonwaves/blog-kit-react) - React
+  components for rendering blogs
+
+## License
+
+ISC

package/dist/index.cjs

@@ -0,0 +1,114 @@
+"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/index.ts
+var src_exports = {};
+__export(src_exports, {
+  extractBlog: () => extractBlog,
+  extractBlogMeta: () => extractBlogMeta,
+  getAllBlogsMeta: () => getAllBlogsMeta,
+  getBlog: () => getBlog
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/parser.ts
+var import_fs = __toESM(require("fs"), 1);
+var import_path = __toESM(require("path"), 1);
+var import_gray_matter = __toESM(require("gray-matter"), 1);
+var import_reading_time = __toESM(require("reading-time"), 1);
+function extractBlogMeta(content, slug) {
+  const { data, content: markdownContent } = (0, import_gray_matter.default)(content);
+  const readingTimeText = (0, import_reading_time.default)(markdownContent).text;
+  return {
+    slug,
+    ...data,
+    readingTime: readingTimeText
+  };
+}
+function extractBlog(content, slug) {
+  const { data, content: markdownContent } = (0, import_gray_matter.default)(content);
+  const readingTimeText = (0, import_reading_time.default)(markdownContent).text;
+  return {
+    metadata: {
+      ...data,
+      slug,
+      readingTime: readingTimeText
+    },
+    content: markdownContent,
+    readingTime: readingTimeText
+  };
+}
+function getAllBlogsMeta(config) {
+  const blogDirectory = import_path.default.join(config.contentDirectory, config.blogSubdirectory || "blog");
+  if (!import_fs.default.existsSync(blogDirectory)) {
+    console.warn(`Blog directory not found: ${blogDirectory}`);
+    return [];
+  }
+  const files = import_fs.default.readdirSync(blogDirectory);
+  const blogs = files.filter((file) => file.endsWith(".md")).map((file) => {
+    const slug = file.replace(".md", "");
+    const filePath = import_path.default.join(blogDirectory, file);
+    const fileContent = import_fs.default.readFileSync(filePath, "utf8");
+    const { data, content } = (0, import_gray_matter.default)(fileContent);
+    const readingTimeText = (0, import_reading_time.default)(content).text;
+    return {
+      slug,
+      ...data,
+      readingTime: readingTimeText
+    };
+  }).sort((a, b) => {
+    return new Date(b.date).getTime() - new Date(a.date).getTime();
+  });
+  return blogs;
+}
+function getBlog(slug, config) {
+  const blogDirectory = import_path.default.join(config.contentDirectory, config.blogSubdirectory || "blog");
+  const filePath = import_path.default.join(blogDirectory, `${slug}.md`);
+  if (!import_fs.default.existsSync(filePath)) {
+    return null;
+  }
+  const fileContent = import_fs.default.readFileSync(filePath, "utf8");
+  const { data, content } = (0, import_gray_matter.default)(fileContent);
+  const readingTimeText = (0, import_reading_time.default)(content).text;
+  return {
+    metadata: {
+      ...data,
+      slug
+    },
+    content,
+    readingTime: readingTimeText
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extractBlog,
+  extractBlogMeta,
+  getAllBlogsMeta,
+  getBlog
+});

package/dist/index.d.cts

@@ -0,0 +1,59 @@
+interface BlogMeta {
+    title: string;
+    description: string;
+    date: string;
+    category?: string;
+    slug: string;
+    readingTime: string;
+}
+interface Blog {
+    metadata: BlogMeta;
+    content: string;
+    readingTime: string;
+}
+interface BlogConfig {
+    contentDirectory: string;
+    blogSubdirectory?: string;
+}
+
+/**
+ * Client-side compatible: Extract blog metadata from raw markdown content.
+ * This function works in browser environments (pure React) where you have
+ * the markdown content as a string (e.g., fetched from an API or imported).
+ *
+ * @param content - Raw markdown content string
+ * @param slug - Blog post slug/identifier
+ * @returns Parsed blog metadata
+ */
+declare function extractBlogMeta(content: string, slug: string): BlogMeta;
+/**
+ * Client-side compatible: Extract blog data from raw markdown content.
+ * This function works in browser environments (pure React) where you have
+ * the markdown content as a string (e.g., fetched from an API or imported).
+ *
+ * @param content - Raw markdown content string
+ * @param slug - Blog post slug/identifier
+ * @returns Parsed blog data with metadata and content
+ */
+declare function extractBlog(content: string, slug: string): Blog;
+/**
+ * SSR and SSG only: Get all blogs metadata from the filesystem.
+ * This function requires Node.js fs module and only works in server environments
+ * (Next.js SSR/SSG, Node.js scripts, etc.).
+ *
+ * @param config - Blog kit configuration
+ * @returns Array of blog metadata
+ */
+declare function getAllBlogsMeta(config: BlogConfig): BlogMeta[];
+/**
+ * SSR and SSG only: Get blog from the filesystem.
+ * This function requires Node.js fs module and only works in server environments
+ * (Next.js SSR/SSG, Node.js scripts, etc.).
+ *
+ * @param slug - Blog post slug/identifier
+ * @param config - Blog kit configuration
+ * @returns Blog data or null if not found
+ */
+declare function getBlog(slug: string, config: BlogConfig): Blog | null;
+
+export { type Blog, type BlogConfig, type BlogMeta, extractBlog, extractBlogMeta, getAllBlogsMeta, getBlog };

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+interface BlogMeta {
+    title: string;
+    description: string;
+    date: string;
+    category?: string;
+    slug: string;
+    readingTime: string;
+}
+interface Blog {
+    metadata: BlogMeta;
+    content: string;
+    readingTime: string;
+}
+interface BlogConfig {
+    contentDirectory: string;
+    blogSubdirectory?: string;
+}
+
+/**
+ * Client-side compatible: Extract blog metadata from raw markdown content.
+ * This function works in browser environments (pure React) where you have
+ * the markdown content as a string (e.g., fetched from an API or imported).
+ *
+ * @param content - Raw markdown content string
+ * @param slug - Blog post slug/identifier
+ * @returns Parsed blog metadata
+ */
+declare function extractBlogMeta(content: string, slug: string): BlogMeta;
+/**
+ * Client-side compatible: Extract blog data from raw markdown content.
+ * This function works in browser environments (pure React) where you have
+ * the markdown content as a string (e.g., fetched from an API or imported).
+ *
+ * @param content - Raw markdown content string
+ * @param slug - Blog post slug/identifier
+ * @returns Parsed blog data with metadata and content
+ */
+declare function extractBlog(content: string, slug: string): Blog;
+/**
+ * SSR and SSG only: Get all blogs metadata from the filesystem.
+ * This function requires Node.js fs module and only works in server environments
+ * (Next.js SSR/SSG, Node.js scripts, etc.).
+ *
+ * @param config - Blog kit configuration
+ * @returns Array of blog metadata
+ */
+declare function getAllBlogsMeta(config: BlogConfig): BlogMeta[];
+/**
+ * SSR and SSG only: Get blog from the filesystem.
+ * This function requires Node.js fs module and only works in server environments
+ * (Next.js SSR/SSG, Node.js scripts, etc.).
+ *
+ * @param slug - Blog post slug/identifier
+ * @param config - Blog kit configuration
+ * @returns Blog data or null if not found
+ */
+declare function getBlog(slug: string, config: BlogConfig): Blog | null;
+
+export { type Blog, type BlogConfig, type BlogMeta, extractBlog, extractBlogMeta, getAllBlogsMeta, getBlog };

package/dist/index.js

@@ -0,0 +1,74 @@
+// src/parser.ts
+import fs from "fs";
+import path from "path";
+import matter from "gray-matter";
+import readingTime from "reading-time";
+function extractBlogMeta(content, slug) {
+  const { data, content: markdownContent } = matter(content);
+  const readingTimeText = readingTime(markdownContent).text;
+  return {
+    slug,
+    ...data,
+    readingTime: readingTimeText
+  };
+}
+function extractBlog(content, slug) {
+  const { data, content: markdownContent } = matter(content);
+  const readingTimeText = readingTime(markdownContent).text;
+  return {
+    metadata: {
+      ...data,
+      slug,
+      readingTime: readingTimeText
+    },
+    content: markdownContent,
+    readingTime: readingTimeText
+  };
+}
+function getAllBlogsMeta(config) {
+  const blogDirectory = path.join(config.contentDirectory, config.blogSubdirectory || "blog");
+  if (!fs.existsSync(blogDirectory)) {
+    console.warn(`Blog directory not found: ${blogDirectory}`);
+    return [];
+  }
+  const files = fs.readdirSync(blogDirectory);
+  const blogs = files.filter((file) => file.endsWith(".md")).map((file) => {
+    const slug = file.replace(".md", "");
+    const filePath = path.join(blogDirectory, file);
+    const fileContent = fs.readFileSync(filePath, "utf8");
+    const { data, content } = matter(fileContent);
+    const readingTimeText = readingTime(content).text;
+    return {
+      slug,
+      ...data,
+      readingTime: readingTimeText
+    };
+  }).sort((a, b) => {
+    return new Date(b.date).getTime() - new Date(a.date).getTime();
+  });
+  return blogs;
+}
+function getBlog(slug, config) {
+  const blogDirectory = path.join(config.contentDirectory, config.blogSubdirectory || "blog");
+  const filePath = path.join(blogDirectory, `${slug}.md`);
+  if (!fs.existsSync(filePath)) {
+    return null;
+  }
+  const fileContent = fs.readFileSync(filePath, "utf8");
+  const { data, content } = matter(fileContent);
+  const readingTimeText = readingTime(content).text;
+  return {
+    metadata: {
+      ...data,
+      slug
+    },
+    content,
+    readingTime: readingTimeText
+  };
+}
+export {
+  extractBlog,
+  extractBlogMeta,
+  getAllBlogsMeta,
+  getBlog
+};

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@haroonwaves/blog-kit-core",
+  "version": "0.0.4",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "gray-matter": "^4.0.3",
+    "reading-time": "^1.5.0"
+  },
+  "devDependencies": {
+    "tsup": "^7.2.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "type-check": "tsc --noEmit"
+  }
+}