marked 11.0.0 → 11.1.0

package/lib/marked.d.cts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v8.1.2
+// Generated by dts-bundle-generator v9.0.0
 
 export type Token = (Tokens.Space | Tokens.Code | Tokens.Heading | Tokens.Table | Tokens.Hr | Tokens.Blockquote | Tokens.List | Tokens.ListItem | Tokens.Paragraph | Tokens.HTML | Tokens.Text | Tokens.Def | Tokens.Escape | Tokens.Tag | Tokens.Image | Tokens.Link | Tokens.Strong | Tokens.Em | Tokens.Codespan | Tokens.Br | Tokens.Del | Tokens.Generic);
 export declare namespace Tokens {
@@ -335,6 +335,23 @@ declare class _Tokenizer {
 	url(src: string): Tokens.Link | undefined;
 	inlineText(src: string): Tokens.Text | undefined;
 }
+declare class _Hooks {
+	options: MarkedOptions;
+	constructor(options?: MarkedOptions);
+	static passThroughHooks: Set<string>;
+	/**
+	 * Process markdown before marked
+	 */
+	preprocess(markdown: string): string;
+	/**
+	 * Process HTML after marked is finished
+	 */
+	postprocess(html: string): string;
+	/**
+	 * Process all tokens before walk tokens
+	 */
+	processAllTokens(tokens: Token[] | TokensList): Token[] | TokensList;
+}
 export interface TokenizerThis {
 	lexer: _Lexer;
 }
@@ -356,6 +373,10 @@ export interface RendererExtension {
 	renderer: RendererExtensionFunction;
 }
 export type TokenizerAndRendererExtension = TokenizerExtension | RendererExtension | (TokenizerExtension & RendererExtension);
+export type HooksApi = Omit<_Hooks, "constructor" | "options">;
+export type HooksObject = {
+	[K in keyof HooksApi]?: (...args: Parameters<HooksApi[K]>) => ReturnType<HooksApi[K]> | Promise<ReturnType<HooksApi[K]>>;
+};
 export type RendererApi = Omit<_Renderer, "constructor" | "options">;
 export type RendererObject = {
 	[K in keyof RendererApi]?: (...args: Parameters<RendererApi[K]>) => ReturnType<RendererApi[K]> | false;
@@ -384,13 +405,10 @@ export interface MarkedExtension {
 	/**
 	 * Hooks are methods that hook into some part of marked.
 	 * preprocess is called to process markdown before sending it to marked.
+	 * processAllTokens is called with the TokensList before walkTokens.
 	 * postprocess is called to process html after marked has finished parsing.
 	 */
-	hooks?: {
-		preprocess: (markdown: string) => string | Promise<string>;
-		postprocess: (html: string) => string | Promise<string>;
-		options?: MarkedOptions;
-	} | null;
+	hooks?: HooksObject | undefined | null;
 	/**
 	 * Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
 	 */
@@ -417,7 +435,11 @@ export interface MarkedExtension {
 	 */
 	walkTokens?: ((token: Token) => void | Promise<void>) | undefined | null;
 }
-export interface MarkedOptions extends Omit<MarkedExtension, "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
+export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
+	/**
+	 * Hooks are methods that hook into some part of marked.
+	 */
+	hooks?: _Hooks | undefined | null;
 	/**
 	 * Type: object Default: new Renderer()
 	 *
@@ -532,19 +554,6 @@ declare class _Lexer {
 	 */
 	inlineTokens(src: string, tokens?: Token[]): Token[];
 }
-declare class _Hooks {
-	options: MarkedOptions;
-	constructor(options?: MarkedOptions);
-	static passThroughHooks: Set<string>;
-	/**
-	 * Process markdown before marked
-	 */
-	preprocess(markdown: string): string;
-	/**
-	 * Process HTML after marked is finished
-	 */
-	postprocess(html: string): string;
-}
 declare function _getDefaults(): MarkedOptions;
 declare let _defaults: MarkedOptions;
 export type MaybePromise = void | Promise<void>;

package/lib/marked.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v8.1.2
+// Generated by dts-bundle-generator v9.0.0
 
 export type Token = (Tokens.Space | Tokens.Code | Tokens.Heading | Tokens.Table | Tokens.Hr | Tokens.Blockquote | Tokens.List | Tokens.ListItem | Tokens.Paragraph | Tokens.HTML | Tokens.Text | Tokens.Def | Tokens.Escape | Tokens.Tag | Tokens.Image | Tokens.Link | Tokens.Strong | Tokens.Em | Tokens.Codespan | Tokens.Br | Tokens.Del | Tokens.Generic);
 export declare namespace Tokens {
@@ -335,6 +335,23 @@ declare class _Tokenizer {
 	url(src: string): Tokens.Link | undefined;
 	inlineText(src: string): Tokens.Text | undefined;
 }
+declare class _Hooks {
+	options: MarkedOptions;
+	constructor(options?: MarkedOptions);
+	static passThroughHooks: Set<string>;
+	/**
+	 * Process markdown before marked
+	 */
+	preprocess(markdown: string): string;
+	/**
+	 * Process HTML after marked is finished
+	 */
+	postprocess(html: string): string;
+	/**
+	 * Process all tokens before walk tokens
+	 */
+	processAllTokens(tokens: Token[] | TokensList): Token[] | TokensList;
+}
 export interface TokenizerThis {
 	lexer: _Lexer;
 }
@@ -356,6 +373,10 @@ export interface RendererExtension {
 	renderer: RendererExtensionFunction;
 }
 export type TokenizerAndRendererExtension = TokenizerExtension | RendererExtension | (TokenizerExtension & RendererExtension);
+export type HooksApi = Omit<_Hooks, "constructor" | "options">;
+export type HooksObject = {
+	[K in keyof HooksApi]?: (...args: Parameters<HooksApi[K]>) => ReturnType<HooksApi[K]> | Promise<ReturnType<HooksApi[K]>>;
+};
 export type RendererApi = Omit<_Renderer, "constructor" | "options">;
 export type RendererObject = {
 	[K in keyof RendererApi]?: (...args: Parameters<RendererApi[K]>) => ReturnType<RendererApi[K]> | false;
@@ -384,13 +405,10 @@ export interface MarkedExtension {
 	/**
 	 * Hooks are methods that hook into some part of marked.
 	 * preprocess is called to process markdown before sending it to marked.
+	 * processAllTokens is called with the TokensList before walkTokens.
 	 * postprocess is called to process html after marked has finished parsing.
 	 */
-	hooks?: {
-		preprocess: (markdown: string) => string | Promise<string>;
-		postprocess: (html: string) => string | Promise<string>;
-		options?: MarkedOptions;
-	} | null;
+	hooks?: HooksObject | undefined | null;
 	/**
 	 * Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
 	 */
@@ -417,7 +435,11 @@ export interface MarkedExtension {
 	 */
 	walkTokens?: ((token: Token) => void | Promise<void>) | undefined | null;
 }
-export interface MarkedOptions extends Omit<MarkedExtension, "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
+export interface MarkedOptions extends Omit<MarkedExtension, "hooks" | "renderer" | "tokenizer" | "extensions" | "walkTokens"> {
+	/**
+	 * Hooks are methods that hook into some part of marked.
+	 */
+	hooks?: _Hooks | undefined | null;
 	/**
 	 * Type: object Default: new Renderer()
 	 *
@@ -532,19 +554,6 @@ declare class _Lexer {
 	 */
 	inlineTokens(src: string, tokens?: Token[]): Token[];
 }
-declare class _Hooks {
-	options: MarkedOptions;
-	constructor(options?: MarkedOptions);
-	static passThroughHooks: Set<string>;
-	/**
-	 * Process markdown before marked
-	 */
-	preprocess(markdown: string): string;
-	/**
-	 * Process HTML after marked is finished
-	 */
-	postprocess(html: string): string;
-}
 declare function _getDefaults(): MarkedOptions;
 declare let _defaults: MarkedOptions;
 export type MaybePromise = void | Promise<void>;

package/lib/marked.esm.js

@@ -1,5 +1,5 @@
 /**
- * marked v11.0.0 - a markdown parser
+ * marked v11.1.0 - a markdown parser
  * Copyright (c) 2011-2023, Christopher Jeffrey. (MIT Licensed)
  * https://github.com/markedjs/marked
  */
@@ -2022,7 +2022,8 @@ class _Hooks {
     }
     static passThroughHooks = new Set([
         'preprocess',
-        'postprocess'
+        'postprocess',
+        'processAllTokens'
     ]);
     /**
      * Process markdown before marked
@@ -2036,6 +2037,12 @@ class _Hooks {
     postprocess(html) {
         return html;
     }
+    /**
+     * Process all tokens before walk tokens
+     */
+    processAllTokens(tokens) {
+        return tokens;
+    }
 }
 
 class Marked {
@@ -2161,9 +2168,13 @@ class Marked {
             if (pack.renderer) {
                 const renderer = this.defaults.renderer || new _Renderer(this.defaults);
                 for (const prop in pack.renderer) {
-                    if (!(prop in renderer) || prop === 'options') {
+                    if (!(prop in renderer)) {
                         throw new Error(`renderer '${prop}' does not exist`);
                     }
+                    if (prop === 'options') {
+                        // ignore options property
+                        continue;
+                    }
                     const rendererProp = prop;
                     const rendererFunc = pack.renderer[rendererProp];
                     const prevRenderer = renderer[rendererProp];
@@ -2181,9 +2192,13 @@ class Marked {
             if (pack.tokenizer) {
                 const tokenizer = this.defaults.tokenizer || new _Tokenizer(this.defaults);
                 for (const prop in pack.tokenizer) {
-                    if (!(prop in tokenizer) || ['options', 'rules', 'lexer'].includes(prop)) {
+                    if (!(prop in tokenizer)) {
                         throw new Error(`tokenizer '${prop}' does not exist`);
                     }
+                    if (['options', 'rules', 'lexer'].includes(prop)) {
+                        // ignore options, rules, and lexer properties
+                        continue;
+                    }
                     const tokenizerProp = prop;
                     const tokenizerFunc = pack.tokenizer[tokenizerProp];
                     const prevTokenizer = tokenizer[tokenizerProp];
@@ -2203,13 +2218,18 @@ class Marked {
             if (pack.hooks) {
                 const hooks = this.defaults.hooks || new _Hooks();
                 for (const prop in pack.hooks) {
-                    if (!(prop in hooks) || prop === 'options') {
+                    if (!(prop in hooks)) {
                         throw new Error(`hook '${prop}' does not exist`);
                     }
+                    if (prop === 'options') {
+                        // ignore options property
+                        continue;
+                    }
                     const hooksProp = prop;
                     const hooksFunc = pack.hooks[hooksProp];
                     const prevHook = hooks[hooksProp];
                     if (_Hooks.passThroughHooks.has(prop)) {
+                        // @ts-expect-error cannot type hook function dynamically
                         hooks[hooksProp] = (arg) => {
                             if (this.defaults.async) {
                                 return Promise.resolve(hooksFunc.call(hooks, arg)).then(ret => {
@@ -2221,6 +2241,7 @@ class Marked {
                         };
                     }
                     else {
+                        // @ts-expect-error cannot type hook function dynamically
                         hooks[hooksProp] = (...args) => {
                             let ret = hooksFunc.apply(hooks, args);
                             if (ret === false) {
@@ -2285,6 +2306,7 @@ class Marked {
             if (opt.async) {
                 return Promise.resolve(opt.hooks ? opt.hooks.preprocess(src) : src)
                     .then(src => lexer(src, opt))
+                    .then(tokens => opt.hooks ? opt.hooks.processAllTokens(tokens) : tokens)
                     .then(tokens => opt.walkTokens ? Promise.all(this.walkTokens(tokens, opt.walkTokens)).then(() => tokens) : tokens)
                     .then(tokens => parser(tokens, opt))
                     .then(html => opt.hooks ? opt.hooks.postprocess(html) : html)
@@ -2294,7 +2316,10 @@ class Marked {
                 if (opt.hooks) {
                     src = opt.hooks.preprocess(src);
                 }
-                const tokens = lexer(src, opt);
+                let tokens = lexer(src, opt);
+                if (opt.hooks) {
+                    tokens = opt.hooks.processAllTokens(tokens);
+                }
                 if (opt.walkTokens) {
                     this.walkTokens(tokens, opt.walkTokens);
                 }