@wdprlib/parser 1.1.2 → 2.0.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Position as Position2, Point, Version as Version2, Element as Element6, SyntaxTree as SyntaxTree4, ContainerType, ContainerData, AttributeMap, VariableMap, Alignment, LinkType, LinkLocation, LinkLabel, PageRef as PageRef2, ImageSource, FloatAlignment, ListType, ListItem, ListData, CodeBlockData as CodeBlockData2, TabData, TableCell, TableRow, TableData, DefinitionListItem, Module as Module4, CollapsibleData, ClearFloat, AnchorTarget, HeaderType, AlignType, HeadingLevel, Heading, DateItem, Embed, TocEntry as TocEntry2 } from "@wdprlib/ast";
+import { Position as Position2, Point, Version as Version2, Element as Element6, SyntaxTree as SyntaxTree3, ContainerType, ContainerData, AttributeMap, VariableMap, Alignment, LinkType, LinkLocation, LinkLabel, PageRef as PageRef2, ImageSource, FloatAlignment, ListType, ListItem, ListData, CodeBlockData as CodeBlockData2, TabData, TableCell, TableRow, TableData, DefinitionListItem, Module as Module4, CollapsibleData, ClearFloat, AnchorTarget, HeaderType, AlignType, HeadingLevel, Heading, DateItem, Embed, TocEntry as TocEntry2, Diagnostic as Diagnostic2, DiagnosticSeverity, ParseResult as ParseResult2 } from "@wdprlib/ast";
 import { createPoint, createPosition, text, container, paragraph, bold, italics, heading, lineBreak, horizontalRule, link, list, listItemElements, listItemSubList } from "@wdprlib/ast";
 import { WikitextMode, WikitextSettings as WikitextSettings4 } from "@wdprlib/ast";
 import { createSettings, DEFAULT_SETTINGS } from "@wdprlib/ast";
@@ -134,7 +134,7 @@ declare class Lexer {
 * @group Lexer
 */
 declare function tokenize(source: string, options?: LexerOptions): Token[];
-import { SyntaxTree, WikitextSettings } from "@wdprlib/ast";
+import { WikitextSettings, ParseResult } from "@wdprlib/ast";
 /**
 * Configuration for the {@link Parser} and the {@link parse} function.
 *
@@ -181,9 +181,12 @@ declare class Parser {
 	private ctx;
 	constructor(tokens: Token[], options?: ParserOptions);
 	/**
-	* Parse tokens into SyntaxTree
+	* Parse tokens into a {@link ParseResult} containing the AST and
+	* any diagnostics emitted during parsing.
+	*
+	* @since 2.0.0
 	*/
-	parse(): SyntaxTree;
+	parse(): ParseResult;
 	/**
 	* Check if at end of tokens
 	*/
@@ -207,9 +210,18 @@ declare class Parser {
 	private parseBlock;
 }
 /**
-* Parse source string into SyntaxTree
+* Parse a Wikidot markup string into an AST with diagnostics.
+*
+* @example
+* ```ts
+* import { parse } from "@wdprlib/parser";
+*
+* const { ast, diagnostics } = parse("**bold** and //italic//");
+* ```
+*
+* @since 2.0.0
 */
-declare function parse(source: string, options?: ParserOptions): SyntaxTree;
+declare function parse(source: string, options?: ParserOptions): ParseResult;
 import { Element as Element2 } from "@wdprlib/ast";
 /**
 * Parser function type for re-parsing substituted template output as wikitext.
@@ -716,7 +728,7 @@ interface DataProvider {
 	*/
 	getPageTags?: IfTagsResolver;
 }
-import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
+import { SyntaxTree } from "@wdprlib/ast";
 /**
 * Complete result of extracting data requirements from an AST.
 *
@@ -746,7 +758,7 @@ interface ExtractionResult {
 * @param ast - The parsed syntax tree to analyze
 * @returns Extraction result containing requirements and compiled templates
 */
-declare function extractDataRequirements(ast: SyntaxTree2): ExtractionResult;
+declare function extractDataRequirements(ast: SyntaxTree): ExtractionResult;
 /**
 * Compile a ListPages template string into an executable function.
 *
@@ -914,7 +926,7 @@ declare function isListUsersModule(module: Module3): module is ListUsersModuleDa
 * @returns Array of AST elements produced by parsing the rendered template
 */
 declare function resolveListUsers(_module: ListUsersModuleData, data: ListUsersExternalData, compiledTemplate: ListUsersCompiledTemplate, parse: ParseFunction): Element5[];
-import { SyntaxTree as SyntaxTree3 } from "@wdprlib/ast";
+import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
 /**
 * Configuration for {@link resolveModules}.
 *
@@ -963,5 +975,6 @@ interface ResolveOptions {
 * @param dataProvider - Callback provider to fetch data for each module
 * @param options - Resolution options including requirements
 */
-declare function resolveModules(ast: SyntaxTree3, dataProvider: DataProvider, options: ResolveOptions): Promise<SyntaxTree3>;
-export { tokenize, text, resolveModules, resolveListUsers, resolveIncludes, parseTags, parseParent, parseOrder, parseNumericSelector, parseDateSelector, parseCategory, parse, paragraph, normalizeQuery, listItemSubList, listItemElements, list, link, lineBreak, italics, isListUsersModule, horizontalRule, heading, extractListUsersVariables, extractDataRequirements, createToken, createSettings, createPosition, createPoint, container, compileTemplate, compileListUsersTemplate, bold, WikitextSettings4 as WikitextSettings, WikitextMode, Version2 as Version, VariableMap, VariableContext, UserInfo, TokenType, Token, TocEntry2 as TocEntry, TableRow, TableData, TableCell, TabData, SyntaxTree4 as SyntaxTree, SiteContext, ResolveOptions, ResolveIncludesOptions, Position2 as Position, Point, ParserOptions, Parser, ParseFunction, PageRef2 as PageRef, PageData, NormalizedTags, NormalizedParent, NormalizedOrder, NormalizedNumericSelector, NormalizedListPagesQuery, NormalizedDateSelector, NormalizedCategory, Module4 as Module, ListUsersVariableContext, ListUsersVariable, ListUsersUserData, ListUsersExternalData, ListUsersDataRequirement, ListUsersDataFetcher, ListUsersCompiledTemplate, ListType, ListPagesVariable, ListPagesQuery, ListPagesExternalData, ListPagesDataRequirement, ListPagesDataFetcher, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LexerOptions, Lexer, IncludeFetcher, ImageSource, HeadingLevel, Heading, HeaderType, FloatAlignment, ExtractionResult, Embed, Element6 as Element, DefinitionListItem, DateItem, DataRequirements, DataProvider, DEFAULT_SETTINGS, ContainerType, ContainerData, CompiledTemplate, CollapsibleData, CodeBlockData2 as CodeBlockData, ClearFloat, AttributeMap, AnchorTarget, Alignment, AlignType };
+declare function resolveModules(ast: SyntaxTree2, dataProvider: DataProvider, options: ResolveOptions): Promise<SyntaxTree2>;
+import { STYLE_SLOT_PREFIX } from "@wdprlib/ast";
+export { tokenize, text, resolveModules, resolveListUsers, resolveIncludes, parseTags, parseParent, parseOrder, parseNumericSelector, parseDateSelector, parseCategory, parse, paragraph, normalizeQuery, listItemSubList, listItemElements, list, link, lineBreak, italics, isListUsersModule, horizontalRule, heading, extractListUsersVariables, extractDataRequirements, createToken, createSettings, createPosition, createPoint, container, compileTemplate, compileListUsersTemplate, bold, WikitextSettings4 as WikitextSettings, WikitextMode, Version2 as Version, VariableMap, VariableContext, UserInfo, TokenType, Token, TocEntry2 as TocEntry, TableRow, TableData, TableCell, TabData, SyntaxTree3 as SyntaxTree, SiteContext, STYLE_SLOT_PREFIX, ResolveOptions, ResolveIncludesOptions, Position2 as Position, Point, ParserOptions, Parser, ParseResult2 as ParseResult, ParseFunction, PageRef2 as PageRef, PageData, NormalizedTags, NormalizedParent, NormalizedOrder, NormalizedNumericSelector, NormalizedListPagesQuery, NormalizedDateSelector, NormalizedCategory, Module4 as Module, ListUsersVariableContext, ListUsersVariable, ListUsersUserData, ListUsersExternalData, ListUsersDataRequirement, ListUsersDataFetcher, ListUsersCompiledTemplate, ListType, ListPagesVariable, ListPagesQuery, ListPagesExternalData, ListPagesDataRequirement, ListPagesDataFetcher, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LexerOptions, Lexer, IncludeFetcher, ImageSource, HeadingLevel, Heading, HeaderType, FloatAlignment, ExtractionResult, Embed, Element6 as Element, DiagnosticSeverity, Diagnostic2 as Diagnostic, DefinitionListItem, DateItem, DataRequirements, DataProvider, DEFAULT_SETTINGS, ContainerType, ContainerData, CompiledTemplate, CollapsibleData, CodeBlockData2 as CodeBlockData, ClearFloat, AttributeMap, AnchorTarget, Alignment, AlignType };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Position as Position2, Point, Version as Version2, Element as Element6, SyntaxTree as SyntaxTree4, ContainerType, ContainerData, AttributeMap, VariableMap, Alignment, LinkType, LinkLocation, LinkLabel, PageRef as PageRef2, ImageSource, FloatAlignment, ListType, ListItem, ListData, CodeBlockData as CodeBlockData2, TabData, TableCell, TableRow, TableData, DefinitionListItem, Module as Module4, CollapsibleData, ClearFloat, AnchorTarget, HeaderType, AlignType, HeadingLevel, Heading, DateItem, Embed, TocEntry as TocEntry2 } from "@wdprlib/ast";
+import { Position as Position2, Point, Version as Version2, Element as Element6, SyntaxTree as SyntaxTree3, ContainerType, ContainerData, AttributeMap, VariableMap, Alignment, LinkType, LinkLocation, LinkLabel, PageRef as PageRef2, ImageSource, FloatAlignment, ListType, ListItem, ListData, CodeBlockData as CodeBlockData2, TabData, TableCell, TableRow, TableData, DefinitionListItem, Module as Module4, CollapsibleData, ClearFloat, AnchorTarget, HeaderType, AlignType, HeadingLevel, Heading, DateItem, Embed, TocEntry as TocEntry2, Diagnostic as Diagnostic2, DiagnosticSeverity, ParseResult as ParseResult2 } from "@wdprlib/ast";
 import { createPoint, createPosition, text, container, paragraph, bold, italics, heading, lineBreak, horizontalRule, link, list, listItemElements, listItemSubList } from "@wdprlib/ast";
 import { WikitextMode, WikitextSettings as WikitextSettings4 } from "@wdprlib/ast";
 import { createSettings, DEFAULT_SETTINGS } from "@wdprlib/ast";
@@ -134,7 +134,7 @@ declare class Lexer {
 * @group Lexer
 */
 declare function tokenize(source: string, options?: LexerOptions): Token[];
-import { SyntaxTree, WikitextSettings } from "@wdprlib/ast";
+import { WikitextSettings, ParseResult } from "@wdprlib/ast";
 /**
 * Configuration for the {@link Parser} and the {@link parse} function.
 *
@@ -181,9 +181,12 @@ declare class Parser {
 	private ctx;
 	constructor(tokens: Token[], options?: ParserOptions);
 	/**
-	* Parse tokens into SyntaxTree
+	* Parse tokens into a {@link ParseResult} containing the AST and
+	* any diagnostics emitted during parsing.
+	*
+	* @since 2.0.0
 	*/
-	parse(): SyntaxTree;
+	parse(): ParseResult;
 	/**
 	* Check if at end of tokens
 	*/
@@ -207,9 +210,18 @@ declare class Parser {
 	private parseBlock;
 }
 /**
-* Parse source string into SyntaxTree
+* Parse a Wikidot markup string into an AST with diagnostics.
+*
+* @example
+* ```ts
+* import { parse } from "@wdprlib/parser";
+*
+* const { ast, diagnostics } = parse("**bold** and //italic//");
+* ```
+*
+* @since 2.0.0
 */
-declare function parse(source: string, options?: ParserOptions): SyntaxTree;
+declare function parse(source: string, options?: ParserOptions): ParseResult;
 import { Element as Element2 } from "@wdprlib/ast";
 /**
 * Parser function type for re-parsing substituted template output as wikitext.
@@ -716,7 +728,7 @@ interface DataProvider {
 	*/
 	getPageTags?: IfTagsResolver;
 }
-import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
+import { SyntaxTree } from "@wdprlib/ast";
 /**
 * Complete result of extracting data requirements from an AST.
 *
@@ -746,7 +758,7 @@ interface ExtractionResult {
 * @param ast - The parsed syntax tree to analyze
 * @returns Extraction result containing requirements and compiled templates
 */
-declare function extractDataRequirements(ast: SyntaxTree2): ExtractionResult;
+declare function extractDataRequirements(ast: SyntaxTree): ExtractionResult;
 /**
 * Compile a ListPages template string into an executable function.
 *
@@ -914,7 +926,7 @@ declare function isListUsersModule(module: Module3): module is ListUsersModuleDa
 * @returns Array of AST elements produced by parsing the rendered template
 */
 declare function resolveListUsers(_module: ListUsersModuleData, data: ListUsersExternalData, compiledTemplate: ListUsersCompiledTemplate, parse: ParseFunction): Element5[];
-import { SyntaxTree as SyntaxTree3 } from "@wdprlib/ast";
+import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
 /**
 * Configuration for {@link resolveModules}.
 *
@@ -963,5 +975,6 @@ interface ResolveOptions {
 * @param dataProvider - Callback provider to fetch data for each module
 * @param options - Resolution options including requirements
 */
-declare function resolveModules(ast: SyntaxTree3, dataProvider: DataProvider, options: ResolveOptions): Promise<SyntaxTree3>;
-export { tokenize, text, resolveModules, resolveListUsers, resolveIncludes, parseTags, parseParent, parseOrder, parseNumericSelector, parseDateSelector, parseCategory, parse, paragraph, normalizeQuery, listItemSubList, listItemElements, list, link, lineBreak, italics, isListUsersModule, horizontalRule, heading, extractListUsersVariables, extractDataRequirements, createToken, createSettings, createPosition, createPoint, container, compileTemplate, compileListUsersTemplate, bold, WikitextSettings4 as WikitextSettings, WikitextMode, Version2 as Version, VariableMap, VariableContext, UserInfo, TokenType, Token, TocEntry2 as TocEntry, TableRow, TableData, TableCell, TabData, SyntaxTree4 as SyntaxTree, SiteContext, ResolveOptions, ResolveIncludesOptions, Position2 as Position, Point, ParserOptions, Parser, ParseFunction, PageRef2 as PageRef, PageData, NormalizedTags, NormalizedParent, NormalizedOrder, NormalizedNumericSelector, NormalizedListPagesQuery, NormalizedDateSelector, NormalizedCategory, Module4 as Module, ListUsersVariableContext, ListUsersVariable, ListUsersUserData, ListUsersExternalData, ListUsersDataRequirement, ListUsersDataFetcher, ListUsersCompiledTemplate, ListType, ListPagesVariable, ListPagesQuery, ListPagesExternalData, ListPagesDataRequirement, ListPagesDataFetcher, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LexerOptions, Lexer, IncludeFetcher, ImageSource, HeadingLevel, Heading, HeaderType, FloatAlignment, ExtractionResult, Embed, Element6 as Element, DefinitionListItem, DateItem, DataRequirements, DataProvider, DEFAULT_SETTINGS, ContainerType, ContainerData, CompiledTemplate, CollapsibleData, CodeBlockData2 as CodeBlockData, ClearFloat, AttributeMap, AnchorTarget, Alignment, AlignType };
+declare function resolveModules(ast: SyntaxTree2, dataProvider: DataProvider, options: ResolveOptions): Promise<SyntaxTree2>;
+import { STYLE_SLOT_PREFIX } from "@wdprlib/ast";
+export { tokenize, text, resolveModules, resolveListUsers, resolveIncludes, parseTags, parseParent, parseOrder, parseNumericSelector, parseDateSelector, parseCategory, parse, paragraph, normalizeQuery, listItemSubList, listItemElements, list, link, lineBreak, italics, isListUsersModule, horizontalRule, heading, extractListUsersVariables, extractDataRequirements, createToken, createSettings, createPosition, createPoint, container, compileTemplate, compileListUsersTemplate, bold, WikitextSettings4 as WikitextSettings, WikitextMode, Version2 as Version, VariableMap, VariableContext, UserInfo, TokenType, Token, TocEntry2 as TocEntry, TableRow, TableData, TableCell, TabData, SyntaxTree3 as SyntaxTree, SiteContext, STYLE_SLOT_PREFIX, ResolveOptions, ResolveIncludesOptions, Position2 as Position, Point, ParserOptions, Parser, ParseResult2 as ParseResult, ParseFunction, PageRef2 as PageRef, PageData, NormalizedTags, NormalizedParent, NormalizedOrder, NormalizedNumericSelector, NormalizedListPagesQuery, NormalizedDateSelector, NormalizedCategory, Module4 as Module, ListUsersVariableContext, ListUsersVariable, ListUsersUserData, ListUsersExternalData, ListUsersDataRequirement, ListUsersDataFetcher, ListUsersCompiledTemplate, ListType, ListPagesVariable, ListPagesQuery, ListPagesExternalData, ListPagesDataRequirement, ListPagesDataFetcher, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LexerOptions, Lexer, IncludeFetcher, ImageSource, HeadingLevel, Heading, HeaderType, FloatAlignment, ExtractionResult, Embed, Element6 as Element, DiagnosticSeverity, Diagnostic2 as Diagnostic, DefinitionListItem, DateItem, DataRequirements, DataProvider, DEFAULT_SETTINGS, ContainerType, ContainerData, CompiledTemplate, CollapsibleData, CodeBlockData2 as CodeBlockData, ClearFloat, AttributeMap, AnchorTarget, Alignment, AlignType };