7 Commits
0.1.0 ... 0.2.1

Author SHA1 Message Date
ffdca81c78 Decompression caching and preview links
All checks were successful
Publish Library / Build NPM Project (push) Successful in 10s
Publish Library / Tag Version (push) Successful in 8s
2026-08-22 16:52:07 -04:00
aedb117002 Create search index cache and return more meta
All checks were successful
Publish Library / Build NPM Project (push) Successful in 10s
Publish Library / Tag Version (push) Successful in 8s
2026-08-22 14:24:22 -04:00
4278ea9df9 Added delete
All checks were successful
Publish Library / Build NPM Project (push) Successful in 9s
Publish Library / Tag Version (push) Successful in 8s
2026-08-22 13:01:19 -04:00
86730f1de8 Better searching
All checks were successful
Publish Library / Build NPM Project (push) Successful in 10s
Publish Library / Tag Version (push) Successful in 8s
2026-08-22 12:27:54 -04:00
c5207261fa Added namespace to main page
All checks were successful
Publish Library / Build NPM Project (push) Successful in 9s
Publish Library / Tag Version (push) Successful in 7s
2026-08-22 10:48:40 -04:00
c38f149733 Better pathing
All checks were successful
Publish Library / Build NPM Project (push) Successful in 9s
Publish Library / Tag Version (push) Successful in 9s
2026-08-22 10:22:32 -04:00
f5eaf7f764 Bump 0.1.1
All checks were successful
Publish Library / Build NPM Project (push) Successful in 9s
Publish Library / Tag Version (push) Successful in 53s
2026-08-20 11:38:59 -04:00
7 changed files with 346 additions and 68 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "@ztimson/zim-utils",
"version": "0.1.0",
"version": "0.2.1",
"description": "Native, dependency-light ZIM archive reader/searcher and Kiwix catalog downloader for Node.js",
"author": "Zak Timson",
"license": "MIT",
@@ -10,7 +10,7 @@
"type": "git",
"url": "https://git.zakscode.com/ztimson/zim-utils"
},
"main": "index.js",
"main": "src/index.js",
"dependencies": {
"@ztimson/utils": "^0.30.7",
"lzma1": "^0.3.0",

View File

@@ -1,40 +1,44 @@
import {fuzzyMatch} from './utils.js';
import {decodeHtml} from '@ztimson/utils';
export const CATALOG_URL = 'https://library.kiwix.org/catalog/v2/entries';
export const CATALOG_URL = 'https://library.kiwix.org';
const PAGE_SIZE = 100;
/** Parses `<entry>` blocks out of a Kiwix catalog OPDS XML response. */
function parseEntries(xml) {
function parseEntries(xml, catalog = CATALOG_URL) {
const blocks = xml.match(/<entry>[\s\S]*?<\/entry>/g) || [];
return blocks.map(b => {
const grab = re => (b.match(re) || [])[1] || '';
const linkMatch = b.match(/<link[^>]*type=["']application\/x-zim[^"']*["'][^>]*href=["']([^"']+)["']/);
const iconMatch = b.match(/<link[^>]*rel=["']http:\/\/opds-spec\.org\/image\/thumbnail["'][^>]*href=["']([^"']+)["']/)
|| b.match(/<link[^>]*type=["']image\/[^"']*["'][^>]*href=["']([^"']+)["']/);
let tags = grab(/<tags>([^<]*)<\/tags>/);
if(tags) tags = tags.split(';');
const name = grab(/<name>([^<]*)<\/name>/);
return {
id: grab(/<id>([^<]*)<\/id>/),
title: decodeHtml(grab(/<title>([^<]*)<\/title>/)),
updated: new Date(grab(/<updated>([^<]*)<\/updated>/)),
summary: decodeHtml(grab(/<summary>([^<]*)<\/summary>/)),
language: grab(/<language>([^<]*)<\/language>/),
name: grab(/<name>([^<]*)<\/name>/),
name,
category: grab(/<category>([^<]*)<\/category>/),
tags,
mediaCount: Number(grab(/<mediaCount>([^<]*)<\/mediaCount>/)) || 0,
author: grab(/<author>\s*<name>([^<]*)<\/name>\s*<\/author>/m),
publisher: grab(/<publisher>\s*<name>([^<]*)<\/name>\s*<\/publisher>/m),
articleCount: Number(grab(/<articleCount>([^<]*)<\/articleCount>/)) || 0,
sizeMb: linkMatch ? (Number((b.match(/length=["'](\d+)["']/) || [])[1] || 0) / 1024 / 1024).toFixed(1) : '?',
href: linkMatch ? linkMatch[1] : null,
sizeMb: linkMatch ? +(Number((b.match(/length=["'](\d+)["']/) || [])[1] || 0) / 1024 / 1024).toFixed(1) : '?',
download: linkMatch ? linkMatch[1] : null,
icon: iconMatch ? new URL(iconMatch[1], catalog).href : null,
viewer: name ? new URL(`viewer#${name}`, catalog).href : null,
};
});
}
async function fetchEntries(term, lang, url = CATALOG_URL) {
const params = new URLSearchParams({q: term, count: String(PAGE_SIZE), lang: lang || 'eng'});
const res = await fetch(`${url}?${params}`);
const res = await fetch(`${url}/catalog/v2/entries?${params}`);
if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
return parseEntries(await res.text());
}
@@ -42,7 +46,7 @@ async function fetchEntries(term, lang, url = CATALOG_URL) {
/** Looks up a single catalog entry by exact `name` (used to check for available updates). */
export async function zimCatalogInfo(name, url = CATALOG_URL) {
const params = new URLSearchParams({name, count: '5'});
const res = await fetch(`${url}?${params}`);
const res = await fetch(`${url}/catalog/v2/entries?${params}`);
if (!res.ok) return null;
return parseEntries(await res.text()).find(e => e.name === name) || null;
}

32
src/decompress-worker.js Normal file
View File

@@ -0,0 +1,32 @@
'use strict';
import {parentPort} from 'node:worker_threads';
import {decompress as lzmaDecompress} from 'lzma1';
import {ZstdCodec} from 'zstd-codec';
let zstdStreamingPromise = null;
function getZstd() {
if (!zstdStreamingPromise) {
zstdStreamingPromise = new Promise(resolve => ZstdCodec.run(zstd => resolve(new zstd.Streaming())));
}
return zstdStreamingPromise;
}
/** Rebuilds a full 13-byte "alone" LZMA header from libzim's truncated 5-byte one (unknown size). */
function toLzmaAloneStream(body) {
const header = Buffer.concat([body.subarray(0, 5), Buffer.alloc(8, 0xff)]);
return Buffer.concat([header, body.subarray(5)]);
}
parentPort.on('message', async ({id, compType, body}) => {
try {
const buf = Buffer.from(body);
const data = compType === 4
? Buffer.from(lzmaDecompress(toLzmaAloneStream(buf)))
: Buffer.from((await getZstd()).decompress(new Uint8Array(buf)));
parentPort.postMessage({id, data}, [data.buffer]);
} catch (e) {
parentPort.postMessage({id, error: e.message});
}
});

50
src/decompress.js Normal file
View File

@@ -0,0 +1,50 @@
'use strict';
import {Worker} from 'node:worker_threads';
import path from 'node:path';
import os from 'node:os';
import {fileURLToPath} from 'node:url';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
/** Round-robin pool of worker threads for off-main-thread cluster decompression. */
class DecompressPool {
#workers = [];
#next = 0;
#pending = new Map(); // id -> {resolve, reject}
#nextId = 0;
#active = 0;
constructor(size = Math.max(1, os.cpus().length - 1)) {
for (let i = 0; i < size; i++) this.#spawn();
}
#spawn() {
const worker = new Worker(path.join(__dirname, 'decompress-worker.js'));
worker.on('message', ({id, data, error}) => {
const task = this.#pending.get(id);
if (!task) return;
this.#pending.delete(id);
// No work left in flight -> safe to let the process exit again.
if (--this.#active === 0) for (const w of this.#workers) w.unref();
error ? task.reject(new Error(error)) : task.resolve(Buffer.from(data));
});
worker.unref(); // idle workers must never keep a short script/server alive
this.#workers.push(worker);
}
/** Decompresses `{compType, body}` on the next worker in rotation. `body` must be a Uint8Array/Buffer view. */
run({compType, body}) {
const worker = this.#workers[this.#next];
this.#next = (this.#next + 1) % this.#workers.length;
const id = this.#nextId++;
const owned = new Uint8Array(body);
if (this.#active++ === 0) for (const w of this.#workers) w.ref();
return new Promise((resolve, reject) => {
this.#pending.set(id, {resolve, reject});
worker.postMessage({id, compType, body: owned}, [owned.buffer]);
});
}
}
export const decompressPool = new DecompressPool();

View File

@@ -5,14 +5,23 @@ import {Readable} from 'node:stream';
import {ZimReader} from './reader.js';
import {zimCatalog, zimCatalogInfo, CATALOG_URL} from './catalog.js';
const DEFAULT_READER_TTL = 60_000;
/** Manages a local directory of ZIM archives: listing, update checks, downloads, and reading. */
export class ZimManager {
#catalog;
#dir;
#readerTTL;
#clusterTTL;
#readers = new Map(); // file -> {reader, timer}
#opening = new Map(); // file -> Promise<ZimReader>, dedupes concurrent first-open races
constructor(dir, catalog = CATALOG_URL) {
/** @param {{catalog?: string, readerTTL?: number, clusterTTL?: number}} [opts] */
constructor(dir, catalog = CATALOG_URL, {readerTTL = DEFAULT_READER_TTL, clusterTTL} = {}) {
this.#catalog = catalog;
this.#dir = dir;
this.#readerTTL = readerTTL;
this.#clusterTTL = clusterTTL; // undefined -> ZimReader's own default
}
async #download(url, destPath) {
@@ -44,11 +53,7 @@ export class ZimManager {
let reader;
try {
reader = await new ZimReader(filepath).open();
return {
name: await reader.metadata('Name'),
date: await reader.metadata('Date'),
title: await reader.metadata('Title'),
};
return await reader.metadata();
} catch {
return null;
} finally {
@@ -58,31 +63,48 @@ export class ZimManager {
async #update(name, catalogEntry, localMatch, force) {
const remoteDate = catalogEntry.updated ? new Date(catalogEntry.updated) : null;
const localDate = localMatch?.meta?.date ? new Date(localMatch.meta.date) : null;
const localDate = localMatch?.meta?.updated ?? null;
if (!force && localMatch && remoteDate && localDate && remoteDate <= localDate)
return {name, status: 'skipped', reason: 'up to date'};
if (!catalogEntry.href) return {name, status: 'skipped', reason: 'missing download link'};
if (!catalogEntry.download) return {name, status: 'skipped', reason: 'missing download link'};
const filename = path.basename(new URL(catalogEntry.href).pathname).replace(/\.meta4$/i, '');
const filename = path.basename(new URL(catalogEntry.download).pathname).replace(/\.meta4$/i, '');
const destPath = path.join(this.#dir, filename);
await this.#download(catalogEntry.href, destPath);
if (localMatch && localMatch.file !== destPath) await fs.promises.unlink(localMatch.file).catch(() => {});
return {name, status: 'updated', file: destPath};
await this.#download(catalogEntry.download, destPath);
if (localMatch && localMatch.file !== filename) await this.#evict(path.join(this.#dir, localMatch.file));
return {name, status: 'updated', file: filename};
}
/** Resolves a file path or catalog `name` to a local file path. */
async #resolveFile(fileOrName) {
if (fs.existsSync(fileOrName)) return fileOrName;
const joined = path.join(this.#dir, fileOrName);
if (fs.existsSync(joined)) return joined;
const local = await this.list();
const match = local.find(l => l.meta?.name === fileOrName);
const match = local.find(l => l.meta?.name === fileOrName || path.basename(l.file) === fileOrName);
if (!match) throw new Error(`ZIM not found locally: ${fileOrName}`);
return match.file;
return path.join(this.#dir, match.file);
}
/** Closes and drops a cached reader for `file`, if any (used before delete/replace). */
async #evict(file) {
const entry = this.#readers.get(file);
if (!entry) return new ZimReader(file).delete().catch(() => {});
clearTimeout(entry.timer);
this.#readers.delete(file);
await entry.reader.delete();
}
catalog(search, opts) {
return zimCatalog(search, opts);
}
async delete(fileOrName) {
const file = await this.#resolveFile(fileOrName);
await this.#evict(file);
return {file: path.basename(file), status: 'deleted'};
}
/** Checks whether a local ZIM has a newer version in the catalog, without downloading. */
async isOutdated(file) {
const meta = await this.#readMeta(file);
@@ -90,7 +112,7 @@ export class ZimManager {
const catalogEntry = await zimCatalog(meta.name, this.#catalog);
if (!catalogEntry) return {file, upToDate: null, reason: 'missing from catalog'};
const remoteDate = catalogEntry.updated ? new Date(catalogEntry.updated) : null;
const localDate = meta.date ? new Date(meta.date) : null;
const localDate = meta.updated ?? null;
return {file, name: meta.name, upToDate: !!(remoteDate && localDate && remoteDate <= localDate), localDate, remoteDate};
}
@@ -100,7 +122,7 @@ export class ZimManager {
const files = (await fs.promises.readdir(this.#dir)).filter(f => f.endsWith('.zim'));
return Promise.all(files.map(async f => {
const file = path.join(this.#dir, f);
return {file, meta: await this.#readMeta(file)};
return {file: f, ...(await this.#readMeta(file))};
}));
}
@@ -113,7 +135,7 @@ export class ZimManager {
const local = await this.list();
const localMatch = local.find(l => l.meta?.name === name) ?? null;
const catalogEntry = await zimCatalogInfo(name, this.#catalog) || {name, updated: null, href};
const catalogEntry = await zimCatalogInfo(name, this.#catalog) || {name, updated: null, download: href};
return this.#update(name, catalogEntry, localMatch, force);
}
@@ -136,11 +158,38 @@ export class ZimManager {
return results;
}
/** Opens a `ZimReader` for a local ZIM, resolved by file path or catalog `name`. Caller must `.close()` it. */
/** Opens a fresh `ZimReader` for a local ZIM, resolved by file path or catalog `name`. Caller must `.close()` it. */
async open(fileOrName) {
await this.#ensureDir();
const file = await this.#resolveFile(fileOrName);
return new ZimReader(file).open();
return new ZimReader(file, {clusterTTL: this.#clusterTTL}).open();
}
/**
* Returns a cached, persistently-open `ZimReader` for serving requests — avoids
* re-opening the file per request. Idle-evicted after `readerTTL` ms of no use.
*/
async getCached(fileOrName) {
await this.#ensureDir();
const file = await this.#resolveFile(fileOrName);
let entry = this.#readers.get(file);
if (!entry) {
let pending = this.#opening.get(file);
if (!pending) {
pending = new ZimReader(file, {clusterTTL: this.#clusterTTL}).open();
this.#opening.set(file, pending);
}
const reader = await pending;
this.#opening.delete(file);
entry = this.#readers.get(file) ?? {reader};
this.#readers.set(file, entry);
}
clearTimeout(entry.timer);
entry.timer = setTimeout(() => {
this.#readers.delete(file);
entry.reader.close();
}, this.#readerTTL).unref();
return entry.reader;
}
/** Fuzzy-searches titles across every local ZIM in the library, merging & re-ranking hits by score. */
@@ -149,15 +198,15 @@ export class ZimManager {
const perZim = await Promise.all(local.map(async ({file, meta}) => {
let reader;
try {
reader = await new ZimReader(file).open();
reader = await new ZimReader(path.join(this.#dir, file)).open();
const hits = await reader.search(terms, {limit, htmlOnly});
return hits.map(h => ({...h, file, name: meta?.name}));
return hits.map(h => ({...h, file}));
} catch {
return [];
} finally {
await reader?.close();
}
}));
return perZim.flat().toSorted((a, b) => b.score - a.score).slice(0, limit);
return perZim.flat().filter(a => a.score > 0).toSorted((a, b) => b.score - a.score).slice(0, limit);
}
}

View File

@@ -1,30 +1,18 @@
'use strict';
import fs from 'node:fs';
import {decompress as lzmaDecompress} from 'lzma1';
import {ZstdCodec} from 'zstd-codec';
import {fuzzyMatch} from './utils.js';
import path from 'node:path';
import {decompressPool} from './decompress.js';
import {fuzzyMatch, titleFromUrl} from './utils.js';
const INDEX_VERSION = 1;
const HEADER_SIZE = 80;
const NS_CONTENT = 'C';
const NS_METADATA = 'M';
const TITLE_SENTINEL = 0xffffffffffffffffn; // Indicator -> ZIM v6+ archives with no title
let zstdStreamingPromise = null;
/** Lazily initialised, shared Zstd streaming decompressor (handles unknown-size frames). */
function getZstd() {
if (!zstdStreamingPromise) {
zstdStreamingPromise = new Promise(resolve => ZstdCodec.run(zstd => resolve(new zstd.Streaming())));
}
return zstdStreamingPromise;
}
/** Rebuilds a full 13-byte "alone" LZMA header from libzim's truncated 5-byte one (unknown size). */
function toLzmaAloneStream(body) {
const header = Buffer.concat([body.subarray(0, 5), Buffer.alloc(8, 0xff)]);
return Buffer.concat([header, body.subarray(5)]);
}
const DEFAULT_CLUSTER_CACHE_MAX = 32;
const DEFAULT_CLUSTER_TTL = 60_000;
/** Native, dependency-light reader for .zim archives. Supports zstd & LZMA cluster compression. */
export class ZimReader {
@@ -32,11 +20,20 @@ export class ZimReader {
#header = null;
#mimeTypes = [];
#hasTitleListing = false;
#index;
#clusterCache = new Map(); // clusterNumber -> {data, extended, timer}
#pending = new Map(); // clusterNumber -> Promise, dedupes concurrent misses
#clusterCacheMax;
#clusterTTL;
get articleCount() { return this.#header?.articleCount ?? 0; }
get mediaCount() { return this.#header?.clusterCount ?? 0; }
constructor(path) {
/** @param {{clusterCacheMax?: number, clusterTTL?: number}} [opts] clusterTTL in ms; 0/null disables idle eviction. */
constructor(path, {clusterCacheMax = DEFAULT_CLUSTER_CACHE_MAX, clusterTTL = DEFAULT_CLUSTER_TTL} = {}) {
this.path = path;
this.#clusterCacheMax = clusterCacheMax;
this.#clusterTTL = clusterTTL;
}
/** Full O(n) scan over the URL pointer list, used when there's no title index. */
@@ -63,7 +60,15 @@ export class ZimReader {
return null;
}
async #getBlob(clusterNumber, blobNumber) {
/** Resets a cluster's idle-eviction timer. No-op when TTL disabled. */
#touch(clusterNumber, entry) {
if (!this.#clusterTTL) return;
clearTimeout(entry.timer);
entry.timer = setTimeout(() => this.#clusterCache.delete(clusterNumber), this.#clusterTTL).unref();
}
/** Fetches + decompresses a cluster exactly once, offloading decompression to the worker pool. */
async #loadCluster(clusterNumber) {
const start = await this.#ptr64(this.#header.clusterPtrPos, clusterNumber);
const isLast = clusterNumber === this.#header.clusterCount - 1;
const end = isLast
@@ -76,14 +81,42 @@ export class ZimReader {
const body = raw.subarray(1);
let data;
if (compType <= 1) data = body;
else if (compType === 4) data = Buffer.from(lzmaDecompress(toLzmaAloneStream(body)));
else if (compType === 5) data = Buffer.from((await getZstd()).decompress(new Uint8Array(body)));
if (compType <= 1) data = Buffer.from(body);
else if (compType === 4 || compType === 5) data = await decompressPool.run({compType, body});
else throw new Error(`Unsupported cluster compression type: ${compType}`);
if (!data) throw new Error(`Cluster ${clusterNumber} failed to decompress (compType ${compType})`);
const readPtr = i => extended ? Number(data.readBigUInt64LE(i * 8)) : data.readUInt32LE(i * 4);
return data.subarray(readPtr(blobNumber), readPtr(blobNumber + 1));
return {data, extended};
}
async #getBlob(clusterNumber, blobNumber) {
let entry = this.#clusterCache.get(clusterNumber);
if (!entry) {
let pending = this.#pending.get(clusterNumber);
if (!pending) {
pending = this.#loadCluster(clusterNumber);
this.#pending.set(clusterNumber, pending);
}
entry = await pending;
this.#pending.delete(clusterNumber);
this.#clusterCache.set(clusterNumber, entry);
if (this.#clusterCache.size > this.#clusterCacheMax) {
const oldestKey = this.#clusterCache.keys().next().value;
clearTimeout(this.#clusterCache.get(oldestKey)?.timer);
this.#clusterCache.delete(oldestKey);
}
}
this.#touch(clusterNumber, entry);
const readPtr = i => entry.extended ? Number(entry.data.readBigUInt64LE(i * 8)) : entry.data.readUInt32LE(i * 4);
return entry.data.subarray(readPtr(blobNumber), readPtr(blobNumber + 1));
}
async #icon(size = 48) {
const page = await this.readPage(`Illustration_${size}x${size}@1`, NS_METADATA)
|| await this.readPage('Favicon', NS_METADATA);
if (!page) return null;
return `data:${page.mimetype};base64,${page.data.toString('base64')}`;
}
async #ptr64(base, index) {
@@ -172,15 +205,90 @@ export class ZimReader {
return dirents;
}
/** Path of the cached word index, kept in an `index/` subdirectory next to the archive. */
#indexPath() {
return path.join(path.dirname(this.path), 'index', `${path.basename(this.path)}.idx.json`);
}
/** Builds (or loads a cached) word -> entry index, avoiding a re-scan on every search. */
async #wordIndex() {
if (this.#index) return this.#index;
const cachePath = this.#indexPath();
const stat = await fs.promises.stat(this.path);
if (fs.existsSync(cachePath)) {
try {
const cached = JSON.parse(await fs.promises.readFile(cachePath, 'utf8'));
// Rebuild if stale: index predates the archive's current mtime (e.g. a re-download).
if (cached.version === INDEX_VERSION && cached.mtimeMs >= stat.mtimeMs) {
return (this.#index = cached);
}
} catch {}
}
// Expensive full scan — only happens once per archive (or after it changes).
const dirents = await this.#allDirents();
const entries = [];
const words = new Map(); // word -> [entryIndex, ...]
for (const d of dirents) {
if (d.namespace !== NS_CONTENT) continue;
const idx = entries.length;
entries.push({url: d.url, title: d.title, mimetype: d.mimetype});
const text = `${d.title} ${titleFromUrl(d.url)}`.toLowerCase();
for (const w of text.split(/\W+/).filter(Boolean)) {
if (!words.has(w)) words.set(w, []);
words.get(w).push(idx);
}
}
const index = {version: INDEX_VERSION, size: stat.size, mtimeMs: stat.mtimeMs, entries, words: Object.fromEntries(words)};
await fs.promises.mkdir(path.dirname(cachePath), {recursive: true});
await fs.promises.writeFile(cachePath, JSON.stringify(index));
return (this.#index = index);
}
async close() {
if (this.#fd) await this.#fd.close();
this.#fd = null;
for (const entry of this.#clusterCache.values()) clearTimeout(entry.timer);
this.#clusterCache.clear();
this.#pending.clear();
}
/** Deletes the zim archive and its cached index (if any). Safe to call on unopened readers. */
async delete() {
await this.close();
this.#index = null;
await fs.promises.rm(this.path, {force: true});
await fs.promises.rm(this.#indexPath(), {force: true});
}
/** Reads an 'M' namespace metadata value (e.g. Name, Date, Title). Returns null if missing. */
async metadata(key) {
const get = async key => {
const page = await this.readPage(key, NS_METADATA);
return page ? page.data.toString('utf8') : null;
};
if(key) return get(key);
const [title, creator, publisher, date, description, language, name, tags] = await Promise.all(
['Title', 'Creator', 'Publisher', 'Date', 'Description', 'Language', 'Name', 'Tags'].map(get)
);
return {
title,
updated: date ? new Date(date) : null,
summary: description,
language,
name,
category: tags ? tags.split(';')[0] || '' : '',
tags: tags ? tags.split(';') : [],
author: creator,
publisher,
articleCount: this.articleCount,
mediaCount: this.mediaCount,
sizeMb: +((await fs.promises.stat(this.path)).size / 1024 / 1024).toFixed(1),
icon: await this.#icon(),
};
}
/** Opens the archive and parses its header + mimetype list. */
@@ -206,7 +314,7 @@ export class ZimReader {
let dirent = await this.#readDirent(await this.#ptr64(this.#header.urlPtrPos, this.#header.mainPage));
dirent = await this.#resolveRedirect(dirent);
const data = await this.#getBlob(dirent.cluster, dirent.blob);
return {mimetype: this.#mimeTypes[dirent.mimetype] || 'application/octet-stream', data, url: dirent.url};
return {mimetype: this.#mimeTypes[dirent.mimetype] || 'application/octet-stream', data, url: dirent.url, namespace: dirent.namespace};
}
/**
@@ -219,17 +327,29 @@ export class ZimReader {
const termList = String(terms).split(',').map(t => t.trim()).filter(Boolean);
if (!termList.length) return [];
const candidates = this.#hasTitleListing
? await this.#titleIndexCandidates(termList[0])
: await this.#allDirents();
let candidates;
if (this.#hasTitleListing && this.#header.articleCount > 5000) {
candidates = await this.#titleIndexCandidates(termList[0]);
} else {
const {entries, words} = await this.#wordIndex();
// Pull candidates from postings of any word that starts with (or contains) the search term.
const q = termList[0].toLowerCase();
const idxSet = new Set();
for (const [word, postings] of Object.entries(words)) {
if (word.includes(q) || q.includes(word)) postings.forEach(i => idxSet.add(i));
}
candidates = [...idxSet].map(i => ({...entries[i], namespace: NS_CONTENT}));
}
const scored = [];
for (const dirent of candidates) {
if (dirent.namespace !== NS_CONTENT) continue;
if (htmlOnly && !(this.#mimeTypes[dirent.mimetype] || '').startsWith('text/html')) continue;
const {max} = fuzzyMatch(dirent.title, ...termList);
scored.push({url: dirent.url, title: dirent.title, namespace: dirent.namespace, score: max});
const urlTitle = titleFromUrl(dirent.url);
const titleScore = fuzzyMatch(dirent.title, ...termList).max;
const urlScore = fuzzyMatch(urlTitle, ...termList).max;
scored.push({url: dirent.url, title: dirent.title.length > urlTitle.length ? dirent.title : urlTitle, namespace: NS_CONTENT, score: Math.max(titleScore, urlScore)});
}
return scored.toSorted((a, b) => b.score - a.score).slice(0, limit);
const {summary, mediaCount, articleCount, sizeMb, ...meta} = await this.metadata();
return scored.filter(a => a.score > 0).toSorted((a, b) => b.score - a.score).slice(0, limit).map(a => ({...meta, ...a}));
}
}

View File

@@ -20,13 +20,36 @@ export function similarity(a, b) {
return 1 - levenshtein(a, b) / Math.max(a.length, b.length, 1);
}
function scoreAgainst(text, term) {
if (text.includes(term)) return 1 - (text.length - term.length) / text.length * 0.3;
if (!text.length || !term.length || text[0] !== term[0]) return 0;
const dist = levenshtein(text, term);
const maxAllowed = Math.max(1, Math.ceil(term.length * 0.34));
if (dist > maxAllowed) return 0;
return 1 - dist / Math.max(text.length, term.length);
}
/** Compares `target` against one or more search terms; returns avg/max/per-term similarity. */
export function fuzzyMatch(target, ...terms) {
if (!terms.length) throw new Error('Requires at least 1 term to compare');
const similarities = terms.map(t => similarity(target, t));
const lowerTarget = String(target).toLowerCase();
const words = lowerTarget.split(/\W+/).filter(Boolean);
const similarities = terms.map(term => {
const t = term.toLowerCase();
return Math.max(scoreAgainst(lowerTarget, t), ...words.map(w => scoreAgainst(w, t)));
});
return {
avg: similarities.reduce((acc, s) => acc + s, 0) / similarities.length,
max: Math.max(...similarities),
similarities,
};
}
/** Derives a readable pseudo-title from a URL's last path segment, e.g. ".../diannes-southwest-salad/" -> "Diannes Southwest Salad". */
export function titleFromUrl(url) {
const slug = String(url).replace(/\/$/, '').split('/').pop() || url;
const clean = slug.replace(/\.(zim|meta4|html?|md)$/i, '').replace(/[-_.]+/g, ' ');
return clean.replace(/\b\w/g, c => c.toUpperCase());
}