@fullstackdatasolutions/articles 0.10.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +27 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +6 -1
- package/dist/index.d.ts +6 -1
- package/dist/index.js.map +1 -1
- package/dist/nextjs.d.cts +5 -0
- package/dist/nextjs.d.ts +5 -0
- package/dist/server.cjs +2 -1
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +5 -0
- package/dist/server.d.ts +5 -0
- package/dist/server.js +2 -1
- package/dist/server.js.map +1 -1
- package/package.json +1 -1
- package/src/__tests__/articlesConfig.test.ts +20 -1
- package/src/__tests__/renderMdx.test.tsx +78 -0
- package/src/articlesConfig.ts +6 -0
- package/src/index.ts +1 -0
- package/src/renderMdx.tsx +5 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
+
import { ComponentType } from 'react';
|
|
2
3
|
|
|
3
4
|
interface TocItem {
|
|
4
5
|
id: string;
|
|
@@ -135,6 +136,8 @@ interface HeroConfig {
|
|
|
135
136
|
}
|
|
136
137
|
/** Controls how article body links set target/rel attributes. */
|
|
137
138
|
type LinkTargetStrategy = 'external-new-tab' | 'all-new-tab' | 'same-tab';
|
|
139
|
+
/** React components that article MDX bodies can reference by JSX tag name. */
|
|
140
|
+
type MdxComponents = Record<string, ComponentType<never>>;
|
|
138
141
|
type ArticleBreadcrumbToken = 'home' | 'articles' | 'primaryCategory' | 'folderPath' | 'articleTitle';
|
|
139
142
|
type CategoryBreadcrumbToken = 'home' | 'articles' | 'category';
|
|
140
143
|
type AuthorBreadcrumbToken = 'home' | 'articles' | 'authors' | 'authorName';
|
|
@@ -213,6 +216,8 @@ interface ArticlesConfig {
|
|
|
213
216
|
breadcrumbs?: false | BreadcrumbsConfig;
|
|
214
217
|
/** Article body link target behavior. Default: `'external-new-tab'`. */
|
|
215
218
|
linkTargetStrategy?: LinkTargetStrategy;
|
|
219
|
+
/** Extra components exposed to article MDX bodies by JSX tag name. */
|
|
220
|
+
mdxComponents?: MdxComponents;
|
|
216
221
|
}
|
|
217
222
|
declare const DEFAULT_PAGE_SIZE = 6;
|
|
218
223
|
declare const DEFAULT_CATEGORIES_PAGE_SIZE = 8;
|
|
@@ -444,4 +449,4 @@ interface UseArticlesReturn {
|
|
|
444
449
|
}
|
|
445
450
|
declare function useArticles(): UseArticlesReturn;
|
|
446
451
|
|
|
447
|
-
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 };
|
|
452
|
+
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
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
+
import { ComponentType } from 'react';
|
|
2
3
|
|
|
3
4
|
interface TocItem {
|
|
4
5
|
id: string;
|
|
@@ -135,6 +136,8 @@ interface HeroConfig {
|
|
|
135
136
|
}
|
|
136
137
|
/** Controls how article body links set target/rel attributes. */
|
|
137
138
|
type LinkTargetStrategy = 'external-new-tab' | 'all-new-tab' | 'same-tab';
|
|
139
|
+
/** React components that article MDX bodies can reference by JSX tag name. */
|
|
140
|
+
type MdxComponents = Record<string, ComponentType<never>>;
|
|
138
141
|
type ArticleBreadcrumbToken = 'home' | 'articles' | 'primaryCategory' | 'folderPath' | 'articleTitle';
|
|
139
142
|
type CategoryBreadcrumbToken = 'home' | 'articles' | 'category';
|
|
140
143
|
type AuthorBreadcrumbToken = 'home' | 'articles' | 'authors' | 'authorName';
|
|
@@ -213,6 +216,8 @@ interface ArticlesConfig {
|
|
|
213
216
|
breadcrumbs?: false | BreadcrumbsConfig;
|
|
214
217
|
/** Article body link target behavior. Default: `'external-new-tab'`. */
|
|
215
218
|
linkTargetStrategy?: LinkTargetStrategy;
|
|
219
|
+
/** Extra components exposed to article MDX bodies by JSX tag name. */
|
|
220
|
+
mdxComponents?: MdxComponents;
|
|
216
221
|
}
|
|
217
222
|
declare const DEFAULT_PAGE_SIZE = 6;
|
|
218
223
|
declare const DEFAULT_CATEGORIES_PAGE_SIZE = 8;
|
|
@@ -444,4 +449,4 @@ interface UseArticlesReturn {
|
|
|
444
449
|
}
|
|
445
450
|
declare function useArticles(): UseArticlesReturn;
|
|
446
451
|
|
|
447
|
-
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 };
|
|
452
|
+
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 };
|