asciidoctor 4.0.0-alpha.3 → 4.0.0-alpha.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asciidoctor",
-  "version": "4.0.0-alpha.3",
+  "version": "4.0.0-alpha.4",
   "description": "A JavaScript AsciiDoc processor powered by Asciidoctor",
   "type": "module",
   "main": "index.js",
@@ -54,7 +54,7 @@
   },
   "homepage": "https://github.com/asciidoctor/asciidoctor.js",
   "dependencies": {
-    "@asciidoctor/core": "4.0.0-alpha.3"
+    "@asciidoctor/core": "4.0.0-alpha.4"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.13",

package/types/abstract_node.d.ts

@@ -278,10 +278,9 @@ export abstract class AbstractNode {
      * imageUri, the caller must await the returned Promise.
      *
      * @param {string} imageUri - The URI from which to read the image data (http/https/ftp).
-     * @param {boolean} [cacheUri=false] - A Boolean to control caching (not yet supported in JS).
      * @returns {Promise<string>} a Promise resolving to a String data URI.
      */
-    generateDataUriFromUri(imageUri: string, cacheUri?: boolean): Promise<string>;
+    generateDataUriFromUri(imageUri: string): Promise<string>;
     /**
      * Normalize the asset file or directory to a concrete and rinsed path.
      *

package/types/http_cache.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Fetch a URI, routing through the HTTP cache when `cache-uri` is set on the document.
+ * @param {string} uri
+ * @param {object} doc - the current Document instance
+ * @returns {Promise<Response>}
+ */
+export function fetchUri(uri: string, doc: object): Promise<Response>;
+/**
+ * Base HTTP cache class.
+ *
+ * The default implementation delegates directly to fetch() with no caching.
+ * Subclasses override read() to add caching behaviour.
+ */
+export class HttpCache {
+    /**
+     * Fetch content from a URI, optionally from a cache.
+     * @param {string} uri
+     * @returns {Promise<Response>}
+     */
+    read(uri: string): Promise<Response>;
+}
+/**
+ * In-memory HTTP cache.
+ *
+ * Stores successful responses as ArrayBuffers keyed by URI. On a cache hit
+ * a synthetic Response is reconstructed from the stored data without touching
+ * the network. Non-OK responses (4xx, 5xx) are never cached.
+ *
+ * Safe as an ephemeral per-conversion cache or as a longer-lived process-level
+ * cache when registered via HttpCacheManager.setCache().
+ */
+export class MemoryHttpCache extends HttpCache {
+    read(uri: any): Promise<any>;
+    #private;
+}
+export namespace HttpCacheManager {
+    /** @type {HttpCache|null} */
+    let _cache: HttpCache | null;
+    /**
+     * Register a cache to use for all conversions.
+     * Pass null to unregister and revert to the ephemeral default.
+     * @param {HttpCache|null} cache
+     */
+    function setCache(cache: HttpCache | null): void;
+    /**
+     * Return the registered process-level cache, or null if none is registered.
+     * @returns {HttpCache|null}
+     */
+    function getCache(): HttpCache | null;
+    /**
+     * Return the cache to use for a specific document conversion.
+     *
+     * Returns the registered cache if one exists; otherwise creates (or reuses)
+     * an ephemeral MemoryHttpCache scoped to the document's lifetime via a WeakMap.
+     * @param {object} doc - the current Document instance
+     * @returns {HttpCache}
+     */
+    function getCacheForDocument(doc: object): HttpCache;
+}

package/types/index.d.cts

@@ -56,6 +56,9 @@ import { SyntaxHighlighterBase } from './syntax_highlighter.js';
 import { LoggerManager } from './logging.js';
 import { MemoryLogger } from './logging.js';
 import { NullLogger } from './logging.js';
+import { HttpCache } from './http_cache.js';
+import { MemoryHttpCache } from './http_cache.js';
+import { HttpCacheManager } from './http_cache.js';
 import { SafeMode } from './constants.js';
 import { ContentModel } from './constants.js';
 import { Timings } from './timings.js';
@@ -80,4 +83,4 @@ import { deriveBackendTraits } from './converter.js';
 import { DefaultFactory as DefaultSyntaxHighlighterFactory } from './syntax_highlighter.js';
 import Html5Converter from './converter/html5.js';
 import { SyntaxHighlighter } from './syntax_highlighter.js';
-export { convert, convertFile, Document, DocumentTitle, Author, Footnote, ImageReference, RevisionInfo, Logger, AbstractNode, AbstractBlock, Inline, Block, List, ListItem, Section, Reader, SyntaxHighlighterBase, LoggerManager, MemoryLogger, NullLogger, SafeMode, ContentModel, Timings, Registry, Processor, ProcessorExtension, Preprocessor, TreeProcessor, Postprocessor, IncludeProcessor, DocinfoProcessor, BlockProcessor, InlineMacroProcessor, BlockMacroProcessor, Extensions, Cursor, Converter as ConverterFactory, ConverterBase, CustomFactory as ConverterCustomFactory, DefaultConverterFactory, deriveBackendTraits, DefaultSyntaxHighlighterFactory, Html5Converter, SyntaxHighlighter };
+export { convert, convertFile, Document, DocumentTitle, Author, Footnote, ImageReference, RevisionInfo, Logger, AbstractNode, AbstractBlock, Inline, Block, List, ListItem, Section, Reader, SyntaxHighlighterBase, LoggerManager, MemoryLogger, NullLogger, HttpCache, MemoryHttpCache, HttpCacheManager, SafeMode, ContentModel, Timings, Registry, Processor, ProcessorExtension, Preprocessor, TreeProcessor, Postprocessor, IncludeProcessor, DocinfoProcessor, BlockProcessor, InlineMacroProcessor, BlockMacroProcessor, Extensions, Cursor, Converter as ConverterFactory, ConverterBase, CustomFactory as ConverterCustomFactory, DefaultConverterFactory, deriveBackendTraits, DefaultSyntaxHighlighterFactory, Html5Converter, SyntaxHighlighter };

package/types/index.d.ts

@@ -55,6 +55,9 @@ import { SyntaxHighlighterBase } from './syntax_highlighter.js';
 import { LoggerManager } from './logging.js';
 import { MemoryLogger } from './logging.js';
 import { NullLogger } from './logging.js';
+import { HttpCache } from './http_cache.js';
+import { MemoryHttpCache } from './http_cache.js';
+import { HttpCacheManager } from './http_cache.js';
 import { SafeMode } from './constants.js';
 import { ContentModel } from './constants.js';
 import { Timings } from './timings.js';
@@ -79,4 +82,4 @@ import { deriveBackendTraits } from './converter.js';
 import { DefaultFactory as DefaultSyntaxHighlighterFactory } from './syntax_highlighter.js';
 import Html5Converter from './converter/html5.js';
 import { SyntaxHighlighter } from './syntax_highlighter.js';
-export { convert, convertFile, Document, DocumentTitle, Author, Footnote, ImageReference, RevisionInfo, Logger, AbstractNode, AbstractBlock, Inline, Block, List, ListItem, Section, Reader, SyntaxHighlighterBase, LoggerManager, MemoryLogger, NullLogger, SafeMode, ContentModel, Timings, Registry, Processor, ProcessorExtension, Preprocessor, TreeProcessor, Postprocessor, IncludeProcessor, DocinfoProcessor, BlockProcessor, InlineMacroProcessor, BlockMacroProcessor, Extensions, Cursor, Converter as ConverterFactory, ConverterBase, CustomFactory as ConverterCustomFactory, DefaultConverterFactory, deriveBackendTraits, DefaultSyntaxHighlighterFactory, Html5Converter, SyntaxHighlighter };
+export { convert, convertFile, Document, DocumentTitle, Author, Footnote, ImageReference, RevisionInfo, Logger, AbstractNode, AbstractBlock, Inline, Block, List, ListItem, Section, Reader, SyntaxHighlighterBase, LoggerManager, MemoryLogger, NullLogger, HttpCache, MemoryHttpCache, HttpCacheManager, SafeMode, ContentModel, Timings, Registry, Processor, ProcessorExtension, Preprocessor, TreeProcessor, Postprocessor, IncludeProcessor, DocinfoProcessor, BlockProcessor, InlineMacroProcessor, BlockMacroProcessor, Extensions, Cursor, Converter as ConverterFactory, ConverterBase, CustomFactory as ConverterCustomFactory, DefaultConverterFactory, deriveBackendTraits, DefaultSyntaxHighlighterFactory, Html5Converter, SyntaxHighlighter };

package/types/path_resolver.d.ts

@@ -54,11 +54,6 @@ export class PathResolver {
      * @returns {string} The posixified path.
      */
     posixify(path: string): string;
-    /**
-     * @param {string} path
-     * @returns {string}
-     */
-    posixfy(path: string): string;
     /**
      * Expand the path by resolving parent references (..) and removing self references (.).
      * @param {string} path

package/types/stylesheets.d.ts

@@ -6,5 +6,6 @@ declare class StylesheetsClass {
     get primaryStylesheetName(): string;
     primaryStylesheetData(): Promise<string>;
     embedPrimaryStylesheet(): Promise<string>;
+    writePrimaryStylesheet(stylesoutdir: any): Promise<boolean>;
 }
 export {};

package/types/table.d.ts

@@ -113,7 +113,7 @@ declare class Cell extends AbstractBlock<string | string[]> {
         imageUri(targetImage: string, assetDirKey?: string): Promise<string>;
         mediaUri(target: string, assetDirKey?: string): string;
         generateDataUri(targetImage: string, assetDirKey?: string | null): Promise<string>;
-        generateDataUriFromUri(imageUri: string, cacheUri?: boolean): Promise<string>;
+        generateDataUriFromUri(imageUri: string): Promise<string>;
         normalizeAssetPath(assetRef: string, assetName?: string, autocorrect?: boolean): string;
         normalizeSystemPath(target: string, start?: string | null, jail?: string | null, opts?: any): string;
         normalizeWebPath(target: string, start?: string | null, preserveUriTarget?: boolean): string;