@wdprlib/render 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,73 @@
+import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
+import { Element } from "@wdprlib/ast";
+/**
+* Page context for resolving links, images, etc.
+*/
+interface PageContext {
+	/** Current page's full name (e.g., "secret:test2") */
+	pageName: string;
+	/** Site slug (e.g., "scp-wiki") */
+	site?: string;
+	/** Site domain (e.g., "scp-wiki.wikidot.com") */
+	domain?: string;
+	/** Check if a page exists (for "newpage" class on links) */
+	pageExists?: (page: string) => boolean;
+}
+/**
+* Resolved user information for rendering
+*/
+interface ResolvedUser {
+	/** User's display name (defaults to username if not provided) */
+	name?: string;
+	/** User profile URL. If not provided, link becomes non-navigable */
+	url?: string;
+	/** Avatar image URL. If not provided, no avatar is rendered */
+	avatarUrl?: string;
+}
+/**
+* Resolver functions for dynamic content
+*/
+interface RenderResolvers {
+	/**
+	* Resolve user information from username.
+	* Returns user data for rendering, or null if user not found.
+	* If not provided, user elements are rendered as plain text.
+	*/
+	user?: (username: string) => ResolvedUser | null;
+	/**
+	* Returns URL for htmlBlock iframe src.
+	* Called with the index of the htmlBlock (0-based, matching tree["html-blocks"] order).
+	* If not provided or returns empty string, uses default pattern: /{pageName}/html/{hash}-{nonce}
+	*
+	* SECURITY NOTE: The returned URL is used directly in iframe src attribute.
+	* The application is responsible for validating the URL scheme (e.g., rejecting javascript:, data:).
+	*/
+	htmlBlockUrl?: (index: number) => string;
+}
+/**
+* Options for HTML rendering
+*/
+interface RenderOptions {
+	/** Page context for resolving file paths, links, etc. */
+	page?: PageContext;
+	/** Pre-collected footnote elements from SyntaxTree.footnotes */
+	footnotes?: Element[][];
+	/** Resolver functions for dynamic content */
+	resolvers?: RenderResolvers;
+	/**
+	* Sandbox attribute value for htmlBlock iframes.
+	* - undefined/null: No sandbox attribute (Wikidot compatible, scripts can run)
+	* - string: Use as sandbox attribute value (e.g., "allow-scripts allow-same-origin")
+	*
+	* Examples:
+	* - No sandbox (Wikidot compatible): htmlBlockSandbox: null
+	* - Block scripts: htmlBlockSandbox: "allow-same-origin"
+	* - Allow scripts: htmlBlockSandbox: "allow-scripts allow-same-origin"
+	*/
+	htmlBlockSandbox?: string | null;
+}
+/**
+* Render a SyntaxTree to HTML string
+*/
+declare function renderToHtml(tree: SyntaxTree2, options?: RenderOptions): string;
+export { renderToHtml, ResolvedUser, RenderResolvers, RenderOptions, PageContext };

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import { SyntaxTree as SyntaxTree2 } from "@wdprlib/ast";
+import { Element } from "@wdprlib/ast";
+/**
+* Page context for resolving links, images, etc.
+*/
+interface PageContext {
+	/** Current page's full name (e.g., "secret:test2") */
+	pageName: string;
+	/** Site slug (e.g., "scp-wiki") */
+	site?: string;
+	/** Site domain (e.g., "scp-wiki.wikidot.com") */
+	domain?: string;
+	/** Check if a page exists (for "newpage" class on links) */
+	pageExists?: (page: string) => boolean;
+}
+/**
+* Resolved user information for rendering
+*/
+interface ResolvedUser {
+	/** User's display name (defaults to username if not provided) */
+	name?: string;
+	/** User profile URL. If not provided, link becomes non-navigable */
+	url?: string;
+	/** Avatar image URL. If not provided, no avatar is rendered */
+	avatarUrl?: string;
+}
+/**
+* Resolver functions for dynamic content
+*/
+interface RenderResolvers {
+	/**
+	* Resolve user information from username.
+	* Returns user data for rendering, or null if user not found.
+	* If not provided, user elements are rendered as plain text.
+	*/
+	user?: (username: string) => ResolvedUser | null;
+	/**
+	* Returns URL for htmlBlock iframe src.
+	* Called with the index of the htmlBlock (0-based, matching tree["html-blocks"] order).
+	* If not provided or returns empty string, uses default pattern: /{pageName}/html/{hash}-{nonce}
+	*
+	* SECURITY NOTE: The returned URL is used directly in iframe src attribute.
+	* The application is responsible for validating the URL scheme (e.g., rejecting javascript:, data:).
+	*/
+	htmlBlockUrl?: (index: number) => string;
+}
+/**
+* Options for HTML rendering
+*/
+interface RenderOptions {
+	/** Page context for resolving file paths, links, etc. */
+	page?: PageContext;
+	/** Pre-collected footnote elements from SyntaxTree.footnotes */
+	footnotes?: Element[][];
+	/** Resolver functions for dynamic content */
+	resolvers?: RenderResolvers;
+	/**
+	* Sandbox attribute value for htmlBlock iframes.
+	* - undefined/null: No sandbox attribute (Wikidot compatible, scripts can run)
+	* - string: Use as sandbox attribute value (e.g., "allow-scripts allow-same-origin")
+	*
+	* Examples:
+	* - No sandbox (Wikidot compatible): htmlBlockSandbox: null
+	* - Block scripts: htmlBlockSandbox: "allow-same-origin"
+	* - Allow scripts: htmlBlockSandbox: "allow-scripts allow-same-origin"
+	*/
+	htmlBlockSandbox?: string | null;
+}
+/**
+* Render a SyntaxTree to HTML string
+*/
+declare function renderToHtml(tree: SyntaxTree2, options?: RenderOptions): string;
+export { renderToHtml, ResolvedUser, RenderResolvers, RenderOptions, PageContext };