@foblex/m-render 3.0.1 → 3.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foblex/m-render",
-  "version": "3.0.1",
+  "version": "3.0.5",
   "description": "MRender is a static site generator designed for creating fast and user-friendly documentation sites based on Markdown files. MarkEngine supports extended Markdown syntax and can render Angular components directly from Markdown files.",
   "author": "Siarhei Huzarevich",
   "license": "MIT",

package/types/foblex-m-render.d.ts

@@ -630,9 +630,14 @@ interface IMarkdownPageLayoutOptions {
     hideTableOfContent: boolean;
     expandContentWithoutTableOfContent: boolean;
 }
+interface IMarkdownOriginData {
+    url: string;
+    label: string;
+}
 interface IMarkdownFrontMatterData {
     layout: IMarkdownPageLayoutOptions;
     seo: ISeoOverrides | null;
+    origin: IMarkdownOriginData | null;
 }
 interface IMarkdownFrontMatterParseResult {
     markdown: string;
@@ -648,8 +653,10 @@ declare class MarkdownService {
     private readonly _provider;
     private readonly _pageLayout;
     private readonly _pageSeo;
+    private readonly _pageOrigin;
     readonly pageLayout: i0.Signal<IMarkdownPageLayoutOptions>;
     readonly pageSeo: i0.Signal<ISeoOverrides | null>;
+    readonly pageOrigin: i0.Signal<IMarkdownOriginData | null>;
     constructor();
     parseUrl(src: string): Observable<SafeHtml>;
     parseText(value: string): Observable<SafeHtml>;
@@ -666,6 +673,10 @@ declare class MarkdownService {
     private _parseBoolean;
     private _applyLayoutKey;
     private _applySeoKey;
+    private _applyOriginKey;
+    private _normalizeOriginUrl;
+    private _resolveOrigin;
+    private _getOriginLabel;
     private _parseNumberOrDefault;
     private _applyPageContext;
     private _resetPageContext;
@@ -744,6 +755,7 @@ declare function parseSingleBracketText(line: string): string | null;
 
 declare class MarkdownRenderer implements OnInit, OnDestroy {
     readonly value: i0.InputSignal<SafeHtml | undefined>;
+    readonly origin: i0.InputSignal<IMarkdownOriginData | null>;
     private readonly _hostElement;
     private readonly _router;
     private readonly _injector;
@@ -762,7 +774,7 @@ declare class MarkdownRenderer implements OnInit, OnDestroy {
     protected _onDocumentClick(event: MouseEvent): void;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MarkdownRenderer, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<MarkdownRenderer, "markdown-renderer", never, { "value": { "alias": "value"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MarkdownRenderer, "markdown-renderer", never, { "value": { "alias": "value"; "required": true; "isSignal": true; }; "origin": { "alias": "origin"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare class MarkdownRouter {
@@ -772,6 +784,7 @@ declare class MarkdownRouter {
     private readonly _dataProvider;
     private readonly _metaService;
     protected readonly emptyNavigation: boolean;
+    protected readonly pageOrigin: i0.Signal<_foblex_m_render.IMarkdownOriginData | null>;
     protected readonly shouldExpandContent: i0.Signal<boolean>;
     private readonly _path$;
     protected readonly html: i0.Signal<SafeHtml | undefined>;
@@ -1009,15 +1022,26 @@ declare const DOCUMENTATION_ROUTES: Routes;
 declare function provideHeader(...configuration: Partial<IHeaderConfiguration>[]): Partial<IHasHeaderConfiguration>;
 interface IHeaderConfiguration {
     search?: boolean;
+    searchConfiguration?: IHeaderSearchConfiguration;
     navigation?: IHeaderMenuLink[];
     mediaLinks?: IMediaLink[];
 }
 interface IHasHeaderConfiguration {
     header?: IHeaderConfiguration;
 }
+interface IHeaderSearchConfiguration {
+    appId: string;
+    apiKey: string;
+    indexName: string;
+    placeholder?: string;
+    insights?: boolean;
+    searchParameters?: Record<string, unknown>;
+}
 
 declare function provideHeaderSearch(search?: boolean): Partial<IHeaderConfiguration>;
 
+declare function provideHeaderSearchAlgolia(configuration: IHeaderSearchConfiguration): Partial<IHeaderConfiguration>;
+
 declare function provideHeaderMediaLinks(mediaLinks: IMediaLink[]): Partial<IHeaderConfiguration>;
 
 declare function provideHeaderNavigation(navigation: IHeaderMenuLink[]): Partial<IHeaderConfiguration>;
@@ -1302,9 +1326,16 @@ declare class FBrandLinkComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<FBrandLinkComponent, "f-brand-link", never, { "title": { "alias": "title"; "required": true; "isSignal": true; }; "logo": { "alias": "logo"; "required": true; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "logoAlt": { "alias": "logoAlt"; "required": false; "isSignal": true; }; "href": { "alias": "href"; "required": false; "isSignal": true; }; "routerLink": { "alias": "routerLink"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-declare class FSearchButtonComponent {
+declare class FSearchButtonComponent implements AfterViewInit, OnDestroy {
+    readonly configuration: i0.InputSignal<IHeaderSearchConfiguration | undefined>;
+    private readonly _isBrowser;
+    private readonly _document;
+    private readonly _containerRef;
+    private _instance;
+    ngAfterViewInit(): Promise<void>;
+    ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<FSearchButtonComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FSearchButtonComponent, "f-search-button", never, {}, {}, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FSearchButtonComponent, "f-search-button", never, { "configuration": { "alias": "configuration"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare class FCheckboxComponent {
@@ -1358,5 +1389,5 @@ declare class ThemeButtonComponent implements OnInit {
 
 declare function provideTheme(): Provider[];
 
-export { AVAILABLE_LANGUAGES, ActivateTocByHash, ActivateTocByHashRequest, CalculateAbsoluteTopToContainer, CalculateAbsoluteTopToContainerRequest, CalculateHashFromScrollPosition, CalculateTableOfContent, CalculateTableOfContentRequest, CodeGroup, CodeView, DEFAULT_MARKDOWN_PAGE_LAYOUT_OPTIONS, DOCUMENTATION_CONFIGURATION, DOCUMENTATION_ROUTES, DOCUMENT_ELEMENT, DYNAMIC_COMPONENTS_MODULE_PROVIDERS, Documentation, DocumentationStore, DropdownMenu, DynamicComponentsStore, EMarkdownContainerType, EParsedContainerType, EXTERNAL_COMPONENT_PROVIDER, ExternalComponent, FBrandLinkComponent, FCheckboxComponent, FHomePageButtonsRowComponent, FHomePageFeaturesComponent, FHomePageFooterComponent, FHomePageHeaderComponent, FHomePageHeroComponent, FHomePageMembershipsComponent, FMetaService, FNavigationItemComponent, FRadioButtonComponent, FSearchButtonComponent, F_PREVIEW_NAVIGATION_PROVIDER, FooterNavigationButton, GTAG_CONFIG, GTagService, GetPreviousNextPageNavigationHandler, GetPreviousNextPageNavigationRequest, GetPreviousNextPageNavigationResponse, HEADER_CONFIGURATION_PROVIDER, HOME_PAGE_CONFIGURATION, HOME_ROUTES, HamburgerButton, HandleNavigationLinksHandler, HandleNavigationLinksRequest, HeaderComponent, HeaderMenuBase, Highlight, HighlightService, HomeRootComponent, HomeStore, IS_BROWSER_PLATFORM, InlineMenu, LOCAL_STORAGE, LOCATION, MEDIA_LINKS_PROVIDER, MExecution, MarkCodeFocusedBlocksPostProcessor, MarkdownFooter, MarkdownRenderer, MarkdownRouter, MarkdownService, MediaLinks, Mediatr, NavigationGroupComponent, NavigationPanelComponent, ParseAlerts, ParseAngularExampleWithCodeLinks, ParseGroupedCodeItems, ParsePreviewGroup, ParseShowcase, ParseSingleCodeItem, PopoverService, PreviewActionBar, PreviewCard, PreviewCardBase, PreviewGroupService, RenderDynamicComponent, RenderDynamicComponentRequest, RenderExternalComponent, RenderExternalComponentRequest, RenderInternalComponents, RenderInternalComponentsRequest, SCROLLABLE_CONTAINER, SHOWCASE_DATA, ScrollToElementInContainer, ScrollToElementInContainerRequest, ScrollableContainer, Showcase, ShowcaseItem, TABLE_OF_CONTENT_MODULE_PROVIDERS, TOGGLE_NAVIGATION_COMPONENT, TableOfContent, TableOfContentData, TableOfContentItemsComponent, ThemeButtonComponent, ThemeService, UNIVERSAL_THEME, WINDOW, calculateMarkdownUrl, coerceComponentHeight, copyToClipboard, defineLazyComponent, defineNavigationGroup, encodeDataAttr, extractComponent, getContent, getLanguageLoader, isClosingToken, isOpeningToken, parseComponentTag, parseFileLinkLine, parseIframeUrl, parseSingleBracketText, provide404Markdown, provideBackground, provideComponents, provideDirectory, provideDocumentation, provideFooterNavigation, provideGTag, provideHeader, provideHeaderMediaLinks, provideHeaderNavigation, provideHeaderSearch, provideHero, provideHomeButtons, provideHomeFeatures, provideHomeFooter, provideHomePage, provideImage, provideLanguage, provideLogo, provideMeta, provideNavigation, provideShowcase, provideTableOfContent, provideTheme, provideTitle, resolveHighlightLanguage };
-export type { ConsentState, GTagConfig, HighlightLanguage, IDocumentationConfiguration, IDocumentationFooterConfiguration, IDynamicComponentInstance, IDynamicComponentItem, IExampleViewData, IExecution, IHandler, IHasHeaderConfiguration, IHeaderConfiguration, IHeaderConfigurationStore, IHeaderMenuLink, IHomePageConfiguration, IHomePageFeature, IHomePageFooter, IHomePageHero, IHomePageLink, IHomePageMembership, ILanguageConfiguration, ILink, ILogoConfiguration, IMarkdownContainerData, IMarkdownFooterLink, IMarkdownFooterNavigation, IMarkdownFrontMatterData, IMarkdownFrontMatterParseResult, IMarkdownItToken, IMarkdownPageLayoutOptions, IMediaLink, IMediaLinksProvider, IMetaData, INavigationGroup, INavigationItem, INavigationItemBadge, IParsedContainerData, IPreviewNavigationGroup, IPreviewNavigationService, IScrollableContainer, ISeoOverrides, IShowcaseItem, ITableOfContent, ITableOfContentItem, ITitleConfiguration, IToggleNavigationComponent };
+export { AVAILABLE_LANGUAGES, ActivateTocByHash, ActivateTocByHashRequest, CalculateAbsoluteTopToContainer, CalculateAbsoluteTopToContainerRequest, CalculateHashFromScrollPosition, CalculateTableOfContent, CalculateTableOfContentRequest, CodeGroup, CodeView, DEFAULT_MARKDOWN_PAGE_LAYOUT_OPTIONS, DOCUMENTATION_CONFIGURATION, DOCUMENTATION_ROUTES, DOCUMENT_ELEMENT, DYNAMIC_COMPONENTS_MODULE_PROVIDERS, Documentation, DocumentationStore, DropdownMenu, DynamicComponentsStore, EMarkdownContainerType, EParsedContainerType, EXTERNAL_COMPONENT_PROVIDER, ExternalComponent, FBrandLinkComponent, FCheckboxComponent, FHomePageButtonsRowComponent, FHomePageFeaturesComponent, FHomePageFooterComponent, FHomePageHeaderComponent, FHomePageHeroComponent, FHomePageMembershipsComponent, FMetaService, FNavigationItemComponent, FRadioButtonComponent, FSearchButtonComponent, F_PREVIEW_NAVIGATION_PROVIDER, FooterNavigationButton, GTAG_CONFIG, GTagService, GetPreviousNextPageNavigationHandler, GetPreviousNextPageNavigationRequest, GetPreviousNextPageNavigationResponse, HEADER_CONFIGURATION_PROVIDER, HOME_PAGE_CONFIGURATION, HOME_ROUTES, HamburgerButton, HandleNavigationLinksHandler, HandleNavigationLinksRequest, HeaderComponent, HeaderMenuBase, Highlight, HighlightService, HomeRootComponent, HomeStore, IS_BROWSER_PLATFORM, InlineMenu, LOCAL_STORAGE, LOCATION, MEDIA_LINKS_PROVIDER, MExecution, MarkCodeFocusedBlocksPostProcessor, MarkdownFooter, MarkdownRenderer, MarkdownRouter, MarkdownService, MediaLinks, Mediatr, NavigationGroupComponent, NavigationPanelComponent, ParseAlerts, ParseAngularExampleWithCodeLinks, ParseGroupedCodeItems, ParsePreviewGroup, ParseShowcase, ParseSingleCodeItem, PopoverService, PreviewActionBar, PreviewCard, PreviewCardBase, PreviewGroupService, RenderDynamicComponent, RenderDynamicComponentRequest, RenderExternalComponent, RenderExternalComponentRequest, RenderInternalComponents, RenderInternalComponentsRequest, SCROLLABLE_CONTAINER, SHOWCASE_DATA, ScrollToElementInContainer, ScrollToElementInContainerRequest, ScrollableContainer, Showcase, ShowcaseItem, TABLE_OF_CONTENT_MODULE_PROVIDERS, TOGGLE_NAVIGATION_COMPONENT, TableOfContent, TableOfContentData, TableOfContentItemsComponent, ThemeButtonComponent, ThemeService, UNIVERSAL_THEME, WINDOW, calculateMarkdownUrl, coerceComponentHeight, copyToClipboard, defineLazyComponent, defineNavigationGroup, encodeDataAttr, extractComponent, getContent, getLanguageLoader, isClosingToken, isOpeningToken, parseComponentTag, parseFileLinkLine, parseIframeUrl, parseSingleBracketText, provide404Markdown, provideBackground, provideComponents, provideDirectory, provideDocumentation, provideFooterNavigation, provideGTag, provideHeader, provideHeaderMediaLinks, provideHeaderNavigation, provideHeaderSearch, provideHeaderSearchAlgolia, provideHero, provideHomeButtons, provideHomeFeatures, provideHomeFooter, provideHomePage, provideImage, provideLanguage, provideLogo, provideMeta, provideNavigation, provideShowcase, provideTableOfContent, provideTheme, provideTitle, resolveHighlightLanguage };
+export type { ConsentState, GTagConfig, HighlightLanguage, IDocumentationConfiguration, IDocumentationFooterConfiguration, IDynamicComponentInstance, IDynamicComponentItem, IExampleViewData, IExecution, IHandler, IHasHeaderConfiguration, IHeaderConfiguration, IHeaderConfigurationStore, IHeaderMenuLink, IHeaderSearchConfiguration, IHomePageConfiguration, IHomePageFeature, IHomePageFooter, IHomePageHero, IHomePageLink, IHomePageMembership, ILanguageConfiguration, ILink, ILogoConfiguration, IMarkdownContainerData, IMarkdownFooterLink, IMarkdownFooterNavigation, IMarkdownFrontMatterData, IMarkdownFrontMatterParseResult, IMarkdownItToken, IMarkdownOriginData, IMarkdownPageLayoutOptions, IMediaLink, IMediaLinksProvider, IMetaData, INavigationGroup, INavigationItem, INavigationItemBadge, IParsedContainerData, IPreviewNavigationGroup, IPreviewNavigationService, IScrollableContainer, ISeoOverrides, IShowcaseItem, ITableOfContent, ITableOfContentItem, ITitleConfiguration, IToggleNavigationComponent };