@haroonwaves/blog-kit-core 1.3.1 → 2.0.0

package/README.md

@@ -20,8 +20,7 @@ For complete documentation, API reference, and examples, please visit the
 
 ## Quick Links
 
-- [Quick Start](https://blog-kit.haroonwaves.com/docs/quick-start)
-- [Core Package Usage](https://blog-kit.haroonwaves.com/docs/core-package)
+- [Getting Started](https://blog-kit.haroonwaves.com/docs/getting-started)
 - [API Reference](https://blog-kit.haroonwaves.com/docs/api-reference)
 
 ## Related Packages

package/dist/index.cjs

@@ -30,8 +30,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  getAllBlogsMeta: () => getAllBlogsMeta,
-  getBlog: () => getBlog
+  getAllContentMeta: () => getAllContentMeta,
+  getContent: () => getContent
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -40,16 +40,16 @@ 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 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}`);
+function getAllContentMeta(config) {
+  const contentDirectory = import_path.default.join(config.contentDirectory, config.contentSubdirectory || "blog");
+  if (!import_fs.default.existsSync(contentDirectory)) {
+    console.warn(`Content directory not found: ${contentDirectory}`);
     return [];
   }
-  const files = import_fs.default.readdirSync(blogDirectory);
-  const blogs = files.filter((file) => file.endsWith(".md")).map((file) => {
+  const files = import_fs.default.readdirSync(contentDirectory);
+  const allContent = files.filter((file) => file.endsWith(".md")).map((file) => {
     const slug = file.replace(".md", "");
-    const filePath = import_path.default.join(blogDirectory, file);
+    const filePath = import_path.default.join(contentDirectory, 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;
@@ -61,11 +61,11 @@ function getAllBlogsMeta(config) {
   }).sort((a, b) => {
     return new Date(b.date).getTime() - new Date(a.date).getTime();
   });
-  return blogs;
+  return allContent;
 }
-function getBlog(slug, config) {
-  const blogDirectory = import_path.default.join(config.contentDirectory, config.blogSubdirectory || "blog");
-  const filePath = import_path.default.join(blogDirectory, `${slug}.md`);
+function getContent(slug, config) {
+  const contentDirectory = import_path.default.join(config.contentDirectory, config.contentSubdirectory || "blog");
+  const filePath = import_path.default.join(contentDirectory, `${slug}.md`);
   if (!import_fs.default.existsSync(filePath)) {
     return null;
   }
@@ -78,11 +78,11 @@ function getBlog(slug, config) {
       slug,
       readingTime: readingTimeText
     },
-    content
+    body: content
   };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getAllBlogsMeta,
-  getBlog
+  getAllContentMeta,
+  getContent
 });

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-interface BlogMeta {
+interface ContentMeta {
     title: string;
     description: string;
     date: string;
@@ -6,33 +6,33 @@ interface BlogMeta {
     slug: string;
     readingTime: string;
 }
-interface Blog {
-    metadata: BlogMeta;
-    content: string;
+interface Content {
+    metadata: ContentMeta;
+    body: string;
 }
-interface BlogConfig {
+interface ContentConfig {
     contentDirectory: string;
-    blogSubdirectory?: string;
+    contentSubdirectory?: string;
 }
 
 /**
- * SSR and SSG only: Get all blogs metadata from the filesystem.
+ * SSR and SSG only: Get all content 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
+ * @param config - Content kit configuration
+ * @returns Array of content metadata
  */
-declare function getAllBlogsMeta(config: BlogConfig): BlogMeta[];
+declare function getAllContentMeta(config: ContentConfig): ContentMeta[];
 /**
- * SSR and SSG only: Get blog from the filesystem.
+ * SSR and SSG only: Get content 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
+ * @param slug - Content slug/identifier
+ * @param config - Content kit configuration
+ * @returns Content data or null if not found
  */
-declare function getBlog(slug: string, config: BlogConfig): Blog | null;
+declare function getContent(slug: string, config: ContentConfig): Content | null;
 
-export { type Blog, type BlogConfig, type BlogMeta, getAllBlogsMeta, getBlog };
+export { type Content, type ContentConfig, type ContentMeta, getAllContentMeta, getContent };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-interface BlogMeta {
+interface ContentMeta {
     title: string;
     description: string;
     date: string;
@@ -6,33 +6,33 @@ interface BlogMeta {
     slug: string;
     readingTime: string;
 }
-interface Blog {
-    metadata: BlogMeta;
-    content: string;
+interface Content {
+    metadata: ContentMeta;
+    body: string;
 }
-interface BlogConfig {
+interface ContentConfig {
     contentDirectory: string;
-    blogSubdirectory?: string;
+    contentSubdirectory?: string;
 }
 
 /**
- * SSR and SSG only: Get all blogs metadata from the filesystem.
+ * SSR and SSG only: Get all content 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
+ * @param config - Content kit configuration
+ * @returns Array of content metadata
  */
-declare function getAllBlogsMeta(config: BlogConfig): BlogMeta[];
+declare function getAllContentMeta(config: ContentConfig): ContentMeta[];
 /**
- * SSR and SSG only: Get blog from the filesystem.
+ * SSR and SSG only: Get content 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
+ * @param slug - Content slug/identifier
+ * @param config - Content kit configuration
+ * @returns Content data or null if not found
  */
-declare function getBlog(slug: string, config: BlogConfig): Blog | null;
+declare function getContent(slug: string, config: ContentConfig): Content | null;
 
-export { type Blog, type BlogConfig, type BlogMeta, getAllBlogsMeta, getBlog };
+export { type Content, type ContentConfig, type ContentMeta, getAllContentMeta, getContent };

package/dist/index.js

@@ -3,16 +3,16 @@ import fs from "fs";
 import path from "path";
 import matter from "gray-matter";
 import readingTime from "reading-time";
-function getAllBlogsMeta(config) {
-  const blogDirectory = path.join(config.contentDirectory, config.blogSubdirectory || "blog");
-  if (!fs.existsSync(blogDirectory)) {
-    console.warn(`Blog directory not found: ${blogDirectory}`);
+function getAllContentMeta(config) {
+  const contentDirectory = path.join(config.contentDirectory, config.contentSubdirectory || "blog");
+  if (!fs.existsSync(contentDirectory)) {
+    console.warn(`Content directory not found: ${contentDirectory}`);
     return [];
   }
-  const files = fs.readdirSync(blogDirectory);
-  const blogs = files.filter((file) => file.endsWith(".md")).map((file) => {
+  const files = fs.readdirSync(contentDirectory);
+  const allContent = files.filter((file) => file.endsWith(".md")).map((file) => {
     const slug = file.replace(".md", "");
-    const filePath = path.join(blogDirectory, file);
+    const filePath = path.join(contentDirectory, file);
     const fileContent = fs.readFileSync(filePath, "utf8");
     const { data, content } = matter(fileContent);
     const readingTimeText = readingTime(content).text;
@@ -24,11 +24,11 @@ function getAllBlogsMeta(config) {
   }).sort((a, b) => {
     return new Date(b.date).getTime() - new Date(a.date).getTime();
   });
-  return blogs;
+  return allContent;
 }
-function getBlog(slug, config) {
-  const blogDirectory = path.join(config.contentDirectory, config.blogSubdirectory || "blog");
-  const filePath = path.join(blogDirectory, `${slug}.md`);
+function getContent(slug, config) {
+  const contentDirectory = path.join(config.contentDirectory, config.contentSubdirectory || "blog");
+  const filePath = path.join(contentDirectory, `${slug}.md`);
   if (!fs.existsSync(filePath)) {
     return null;
   }
@@ -41,10 +41,10 @@ function getBlog(slug, config) {
       slug,
       readingTime: readingTimeText
     },
-    content
+    body: content
   };
 }
 export {
-  getAllBlogsMeta,
-  getBlog
+  getAllContentMeta,
+  getContent
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haroonwaves/blog-kit-core",
-  "version": "1.3.1",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",