@autumnsgrove/groveengine 0.6.1 → 0.6.3

package/dist/utils/gallery.d.ts

@@ -5,62 +5,88 @@
  * - minecraft/build_2024-12-01.png → category: minecraft, date: 2024-12-01
  * - selfies/2024-summer.jpg → category: selfies, slug: 2024-summer
  */
+/** Parsed metadata from an image filename */
+export interface ParsedImageMetadata {
+    category: string | null;
+    date: string | null;
+    slug: string;
+    filename: string;
+    extension: string | null;
+    r2Key: string;
+}
+/** Tag object associated with an image */
+export interface ImageTag {
+    slug: string;
+    name?: string;
+}
+/** Gallery image object */
+export interface GalleryImage {
+    r2_key?: string;
+    key?: string;
+    custom_title?: string;
+    custom_date?: string;
+    custom_description?: string;
+    parsed_slug?: string;
+    parsed_date?: string;
+    parsed_category?: string;
+    tags?: ImageTag[];
+}
 /**
  * Parse a filename to extract metadata
- * @param {string} r2Key - R2 object key (e.g., 'minecraft/build.png' or '2025-01-15_photo.jpg')
- * @returns {Object} Parsed metadata: { category, date, slug, filename, extension }
+ * @param r2Key - R2 object key (e.g., 'minecraft/build.png' or '2025-01-15_photo.jpg')
+ * @returns Parsed metadata: { category, date, slug, filename, extension }
  */
-export function parseImageFilename(r2Key: string): Object;
+export declare function parseImageFilename(r2Key: string): ParsedImageMetadata;
 /**
  * Get display title for an image (uses custom title or parsed slug)
- * @param {Object} image - Gallery image object
- * @returns {string} Human-readable title
+ * @param image - Gallery image object
+ * @returns Human-readable title
  */
-export function getImageTitle(image: Object): string;
+export declare function getImageTitle(image: GalleryImage): string;
 /**
  * Get display date for an image (uses custom date or parsed date)
- * @param {Object} image - Gallery image object
- * @returns {string|null} YYYY-MM-DD date string or null
+ * @param image - Gallery image object
+ * @returns YYYY-MM-DD date string or null
  */
-export function getImageDate(image: Object): string | null;
+export declare function getImageDate(image: GalleryImage): string | null;
 /**
  * Filter images by search query (searches title, slug, filename)
- * @param {Array} images - Array of gallery images
- * @param {string} query - Search query
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images
+ * @param query - Search query
+ * @returns Filtered images
  */
-export function searchImages(images: any[], query: string): any[];
+export declare function searchImages(images: GalleryImage[], query: string): GalleryImage[];
 /**
  * Filter images by date range
- * @param {Array} images - Array of gallery images
- * @param {string|null} startDate - YYYY-MM-DD start date (inclusive)
- * @param {string|null} endDate - YYYY-MM-DD end date (inclusive)
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images
+ * @param startDate - YYYY-MM-DD start date (inclusive)
+ * @param endDate - YYYY-MM-DD end date (inclusive)
+ * @returns Filtered images
  */
-export function filterImagesByDateRange(images: any[], startDate: string | null, endDate: string | null): any[];
+export declare function filterImagesByDateRange(images: GalleryImage[], startDate: string | null, endDate: string | null): GalleryImage[];
 /**
  * Filter images by tags
- * @param {Array} images - Array of gallery images (must include 'tags' array)
- * @param {Array} tagSlugs - Array of tag slugs to filter by
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images (must include 'tags' array)
+ * @param tagSlugs - Array of tag slugs to filter by
+ * @returns Filtered images
  */
-export function filterImagesByTags(images: any[], tagSlugs: any[]): any[];
+export declare function filterImagesByTags(images: GalleryImage[], tagSlugs: string[]): GalleryImage[];
 /**
  * Filter images by category (parsed from path)
- * @param {Array} images - Array of gallery images
- * @param {string|null} category - Category to filter by
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images
+ * @param category - Category to filter by
+ * @returns Filtered images
  */
-export function filterImagesByCategory(images: any[], category: string | null): any[];
+export declare function filterImagesByCategory(images: GalleryImage[], category: string | null): GalleryImage[];
 /**
  * Extract unique years from image dates
- * @param {Array} images - Array of gallery images
- * @returns {Array} Sorted array of years (descending)
+ * @param images - Array of gallery images
+ * @returns Sorted array of years (descending)
  */
-export function getAvailableYears(images: any[]): any[];
+export declare function getAvailableYears(images: GalleryImage[]): string[];
 /**
  * Extract unique categories from images
- * @param {Array} images - Array of gallery images
- * @returns {Array} Sorted array of categories
+ * @param images - Array of gallery images
+ * @returns Sorted array of categories
  */
-export function getAvailableCategories(images: any[]): any[];
+export declare function getAvailableCategories(images: GalleryImage[]): string[];

package/dist/utils/gallery.js

@@ -5,177 +5,159 @@
  * - minecraft/build_2024-12-01.png → category: minecraft, date: 2024-12-01
  * - selfies/2024-summer.jpg → category: selfies, slug: 2024-summer
  */
-
 /**
  * Parse a filename to extract metadata
- * @param {string} r2Key - R2 object key (e.g., 'minecraft/build.png' or '2025-01-15_photo.jpg')
- * @returns {Object} Parsed metadata: { category, date, slug, filename, extension }
+ * @param r2Key - R2 object key (e.g., 'minecraft/build.png' or '2025-01-15_photo.jpg')
+ * @returns Parsed metadata: { category, date, slug, filename, extension }
  */
 export function parseImageFilename(r2Key) {
-	const parts = r2Key.split('/');
-	const filename = parts[parts.length - 1];
-	const category = parts.length > 1 ? parts[0] : null;
-
-	// Extract extension
-	const extMatch = filename.match(/\.([^.]+)$/);
-	const extension = extMatch ? extMatch[1] : null;
-	const nameWithoutExt = filename.replace(/\.[^.]+$/, '');
-
-	// Try to extract date (YYYY-MM-DD or YYYY_MM_DD)
-	const dateMatch = nameWithoutExt.match(/(\d{4}[-_]\d{2}[-_]\d{2})/);
-	const date = dateMatch ? dateMatch[1].replace(/_/g, '-') : null;
-
-	// Extract slug (remove date prefix if present)
-	let slug = nameWithoutExt;
-	if (date) {
-		slug = slug.replace(date, '').replace(/^[-_]+/, '').replace(/[-_]+$/, '');
-	}
-
-	// Clean up slug (convert underscores to hyphens)
-	slug = slug.replace(/_/g, '-').toLowerCase();
-
-	return {
-		category,
-		date,
-		slug: slug || 'untitled',
-		filename,
-		extension,
-		r2Key
-	};
+    const parts = r2Key.split("/");
+    const filename = parts[parts.length - 1];
+    const category = parts.length > 1 ? parts[0] : null;
+    // Extract extension
+    const extMatch = filename.match(/\.([^.]+)$/);
+    const extension = extMatch ? extMatch[1] : null;
+    const nameWithoutExt = filename.replace(/\.[^.]+$/, "");
+    // Try to extract date (YYYY-MM-DD or YYYY_MM_DD)
+    const dateMatch = nameWithoutExt.match(/(\d{4}[-_]\d{2}[-_]\d{2})/);
+    const date = dateMatch ? dateMatch[1].replace(/_/g, "-") : null;
+    // Extract slug (remove date prefix if present)
+    let slug = nameWithoutExt;
+    if (date) {
+        slug = slug.replace(date, "").replace(/^[-_]+/, "").replace(/[-_]+$/, "");
+    }
+    // Clean up slug (convert underscores to hyphens)
+    slug = slug.replace(/_/g, "-").toLowerCase();
+    return {
+        category,
+        date,
+        slug: slug || "untitled",
+        filename,
+        extension,
+        r2Key,
+    };
 }
-
 /**
  * Get display title for an image (uses custom title or parsed slug)
- * @param {Object} image - Gallery image object
- * @returns {string} Human-readable title
+ * @param image - Gallery image object
+ * @returns Human-readable title
  */
 export function getImageTitle(image) {
-	if (image.custom_title) return image.custom_title;
-	if (image.parsed_slug) {
-		// Convert slug to Title Case
-		return image.parsed_slug
-			.split('-')
-			.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
-			.join(' ');
-	}
-	return image.r2_key?.split('/').pop() || image.key?.split('/').pop() || 'Untitled';
+    if (image.custom_title)
+        return image.custom_title;
+    if (image.parsed_slug) {
+        // Convert slug to Title Case
+        return image.parsed_slug
+            .split("-")
+            .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+            .join(" ");
+    }
+    return image.r2_key?.split("/").pop() || image.key?.split("/").pop() || "Untitled";
 }
-
 /**
  * Get display date for an image (uses custom date or parsed date)
- * @param {Object} image - Gallery image object
- * @returns {string|null} YYYY-MM-DD date string or null
+ * @param image - Gallery image object
+ * @returns YYYY-MM-DD date string or null
  */
 export function getImageDate(image) {
-	return image.custom_date || image.parsed_date || null;
+    return image.custom_date || image.parsed_date || null;
 }
-
 /**
  * Filter images by search query (searches title, slug, filename)
- * @param {Array} images - Array of gallery images
- * @param {string} query - Search query
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images
+ * @param query - Search query
+ * @returns Filtered images
  */
 export function searchImages(images, query) {
-	if (!query) return images;
-
-	const lowerQuery = query.toLowerCase();
-
-	return images.filter((img) => {
-		const title = getImageTitle(img).toLowerCase();
-		const slug = (img.parsed_slug || '').toLowerCase();
-		const filename = (img.r2_key || img.key || '').toLowerCase();
-		const description = (img.custom_description || '').toLowerCase();
-
-		return (
-			title.includes(lowerQuery) ||
-			slug.includes(lowerQuery) ||
-			filename.includes(lowerQuery) ||
-			description.includes(lowerQuery)
-		);
-	});
+    if (!query)
+        return images;
+    const lowerQuery = query.toLowerCase();
+    return images.filter((img) => {
+        const title = getImageTitle(img).toLowerCase();
+        const slug = (img.parsed_slug || "").toLowerCase();
+        const filename = (img.r2_key || img.key || "").toLowerCase();
+        const description = (img.custom_description || "").toLowerCase();
+        return (title.includes(lowerQuery) ||
+            slug.includes(lowerQuery) ||
+            filename.includes(lowerQuery) ||
+            description.includes(lowerQuery));
+    });
 }
-
 /**
  * Filter images by date range
- * @param {Array} images - Array of gallery images
- * @param {string|null} startDate - YYYY-MM-DD start date (inclusive)
- * @param {string|null} endDate - YYYY-MM-DD end date (inclusive)
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images
+ * @param startDate - YYYY-MM-DD start date (inclusive)
+ * @param endDate - YYYY-MM-DD end date (inclusive)
+ * @returns Filtered images
  */
 export function filterImagesByDateRange(images, startDate, endDate) {
-	if (!startDate && !endDate) return images;
-
-	return images.filter((img) => {
-		const imgDate = getImageDate(img);
-		if (!imgDate) return false;
-
-		if (startDate && imgDate < startDate) return false;
-		if (endDate && imgDate > endDate) return false;
-
-		return true;
-	});
+    if (!startDate && !endDate)
+        return images;
+    return images.filter((img) => {
+        const imgDate = getImageDate(img);
+        if (!imgDate)
+            return false;
+        if (startDate && imgDate < startDate)
+            return false;
+        if (endDate && imgDate > endDate)
+            return false;
+        return true;
+    });
 }
-
 /**
  * Filter images by tags
- * @param {Array} images - Array of gallery images (must include 'tags' array)
- * @param {Array} tagSlugs - Array of tag slugs to filter by
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images (must include 'tags' array)
+ * @param tagSlugs - Array of tag slugs to filter by
+ * @returns Filtered images
  */
 export function filterImagesByTags(images, tagSlugs) {
-	if (!tagSlugs || tagSlugs.length === 0) return images;
-
-	return images.filter((img) => {
-		if (!img.tags || img.tags.length === 0) return false;
-		const imgTagSlugs = img.tags.map((t) => t.slug);
-		return tagSlugs.every((slug) => imgTagSlugs.includes(slug));
-	});
+    if (!tagSlugs || tagSlugs.length === 0)
+        return images;
+    return images.filter((img) => {
+        if (!img.tags || img.tags.length === 0)
+            return false;
+        const imgTagSlugs = img.tags.map((t) => t.slug);
+        return tagSlugs.every((slug) => imgTagSlugs.includes(slug));
+    });
 }
-
 /**
  * Filter images by category (parsed from path)
- * @param {Array} images - Array of gallery images
- * @param {string|null} category - Category to filter by
- * @returns {Array} Filtered images
+ * @param images - Array of gallery images
+ * @param category - Category to filter by
+ * @returns Filtered images
  */
 export function filterImagesByCategory(images, category) {
-	if (!category) return images;
-	return images.filter((img) => img.parsed_category === category);
+    if (!category)
+        return images;
+    return images.filter((img) => img.parsed_category === category);
 }
-
 /**
  * Extract unique years from image dates
- * @param {Array} images - Array of gallery images
- * @returns {Array} Sorted array of years (descending)
+ * @param images - Array of gallery images
+ * @returns Sorted array of years (descending)
  */
 export function getAvailableYears(images) {
-	const years = new Set();
-
-	images.forEach((img) => {
-		const date = getImageDate(img);
-		if (date) {
-			const year = date.substring(0, 4);
-			years.add(year);
-		}
-	});
-
-	return Array.from(years).sort((a, b) => b.localeCompare(a));
+    const years = new Set();
+    images.forEach((img) => {
+        const date = getImageDate(img);
+        if (date) {
+            const year = date.substring(0, 4);
+            years.add(year);
+        }
+    });
+    return Array.from(years).sort((a, b) => b.localeCompare(a));
 }
-
 /**
  * Extract unique categories from images
- * @param {Array} images - Array of gallery images
- * @returns {Array} Sorted array of categories
+ * @param images - Array of gallery images
+ * @returns Sorted array of categories
  */
 export function getAvailableCategories(images) {
-	const categories = new Set();
-
-	images.forEach((img) => {
-		if (img.parsed_category) {
-			categories.add(img.parsed_category);
-		}
-	});
-
-	return Array.from(categories).sort();
+    const categories = new Set();
+    images.forEach((img) => {
+        if (img.parsed_category) {
+            categories.add(img.parsed_category);
+        }
+    });
+    return Array.from(categories).sort();
 }

package/dist/utils/gutter.d.ts

@@ -5,50 +5,71 @@
  * and anchor resolution. Used by ContentWithGutter component and related
  * functionality across the site.
  */
+/** Anchor types supported by the gutter system */
+export type AnchorType = "none" | "paragraph" | "tag" | "header";
+/** Parsed anchor result */
+export interface ParsedAnchor {
+    type: AnchorType;
+    value: string | number | null;
+}
+/** Header object from markdown parsing */
+export interface Header {
+    id: string;
+    text: string;
+    level?: number;
+}
+/** Gutter item with anchor */
+export interface GutterItem {
+    anchor?: string;
+    type?: string;
+    content?: string;
+    src?: string;
+    [key: string]: unknown;
+}
 /**
  * Parse anchor string to determine anchor type and value
- * @param {string} anchor - The anchor string from manifest
- * @returns {Object} Object with type and value properties
+ * @param anchor - The anchor string from manifest
+ * @returns Object with type and value properties
  */
-export function parseAnchor(anchor: string): Object;
+export declare function parseAnchor(anchor: string | undefined | null): ParsedAnchor;
 /**
  * Generate a unique key for an anchor (used for grouping and positioning)
- * @param {string} anchor - The anchor string
- * @param {Array} headers - Array of header objects with id and text
- * @returns {string} A unique key for the anchor
+ * @param anchor - The anchor string
+ * @param headers - Array of header objects with id and text
+ * @returns A unique key for the anchor
  */
-export function getAnchorKey(anchor: string, headers?: any[]): string;
+export declare function getAnchorKey(anchor: string, headers?: Header[]): string;
 /**
  * Get all unique anchors from items (preserving order)
- * @param {Array} items - Array of gutter items
- * @returns {Array} Array of unique anchor strings
+ * @param items - Array of gutter items
+ * @returns Array of unique anchor strings
  */
-export function getUniqueAnchors(items: any[]): any[];
+export declare function getUniqueAnchors(items: GutterItem[] | undefined | null): string[];
 /**
  * Get display label for an anchor (used in overflow section)
- * @param {string} anchor - The anchor string
- * @returns {string} Human-readable label for the anchor
+ * @param anchor - The anchor string
+ * @returns Human-readable label for the anchor
  */
-export function getAnchorLabel(anchor: string): string;
+export declare function getAnchorLabel(anchor: string): string;
 /**
  * Get items that match a specific anchor
- * @param {Array} items - Array of gutter items
- * @param {string} anchor - The anchor to match
- * @returns {Array} Items matching the anchor
+ * @param items - Array of gutter items
+ * @param anchor - The anchor to match
+ * @returns Items matching the anchor
  */
-export function getItemsForAnchor(items: any[], anchor: string): any[];
+export declare function getItemsForAnchor(items: GutterItem[] | undefined | null, anchor: string): GutterItem[];
 /**
  * Get items that don't have a valid anchor (orphan items shown at top)
- * @param {Array} items - Array of gutter items
- * @param {Array} headers - Array of header objects
- * @returns {Array} Items without valid anchors
+ * @param items - Array of gutter items
+ * @param headers - Array of header objects
+ * @returns Items without valid anchors
  */
-export function getOrphanItems(items: any[], headers?: any[]): any[];
+export declare function getOrphanItems(items: GutterItem[] | undefined | null, headers?: Header[]): GutterItem[];
 /**
  * Find the DOM element for an anchor within a content element
- * @param {string} anchor - The anchor string
- * @param {HTMLElement} contentEl - The content container element
- * @param {Array} headers - Array of header objects
- * @returns {HTMLElement|null} The DOM element or null if not found
+ * @param anchor - The anchor string
+ * @param contentEl - The content container element
+ * @param headers - Array of header objects
+ * @returns The DOM element or null if not found
  */
-export function findAnchorElement(anchor: string, contentEl: HTMLElement, headers?: any[]): HTMLElement | null;
+export declare function findAnchorElement(anchor: string, contentEl: HTMLElement | null, headers?: Header[]): HTMLElement | null;