Files
openclaw/extensions/diffs/src/viewer-assets.ts
Dallin Romney d638611684 feat: split diffs language pack
Split the diffs viewer Shiki language pack into an external publishable plugin.

The diffs plugin keeps the default curated syntax set, while the new @openclaw/diffs-language-pack package carries the extended Shiki languages for npm and ClawHub distribution. The install metadata includes the external ClawHub spec, and the curated C# alias set keeps both c# and cs supported without the language pack.

Co-authored-by: Dallin Romney <dallinromney@gmail.com>
2026-05-27 18:08:40 +01:00

190 lines
5.4 KiB
TypeScript

import crypto from "node:crypto";
import fs from "node:fs/promises";
import { fileURLToPath } from "node:url";
export const VIEWER_ASSET_PREFIX = "/plugins/diffs/assets/";
export const VIEWER_LOADER_PATH = `${VIEWER_ASSET_PREFIX}viewer.js`;
export const VIEWER_RUNTIME_PATH = `${VIEWER_ASSET_PREFIX}viewer-runtime.js`;
export const LANGUAGE_PACK_VIEWER_ASSET_PREFIX = "/plugins/diffs-language-pack/assets/";
export const LANGUAGE_PACK_VIEWER_LOADER_PATH = `${LANGUAGE_PACK_VIEWER_ASSET_PREFIX}viewer.js`;
export const LANGUAGE_PACK_VIEWER_RUNTIME_PATH = `${LANGUAGE_PACK_VIEWER_ASSET_PREFIX}viewer-runtime.js`;
const VIEWER_RUNTIME_RELATIVE_IMPORT_PATH = "./viewer-runtime.js";
const VIEWER_RUNTIME_CANDIDATE_RELATIVE_PATHS = [
"./assets/viewer-runtime.js",
"../assets/viewer-runtime.js",
] as const;
const LANGUAGE_PACK_RUNTIME_CANDIDATE_RELATIVE_PATHS = [
"../../diffs-language-pack/assets/viewer-runtime.js",
"../diffs-language-pack/assets/viewer-runtime.js",
] as const;
type ServedViewerAsset = {
body: string | Buffer;
contentType: string;
};
type RuntimeAssetCache = {
mtimeMs: number;
runtimeBody: Buffer;
loaderBody: string;
};
let runtimeAssetCache: RuntimeAssetCache | null = null;
let languagePackRuntimeAssetCache: RuntimeAssetCache | null = null;
type ViewerRuntimeFileUrlParams = {
baseUrl?: string | URL;
stat?: (path: string) => Promise<unknown>;
};
function isMissingFileError(error: unknown): error is NodeJS.ErrnoException {
return error instanceof Error && "code" in error && error.code === "ENOENT";
}
export async function resolveViewerRuntimeFileUrl(
params: ViewerRuntimeFileUrlParams = {},
): Promise<URL> {
const baseUrl = params.baseUrl ?? import.meta.url;
const stat = params.stat ?? ((path: string) => fs.stat(path));
let missingFileError: NodeJS.ErrnoException | null = null;
for (const relativePath of VIEWER_RUNTIME_CANDIDATE_RELATIVE_PATHS) {
const candidateUrl = new URL(relativePath, baseUrl);
try {
await stat(fileURLToPath(candidateUrl));
return candidateUrl;
} catch (error) {
if (isMissingFileError(error)) {
missingFileError = error;
continue;
}
throw error;
}
}
if (missingFileError) {
throw missingFileError;
}
throw new Error("viewer runtime asset candidates were not checked");
}
export async function getServedViewerAsset(pathname: string): Promise<ServedViewerAsset | null> {
if (pathname !== VIEWER_LOADER_PATH && pathname !== VIEWER_RUNTIME_PATH) {
return null;
}
const assets = await loadViewerAssets();
if (pathname === VIEWER_LOADER_PATH) {
return {
body: assets.loaderBody,
contentType: "text/javascript; charset=utf-8",
};
}
if (pathname === VIEWER_RUNTIME_PATH) {
return {
body: assets.runtimeBody,
contentType: "text/javascript; charset=utf-8",
};
}
return null;
}
export async function getServedLanguagePackViewerAsset(
pathname: string,
): Promise<ServedViewerAsset | null> {
if (
pathname !== LANGUAGE_PACK_VIEWER_LOADER_PATH &&
pathname !== LANGUAGE_PACK_VIEWER_RUNTIME_PATH
) {
return null;
}
let assets: RuntimeAssetCache;
try {
const runtimeUrl = await resolveRuntimeFileUrl(LANGUAGE_PACK_RUNTIME_CANDIDATE_RELATIVE_PATHS);
assets = await loadRuntimeAssets({
runtimeUrl,
cache: languagePackRuntimeAssetCache,
updateCache: (cache) => {
languagePackRuntimeAssetCache = cache;
},
});
} catch (error) {
if (isMissingFileError(error)) {
return null;
}
throw error;
}
if (pathname === LANGUAGE_PACK_VIEWER_LOADER_PATH) {
return {
body: assets.loaderBody,
contentType: "text/javascript; charset=utf-8",
};
}
return {
body: assets.runtimeBody,
contentType: "text/javascript; charset=utf-8",
};
}
async function loadViewerAssets(): Promise<RuntimeAssetCache> {
const runtimeUrl = await resolveViewerRuntimeFileUrl();
return loadRuntimeAssets({
runtimeUrl,
cache: runtimeAssetCache,
updateCache: (cache) => {
runtimeAssetCache = cache;
},
});
}
async function loadRuntimeAssets(params: {
cache: RuntimeAssetCache | null;
runtimeUrl: URL;
updateCache(cache: RuntimeAssetCache): void;
}): Promise<RuntimeAssetCache> {
const runtimePath = fileURLToPath(params.runtimeUrl);
const runtimeStat = await fs.stat(runtimePath);
if (params.cache && params.cache.mtimeMs === runtimeStat.mtimeMs) {
return params.cache;
}
const runtimeBody = await fs.readFile(runtimePath);
const hash = crypto.createHash("sha1").update(runtimeBody).digest("hex").slice(0, 12);
const cache = {
mtimeMs: runtimeStat.mtimeMs,
runtimeBody,
loaderBody: `import "${VIEWER_RUNTIME_RELATIVE_IMPORT_PATH}?v=${hash}";\n`,
};
params.updateCache(cache);
return cache;
}
async function resolveRuntimeFileUrl(relativePaths: readonly string[]): Promise<URL> {
let missingFileError: NodeJS.ErrnoException | null = null;
for (const relativePath of relativePaths) {
const candidateUrl = new URL(relativePath, import.meta.url);
try {
await fs.stat(fileURLToPath(candidateUrl));
return candidateUrl;
} catch (error) {
if (isMissingFileError(error)) {
missingFileError = error;
continue;
}
throw error;
}
}
if (missingFileError) {
throw missingFileError;
}
throw new Error("viewer runtime asset candidates were not checked");
}