bunki 0.7.1 → 0.9.0

package/dist/utils/json-ld.d.ts

@@ -0,0 +1,205 @@
+/**
+ * JSON-LD (JavaScript Object Notation for Linked Data) utility functions
+ * for generating structured data markup for SEO optimization.
+ *
+ * This module provides functions to generate Schema.org structured data
+ * in JSON-LD format, which helps search engines better understand your content.
+ *
+ * Supported schema types:
+ * - BlogPosting: For individual blog posts/articles
+ * - WebSite: For the homepage/website metadata
+ * - BreadcrumbList: For navigation breadcrumbs
+ * - Organization: For publisher/organization information
+ * - Person: For author information
+ *
+ * @see https://schema.org/
+ * @see https://developers.google.com/search/docs/appearance/structured-data/intro-structured-data
+ */
+import type { Post, SiteConfig } from "../types.js";
+/**
+ * Base Schema.org Thing type
+ */
+interface SchemaOrgThing {
+    "@context": "https://schema.org";
+    "@type": string;
+    [key: string]: any;
+}
+/**
+ * Options for generating BlogPosting JSON-LD
+ */
+export interface BlogPostingOptions {
+    /** The post object */
+    post: Post;
+    /** Site configuration */
+    site: SiteConfig;
+    /** Optional image URL for the post (first image extracted from content) */
+    imageUrl?: string;
+    /** Optional date modified (defaults to date published) */
+    dateModified?: string;
+}
+/**
+ * Options for generating WebSite JSON-LD
+ */
+export interface WebSiteOptions {
+    /** Site configuration */
+    site: SiteConfig;
+}
+/**
+ * Options for generating BreadcrumbList JSON-LD
+ */
+export interface BreadcrumbListOptions {
+    /** Site configuration */
+    site: SiteConfig;
+    /** Current post (optional, for post pages) */
+    post?: Post;
+    /** Custom breadcrumb items */
+    items?: Array<{
+        name: string;
+        url: string;
+    }>;
+}
+/**
+ * Generates a Person schema for author information
+ *
+ * @param name - Author's name
+ * @param email - Author's email (optional)
+ * @returns Person schema object
+ *
+ * @example
+ * const author = generatePersonSchema("John Doe", "john@example.com");
+ * // Returns: { "@type": "Person", "name": "John Doe", "email": "john@example.com" }
+ */
+export declare function generatePersonSchema(name: string, email?: string): SchemaOrgThing;
+/**
+ * Generates an Organization schema for publisher information
+ *
+ * @param site - Site configuration
+ * @returns Organization schema object
+ *
+ * @example
+ * const org = generateOrganizationSchema({ title: "My Blog", baseUrl: "https://example.com" });
+ * // Returns: { "@type": "Organization", "name": "My Blog", "url": "https://example.com" }
+ */
+export declare function generateOrganizationSchema(site: SiteConfig): SchemaOrgThing;
+/**
+ * Generates BlogPosting structured data for a blog post
+ *
+ * This is the primary schema for individual blog posts/articles.
+ * It provides search engines with detailed information about the post
+ * including title, author, publication date, content, and more.
+ *
+ * @param options - BlogPosting generation options
+ * @returns BlogPosting schema as JSON-LD object
+ *
+ * @example
+ * const jsonLd = generateBlogPostingSchema({
+ *   post: { title: "Hello World", date: "2025-01-15T10:00:00Z", ... },
+ *   site: { title: "My Blog", baseUrl: "https://example.com", ... }
+ * });
+ *
+ * @see https://schema.org/BlogPosting
+ */
+export declare function generateBlogPostingSchema(options: BlogPostingOptions): SchemaOrgThing;
+/**
+ * Generates WebSite structured data for the homepage
+ *
+ * This schema provides search engines with information about the website
+ * itself, including name, description, and URL.
+ *
+ * @param options - WebSite generation options
+ * @returns WebSite schema as JSON-LD object
+ *
+ * @example
+ * const jsonLd = generateWebSiteSchema({
+ *   site: { title: "My Blog", baseUrl: "https://example.com", description: "..." }
+ * });
+ *
+ * @see https://schema.org/WebSite
+ */
+export declare function generateWebSiteSchema(options: WebSiteOptions): SchemaOrgThing;
+/**
+ * Generates BreadcrumbList structured data for navigation
+ *
+ * Breadcrumbs help search engines understand the site's hierarchy
+ * and can appear in search results.
+ *
+ * @param options - BreadcrumbList generation options
+ * @returns BreadcrumbList schema as JSON-LD object
+ *
+ * @example
+ * // For a blog post
+ * const jsonLd = generateBreadcrumbListSchema({
+ *   site: { title: "My Blog", baseUrl: "https://example.com" },
+ *   post: { title: "Hello World", url: "/2025/hello-world/" }
+ * });
+ *
+ * @see https://schema.org/BreadcrumbList
+ */
+export declare function generateBreadcrumbListSchema(options: BreadcrumbListOptions): SchemaOrgThing;
+/**
+ * Converts a JSON-LD object to an HTML script tag string
+ *
+ * This helper function serializes the JSON-LD object and wraps it
+ * in a script tag for inclusion in HTML templates.
+ *
+ * @param jsonLd - The JSON-LD object to convert
+ * @returns HTML script tag string
+ *
+ * @example
+ * const schema = generateBlogPostingSchema({ ... });
+ * const scriptTag = toScriptTag(schema);
+ * // Returns: '<script type="application/ld+json">{"@context":"https://schema.org",...}</script>'
+ */
+export declare function toScriptTag(jsonLd: SchemaOrgThing): string;
+/**
+ * Extracts the first image URL from HTML content
+ *
+ * Searches for the first <img> tag in HTML content and returns its src attribute.
+ * This is useful for automatically finding a representative image for BlogPosting schema.
+ *
+ * @param html - HTML content to search
+ * @param baseUrl - Base URL to prepend to relative image URLs
+ * @returns Full image URL or undefined if no image found
+ *
+ * @example
+ * const imageUrl = extractFirstImageUrl(
+ *   '<p>Text</p><img src="/img/photo.jpg" alt="Photo">',
+ *   'https://example.com'
+ * );
+ * // Returns: 'https://example.com/img/photo.jpg'
+ */
+export declare function extractFirstImageUrl(html: string, baseUrl: string): string | undefined;
+/**
+ * Generates multiple JSON-LD schemas for a blog post page
+ *
+ * This is a convenience function that generates all relevant schemas
+ * for a typical blog post page: BlogPosting, BreadcrumbList, and Organization.
+ *
+ * @param options - BlogPosting generation options
+ * @returns Array of JSON-LD schemas
+ *
+ * @example
+ * const schemas = generatePostPageSchemas({
+ *   post: { ... },
+ *   site: { ... }
+ * });
+ * // Returns: [BlogPosting, BreadcrumbList]
+ */
+export declare function generatePostPageSchemas(options: BlogPostingOptions): SchemaOrgThing[];
+/**
+ * Generates multiple JSON-LD schemas for the homepage
+ *
+ * This is a convenience function that generates all relevant schemas
+ * for the homepage: WebSite and Organization.
+ *
+ * @param options - WebSite generation options
+ * @returns Array of JSON-LD schemas
+ *
+ * @example
+ * const schemas = generateHomePageSchemas({
+ *   site: { title: "My Blog", baseUrl: "https://example.com", ... }
+ * });
+ * // Returns: [WebSite, Organization]
+ */
+export declare function generateHomePageSchemas(options: WebSiteOptions): SchemaOrgThing[];
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunki",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "description": "An opinionated static site generator built with Bun featuring PostCSS integration and modern web development workflows",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -50,8 +50,8 @@
     "commander": "^14.0.2",
     "gray-matter": "^4.0.3",
     "highlight.js": "^11.11.1",
-    "marked": "^16.4.1",
-    "marked-highlight": "^2.2.2",
+    "marked": "^17.0.1",
+    "marked-highlight": "^2.2.3",
     "nunjucks": "^3.2.4",
     "postcss": "^8.5.6",
     "postcss-cli": "^11.0.1",
@@ -59,15 +59,15 @@
     "slugify": "^1.6.6"
   },
   "devDependencies": {
-    "@tailwindcss/postcss": "^4.1.16",
+    "@tailwindcss/postcss": "^4.1.18",
     "@types/nunjucks": "^3.2.6",
     "@types/sanitize-html": "^2.16.0",
-    "autoprefixer": "^10.4.21",
-    "bun-types": "^1.3.1",
+    "autoprefixer": "^10.4.23",
+    "bun-types": "^1.3.5",
     "husky": "^9.1.7",
-    "lint-staged": "^16.2.6",
-    "prettier": "^3.6.2",
-    "tailwindcss": "^4.1.16",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.4",
+    "tailwindcss": "^4.1.18",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
@@ -84,7 +84,7 @@
     "README.md"
   ],
   "engines": {
-    "bun": ">=1.3.0",
+    "bun": ">=1.3.2",
     "node": ">=18.0.0"
   },
   "engineStrict": true,