@wdprlib/parser 4.0.0 → 4.2.0

package/src/parser/rules/block/module/listpages/url-resolution/fields.ts

@@ -1,9 +1,9 @@
 import type { ListPagesQuery } from "../types";
 
 export type UrlResolvableField =
-  | { attr: string; queryKey: StringUrlQueryKey; type: "string" }
-  | { attr: string; queryKey: NumberUrlQueryKey; type: "number" }
-  | { attr: string; queryKey: BooleanUrlQueryKey; type: "boolean" };
+  | { attr: string; queryKey: StringUrlQueryKey; type: "string"; urlAttrs?: readonly string[] }
+  | { attr: string; queryKey: NumberUrlQueryKey; type: "number"; urlAttrs?: readonly string[] }
+  | { attr: string; queryKey: BooleanUrlQueryKey; type: "boolean"; urlAttrs?: readonly string[] };
 
 type StringUrlQueryKey = Extract<
   keyof ListPagesQuery,
@@ -33,7 +33,7 @@ export const URL_RESOLVABLE_FIELDS: readonly UrlResolvableField[] = [
   { attr: "limit", queryKey: "limit", type: "number" },
   { attr: "per-page", queryKey: "perPage", type: "number" },
   { attr: "order", queryKey: "order", type: "string" },
-  { attr: "tags", queryKey: "tags", type: "string" },
+  { attr: "tags", queryKey: "tags", type: "string", urlAttrs: ["tag"] },
   { attr: "category", queryKey: "category", type: "string" },
   { attr: "parent", queryKey: "parent", type: "string" },
   { attr: "range", queryKey: "range", type: "string" },

package/src/parser/rules/block/module/listpages/url-resolution/params.ts

@@ -1,3 +1,5 @@
+import { URL_RESOLVABLE_FIELDS } from "./fields";
+
 /**
  * Parse URL path parameters like /offset/1/page2_limit/1.
  * Returns a map of parameter name -> value.
@@ -5,9 +7,10 @@
 export function parseUrlParams(url: string): Map<string, string> {
   const params = new Map<string, string>();
   const parts = url.split("/").filter(Boolean);
+  const pairStart = isUrlParameter(parts[0]) ? 0 : 1;
 
   // Skip the page name (first part), parse key/value pairs.
-  for (let i = 1; i < parts.length - 1; i += 2) {
+  for (let i = pairStart; i < parts.length - 1; i += 2) {
     const key = parts[i];
     const value = parts[i + 1];
     if (key && value) {
@@ -17,3 +20,11 @@ export function parseUrlParams(url: string): Map<string, string> {
 
   return params;
 }
+
+const URL_PARAMETER_NAMES = new Set(
+  URL_RESOLVABLE_FIELDS.flatMap((field) => [field.attr, ...(field.urlAttrs ?? [])]),
+);
+
+function isUrlParameter(param: string | undefined): boolean {
+  return param !== undefined && URL_PARAMETER_NAMES.has(param);
+}

package/src/parser/rules/block/module/listpages/url-resolution/resolve.ts

@@ -25,7 +25,12 @@ export function resolveQuery(
     const rawValue = rawAttributes[field.attr];
     if (!rawValue) continue;
 
-    const resolvedValue = resolveUrlValue(rawValue, field.attr, urlParams, urlAttrPrefix);
+    const resolvedValue = resolveUrlValue(
+      rawValue,
+      getUrlParamNames(field),
+      urlParams,
+      urlAttrPrefix,
+    );
     if (resolvedValue === undefined) continue;
 
     assignResolvedUrlField(resolved, field, resolvedValue);
@@ -34,6 +39,10 @@ export function resolveQuery(
   return resolved;
 }
 
+function getUrlParamNames(field: (typeof URL_RESOLVABLE_FIELDS)[number]): readonly string[] {
+  return field.urlAttrs ? [field.attr, ...field.urlAttrs] : [field.attr];
+}
+
 /**
  * Resolve all `@URL` parameters and normalize the query.
  *

package/src/parser/rules/block/module/listpages/url-resolution/value.ts

@@ -2,14 +2,14 @@
  * Resolve @URL|default format with actual URL parameters.
  *
  * @param rawValue - The raw attribute value (e.g., "@URL|0")
- * @param paramName - The parameter name (e.g., "offset")
+ * @param paramNames - The parameter name or names (e.g., "offset")
  * @param urlParams - Parsed URL parameters
  * @param prefix - Optional URL attribute prefix (e.g., "page2")
  * @returns Resolved value
  */
 export function resolveUrlValue(
   rawValue: string | undefined,
-  paramName: string,
+  paramNames: string | readonly string[],
   urlParams: Map<string, string>,
   prefix?: string,
 ): string | undefined {
@@ -20,6 +20,15 @@ export function resolveUrlValue(
   }
 
   const defaultValue = rawValue.includes("|") ? rawValue.split("|")[1] : undefined;
-  const actualParamName = prefix ? `${prefix}_${paramName}` : paramName;
-  return urlParams.get(actualParamName) ?? defaultValue;
+  for (const paramName of toParamNames(paramNames)) {
+    const actualParamName = prefix ? `${prefix}_${paramName}` : paramName;
+    const value = urlParams.get(actualParamName);
+    if (value !== undefined) return value;
+  }
+
+  return defaultValue;
+}
+
+function toParamNames(paramNames: string | readonly string[]): readonly string[] {
+  return typeof paramNames === "string" ? [paramNames] : paramNames;
 }

package/src/parser/rules/block/module/mapping.ts

@@ -19,6 +19,7 @@ import { joinModuleRule } from "./join/index";
 import { pageTreeModuleRule } from "./page-tree/index";
 import { listPagesModuleRule } from "./listpages/parser";
 import { listUsersModuleRule } from "./listusers/parser";
+import { tagCloudModuleRule } from "./tagcloud/parser";
 
 /**
  * Complete list of all registered module rules.
@@ -35,6 +36,7 @@ export const MODULE_RULES: ModuleRule[] = [
   pageTreeModuleRule,
   listPagesModuleRule,
   listUsersModuleRule,
+  tagCloudModuleRule,
 ];
 
 /**

package/src/parser/rules/block/module/resolution/contexts.ts

@@ -9,8 +9,9 @@ import type {
   ListUsersDataRequirement,
   ListUsersExternalData,
 } from "../listusers/types";
+import type { TagCloudDataRequirement, TagCloudExternalData } from "../tagcloud/types";
 import type { ParseFunction } from "../listpages/resolve";
-import { buildListPagesDataMap, buildListUsersDataMap } from "./data-maps";
+import { buildListPagesDataMap, buildListUsersDataMap, buildTagCloudDataMap } from "./data-maps";
 
 /**
  * Context for ListPages resolution.
@@ -54,6 +55,33 @@ export async function buildListPagesContext(
   };
 }
 
+/**
+ * Context for TagCloud resolution.
+ *
+ * TagCloud has no template body, so unlike ListPages/ListUsers the context
+ * carries only the fetched data.
+ */
+export interface TagCloudContext {
+  dataMap: Map<number, TagCloudExternalData>;
+}
+
+export async function buildTagCloudContext(
+  dataProvider: DataProvider,
+  requirements: TagCloudDataRequirement[],
+): Promise<TagCloudContext | null> {
+  if (requirements.length === 0 || !dataProvider.fetchTagCloud) {
+    return null;
+  }
+
+  const dataMap = await buildTagCloudDataMap(dataProvider, requirements);
+
+  if (dataMap.size === 0) {
+    return null;
+  }
+
+  return { dataMap };
+}
+
 export async function buildListUsersContext(
   dataProvider: DataProvider,
   requirements: ListUsersDataRequirement[],

package/src/parser/rules/block/module/resolution/data-maps.ts

@@ -1,6 +1,7 @@
 import type { DataProvider } from "../types-common";
 import type { ListPagesDataRequirement, ListPagesExternalData } from "../listpages/types";
 import type { ListUsersDataRequirement, ListUsersExternalData } from "../listusers/types";
+import type { TagCloudDataRequirement, TagCloudExternalData } from "../tagcloud/types";
 import { parseUrlParams, resolveAndNormalizeQuery } from "../listpages/url-resolver";
 
 export async function buildListPagesDataMap(
@@ -37,3 +38,19 @@ export async function buildListUsersDataMap(
 
   return dataMap;
 }
+
+export async function buildTagCloudDataMap(
+  dataProvider: DataProvider,
+  requirements: TagCloudDataRequirement[],
+): Promise<Map<number, TagCloudExternalData>> {
+  const dataMap = new Map<number, TagCloudExternalData>();
+
+  for (const req of requirements) {
+    const data = await dataProvider.fetchTagCloud?.(req);
+    if (data) {
+      dataMap.set(req.id, data);
+    }
+  }
+
+  return dataMap;
+}

package/src/parser/rules/block/module/resolution/dynamic-modules.ts

@@ -1,19 +1,23 @@
 import type { Element } from "@wdprlib/ast";
 import { isListPagesModule, resolveListPages } from "../listpages/resolve";
 import { isListUsersModule, resolveListUsers } from "../listusers/resolve";
+import { isTagCloudModule, resolveTagCloud } from "../tagcloud/resolve";
 import { walkElements } from "../walk";
-import type { ListPagesContext, ListUsersContext } from "./contexts";
+import type { ListPagesContext, ListUsersContext, TagCloudContext } from "./contexts";
 
 export interface DynamicModuleContext {
   listPages: ListPagesContext | null;
   listUsers: ListUsersContext | null;
+  tagCloud: TagCloudContext | null;
   fetchListPagesProvided: boolean;
   fetchListUsersProvided: boolean;
+  fetchTagCloudProvided: boolean;
 }
 
 export interface DynamicModuleIds {
   listPagesId: number;
   listUsersId: number;
+  tagCloudId: number;
 }
 
 export interface DynamicModuleResolution {
@@ -75,11 +79,32 @@ export function resolveDynamicModuleElement(
     };
   }
 
+  if (isTagCloudModule(element.data)) {
+    const elements: Element[] = [];
+    const tagCloudId = ids.tagCloudId;
+
+    if (ctx.tagCloud) {
+      const moduleData = ctx.tagCloud.dataMap.get(tagCloudId);
+
+      if (moduleData) {
+        elements.push(...resolveTagCloud(element.data, moduleData));
+      }
+    } else if (!ctx.fetchTagCloudProvided) {
+      elements.push(element);
+    }
+
+    return {
+      handled: true,
+      elements,
+      ids: { ...ids, tagCloudId: tagCloudId + 1 },
+    };
+  }
+
   return { handled: false, elements: [element], ids };
 }
 
 export function countDynamicModules(elements: Element[]): DynamicModuleIds {
-  const counts: DynamicModuleIds = { listPagesId: 0, listUsersId: 0 };
+  const counts: DynamicModuleIds = { listPagesId: 0, listUsersId: 0, tagCloudId: 0 };
   walkElements(elements, (element) => {
     if (element.element !== "module") return;
 
@@ -87,6 +112,8 @@ export function countDynamicModules(elements: Element[]): DynamicModuleIds {
       counts.listPagesId++;
     } else if (isListUsersModule(element.data)) {
       counts.listUsersId++;
+    } else if (isTagCloudModule(element.data)) {
+      counts.tagCloudId++;
     }
   });
   return counts;

package/src/parser/rules/block/module/resolution/walk-resolve.ts

@@ -1,7 +1,7 @@
 import type { Element } from "@wdprlib/ast";
 import { mapElementChildrenWithState } from "../walk";
 import { isIfTagsElement, resolveIfTags, type IfTagsData } from "../iftags/resolve";
-import type { ListPagesContext, ListUsersContext } from "./contexts";
+import type { ListPagesContext, ListUsersContext, TagCloudContext } from "./contexts";
 import { countDynamicModules, resolveDynamicModuleElement } from "./dynamic-modules";
 
 /**
@@ -10,19 +10,24 @@ import { countDynamicModules, resolveDynamicModuleElement } from "./dynamic-modu
 export interface WalkContext {
   listPages: ListPagesContext | null;
   listUsers: ListUsersContext | null;
+  tagCloud: TagCloudContext | null;
   /** Whether fetchListPages callback was provided, even if no data returned. */
   fetchListPagesProvided: boolean;
   /** Whether fetchListUsers callback was provided, even if no data returned. */
   fetchListUsersProvided: boolean;
+  /** Whether fetchTagCloud callback was provided, even if no data returned. */
+  fetchTagCloudProvided: boolean;
   pageTags: string[] | null;
   listPagesIdCounter: number;
   listUsersIdCounter: number;
+  tagCloudIdCounter: number;
 }
 
 export interface WalkResult {
   elements: Element[];
   nextListPagesId: number;
   nextListUsersId: number;
+  nextTagCloudId: number;
 }
 
 /**
@@ -32,13 +37,19 @@ export function walkAndResolve(elements: Element[], ctx: WalkContext): WalkResul
   const result: Element[] = [];
   let listPagesId = ctx.listPagesIdCounter;
   let listUsersId = ctx.listUsersIdCounter;
+  let tagCloudId = ctx.tagCloudIdCounter;
 
   for (const element of elements) {
-    const dynamicModule = resolveDynamicModuleElement(element, ctx, { listPagesId, listUsersId });
+    const dynamicModule = resolveDynamicModuleElement(element, ctx, {
+      listPagesId,
+      listUsersId,
+      tagCloudId,
+    });
     if (dynamicModule.handled) {
       result.push(...dynamicModule.elements);
       listPagesId = dynamicModule.ids.listPagesId;
       listUsersId = dynamicModule.ids.listUsersId;
+      tagCloudId = dynamicModule.ids.tagCloudId;
       continue;
     }
 
@@ -52,20 +63,24 @@ export function walkAndResolve(elements: Element[], ctx: WalkContext): WalkResul
             ...ctx,
             listPagesIdCounter: listPagesId,
             listUsersIdCounter: listUsersId,
+            tagCloudIdCounter: tagCloudId,
           });
           result.push(...childResult.elements);
           listPagesId = childResult.nextListPagesId;
           listUsersId = childResult.nextListUsersId;
+          tagCloudId = childResult.nextTagCloudId;
         } else {
           const counts = countDynamicModules(ifTagsData.elements);
           listPagesId += counts.listPagesId;
           listUsersId += counts.listUsersId;
+          tagCloudId += counts.tagCloudId;
         }
       } else {
         const childResult = walkAndResolve(ifTagsData.elements, {
           ...ctx,
           listPagesIdCounter: listPagesId,
           listUsersIdCounter: listUsersId,
+          tagCloudIdCounter: tagCloudId,
         });
         result.push({
           element: "if-tags",
@@ -76,24 +91,27 @@ export function walkAndResolve(elements: Element[], ctx: WalkContext): WalkResul
         });
         listPagesId = childResult.nextListPagesId;
         listUsersId = childResult.nextListUsersId;
+        tagCloudId = childResult.nextTagCloudId;
       }
       continue;
     }
 
     const mapped = mapElementChildrenWithState(
       element,
-      { listPagesId, listUsersId },
+      { listPagesId, listUsersId, tagCloudId },
       (children, state) => {
         const childResult = walkAndResolve(children, {
           ...ctx,
           listPagesIdCounter: state.listPagesId,
           listUsersIdCounter: state.listUsersId,
+          tagCloudIdCounter: state.tagCloudId,
         });
         return {
           elements: childResult.elements,
           state: {
             listPagesId: childResult.nextListPagesId,
             listUsersId: childResult.nextListUsersId,
+            tagCloudId: childResult.nextTagCloudId,
           },
         };
       },
@@ -101,7 +119,13 @@ export function walkAndResolve(elements: Element[], ctx: WalkContext): WalkResul
     result.push(mapped.element);
     listPagesId = mapped.state.listPagesId;
     listUsersId = mapped.state.listUsersId;
+    tagCloudId = mapped.state.tagCloudId;
   }
 
-  return { elements: result, nextListPagesId: listPagesId, nextListUsersId: listUsersId };
+  return {
+    elements: result,
+    nextListPagesId: listPagesId,
+    nextListUsersId: listUsersId,
+    nextTagCloudId: tagCloudId,
+  };
 }

package/src/parser/rules/block/module/resolve.ts

@@ -21,8 +21,13 @@ import type { DataProvider } from "./types-common";
 import { resolveIncludes } from "./include";
 import type { ListPagesDataRequirement, CompiledTemplate } from "./listpages/types";
 import type { ListUsersDataRequirement, ListUsersCompiledTemplate } from "./listusers/types";
+import type { TagCloudDataRequirement } from "./tagcloud/types";
 import type { ParseFunction } from "./listpages/resolve";
-import { buildListPagesContext, buildListUsersContext } from "./resolution/contexts";
+import {
+  buildListPagesContext,
+  buildListUsersContext,
+  buildTagCloudContext,
+} from "./resolution/contexts";
 import { walkAndResolve } from "./resolution/walk-resolve";
 import { collectStyles } from "./resolution/styles";
 
@@ -71,6 +76,7 @@ export interface ResolveOptions {
   requirements: {
     listPages?: ListPagesDataRequirement[];
     listUsers?: ListUsersDataRequirement[];
+    tagCloud?: TagCloudDataRequirement[];
   };
 
   /**
@@ -139,17 +145,21 @@ export async function resolveModules(
     options.compiledListUsersTemplates,
     parse,
   );
+  const tagCloudCtx = await buildTagCloudContext(dataProvider, options.requirements.tagCloud ?? []);
   const pageTags = dataProvider.getPageTags?.() ?? null;
 
   // Resolve AST
   const resolvedElements = walkAndResolve(ast.elements, {
     listPages: listPagesCtx,
     listUsers: listUsersCtx,
+    tagCloud: tagCloudCtx,
     fetchListPagesProvided: dataProvider.fetchListPages !== undefined,
     fetchListUsersProvided: dataProvider.fetchListUsers !== undefined,
+    fetchTagCloudProvided: dataProvider.fetchTagCloud !== undefined,
     pageTags,
     listPagesIdCounter: 0,
     listUsersIdCounter: 0,
+    tagCloudIdCounter: 0,
   });
 
   // Collect style elements from resolved AST

package/src/parser/rules/block/module/tagcloud/index.ts

@@ -0,0 +1,15 @@
+/**
+ *
+ * Barrel exports for the TagCloud module.
+ *
+ * @module
+ */
+
+export { tagCloudModuleRule } from "./parser";
+export { isTagCloudModule, resolveTagCloud, type TagCloudModuleData } from "./resolve";
+export type {
+  TagCloudDataFetcher,
+  TagCloudDataRequirement,
+  TagCloudExternalData,
+  TagCloudTagData,
+} from "./types";

package/src/parser/rules/block/module/tagcloud/parser.ts

@@ -0,0 +1,127 @@
+/**
+ *
+ * Parser rule for the Wikidot `[[module TagCloud]]` block.
+ *
+ * Parses font size, color, target, limit, and category attributes into a
+ * `tag-cloud` Module AST node, mirroring the validation behavior of Wikidot's
+ * `PagesTagCloudModule`. Invalid font size or color formats produce an error
+ * block element, matching Wikidot's ProcessException messages.
+ *
+ * @module
+ */
+
+import { CSS_LENGTH_UNITS, type CssLengthUnit, type Element, type Module } from "@wdprlib/ast";
+import type { ModuleRule } from "../types";
+
+/**
+ * Matches a font size value like `300%`, `2em`, or `16px`.
+ *
+ * Wikidot only accepts `px`, `em`, and `%` here; wdpr deliberately extends
+ * this to all CSS length units (see `CSS_LENGTH_UNITS`), case-insensitively.
+ */
+const FONT_SIZE_PATTERN = new RegExp(`^([0-9]+)(${CSS_LENGTH_UNITS.join("|")})$`, "i");
+
+/** Matches a color value like `64,64,128` (range is not enforced, per Wikidot). */
+const COLOR_PATTERN = /^[0-9]+,[0-9]+,[0-9]+$/;
+
+/** Matches a strictly positive integer, mirroring PHP's `is_numeric` + `> 0` gate. */
+const POSITIVE_INT_PATTERN = /^[0-9]+$/;
+
+const ERROR_FONT_FORMAT =
+  "Unsupported format for font size. Use a number followed by a CSS length unit such as px, em or %.";
+const ERROR_FONT_MISMATCH = "Format for minFontSize and maxFontSize must use the same unit.";
+const ERROR_COLOR_FORMAT =
+  'Unsupported color format. Use "RRR,GGG,BBB" for Red,Green,Blue each within 0-255 range.';
+
+/** Build the Wikidot-compatible error block for invalid attribute values. */
+function errorBlock(message: string): Element {
+  return {
+    element: "container",
+    data: {
+      type: "div",
+      attributes: { class: "error-block" },
+      elements: [{ element: "text", data: message }],
+    },
+  };
+}
+
+/** Parse a limit value, falling back to 50 unless it is a safe positive integer. */
+function parseLimit(value: string | undefined): number {
+  if (!value || !POSITIVE_INT_PATTERN.test(value)) return 50;
+  const num = Number.parseInt(value, 10);
+  return Number.isSafeInteger(num) && num > 0 ? num : 50;
+}
+
+/** Normalize a target path to `/<path>/tag/`, or the Wikidot default. */
+function normalizeTarget(value: string | undefined): string {
+  if (!value) return "/system:page-tags/tag/";
+  let target = value;
+  if (!target.startsWith("/")) target = `/${target}`;
+  if (!target.endsWith("/")) target = `${target}/`;
+  return `${target}tag/`;
+}
+
+/** Parse a `R,G,B` color string into a tuple (input must match COLOR_PATTERN). */
+function parseColor(value: string): [number, number, number] {
+  const [r = 0, g = 0, b = 0] = value.split(",").map((part) => Number.parseInt(part, 10));
+  return [r, g, b];
+}
+
+/**
+ * Module rule for `[[module TagCloud]]`.
+ *
+ * Displays a weighted cloud of page tags. Font sizes and colors are only
+ * honored when both min and max are given (Wikidot behavior); otherwise the
+ * defaults (100%-300%, rgb(128,128,192)-rgb(64,64,128)) apply. Tag data is
+ * supplied during the resolution phase via `DataProvider.fetchTagCloud`.
+ */
+export const tagCloudModuleRule: ModuleRule = {
+  name: "module-tagcloud",
+  acceptsNames: ["tagcloud"],
+  hasBody: false,
+
+  parse(_ctx, _pos, args): Module | Element {
+    const maxFontSize = args.maxfontsize;
+    const minFontSize = args.minfontsize;
+    const maxColor = args.maxcolor;
+    const minColor = args.mincolor;
+
+    let sizeSmall = 100;
+    let sizeBig = 300;
+    let fontSizeUnit: CssLengthUnit = "%";
+    if (maxFontSize && minFontSize) {
+      const maxMatch = FONT_SIZE_PATTERN.exec(maxFontSize);
+      if (!maxMatch) return errorBlock(ERROR_FONT_FORMAT);
+      const maxUnit = (maxMatch[2] as string).toLowerCase() as CssLengthUnit;
+      const minMatch = FONT_SIZE_PATTERN.exec(minFontSize);
+      if (!minMatch || (minMatch[2] as string).toLowerCase() !== maxUnit) {
+        return errorBlock(ERROR_FONT_MISMATCH);
+      }
+      sizeBig = Number.parseInt(maxMatch[1] as string, 10);
+      sizeSmall = Number.parseInt(minMatch[1] as string, 10);
+      fontSizeUnit = maxUnit;
+    }
+
+    let colorSmall: [number, number, number] = [128, 128, 192];
+    let colorBig: [number, number, number] = [64, 64, 128];
+    if (maxColor && minColor) {
+      if (!COLOR_PATTERN.test(maxColor) || !COLOR_PATTERN.test(minColor)) {
+        return errorBlock(ERROR_COLOR_FORMAT);
+      }
+      colorSmall = parseColor(minColor);
+      colorBig = parseColor(maxColor);
+    }
+
+    return {
+      module: "tag-cloud",
+      "min-font-size": sizeSmall,
+      "max-font-size": sizeBig,
+      "font-size-unit": fontSizeUnit,
+      "min-color": colorSmall,
+      "max-color": colorBig,
+      target: normalizeTarget(args.target),
+      limit: parseLimit(args.limit),
+      category: args.category || null,
+    };
+  },
+};