Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .lefthook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pre-commit:

eslint:
run: npx eslint --fix --cache --max-warnings=0 {staged_files}
glob: "*.{ts,js,mjs}"
glob: "*.{js,mjs}"
stage_fixed: true

post-merge:
Expand Down
8 changes: 4 additions & 4 deletions api/cli.ts → api/cli.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { mkdir, writeFile } from "node:fs/promises";
import { major } from "semver";
import { bcdAPIs, walk } from "./index";
import { version } from "./package.json";
import semver from "semver";
import { bcdAPIs, walk } from "./index.js";
import pkg from "./package.json" with { type: "json" };

const BUILD_PATH = `out/v${major(version)}`;
const BUILD_PATH = `out/v${semver.major(pkg.version)}`;

main();

Expand Down
177 changes: 177 additions & 0 deletions api/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
import bcd from "@mdn/browser-compat-data" with { type: "json" };

/**
* @import {
* BrowserName,
* Browsers,
* CompatStatement,
* Identifier,
* SimpleSupportStatement,
* SupportStatement,
* VersionValue,
* } from "@mdn/browser-compat-data"
*/

/**
* @typedef {object} Data
* @property {{ timestamp: string; version: string }} __meta
* @property {string} query
* @property {IdentifierExtended} data
* @property {Browsers} browsers
*/

/**
* @typedef {SimpleSupportStatement & { release_date?: string }} SimpleSupportStatementExtended
*/

/**
* @typedef {Omit<CompatStatement, "support"> & {
* support: Partial<Record<BrowserName, SimpleSupportStatementExtended[]>>;
* }} CompatStatementExtended
*/

/**
* @typedef {{ [key: string]: IdentifierExtended | CompatStatementExtended }} IdentifierExtended
*/

const { __meta, browsers, ...bcdAPIs } = bcd;

export { __meta, bcdAPIs };

const filteredBrowsers = /** @type {Browsers} */ (
Object.fromEntries(
Object.entries(browsers).map(([name, statement]) => [
name,
{
...statement,
releases: Object.fromEntries(
Object.entries(statement.releases).filter(
([_, statement]) => statement.status !== "retired",
),
),
},
]),
)
);

/**
* @param {string} path
* @returns {Data | undefined}
*/
export function getBCDDataForPath(path) {
const subtree = path
.split(".")
.reduce(
(prev, curr) => prev?.[curr],
/** @type {Identifier | undefined} */ (bcdAPIs),
);
if (subtree) {
return {
__meta,
query: path,
data: walk(subtree, path),
browsers: filteredBrowsers,
};
}
}

/**
* @param {Identifier} tree
* @param {string} path
* @param {(data: Data) => void} [callback]
* @returns {IdentifierExtended}
*/
export function walk(tree, path, callback) {
/** @type {IdentifierExtended} */
const extendedTree = Object.fromEntries(
Object.entries(tree).map(([key, subtree]) => [
key,
key === "__compat"
? extendCompatStatement(/** @type {CompatStatement} */ (subtree))
: walk(/** @type {Identifier} */ (subtree), `${path}.${key}`, callback),
]),
);

/** @type {Data} */
const data = {
__meta,
query: path.slice(1),
data: extendedTree,
browsers: filteredBrowsers,
};
callback?.(data);
return extendedTree;
}

/**
* @param {CompatStatement} statement
* @returns {CompatStatementExtended}
*/
function extendCompatStatement(statement) {
const support = Object.fromEntries(
/** @type {[BrowserName, SupportStatement][]} */ (
Object.entries(statement.support)
).map(([browserName, supportStatement]) => [
browserName,
(supportStatement instanceof Array
? supportStatement
: [supportStatement]
).map((simpleSupportStatement) =>
extendSimpleSupportStatement(simpleSupportStatement, browserName),
),
]),
);
return {
...statement,
mdn_url: getPathFromAbsoluteURL(statement.mdn_url),
support,
};
}

/**
* @param {SimpleSupportStatement} statement
* @param {BrowserName} browserName
* @returns {SimpleSupportStatementExtended}
*/
function extendSimpleSupportStatement(statement, browserName) {
const added = normalizeVersion(statement.version_added);
return {
...statement,
release_date: added
? browsers[browserName].releases[added]?.release_date
: undefined,
};
}

/**
* @param {string} [absoluteUrl]
* @returns {string | undefined}
*/
function getPathFromAbsoluteURL(absoluteUrl) {
if (!absoluteUrl || !absoluteUrl.includes("://")) {
return absoluteUrl;
}

const url = new URL(absoluteUrl);
if (url.hostname !== "developer.mozilla.org") {
return absoluteUrl;
}

const slug = url.pathname + url.hash;
if (slug.startsWith("/docs/")) {
return `/en-US${slug}`;
}
return slug;
}

/**
* @param {VersionValue} [version]
* @returns {string | undefined}
*/
function normalizeVersion(version) {
return typeof version === "string"
? version.startsWith("≤")
? version.slice(1)
: version
: undefined;
}
151 changes: 0 additions & 151 deletions api/index.ts

This file was deleted.

Loading