@wdprlib/ast 4.1.0 → 4.3.0

package/dist/index.cjs

@@ -40,6 +40,7 @@ __export(exports_src, {
   isTruthy: () => isTruthy,
   isStringContainerType: () => isStringContainerType,
   isParagraphSafe: () => isParagraphSafe,
+  isPageButtonAction: () => isPageButtonAction,
   isHeaderType: () => isHeaderType,
   isContainerTypeParagraphSafe: () => isContainerTypeParagraphSafe,
   isAlignType: () => isAlignType,
@@ -62,8 +63,8 @@ module.exports = __toCommonJS(exports_src);
 
 // packages/ast/src/build-info.generated.ts
 var buildInfo = Object.freeze({
-  version: "4.1.0",
-  sha: "cc290b0d882de3ed9ea33ec060ddfc8a7b9da59a",
+  version: "4.3.0",
+  sha: "5e221ddeccc585e64dd1a2eb49b14817c3c1be5d",
   dirty: false
 });
 // packages/ast/src/position.ts
@@ -159,6 +160,7 @@ function isContainerTypeParagraphSafe(type) {
     case "size":
       return true;
     case "div":
+    case "note":
     case "blockquote":
     case "paragraph":
     case "heading":
@@ -218,7 +220,10 @@ function isParagraphSafe(element) {
     case "user":
       return true;
     case "date":
+    case "social":
       return true;
+    case "button":
+      return isPageButtonAction(element.data.action);
     case "color":
       return true;
     case "code":
@@ -259,6 +264,30 @@ function isParagraphSafe(element) {
       return false;
   }
 }
+function isPageButtonAction(action) {
+  switch (action) {
+    case "edit":
+    case "edit-append":
+    case "edit-sections":
+    case "history":
+    case "print":
+    case "files":
+    case "tags":
+    case "source":
+    case "backlinks":
+    case "talk":
+    case "delete":
+    case "rename":
+    case "site-tools":
+    case "edit-meta":
+    case "watchers":
+    case "parent":
+    case "lock-page":
+      return true;
+    default:
+      return false;
+  }
+}
 // packages/ast/src/constants.ts
 var STYLE_SLOT_PREFIX = "\x00__IFTAGS_SLOT__";
 var STYLE_ANCHOR_PREFIX = "\x00__STYLE_ANCHOR__";

package/dist/index.d.cts

@@ -171,7 +171,7 @@ interface AlignType {
 *
 * @group Container Types
 */
-type StringContainerType = "bold" | "italics" | "underline" | "superscript" | "subscript" | "strikethrough" | "monospace" | "span" | "div" | "blockquote" | "size" | "paragraph" | "heading" | "collapsible" | "definition-list" | "definition-list-item" | "definition-list-key" | "definition-list-value" | "table-row" | "table-cell";
+type StringContainerType = "bold" | "italics" | "underline" | "superscript" | "subscript" | "strikethrough" | "monospace" | "span" | "div" | "note" | "blockquote" | "size" | "paragraph" | "heading" | "collapsible" | "definition-list" | "definition-list-item" | "definition-list-key" | "definition-list-value" | "table-row" | "table-cell";
 /**
 * Union of all container type discriminators.
 * Every container element in the AST carries one of these to identify
@@ -730,6 +730,20 @@ interface TableOfContentsData {
 	align: Alignment | null;
 }
 /**
+* Resolved pagination state and navigation targets.
+*
+* @group Element Data
+*/
+interface PagerData {
+	currentPage: number;
+	totalPages: number;
+	/** Ascending targets, including the current page, its neighbors, and both ends. */
+	pages: {
+		page: number;
+		href: string;
+	}[];
+}
+/**
 * Data for `[[footnoteblock]]` elements.
 *
 * @group Element Data
@@ -785,9 +799,29 @@ interface DateData {
 	value: DateItem;
 	/** strftime-style format string, or null for default */
 	format: string | null;
-	/** Whether to show a tooltip with the full date on hover */
+	/** Whether to show elapsed time in a tooltip on hover */
 	hover: boolean;
 }
+/** Standalone page-option action, used by [[button action]].
+* @group Element Data
+*/
+type PageButtonAction = "edit" | "edit-append" | "edit-sections" | "history" | "print" | "files" | "tags" | "source" | "backlinks" | "talk" | "delete" | "rename" | "site-tools" | "edit-meta" | "watchers" | "parent" | "lock-page";
+/** Data for a standalone [[button]] element.
+* @group Element Data
+*/
+interface PageButtonData {
+	/** Unknown actions remain representable so the renderer can display the error. */
+	action: string;
+	text: string | null;
+	attributes: AttributeMap;
+}
+/** Data for [[social]], with null selecting the default services.
+* @group Element Data
+*/
+interface SocialData {
+	/** Unsupported names remain representable, but produce no share link. */
+	sites: string[] | null;
+}
 /**
 * Data for `##color|text##` inline color syntax.
 *
@@ -936,6 +970,7 @@ type ElementDataMap = {
 	"definition-list": DefinitionListItem[];
 	collapsible: CollapsibleData;
 	"table-of-contents": TableOfContentsData;
+	pager: PagerData;
 	footnote: void;
 	"footnote-ref": number;
 	"footnote-block": FootnoteBlockData;
@@ -943,6 +978,8 @@ type ElementDataMap = {
 	"bibliography-block": BibliographyBlockData;
 	user: UserData;
 	date: DateData;
+	button: PageButtonData;
+	social: SocialData;
 	color: ColorData;
 	code: CodeBlockData;
 	math: MathData;
@@ -1147,6 +1184,8 @@ declare function isContainerTypeParagraphSafe(type: ContainerType): boolean;
 * @group Utilities
 */
 declare function isParagraphSafe(element: Element): boolean;
+/** Whether a standalone button names a supported page action. */
+declare function isPageButtonAction(action: string): action is PageButtonAction;
 /**
 * Severity level of a diagnostic.
 *
@@ -1439,4 +1478,4 @@ interface WikitextPageContext {
 * @group Core
 */
 type Version = "wikidot";
-export { text, paragraph, listItemSubList, listItemElements, list, link, lineBreak, italics, isTruthy, isStringContainerType, isParagraphSafe, isHeaderType, isContainerTypeParagraphSafe, isAlignType, horizontalRule, heading, formatExprValue, evaluateExpression, createSettings, createPosition, createPoint, container, buildInfo, bold, WikitextSettings, WikitextPageFile, WikitextPageContext, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, STYLE_SLOT_PREFIX, STYLE_ANCHOR_PREFIX, Position, Point, ParseResult, PageRef, Module, MathInlineData, MathData, ListType, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LinkData, IncludeData, ImageSource, ImageData, IframeData, IfTagsData, IfExprData, IfCondData, HtmlData, HeadingLevel, Heading, HeaderType, GallerySize, GalleryOrder, GalleryItem, GalleryData, GalleryContent, FootnoteBlockData, FloatAlignment, ExprResult, ExprData, EmbedBlockData, Embed, ElementOf, ElementName, ElementDataMap, ElementData, Element, DiagnosticSeverity, Diagnostic, DefinitionListItem, DateItem, DateData, DEFAULT_SETTINGS, CssLengthUnit, ContainerType, ContainerData, ColorData, CollapsibleData, CodeBlockData, ClearFloat, CSS_LENGTH_UNITS, BibliographyCiteData, BibliographyBlockData, AttributeMap, AnchorTarget, AnchorData, Alignment, AlignType };
+export { text, paragraph, listItemSubList, listItemElements, list, link, lineBreak, italics, isTruthy, isStringContainerType, isParagraphSafe, isPageButtonAction, isHeaderType, isContainerTypeParagraphSafe, isAlignType, horizontalRule, heading, formatExprValue, evaluateExpression, createSettings, createPosition, createPoint, container, buildInfo, bold, WikitextSettings, WikitextPageFile, WikitextPageContext, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, SocialData, STYLE_SLOT_PREFIX, STYLE_ANCHOR_PREFIX, Position, Point, ParseResult, PagerData, PageRef, PageButtonData, PageButtonAction, Module, MathInlineData, MathData, ListType, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LinkData, IncludeData, ImageSource, ImageData, IframeData, IfTagsData, IfExprData, IfCondData, HtmlData, HeadingLevel, Heading, HeaderType, GallerySize, GalleryOrder, GalleryItem, GalleryData, GalleryContent, FootnoteBlockData, FloatAlignment, ExprResult, ExprData, EmbedBlockData, Embed, ElementOf, ElementName, ElementDataMap, ElementData, Element, DiagnosticSeverity, Diagnostic, DefinitionListItem, DateItem, DateData, DEFAULT_SETTINGS, CssLengthUnit, ContainerType, ContainerData, ColorData, CollapsibleData, CodeBlockData, ClearFloat, CSS_LENGTH_UNITS, BibliographyCiteData, BibliographyBlockData, AttributeMap, AnchorTarget, AnchorData, Alignment, AlignType };

package/dist/index.d.ts

@@ -171,7 +171,7 @@ interface AlignType {
 *
 * @group Container Types
 */
-type StringContainerType = "bold" | "italics" | "underline" | "superscript" | "subscript" | "strikethrough" | "monospace" | "span" | "div" | "blockquote" | "size" | "paragraph" | "heading" | "collapsible" | "definition-list" | "definition-list-item" | "definition-list-key" | "definition-list-value" | "table-row" | "table-cell";
+type StringContainerType = "bold" | "italics" | "underline" | "superscript" | "subscript" | "strikethrough" | "monospace" | "span" | "div" | "note" | "blockquote" | "size" | "paragraph" | "heading" | "collapsible" | "definition-list" | "definition-list-item" | "definition-list-key" | "definition-list-value" | "table-row" | "table-cell";
 /**
 * Union of all container type discriminators.
 * Every container element in the AST carries one of these to identify
@@ -730,6 +730,20 @@ interface TableOfContentsData {
 	align: Alignment | null;
 }
 /**
+* Resolved pagination state and navigation targets.
+*
+* @group Element Data
+*/
+interface PagerData {
+	currentPage: number;
+	totalPages: number;
+	/** Ascending targets, including the current page, its neighbors, and both ends. */
+	pages: {
+		page: number;
+		href: string;
+	}[];
+}
+/**
 * Data for `[[footnoteblock]]` elements.
 *
 * @group Element Data
@@ -785,9 +799,29 @@ interface DateData {
 	value: DateItem;
 	/** strftime-style format string, or null for default */
 	format: string | null;
-	/** Whether to show a tooltip with the full date on hover */
+	/** Whether to show elapsed time in a tooltip on hover */
 	hover: boolean;
 }
+/** Standalone page-option action, used by [[button action]].
+* @group Element Data
+*/
+type PageButtonAction = "edit" | "edit-append" | "edit-sections" | "history" | "print" | "files" | "tags" | "source" | "backlinks" | "talk" | "delete" | "rename" | "site-tools" | "edit-meta" | "watchers" | "parent" | "lock-page";
+/** Data for a standalone [[button]] element.
+* @group Element Data
+*/
+interface PageButtonData {
+	/** Unknown actions remain representable so the renderer can display the error. */
+	action: string;
+	text: string | null;
+	attributes: AttributeMap;
+}
+/** Data for [[social]], with null selecting the default services.
+* @group Element Data
+*/
+interface SocialData {
+	/** Unsupported names remain representable, but produce no share link. */
+	sites: string[] | null;
+}
 /**
 * Data for `##color|text##` inline color syntax.
 *
@@ -936,6 +970,7 @@ type ElementDataMap = {
 	"definition-list": DefinitionListItem[];
 	collapsible: CollapsibleData;
 	"table-of-contents": TableOfContentsData;
+	pager: PagerData;
 	footnote: void;
 	"footnote-ref": number;
 	"footnote-block": FootnoteBlockData;
@@ -943,6 +978,8 @@ type ElementDataMap = {
 	"bibliography-block": BibliographyBlockData;
 	user: UserData;
 	date: DateData;
+	button: PageButtonData;
+	social: SocialData;
 	color: ColorData;
 	code: CodeBlockData;
 	math: MathData;
@@ -1147,6 +1184,8 @@ declare function isContainerTypeParagraphSafe(type: ContainerType): boolean;
 * @group Utilities
 */
 declare function isParagraphSafe(element: Element): boolean;
+/** Whether a standalone button names a supported page action. */
+declare function isPageButtonAction(action: string): action is PageButtonAction;
 /**
 * Severity level of a diagnostic.
 *
@@ -1439,4 +1478,4 @@ interface WikitextPageContext {
 * @group Core
 */
 type Version = "wikidot";
-export { text, paragraph, listItemSubList, listItemElements, list, link, lineBreak, italics, isTruthy, isStringContainerType, isParagraphSafe, isHeaderType, isContainerTypeParagraphSafe, isAlignType, horizontalRule, heading, formatExprValue, evaluateExpression, createSettings, createPosition, createPoint, container, buildInfo, bold, WikitextSettings, WikitextPageFile, WikitextPageContext, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, STYLE_SLOT_PREFIX, STYLE_ANCHOR_PREFIX, Position, Point, ParseResult, PageRef, Module, MathInlineData, MathData, ListType, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LinkData, IncludeData, ImageSource, ImageData, IframeData, IfTagsData, IfExprData, IfCondData, HtmlData, HeadingLevel, Heading, HeaderType, GallerySize, GalleryOrder, GalleryItem, GalleryData, GalleryContent, FootnoteBlockData, FloatAlignment, ExprResult, ExprData, EmbedBlockData, Embed, ElementOf, ElementName, ElementDataMap, ElementData, Element, DiagnosticSeverity, Diagnostic, DefinitionListItem, DateItem, DateData, DEFAULT_SETTINGS, CssLengthUnit, ContainerType, ContainerData, ColorData, CollapsibleData, CodeBlockData, ClearFloat, CSS_LENGTH_UNITS, BibliographyCiteData, BibliographyBlockData, AttributeMap, AnchorTarget, AnchorData, Alignment, AlignType };
+export { text, paragraph, listItemSubList, listItemElements, list, link, lineBreak, italics, isTruthy, isStringContainerType, isParagraphSafe, isPageButtonAction, isHeaderType, isContainerTypeParagraphSafe, isAlignType, horizontalRule, heading, formatExprValue, evaluateExpression, createSettings, createPosition, createPoint, container, buildInfo, bold, WikitextSettings, WikitextPageFile, WikitextPageContext, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, SocialData, STYLE_SLOT_PREFIX, STYLE_ANCHOR_PREFIX, Position, Point, ParseResult, PagerData, PageRef, PageButtonData, PageButtonAction, Module, MathInlineData, MathData, ListType, ListItem, ListData, LinkType, LinkLocation, LinkLabel, LinkData, IncludeData, ImageSource, ImageData, IframeData, IfTagsData, IfExprData, IfCondData, HtmlData, HeadingLevel, Heading, HeaderType, GallerySize, GalleryOrder, GalleryItem, GalleryData, GalleryContent, FootnoteBlockData, FloatAlignment, ExprResult, ExprData, EmbedBlockData, Embed, ElementOf, ElementName, ElementDataMap, ElementData, Element, DiagnosticSeverity, Diagnostic, DefinitionListItem, DateItem, DateData, DEFAULT_SETTINGS, CssLengthUnit, ContainerType, ContainerData, ColorData, CollapsibleData, CodeBlockData, ClearFloat, CSS_LENGTH_UNITS, BibliographyCiteData, BibliographyBlockData, AttributeMap, AnchorTarget, AnchorData, Alignment, AlignType };

package/dist/index.js

@@ -1,7 +1,7 @@
 // packages/ast/src/build-info.generated.ts
 var buildInfo = Object.freeze({
-  version: "4.1.0",
-  sha: "cc290b0d882de3ed9ea33ec060ddfc8a7b9da59a",
+  version: "4.3.0",
+  sha: "5e221ddeccc585e64dd1a2eb49b14817c3c1be5d",
   dirty: false
 });
 // packages/ast/src/position.ts
@@ -97,6 +97,7 @@ function isContainerTypeParagraphSafe(type) {
     case "size":
       return true;
     case "div":
+    case "note":
     case "blockquote":
     case "paragraph":
     case "heading":
@@ -156,7 +157,10 @@ function isParagraphSafe(element) {
     case "user":
       return true;
     case "date":
+    case "social":
       return true;
+    case "button":
+      return isPageButtonAction(element.data.action);
     case "color":
       return true;
     case "code":
@@ -197,6 +201,30 @@ function isParagraphSafe(element) {
       return false;
   }
 }
+function isPageButtonAction(action) {
+  switch (action) {
+    case "edit":
+    case "edit-append":
+    case "edit-sections":
+    case "history":
+    case "print":
+    case "files":
+    case "tags":
+    case "source":
+    case "backlinks":
+    case "talk":
+    case "delete":
+    case "rename":
+    case "site-tools":
+    case "edit-meta":
+    case "watchers":
+    case "parent":
+    case "lock-page":
+      return true;
+    default:
+      return false;
+  }
+}
 // packages/ast/src/constants.ts
 var STYLE_SLOT_PREFIX = "\x00__IFTAGS_SLOT__";
 var STYLE_ANCHOR_PREFIX = "\x00__STYLE_ANCHOR__";
@@ -687,6 +715,7 @@ export {
   isTruthy,
   isStringContainerType,
   isParagraphSafe,
+  isPageButtonAction,
   isHeaderType,
   isContainerTypeParagraphSafe,
   isAlignType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdprlib/ast",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "AST types for Wikidot markup",
   "keywords": [
     "ast",

package/src/build-info.generated.ts

@@ -5,7 +5,7 @@ export const buildInfo: Readonly<{
   sha: string | null;
   dirty: boolean | null;
 }> = Object.freeze({
-  version: "4.1.0",
-  sha: "cc290b0d882de3ed9ea33ec060ddfc8a7b9da59a",
+  version: "4.3.0",
+  sha: "5e221ddeccc585e64dd1a2eb49b14817c3c1be5d",
   dirty: false,
 });

package/src/element.ts

@@ -122,6 +122,7 @@ export type StringContainerType =
   | "monospace"
   | "span"
   | "div"
+  | "note"
   | "blockquote"
   | "size"
   | "paragraph"
@@ -742,6 +743,18 @@ export interface TableOfContentsData {
   align: Alignment | null;
 }
 
+/**
+ * Resolved pagination state and navigation targets.
+ *
+ * @group Element Data
+ */
+export interface PagerData {
+  currentPage: number;
+  totalPages: number;
+  /** Ascending targets, including the current page, its neighbors, and both ends. */
+  pages: { page: number; href: string }[];
+}
+
 /**
  * Data for `[[footnoteblock]]` elements.
  *
@@ -802,10 +815,50 @@ export interface DateData {
   value: DateItem;
   /** strftime-style format string, or null for default */
   format: string | null;
-  /** Whether to show a tooltip with the full date on hover */
+  /** Whether to show elapsed time in a tooltip on hover */
   hover: boolean;
 }
 
+/** Standalone page-option action, used by [[button action]].
+ * @group Element Data
+ */
+export type PageButtonAction =
+  | "edit"
+  | "edit-append"
+  | "edit-sections"
+  | "history"
+  | "print"
+  | "files"
+  | "tags"
+  | "source"
+  | "backlinks"
+  | "talk"
+  | "delete"
+  | "rename"
+  | "site-tools"
+  | "edit-meta"
+  | "watchers"
+  | "parent"
+  | "lock-page";
+
+/** Data for a standalone [[button]] element.
+ * @group Element Data
+ */
+export interface PageButtonData {
+  /** Unknown actions remain representable so the renderer can display the error. */
+  action: string;
+  text: string | null;
+  attributes: AttributeMap;
+}
+
+/** Data for [[social]], with null selecting the default services.
+ * @group Element Data
+ */
+export interface SocialData {
+  /** Unsupported names remain representable, but produce no share link. */
+  sites: string[] | null;
+}
+
 /**
  * Data for `##color|text##` inline color syntax.
  *
@@ -969,6 +1022,7 @@ export type ElementDataMap = {
   "definition-list": DefinitionListItem[];
   collapsible: CollapsibleData;
   "table-of-contents": TableOfContentsData;
+  pager: PagerData;
   footnote: void;
   "footnote-ref": number;
   "footnote-block": FootnoteBlockData;
@@ -976,6 +1030,8 @@ export type ElementDataMap = {
   "bibliography-block": BibliographyBlockData;
   user: UserData;
   date: DateData;
+  button: PageButtonData;
+  social: SocialData;
   color: ColorData;
   code: CodeBlockData;
   math: MathData;
@@ -1269,6 +1325,7 @@ export function isContainerTypeParagraphSafe(type: ContainerType): boolean {
     case "size":
       return true;
     case "div":
+    case "note":
     case "blockquote":
     case "paragraph":
     case "heading":
@@ -1341,7 +1398,10 @@ export function isParagraphSafe(element: Element): boolean {
     case "user":
       return true;
     case "date":
+    case "social":
       return true;
+    case "button":
+      return isPageButtonAction(element.data.action);
     case "color":
       return true;
     case "code":
@@ -1382,3 +1442,29 @@ export function isParagraphSafe(element: Element): boolean {
       return false;
   }
 }
+
+/** Whether a standalone button names a supported page action. */
+export function isPageButtonAction(action: string): action is PageButtonAction {
+  switch (action) {
+    case "edit":
+    case "edit-append":
+    case "edit-sections":
+    case "history":
+    case "print":
+    case "files":
+    case "tags":
+    case "source":
+    case "backlinks":
+    case "talk":
+    case "delete":
+    case "rename":
+    case "site-tools":
+    case "edit-meta":
+    case "watchers":
+    case "parent":
+    case "lock-page":
+      return true;
+    default:
+      return false;
+  }
+}

package/src/index.ts

@@ -75,11 +75,15 @@ export type {
   GalleryContent,
   GalleryData,
   TableOfContentsData,
+  PagerData,
   FootnoteBlockData,
   BibliographyCiteData,
   BibliographyBlockData,
   UserData,
   DateData,
+  PageButtonAction,
+  PageButtonData,
+  SocialData,
   ColorData,
   MathData,
   MathInlineData,
@@ -109,6 +113,7 @@ export {
   isAlignType,
   isContainerTypeParagraphSafe,
   isParagraphSafe,
+  isPageButtonAction,
 } from "./element";
 
 // Diagnostics