@ng-doc/utils 17.6.15 → 18.0.0-beta.1

package/html/helpers/index.d.ts

@@ -1,8 +1,7 @@
 export * from './attr-value';
 export * from './has-class';
 export * from './has-link-ancestor';
+export * from './is-code-block';
 export * from './is-code-node';
 export * from './is-element';
-export * from './is-text';
-export * from './line-break';
-export * from './text-element';
+export * from './is-heading';

package/html/helpers/is-code-block.d.ts

@@ -0,0 +1,7 @@
+import { Element, Root } from 'hast';
+/**
+ *
+ * @param parent
+ * @param node
+ */
+export declare function isCodeBlock(parent: Root | Element | null, node: Element): node is Element;

package/html/helpers/is-element.d.ts

@@ -1,6 +1,6 @@
-import { Element, ElementContent } from 'hast';
+import { Content, Element } from 'hast';
 /**
  *
  * @param node
  */
-export declare function isElement(node?: ElementContent): node is Element;
+export declare function isElement(node?: Content): node is Element;

package/html/helpers/is-heading.d.ts

@@ -0,0 +1,6 @@
+import { Element } from 'hast';
+/**
+ *
+ * @param node
+ */
+export declare function isHeading(node: Element): boolean;

package/html/plugins/add-heading-anchors.plugin.d.ts

@@ -0,0 +1,6 @@
+/**
+ *
+ * @param options
+ * @param route
+ */
+export default function addHeadingAnchors(route?: string): any;

package/html/plugins/keywords.plugin.d.ts

@@ -1,10 +1,14 @@
-import { NgDocKeyword } from '@ng-doc/core/interfaces';
+import { NgDocKeyword } from '@ng-doc/core';
 import { Element } from 'hast';
-import { NgDocHtmlPostProcessorConfig } from '../html-post-processor';
 export type AddKeyword = (keyword: string) => void;
 export type GetKeyword = (keyword: string) => NgDocKeyword | undefined;
+interface Config {
+    addUsedKeyword?: AddKeyword;
+    getKeyword?: GetKeyword;
+}
 /**
  *
  * @param config
  */
-export default function keywordsPlugin(config: NgDocHtmlPostProcessorConfig): (tree: Element) => void;
+export default function keywordsPlugin(config: Config): (tree: Element) => undefined;
+export {};

package/html/plugins/mark-elements.plugin.d.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * Marks all elements with the NG_DOC_ELEMENT class name
  * @param tree
  * @param headings
  */

package/html/plugins/mermaid.plugin.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Plugin to transform mermaid code blocks into mermaid elements that are going to be rendered by the mermaid processor.
+ * @param tree
+ * @param headings
+ */
+export default function mermaidPlugin(): any;

package/html/plugins/slugger.plugin.d.ts

@@ -1,4 +1,4 @@
-import { NgDocEntityAnchor, NgDocHeading } from '@ng-doc/core';
+import { NgDocHeading, NgDocPageAnchor } from '@ng-doc/core';
 import { Root } from 'hast';
 /**
  *
@@ -6,4 +6,4 @@ import { Root } from 'hast';
  * @param addAnchor
  * @param headings
  */
-export default function sluggerPlugin(addAnchor: (anchor: NgDocEntityAnchor) => void, headings?: NgDocHeading[]): (tree: Root) => void;
+export default function sluggerPlugin(addAnchor?: (anchor: NgDocPageAnchor) => void, headings?: NgDocHeading[]): (tree: Root) => void;

package/html/plugins/table-wrapper.d.ts

@@ -0,0 +1,4 @@
+/**
+ *
+ */
+export default function (): any;

package/html/post-process-html.d.ts

@@ -0,0 +1,13 @@
+export interface PostProcessHtmlOutput {
+    content: string;
+    usedKeywords: string[];
+    error?: unknown;
+}
+/**
+ *
+ * @param html
+ * @param config
+ * @param config.addUsedKeyword
+ * @param addUsedKeyword
+ */
+export declare function postProcessHtml(html: string): Promise<PostProcessHtmlOutput>;

package/html/process-html.d.ts

@@ -0,0 +1,18 @@
+import { NgDocHeading, NgDocPageAnchor } from '@ng-doc/core';
+export interface NgDocHtmlProcessorConfig {
+    lightTheme?: string;
+    darkTheme?: string;
+    headings?: NgDocHeading[];
+    route?: string;
+}
+export interface NgDocHtmlProcessorOutput {
+    content: string;
+    anchors: NgDocPageAnchor[];
+    error?: unknown;
+}
+/**
+ *
+ * @param html
+ * @param config
+ */
+export declare function processHtml(html: string, config: NgDocHtmlProcessorConfig): Promise<NgDocHtmlProcessorOutput>;

package/html/replace-keywords.d.ts

@@ -0,0 +1,12 @@
+import { GetKeyword } from './plugins/keywords.plugin';
+export interface ReplaceKeywordsConfig {
+    getKeyword: GetKeyword;
+}
+/**
+ *
+ * @param html
+ * @param config
+ * @param config.getKeyword
+ * @param getKeyword
+ */
+export declare function replaceKeywords(html: string, { getKeyword }: ReplaceKeywordsConfig): Promise<string>;

package/html/stringify-entities.d.ts

@@ -0,0 +1,5 @@
+/**
+ *
+ * @param content
+ */
+export declare function stringifyEntities(content: string): string;

package/index.d.ts

@@ -1,3 +1,5 @@
-export * from './html/html-post-processor';
-export * from './html/html-processor';
+export * from './html/post-process-html';
+export * from './html/process-html';
 export * from './html/remove-not-indexable-content';
+export * from './html/replace-keywords';
+export * from './html/stringify-entities';