mirror of
https://github.com/AikidoSec/safe-chain.git
synced 2026-05-26 12:10:49 +00:00
484cbcd960
When you write @typedef {Object} ScanResult, you’re telling both JSDoc and TypeScript’s parser that this typedef represents an object type, not just an abstract name. This is important because it makes tools like IDEs, linters, and TypeScript’s JSDoc inference more reliable. It avoids ambiguity, especially in cases where the typedef might later be confused with something like a primitive, union, or function type. The official TypeScript documentation and the JSDoc spec both show this form as the canonical one for object shapes.
46 lines
1.2 KiB
JavaScript
46 lines
1.2 KiB
JavaScript
import fetch from "make-fetch-happen";
|
|
|
|
const malwareDatabaseUrl =
|
|
"https://malware-list.aikido.dev/malware_predictions.json";
|
|
|
|
/**
|
|
* @typedef {Object} MalwarePackage
|
|
* @property {string} package_name
|
|
* @property {string} version
|
|
* @property {string} reason
|
|
*/
|
|
|
|
/**
|
|
* @returns {Promise<{malwareDatabase: MalwarePackage[], version: string | undefined}>}
|
|
*/
|
|
export async function fetchMalwareDatabase() {
|
|
const response = await fetch(malwareDatabaseUrl);
|
|
if (!response.ok) {
|
|
throw new Error(`Error fetching malware database: ${response.statusText}`);
|
|
}
|
|
|
|
try {
|
|
let malwareDatabase = await response.json();
|
|
return {
|
|
malwareDatabase: malwareDatabase,
|
|
version: response.headers.get("etag") || undefined,
|
|
};
|
|
} catch (/** @type {any} */ error) {
|
|
throw new Error(`Error parsing malware database: ${error.message}`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<string | undefined>}
|
|
*/
|
|
export async function fetchMalwareDatabaseVersion() {
|
|
const response = await fetch(malwareDatabaseUrl, {
|
|
method: "HEAD",
|
|
});
|
|
if (!response.ok) {
|
|
throw new Error(
|
|
`Error fetching malware database version: ${response.statusText}`
|
|
);
|
|
}
|
|
return response.headers.get("etag") || undefined;
|
|
}
|