@wdprlib/ast 2.2.0 → 2.3.0

package/dist/index.d.cts

@@ -642,6 +642,78 @@ interface ImageData {
 	attributes: AttributeMap;
 }
 /**
+* Image size keyword accepted by `[[gallery]]`.
+* Invalid or missing values fall back to `"thumbnail"` at parse time,
+* matching the Wikidot renderer.
+*
+* @group Element Data
+*/
+type GallerySize = "small" | "medium" | "thumbnail" | "square" | "original";
+/**
+* Sort order for auto-collected gallery files, normalized at parse time.
+* Deprecated Wikidot aliases (`nameDesc`, `dateAdded`, `dateAddedDesc`) and
+* the ListPages-style `"... desc desc"` forms are folded into these four
+* values. Only meaningful for the content-less (auto) form.
+*
+* @group Element Data
+*/
+type GalleryOrder = "name" | "name desc" | "created_at" | "created_at desc";
+/**
+* A single `: source link="..." alt="..."` entry inside `[[gallery]]`.
+*
+* @group Element Data
+*/
+interface GalleryItem {
+	/**
+	* Raw image source string with any leading `*` removed.
+	* Classification follows the Wikidot rules and happens at render time:
+	* a source containing `://` is external, one containing `/` refers to
+	* another page's file, anything else is a file on the current page.
+	*/
+	source: string;
+	/**
+	* Link target with any leading `*` removed, or null when the item has no
+	* `link` attribute.
+	*/
+	link: string | null;
+	/** Alternative text for the image, or null when no `alt` attribute is given */
+	alt: string | null;
+	/** true if the link opens in a new window (`*` prefix on source or link) */
+	newWindow: boolean;
+}
+/**
+* Body of a `[[gallery]]` element.
+*
+* - `"items"` — the content form with explicit `: source` lines.
+*   `items` is always non-empty: the content form requires at least one
+*   line to parse.
+* - `"auto"` — the content-less form, which shows the current page's image
+*   attachments. `files` is null until data resolution fills it with the
+*   attachment filenames (already sorted by the gallery's `order`).
+*
+* @group Element Data
+*/
+type GalleryContent = {
+	type: "items";
+	items: GalleryItem[];
+} | {
+	type: "auto";
+	files: string[] | null;
+};
+/**
+* Data for `[[gallery]]` elements.
+*
+* @group Element Data
+*/
+interface GalleryData {
+	size: GallerySize;
+	/** Sort order for auto-collected files (parse-time normalized) */
+	order: GalleryOrder;
+	/** false when `viewer="no"`/`"false"` disables the lightbox */
+	viewer: boolean;
+	content: GalleryContent;
+}
+/**
 * Data for `[[toc]]` (table of contents) elements.
 *
 * @group Element Data
@@ -852,6 +924,7 @@ type ElementDataMap = {
 	"anchor-name": string;
 	link: LinkData;
 	image: ImageData;
+	gallery: GalleryData;
 	list: ListData;
 	"definition-list": DefinitionListItem[];
 	collapsible: CollapsibleData;
@@ -1330,4 +1403,4 @@ declare function evaluateExpression(expr: string): ExprResult;
 * @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, bold, WikitextSettings, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, STYLE_SLOT_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, 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, isHeaderType, isContainerTypeParagraphSafe, isAlignType, horizontalRule, heading, formatExprValue, evaluateExpression, createSettings, createPosition, createPoint, container, bold, WikitextSettings, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, STYLE_SLOT_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 };

package/dist/index.d.ts

@@ -642,6 +642,78 @@ interface ImageData {
 	attributes: AttributeMap;
 }
 /**
+* Image size keyword accepted by `[[gallery]]`.
+* Invalid or missing values fall back to `"thumbnail"` at parse time,
+* matching the Wikidot renderer.
+*
+* @group Element Data
+*/
+type GallerySize = "small" | "medium" | "thumbnail" | "square" | "original";
+/**
+* Sort order for auto-collected gallery files, normalized at parse time.
+* Deprecated Wikidot aliases (`nameDesc`, `dateAdded`, `dateAddedDesc`) and
+* the ListPages-style `"... desc desc"` forms are folded into these four
+* values. Only meaningful for the content-less (auto) form.
+*
+* @group Element Data
+*/
+type GalleryOrder = "name" | "name desc" | "created_at" | "created_at desc";
+/**
+* A single `: source link="..." alt="..."` entry inside `[[gallery]]`.
+*
+* @group Element Data
+*/
+interface GalleryItem {
+	/**
+	* Raw image source string with any leading `*` removed.
+	* Classification follows the Wikidot rules and happens at render time:
+	* a source containing `://` is external, one containing `/` refers to
+	* another page's file, anything else is a file on the current page.
+	*/
+	source: string;
+	/**
+	* Link target with any leading `*` removed, or null when the item has no
+	* `link` attribute.
+	*/
+	link: string | null;
+	/** Alternative text for the image, or null when no `alt` attribute is given */
+	alt: string | null;
+	/** true if the link opens in a new window (`*` prefix on source or link) */
+	newWindow: boolean;
+}
+/**
+* Body of a `[[gallery]]` element.
+*
+* - `"items"` — the content form with explicit `: source` lines.
+*   `items` is always non-empty: the content form requires at least one
+*   line to parse.
+* - `"auto"` — the content-less form, which shows the current page's image
+*   attachments. `files` is null until data resolution fills it with the
+*   attachment filenames (already sorted by the gallery's `order`).
+*
+* @group Element Data
+*/
+type GalleryContent = {
+	type: "items";
+	items: GalleryItem[];
+} | {
+	type: "auto";
+	files: string[] | null;
+};
+/**
+* Data for `[[gallery]]` elements.
+*
+* @group Element Data
+*/
+interface GalleryData {
+	size: GallerySize;
+	/** Sort order for auto-collected files (parse-time normalized) */
+	order: GalleryOrder;
+	/** false when `viewer="no"`/`"false"` disables the lightbox */
+	viewer: boolean;
+	content: GalleryContent;
+}
+/**
 * Data for `[[toc]]` (table of contents) elements.
 *
 * @group Element Data
@@ -852,6 +924,7 @@ type ElementDataMap = {
 	"anchor-name": string;
 	link: LinkData;
 	image: ImageData;
+	gallery: GalleryData;
 	list: ListData;
 	"definition-list": DefinitionListItem[];
 	collapsible: CollapsibleData;
@@ -1330,4 +1403,4 @@ declare function evaluateExpression(expr: string): ExprResult;
 * @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, bold, WikitextSettings, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, STYLE_SLOT_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, 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, isHeaderType, isContainerTypeParagraphSafe, isAlignType, horizontalRule, heading, formatExprValue, evaluateExpression, createSettings, createPosition, createPoint, container, bold, WikitextSettings, WikitextMode, Version, VariableMap, UserData, TocEntry, TableRow, TableOfContentsData, TableData, TableCell, TabData, SyntaxTree, StringContainerType, STYLE_SLOT_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 };

package/package.json

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

package/src/element.ts

@@ -658,6 +658,79 @@ export interface ImageData {
   attributes: AttributeMap;
 }
 
+/**
+ * Image size keyword accepted by `[[gallery]]`.
+ * Invalid or missing values fall back to `"thumbnail"` at parse time,
+ * matching the Wikidot renderer.
+ *
+ * @group Element Data
+ */
+export type GallerySize = "small" | "medium" | "thumbnail" | "square" | "original";
+
+/**
+ * Sort order for auto-collected gallery files, normalized at parse time.
+ * Deprecated Wikidot aliases (`nameDesc`, `dateAdded`, `dateAddedDesc`) and
+ * the ListPages-style `"... desc desc"` forms are folded into these four
+ * values. Only meaningful for the content-less (auto) form.
+ *
+ * @group Element Data
+ */
+export type GalleryOrder = "name" | "name desc" | "created_at" | "created_at desc";
+
+/**
+ * A single `: source link="..." alt="..."` entry inside `[[gallery]]`.
+ *
+ * @group Element Data
+ */
+export interface GalleryItem {
+  /**
+   * Raw image source string with any leading `*` removed.
+   * Classification follows the Wikidot rules and happens at render time:
+   * a source containing `://` is external, one containing `/` refers to
+   * another page's file, anything else is a file on the current page.
+   */
+  source: string;
+  /**
+   * Link target with any leading `*` removed, or null when the item has no
+   * `link` attribute.
+   */
+  link: string | null;
+  /** Alternative text for the image, or null when no `alt` attribute is given */
+  alt: string | null;
+  /** true if the link opens in a new window (`*` prefix on source or link) */
+  newWindow: boolean;
+}
+
+/**
+ * Body of a `[[gallery]]` element.
+ *
+ * - `"items"` — the content form with explicit `: source` lines.
+ *   `items` is always non-empty: the content form requires at least one
+ *   line to parse.
+ * - `"auto"` — the content-less form, which shows the current page's image
+ *   attachments. `files` is null until data resolution fills it with the
+ *   attachment filenames (already sorted by the gallery's `order`).
+ *
+ * @group Element Data
+ */
+export type GalleryContent =
+  | { type: "items"; items: GalleryItem[] }
+  | { type: "auto"; files: string[] | null };
+
+/**
+ * Data for `[[gallery]]` elements.
+ *
+ * @group Element Data
+ */
+export interface GalleryData {
+  size: GallerySize;
+  /** Sort order for auto-collected files (parse-time normalized) */
+  order: GalleryOrder;
+  /** false when `viewer="no"`/`"false"` disables the lightbox */
+  viewer: boolean;
+  content: GalleryContent;
+}
+
 /**
  * Data for `[[toc]]` (table of contents) elements.
  *
@@ -890,6 +963,7 @@ export type ElementDataMap = {
   "anchor-name": string;
   link: LinkData;
   image: ImageData;
+  gallery: GalleryData;
   list: ListData;
   "definition-list": DefinitionListItem[];
   collapsible: CollapsibleData;

package/src/index.ts

@@ -67,6 +67,11 @@ export type {
   AnchorData,
   LinkData,
   ImageData,
+  GallerySize,
+  GalleryOrder,
+  GalleryItem,
+  GalleryContent,
+  GalleryData,
   TableOfContentsData,
   FootnoteBlockData,
   BibliographyCiteData,