@wdprlib/render 2.0.0 → 3.0.0

package/dist/index.d.cts

@@ -1,21 +1,19 @@
 import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
-import { Element, WikitextSettings } from "@wdprlib/ast";
+import { Element as Element2, WikitextSettings as WikitextSettings2 } from "@wdprlib/ast";
 /**
-* Allowlist entry for embed content validation
-* Each entry specifies a host pattern and optional path prefix
+* Allowlist entry for embed content validation.
 */
 interface EmbedAllowlistEntry {
-	/** Host pattern. Supports wildcard prefix '*.' (e.g., '*.youtube.com') */
+	/** Host pattern. Supports wildcard prefix `*.` such as `*.youtube.com`. */
 	host: string;
-	/** Optional path prefix that must match (e.g., '/embed/') */
+	/** Optional path prefix that must match, such as `/embed/`. */
 	pathPrefix?: string;
 }
 /**
-* Default allowlist for embed content (ported from Wikidot's default.php)
-* Only iframes with src matching these host+path patterns will be rendered.
+* Default allowlist for embed content.
 *
-* Note: Set to null to allow any HTTPS iframe (Wikidot's 'anyiframe' behavior).
-* sanitize-html still enforces HTTPS-only and blocks dangerous attributes.
+* Set the render option to `null` to allow any HTTP(S) iframe while still using
+* sanitizer and scheme validation.
 */
 declare const DEFAULT_EMBED_ALLOWLIST: EmbedAllowlistEntry[] | null;
 /**
@@ -30,10 +28,14 @@ declare const DEFAULT_EMBED_ALLOWLIST: EmbedAllowlistEntry[] | null;
 interface PageContext {
 	/** Full page name including category prefix (e.g. `"secret:test2"`) */
 	pageName: string;
-	/** Site slug used to build inter-site URLs (e.g. `"scp-wiki"`) */
+	/** Site slug for the current page (e.g. `"scp-wiki"`) */
 	site?: string;
-	/** Site domain used for absolute URL generation (e.g. `"scp-wiki.wikidot.com"`) */
+	/** Current site domain used for absolute URL generation (e.g. `"scp-wiki.example.org"`) */
 	domain?: string;
+	/** Known domains for cross-site page references keyed by site slug. */
+	siteDomains?: Record<string, string>;
+	/** Resolve a cross-site page reference site slug to a domain. */
+	resolveSiteDomain?: (site: string) => string | null | undefined;
 	/**
 	* Returns whether a page exists on the site.
 	* When a target page does not exist, the renderer adds `class="newpage"`
@@ -116,7 +118,7 @@ interface RenderOptions {
 	* Context-dependent feature flags.
 	* Defaults to page-mode settings when omitted.
 	*/
-	settings?: WikitextSettings;
+	settings?: WikitextSettings2;
 	/** Page context for resolving relative links, local file paths, etc. */
 	page?: PageContext;
 	/**
@@ -124,7 +126,7 @@ interface RenderOptions {
 	* Passed through so the renderer can emit footnote bodies in the
 	* `[[footnoteblock]]` section.
 	*/
-	footnotes?: Element[][];
+	footnotes?: Element2[][];
 	/** Callbacks for resolving users, HTML-block URLs, etc. */
 	resolvers?: RenderResolvers;
 	/**

package/dist/index.d.ts

@@ -1,21 +1,19 @@
 import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
-import { Element, WikitextSettings } from "@wdprlib/ast";
+import { Element as Element2, WikitextSettings as WikitextSettings2 } from "@wdprlib/ast";
 /**
-* Allowlist entry for embed content validation
-* Each entry specifies a host pattern and optional path prefix
+* Allowlist entry for embed content validation.
 */
 interface EmbedAllowlistEntry {
-	/** Host pattern. Supports wildcard prefix '*.' (e.g., '*.youtube.com') */
+	/** Host pattern. Supports wildcard prefix `*.` such as `*.youtube.com`. */
 	host: string;
-	/** Optional path prefix that must match (e.g., '/embed/') */
+	/** Optional path prefix that must match, such as `/embed/`. */
 	pathPrefix?: string;
 }
 /**
-* Default allowlist for embed content (ported from Wikidot's default.php)
-* Only iframes with src matching these host+path patterns will be rendered.
+* Default allowlist for embed content.
 *
-* Note: Set to null to allow any HTTPS iframe (Wikidot's 'anyiframe' behavior).
-* sanitize-html still enforces HTTPS-only and blocks dangerous attributes.
+* Set the render option to `null` to allow any HTTP(S) iframe while still using
+* sanitizer and scheme validation.
 */
 declare const DEFAULT_EMBED_ALLOWLIST: EmbedAllowlistEntry[] | null;
 /**
@@ -30,10 +28,14 @@ declare const DEFAULT_EMBED_ALLOWLIST: EmbedAllowlistEntry[] | null;
 interface PageContext {
 	/** Full page name including category prefix (e.g. `"secret:test2"`) */
 	pageName: string;
-	/** Site slug used to build inter-site URLs (e.g. `"scp-wiki"`) */
+	/** Site slug for the current page (e.g. `"scp-wiki"`) */
 	site?: string;
-	/** Site domain used for absolute URL generation (e.g. `"scp-wiki.wikidot.com"`) */
+	/** Current site domain used for absolute URL generation (e.g. `"scp-wiki.example.org"`) */
 	domain?: string;
+	/** Known domains for cross-site page references keyed by site slug. */
+	siteDomains?: Record<string, string>;
+	/** Resolve a cross-site page reference site slug to a domain. */
+	resolveSiteDomain?: (site: string) => string | null | undefined;
 	/**
 	* Returns whether a page exists on the site.
 	* When a target page does not exist, the renderer adds `class="newpage"`
@@ -116,7 +118,7 @@ interface RenderOptions {
 	* Context-dependent feature flags.
 	* Defaults to page-mode settings when omitted.
 	*/
-	settings?: WikitextSettings;
+	settings?: WikitextSettings2;
 	/** Page context for resolving relative links, local file paths, etc. */
 	page?: PageContext;
 	/**
@@ -124,7 +126,7 @@ interface RenderOptions {
 	* Passed through so the renderer can emit footnote bodies in the
 	* `[[footnoteblock]]` section.
 	*/
-	footnotes?: Element[][];
+	footnotes?: Element2[][];
 	/** Callbacks for resolving users, HTML-block URLs, etc. */
 	resolvers?: RenderResolvers;
 	/**