markmap-lib 0.11.6 → 0.12.0

package/types/types.d.ts

@@ -1,32 +1,53 @@
-import { CSSItem, JSItem, INode } from 'markmap-common';
-import { createTransformHooks } from './plugins/base';
-export declare type ITransformHooks = ReturnType<typeof createTransformHooks>;
-export interface IAssets {
-    styles?: CSSItem[];
-    scripts?: JSItem[];
-}
-export interface IMarkmapCreateOptions {
-    /**
-     * Markdown content as string.
-     */
-    content?: string;
-    /**
-     * Output file path of the markmap HTML file.
-     * If not provided, the same basename as the Markdown input file will be used.
-     */
-    output?: string;
-}
-export interface IAssetsMap {
-    [key: string]: IAssets;
-}
-export interface IFeatures {
-    [key: string]: boolean;
-}
-export interface ITransformResult {
-    root: INode;
-    features: IFeatures;
-}
-export interface ITransformPlugin {
-    name: string;
-    transform: (transformHooks: ITransformHooks) => IAssets;
-}
+import type { Remarkable } from 'remarkable';
+import { CSSItem, JSItem, INode, IWrapContext, Hook } from 'markmap-common';
+export interface ITransformHooks {
+    /**
+     * Tapped once when the parser is created.
+     */
+    parser: Hook<[md: Remarkable]>;
+    /**
+     * Tapped every time when Markdown content is transformed.
+     */
+    transform: Hook<[md: Remarkable, context: ITransformContext]>;
+    /**
+     * Tapped when Remarkable renders an HTML tag in Markdown.
+     */
+    htmltag: Hook<[ctx: IWrapContext<any>]>;
+    /**
+     * Indicate that the last transformation is not complete for reasons like
+     * lack of resources and is called when it is ready for a new transformation.
+     */
+    retransform: Hook<[]>;
+}
+export interface IAssets {
+    styles?: CSSItem[];
+    scripts?: JSItem[];
+}
+export interface IMarkmapCreateOptions {
+    /**
+     * Markdown content as string.
+     */
+    content?: string;
+    /**
+     * Output file path of the markmap HTML file.
+     * If not provided, the same basename as the Markdown input file will be used.
+     */
+    output?: string;
+}
+export interface IAssetsMap {
+    [key: string]: IAssets;
+}
+export interface IFeatures {
+    [key: string]: boolean;
+}
+export interface ITransformContext {
+    features: IFeatures;
+    frontmatter?: any;
+}
+export interface ITransformResult extends ITransformContext {
+    root: INode;
+}
+export interface ITransformPlugin {
+    name: string;
+    transform: (transformHooks: ITransformHooks) => IAssets;
+}