@fullstackdatasolutions/articles 0.10.0 → 0.12.0

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ComponentType } from 'react';
 
 interface TocItem {
     id: string;
@@ -135,6 +136,8 @@ interface HeroConfig {
 }
 /** Controls how article body links set target/rel attributes. */
 type LinkTargetStrategy = 'external-new-tab' | 'all-new-tab' | 'same-tab';
+/** React components that article MDX bodies can reference by JSX tag name. */
+type MdxComponents = Record<string, ComponentType<never>>;
 type ArticleBreadcrumbToken = 'home' | 'articles' | 'primaryCategory' | 'folderPath' | 'articleTitle';
 type CategoryBreadcrumbToken = 'home' | 'articles' | 'category';
 type AuthorBreadcrumbToken = 'home' | 'articles' | 'authors' | 'authorName';
@@ -213,6 +216,8 @@ interface ArticlesConfig {
     breadcrumbs?: false | BreadcrumbsConfig;
     /** Article body link target behavior. Default: `'external-new-tab'`. */
     linkTargetStrategy?: LinkTargetStrategy;
+    /** Extra components exposed to article MDX bodies by JSX tag name. */
+    mdxComponents?: MdxComponents;
 }
 declare const DEFAULT_PAGE_SIZE = 6;
 declare const DEFAULT_CATEGORIES_PAGE_SIZE = 8;
@@ -220,8 +225,10 @@ declare const DEFAULT_LAYOUT: ArticlesSection[];
 declare function breadcrumbsAreEnabled(config: ArticlesConfig): boolean;
 declare function getBreadcrumbsConfig(config: ArticlesConfig): BreadcrumbsConfig;
 
-declare function ArticlesPage({ config }: Readonly<{
+declare function ArticlesPage({ config, initialArticles, initialCategories, }: Readonly<{
     config: ArticlesConfig;
+    initialArticles?: Article[];
+    initialCategories?: CategoryInfo[];
 }>): react_jsx_runtime.JSX.Element;
 
 type ArticleCardProps = Readonly<{
@@ -442,6 +449,6 @@ interface UseArticlesReturn {
     error: string | null;
     handleSearch: (query: string) => void;
 }
-declare function useArticles(): UseArticlesReturn;
+declare function useArticles(initialArticles?: Article[], initialCategories?: CategoryInfo[]): UseArticlesReturn;
 
-export { type Article, ArticleBackLink, type ArticleBreadcrumbEntry, type ArticleBreadcrumbToken, ArticleCard, ArticleCategoryGrid, type ArticleComment, type ArticleCommentWithReplies, ArticleDetailHero, ArticleNavigation, ArticleSEO, ArticleSchema, ArticleSearchBar, ArticleSocialShare, ArticleTOC, type ArticlesConfig, ArticlesHero, ArticlesPage, type ArticlesSection, type ArticlesTheme, AuthorArticlesPage, type AuthorBreadcrumbEntry, type AuthorBreadcrumbToken, AuthorCard, AuthorDetailHero, type AuthorProfile, type AuthorSocial, AuthorSocialLinks, Breadcrumb, type BreadcrumbItem, type BreadcrumbLabels, BreadcrumbSchema, type BreadcrumbsConfig, CategoryArticlesPage, type CategoryBreadcrumbEntry, type CategoryBreadcrumbToken, type CategoryDescription, type CategoryInfo, CollectionPageSchema, CommentForm, CommentItem, CommentThread, type CommentsConfig, CommentsSection, type CustomBreadcrumbItem, DEFAULT_CATEGORIES_PAGE_SIZE, DEFAULT_LAYOUT, DEFAULT_PAGE_SIZE, FAQPageSchema, type FaqItem, FeaturedArticle, type HowToStep, LatestArticles, LatestArticlesSection, type LinkTargetStrategy, ScrollToTop, type TocItem, type UseArticlesReturn, breadcrumbsAreEnabled, getBreadcrumbsConfig, useArticles };
+export { type Article, ArticleBackLink, type ArticleBreadcrumbEntry, type ArticleBreadcrumbToken, ArticleCard, ArticleCategoryGrid, type ArticleComment, type ArticleCommentWithReplies, ArticleDetailHero, ArticleNavigation, ArticleSEO, ArticleSchema, ArticleSearchBar, ArticleSocialShare, ArticleTOC, type ArticlesConfig, ArticlesHero, ArticlesPage, type ArticlesSection, type ArticlesTheme, AuthorArticlesPage, type AuthorBreadcrumbEntry, type AuthorBreadcrumbToken, AuthorCard, AuthorDetailHero, type AuthorProfile, type AuthorSocial, AuthorSocialLinks, Breadcrumb, type BreadcrumbItem, type BreadcrumbLabels, BreadcrumbSchema, type BreadcrumbsConfig, CategoryArticlesPage, type CategoryBreadcrumbEntry, type CategoryBreadcrumbToken, type CategoryDescription, type CategoryInfo, CollectionPageSchema, CommentForm, CommentItem, CommentThread, type CommentsConfig, CommentsSection, type CustomBreadcrumbItem, DEFAULT_CATEGORIES_PAGE_SIZE, DEFAULT_LAYOUT, DEFAULT_PAGE_SIZE, FAQPageSchema, type FaqItem, FeaturedArticle, type HowToStep, LatestArticles, LatestArticlesSection, type LinkTargetStrategy, type MdxComponents, ScrollToTop, type TocItem, type UseArticlesReturn, breadcrumbsAreEnabled, getBreadcrumbsConfig, useArticles };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ComponentType } from 'react';
 
 interface TocItem {
     id: string;
@@ -135,6 +136,8 @@ interface HeroConfig {
 }
 /** Controls how article body links set target/rel attributes. */
 type LinkTargetStrategy = 'external-new-tab' | 'all-new-tab' | 'same-tab';
+/** React components that article MDX bodies can reference by JSX tag name. */
+type MdxComponents = Record<string, ComponentType<never>>;
 type ArticleBreadcrumbToken = 'home' | 'articles' | 'primaryCategory' | 'folderPath' | 'articleTitle';
 type CategoryBreadcrumbToken = 'home' | 'articles' | 'category';
 type AuthorBreadcrumbToken = 'home' | 'articles' | 'authors' | 'authorName';
@@ -213,6 +216,8 @@ interface ArticlesConfig {
     breadcrumbs?: false | BreadcrumbsConfig;
     /** Article body link target behavior. Default: `'external-new-tab'`. */
     linkTargetStrategy?: LinkTargetStrategy;
+    /** Extra components exposed to article MDX bodies by JSX tag name. */
+    mdxComponents?: MdxComponents;
 }
 declare const DEFAULT_PAGE_SIZE = 6;
 declare const DEFAULT_CATEGORIES_PAGE_SIZE = 8;
@@ -220,8 +225,10 @@ declare const DEFAULT_LAYOUT: ArticlesSection[];
 declare function breadcrumbsAreEnabled(config: ArticlesConfig): boolean;
 declare function getBreadcrumbsConfig(config: ArticlesConfig): BreadcrumbsConfig;
 
-declare function ArticlesPage({ config }: Readonly<{
+declare function ArticlesPage({ config, initialArticles, initialCategories, }: Readonly<{
     config: ArticlesConfig;
+    initialArticles?: Article[];
+    initialCategories?: CategoryInfo[];
 }>): react_jsx_runtime.JSX.Element;
 
 type ArticleCardProps = Readonly<{
@@ -442,6 +449,6 @@ interface UseArticlesReturn {
     error: string | null;
     handleSearch: (query: string) => void;
 }
-declare function useArticles(): UseArticlesReturn;
+declare function useArticles(initialArticles?: Article[], initialCategories?: CategoryInfo[]): UseArticlesReturn;
 
-export { type Article, ArticleBackLink, type ArticleBreadcrumbEntry, type ArticleBreadcrumbToken, ArticleCard, ArticleCategoryGrid, type ArticleComment, type ArticleCommentWithReplies, ArticleDetailHero, ArticleNavigation, ArticleSEO, ArticleSchema, ArticleSearchBar, ArticleSocialShare, ArticleTOC, type ArticlesConfig, ArticlesHero, ArticlesPage, type ArticlesSection, type ArticlesTheme, AuthorArticlesPage, type AuthorBreadcrumbEntry, type AuthorBreadcrumbToken, AuthorCard, AuthorDetailHero, type AuthorProfile, type AuthorSocial, AuthorSocialLinks, Breadcrumb, type BreadcrumbItem, type BreadcrumbLabels, BreadcrumbSchema, type BreadcrumbsConfig, CategoryArticlesPage, type CategoryBreadcrumbEntry, type CategoryBreadcrumbToken, type CategoryDescription, type CategoryInfo, CollectionPageSchema, CommentForm, CommentItem, CommentThread, type CommentsConfig, CommentsSection, type CustomBreadcrumbItem, DEFAULT_CATEGORIES_PAGE_SIZE, DEFAULT_LAYOUT, DEFAULT_PAGE_SIZE, FAQPageSchema, type FaqItem, FeaturedArticle, type HowToStep, LatestArticles, LatestArticlesSection, type LinkTargetStrategy, ScrollToTop, type TocItem, type UseArticlesReturn, breadcrumbsAreEnabled, getBreadcrumbsConfig, useArticles };
+export { type Article, ArticleBackLink, type ArticleBreadcrumbEntry, type ArticleBreadcrumbToken, ArticleCard, ArticleCategoryGrid, type ArticleComment, type ArticleCommentWithReplies, ArticleDetailHero, ArticleNavigation, ArticleSEO, ArticleSchema, ArticleSearchBar, ArticleSocialShare, ArticleTOC, type ArticlesConfig, ArticlesHero, ArticlesPage, type ArticlesSection, type ArticlesTheme, AuthorArticlesPage, type AuthorBreadcrumbEntry, type AuthorBreadcrumbToken, AuthorCard, AuthorDetailHero, type AuthorProfile, type AuthorSocial, AuthorSocialLinks, Breadcrumb, type BreadcrumbItem, type BreadcrumbLabels, BreadcrumbSchema, type BreadcrumbsConfig, CategoryArticlesPage, type CategoryBreadcrumbEntry, type CategoryBreadcrumbToken, type CategoryDescription, type CategoryInfo, CollectionPageSchema, CommentForm, CommentItem, CommentThread, type CommentsConfig, CommentsSection, type CustomBreadcrumbItem, DEFAULT_CATEGORIES_PAGE_SIZE, DEFAULT_LAYOUT, DEFAULT_PAGE_SIZE, FAQPageSchema, type FaqItem, FeaturedArticle, type HowToStep, LatestArticles, LatestArticlesSection, type LinkTargetStrategy, type MdxComponents, ScrollToTop, type TocItem, type UseArticlesReturn, breadcrumbsAreEnabled, getBreadcrumbsConfig, useArticles };

package/dist/index.js

@@ -648,12 +648,12 @@ function getBreadcrumbsConfig(config) {
 
 // src/useArticles.ts
 import { useState as useState3, useCallback, useEffect as useEffect3, useRef } from "react";
-function useArticles() {
+function useArticles(initialArticles, initialCategories) {
   const [searchQuery, setSearchQuery] = useState3("");
   const debounceRef = useRef(null);
-  const [articles, setArticles] = useState3([]);
-  const [categories, setCategories] = useState3([]);
-  const [loading, setLoading] = useState3(true);
+  const [articles, setArticles] = useState3(initialArticles != null ? initialArticles : []);
+  const [categories, setCategories] = useState3(initialCategories != null ? initialCategories : []);
+  const [loading, setLoading] = useState3(initialArticles === void 0);
   const [error, setError] = useState3(null);
   const fetchArticles = useCallback((query) => __async(this, null, function* () {
     try {
@@ -691,7 +691,7 @@ function useArticles() {
     }
   }), []);
   useEffect3(() => {
-    fetchArticles("");
+    if (initialArticles === void 0) fetchArticles("");
   }, [fetchArticles]);
   const handleSearch = useCallback(
     (query) => {
@@ -822,9 +822,13 @@ function renderSection(section, ctx, config) {
       return null;
   }
 }
-function ArticlesPage({ config }) {
+function ArticlesPage({
+  config,
+  initialArticles,
+  initialCategories
+}) {
   var _a, _b, _c;
-  const state = useArticles();
+  const state = useArticles(initialArticles, initialCategories);
   const layout = (_a = config.layout) != null ? _a : DEFAULT_LAYOUT;
   const pageSize = (_b = config.pageSize) != null ? _b : DEFAULT_PAGE_SIZE;
   const categoriesPageSize = (_c = config.categoriesPageSize) != null ? _c : DEFAULT_CATEGORIES_PAGE_SIZE;