@siglum/engine 0.1.0

package/types/storage.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Get metadata for a cached CTAN package.
+ * @param {string} packageName - Package name
+ * @returns {Promise<Object|null>} Package metadata or null
+ */
+export function getPackageMeta(packageName: string): Promise<any | null>;
+/**
+ * Save metadata for a CTAN package.
+ * @param {string} packageName - Package name
+ * @param {Object} meta - Package metadata
+ * @returns {Promise<boolean>} True if saved successfully
+ */
+export function savePackageMeta(packageName: string, meta: any): Promise<boolean>;
+/**
+ * List all cached CTAN packages and their metadata.
+ * @returns {Promise<Object[]>} Array of package metadata objects
+ */
+export function listAllCachedPackages(): Promise<any[]>;
+/**
+ * Ensure the /texlive filesystem is mounted for CTAN package storage.
+ * @returns {Promise<boolean>} True if mounted successfully
+ */
+export function ensureTexliveMounted(): Promise<boolean>;
+/**
+ * Get a bundle from the cache.
+ * @param {string} bundleName - Bundle name
+ * @returns {Promise<ArrayBuffer|null>} Bundle data or null if not cached
+ */
+export function getBundleFromCache(bundleName: string): Promise<ArrayBuffer | null>;
+/**
+ * Save a bundle to the cache.
+ * @param {string} bundleName - Bundle name
+ * @param {ArrayBuffer|SharedArrayBuffer} data - Bundle data
+ * @returns {Promise<boolean>} True if saved successfully
+ */
+export function saveBundleToCache(bundleName: string, data: ArrayBuffer | SharedArrayBuffer): Promise<boolean>;
+/**
+ * Get a manifest from the cache.
+ * @param {string} name - Manifest name (without .json extension)
+ * @returns {Promise<Object|null>} Parsed manifest or null
+ */
+export function getManifestFromCache(name: string): Promise<any | null>;
+/**
+ * Save a manifest to the cache.
+ * @param {string} name - Manifest name (without .json extension)
+ * @param {Object} data - Manifest data
+ * @returns {Promise<boolean>} True if saved successfully
+ */
+export function saveManifestToCache(name: string, data: any): Promise<boolean>;
+/**
+ * Get the cached manifest version number.
+ * @returns {Promise<number>} Version number (0 if not set)
+ */
+export function getManifestVersion(): Promise<number>;
+/**
+ * Save the manifest version number.
+ * @param {number} version - Version number
+ * @returns {Promise<boolean>} True if saved successfully
+ */
+export function saveManifestVersion(version: number): Promise<boolean>;
+/**
+ * Get cached aux files for a preamble hash.
+ * @param {string} preambleHash - Hash of the document preamble
+ * @returns {Promise<{hash: string, files: Object, timestamp: number}|null>} Cached entry or null
+ */
+export function getAuxCache(preambleHash: string): Promise<{
+    hash: string;
+    files: any;
+    timestamp: number;
+} | null>;
+/**
+ * Save aux files for a preamble hash.
+ * @param {string} preambleHash - Hash of the document preamble
+ * @param {Object} auxFiles - Aux files to cache
+ * @returns {Promise<void>}
+ */
+export function saveAuxCache(preambleHash: string, auxFiles: any): Promise<void>;
+/**
+ * Get a cached compiled PDF.
+ * @param {string} docHash - Document content hash
+ * @param {string} engine - Engine used ('pdflatex', 'xelatex', 'lualatex')
+ * @returns {Promise<Uint8Array|null>} PDF data or null if not cached
+ */
+export function getCachedPdf(docHash: string, engine: string): Promise<Uint8Array | null>;
+/**
+ * Save a compiled PDF to the cache.
+ * @param {string} docHash - Document content hash
+ * @param {string} engine - Engine used ('pdflatex', 'xelatex', 'lualatex')
+ * @param {Uint8Array} pdfData - PDF data
+ * @returns {Promise<void>}
+ */
+export function saveCachedPdf(docHash: string, engine: string, pdfData: Uint8Array): Promise<void>;
+/**
+ * Get the path for a format file.
+ * @param {string} fmtKey - Format key
+ * @returns {string} Path to format file
+ */
+export function getFmtPath(fmtKey: string): string;
+/**
+ * Clear all cached CTAN package metadata.
+ * @returns {Promise<boolean>} True if cleared successfully
+ */
+export function clearCTANCache(): Promise<boolean>;
+/**
+ * Get cached WASM bytes and compile to WebAssembly.Module.
+ * @returns {Promise<WebAssembly.Module|null>} Compiled module or null
+ */
+export function getCompiledWasmModule(): Promise<WebAssembly.Module | null>;
+/**
+ * Save WASM bytes to IndexedDB for future compilation.
+ * @param {Uint8Array} bytes - WASM bytes
+ * @returns {Promise<boolean>} True if saved successfully
+ */
+export function saveWasmBytes(bytes: Uint8Array): Promise<boolean>;
+/**
+ * Save WASM memory snapshot for instant restore on next load.
+ * @param {WebAssembly.Memory|Uint8Array} memoryOrSnapshot - Memory object or snapshot bytes
+ * @param {Object} [metadata] - Optional metadata to save with snapshot
+ * @returns {Promise<boolean>} True if saved successfully
+ */
+export function saveWasmMemorySnapshot(memoryOrSnapshot: WebAssembly.Memory | Uint8Array, metadata?: any): Promise<boolean>;
+export { hashDocument } from "./hash.js";
+export const CTAN_CACHE_VERSION: 9;
+export const MANIFEST_CACHE_VERSION: 5;

package/types/utils.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Create a batched logger that collects messages and flushes them once per animation frame.
+ * This prevents DOM thrashing when the compiler emits many log messages rapidly.
+ *
+ * @param {function(string[]): void} onFlush - Called with array of messages to display
+ * @returns {function(string): void} - Logger function to pass to SiglumCompiler's onLog option
+ *
+ * @example
+ * const compiler = new SiglumCompiler({
+ *     onLog: createBatchedLogger((messages) => {
+ *         statusDiv.textContent += messages.join('\n') + '\n';
+ *         statusDiv.scrollTop = statusDiv.scrollHeight;
+ *     }),
+ * });
+ */
+export function createBatchedLogger(onFlush: (arg0: string[]) => void): (arg0: string) => void;