web-features 2.49.0 → 3.0.0-dev-20250917154839-f630e00

package/index.d.ts

@@ -1,93 +1,8 @@
-/** Browser information */
-interface BrowserData {
-    /** The name of the browser, as in "Edge" or "Safari on iOS" */
-    name: string;
-    /** The browser's releases */
-    releases: Release[];
-}
-/** Browser release information */
-interface Release {
-    /** The version string, as in "10" or "17.1" */
-    version: string;
-    /** The release date, as in "2023-12-11" */
-    date: string;
-}
-interface FeatureData {
-    /** Short name */
-    name: string;
-    /** Short description of the feature, as a plain text string */
-    description: string;
-    /** Short description of the feature, as an HTML string */
-    description_html: string;
-    /** Specification URL(s) */
-    spec: string | [string, string, ...string[]];
-    /** Group identifier(s) */
-    group?: string | [string, string, ...string[]];
-    /** Snapshot identifier(s) */
-    snapshot?: string | [string, string, ...string[]];
-    /** caniuse.com identifier(s) */
-    caniuse?: string | [string, string, ...string[]];
-    /** Whether a feature is considered a "baseline" web platform feature and when it achieved that status */
-    status: SupportStatus;
-    /** Sources of support data for this feature */
-    compat_features?: string[];
-    /** Whether developers are formally discouraged from using this feature */
-    discouraged?: Discouraged;
-}
-type BrowserIdentifier = "chrome" | "chrome_android" | "edge" | "firefox" | "firefox_android" | "safari" | "safari_ios";
-type BaselineHighLow = "high" | "low";
-interface Status {
-    /** Whether the feature is Baseline (low substatus), Baseline (high substatus), or not (false) */
-    baseline: BaselineHighLow | false;
-    /** Date the feature achieved Baseline low status */
-    baseline_low_date?: string;
-    /** Date the feature achieved Baseline high status */
-    baseline_high_date?: string;
-    /** Browser versions that most-recently introduced the feature */
-    support: {
-        [K in BrowserIdentifier]?: string;
-    };
-}
-interface SupportStatus extends Status {
-    /** Statuses for each key in the feature's compat_features list, if applicable. Not available to the npm release of web-features. */
-    by_compat_key?: Record<string, Status>;
-}
-interface Discouraged {
-    /** Links to a formal discouragement notice, such as specification text, intent-to-unship, etc. */
-    according_to: string[];
-    /** IDs for features that substitute some or all of this feature's utility */
-    alternatives?: string[];
-}
-interface GroupData {
-    /** Short name */
-    name: string;
-    /** Identifier of parent group */
-    parent?: string;
-}
-interface SnapshotData {
-    /** Short name */
-    name: string;
-    /** Specification */
-    spec: string;
-}
-
-declare const browsers: {
-    chrome: BrowserData;
-    chrome_android: BrowserData;
-    edge: BrowserData;
-    firefox: BrowserData;
-    firefox_android: BrowserData;
-    safari: BrowserData;
-    safari_ios: BrowserData;
+declare const browsers: import("./types.quicktype").Browsers, features: {
+    [key: string]: import("./types").FeatureData | import("./types").FeatureMovedData | import("./types").FeatureSplitData;
+}, groups: {
+    [key: string]: import("./types.quicktype").GroupData;
+}, snapshots: {
+    [key: string]: import("./types.quicktype").SnapshotData;
 };
-declare const features: {
-    [key: string]: FeatureData;
-};
-declare const groups: {
-    [key: string]: GroupData;
-};
-declare const snapshots: {
-    [key: string]: SnapshotData;
-};
-
 export { browsers, features, groups, snapshots };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "web-features",
   "description": "Curated list of Web platform features",
-  "version": "2.49.0",
+  "version": "3.0.0-dev-20250917154839-f630e00",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -18,12 +18,14 @@
   "types": "./index.d.ts",
   "files": [
     "index.d.ts",
+    "types.d.ts",
+    "types.quicktype.d.ts",
     "index.js",
     "data.json",
     "data.schema.json"
   ],
   "scripts": {
-    "prepare": "tsc && rm types.js && tsup ./index.ts --dts-only --format=esm --out-dir=."
+    "prepare": "tsc && rm types.js && rm types.quicktype.js"
   },
   "devDependencies": {
     "@types/node": "^20.19.16",

package/types.d.ts

@@ -0,0 +1,26 @@
+import type { BaselineEnum as BaselineHighLow, BrowserData, Browsers, Discouraged, GroupData, Kind, FeatureData as QuicktypeMonolithicFeatureData, Status as QuicktypeStatus, StatusHeadline as QuicktypeStatusHeadline, WebFeaturesData as QuicktypeWebFeaturesData, Release, SnapshotData, Support } from "./types.quicktype";
+export type { BaselineHighLow, BrowserData, Browsers, Discouraged, GroupData, Release, SnapshotData, Support, };
+export interface Status extends QuicktypeStatus {
+    baseline: false | BaselineHighLow;
+}
+export interface SupportStatus extends QuicktypeStatusHeadline {
+    baseline: false | BaselineHighLow;
+}
+export interface WebFeaturesData extends Pick<QuicktypeWebFeaturesData, "browsers" | "groups" | "snapshots"> {
+    features: {
+        [key: string]: FeatureData | FeatureMovedData | FeatureSplitData;
+    };
+}
+export type FeatureData = {
+    kind: "feature";
+} & Required<Pick<QuicktypeMonolithicFeatureData, "description_html" | "description" | "name" | "spec" | "status">> & Partial<Pick<QuicktypeMonolithicFeatureData, "caniuse" | "compat_features" | "discouraged" | "group" | "snapshot">>;
+type FeatureRedirectData = {
+    kind: Exclude<Kind, "feature">;
+} & Required<Pick<QuicktypeMonolithicFeatureData, "redirect_target" | "redirect_targets">>;
+export interface FeatureMovedData extends Omit<FeatureRedirectData, "redirect_targets"> {
+    kind: "moved";
+}
+export interface FeatureSplitData extends Omit<FeatureRedirectData, "redirect_target"> {
+    kind: "split";
+}
+export type BrowserIdentifier = keyof Browsers;

package/types.quicktype.d.ts

@@ -0,0 +1,217 @@
+/**
+ * The top-level web-features data package
+ */
+export interface WebFeaturesData {
+    /**
+     * Browsers and browser release data
+     */
+    browsers: Browsers;
+    /**
+     * Feature identifiers and data
+     */
+    features: {
+        [key: string]: FeatureData;
+    };
+    /**
+     * Group identifiers and data
+     */
+    groups: {
+        [key: string]: GroupData;
+    };
+    /**
+     * Snapshot identifiers and data
+     */
+    snapshots: {
+        [key: string]: SnapshotData;
+    };
+}
+/**
+ * Browsers and browser release data
+ */
+export interface Browsers {
+    chrome: BrowserData;
+    chrome_android: BrowserData;
+    edge: BrowserData;
+    firefox: BrowserData;
+    firefox_android: BrowserData;
+    safari: BrowserData;
+    safari_ios: BrowserData;
+}
+/**
+ * Browser information
+ */
+export interface BrowserData {
+    /**
+     * The name of the browser, as in "Edge" or "Safari on iOS"
+     */
+    name: string;
+    releases: Release[];
+}
+/**
+ * Browser release information
+ */
+export interface Release {
+    /**
+     * The release date, as in "2023-12-11"
+     */
+    date: string;
+    /**
+     * The version string, as in "10" or "17.1"
+     */
+    version: string;
+}
+/**
+ * A feature data entry
+ *
+ * A feature has permanently moved to exactly one other ID
+ *
+ * A feature has split into two or more other features
+ */
+export interface FeatureData {
+    /**
+     * caniuse.com identifiers
+     */
+    caniuse?: string[];
+    /**
+     * Sources of support data for this feature
+     */
+    compat_features?: string[];
+    /**
+     * Short description of the feature, as a plain text string
+     */
+    description?: string;
+    /**
+     * Short description of the feature, as an HTML string
+     */
+    description_html?: string;
+    /**
+     * Whether developers are formally discouraged from using this feature
+     */
+    discouraged?: Discouraged;
+    /**
+     * Group identifiers
+     */
+    group?: string[];
+    kind: Kind;
+    /**
+     * Short name
+     */
+    name?: string;
+    /**
+     * Snapshot identifiers
+     */
+    snapshot?: string[];
+    /**
+     * Specification URLs
+     */
+    spec?: string[];
+    /**
+     * Whether a feature is considered a "Baseline" web platform feature and when it achieved
+     * that status
+     */
+    status?: StatusHeadline;
+    /**
+     * The new ID for this feature
+     */
+    redirect_target?: string;
+    /**
+     * The new IDs for this feature
+     */
+    redirect_targets?: string[];
+}
+/**
+ * Whether developers are formally discouraged from using this feature
+ */
+export interface Discouraged {
+    /**
+     * Links to a formal discouragement notice, such as specification text, intent-to-unship,
+     * etc.
+     */
+    according_to: string[];
+    /**
+     * IDs for features that substitute some or all of this feature's utility
+     */
+    alternatives?: string[];
+}
+export type Kind = "feature" | "moved" | "split";
+/**
+ * Whether a feature is considered a "Baseline" web platform feature and when it achieved
+ * that status
+ */
+export interface StatusHeadline {
+    /**
+     * Whether the feature is Baseline (low substatus), Baseline (high substatus), or not (false)
+     */
+    baseline: boolean | BaselineEnum;
+    /**
+     * Date the feature achieved Baseline high status
+     */
+    baseline_high_date?: string;
+    /**
+     * Date the feature achieved Baseline low status
+     */
+    baseline_low_date?: string;
+    /**
+     * Statuses for each key in the feature's compat_features list, if applicable. Not available
+     * to the npm release of web-features.
+     */
+    by_compat_key?: {
+        [key: string]: Status;
+    };
+    /**
+     * Browser versions that most-recently introduced the feature
+     */
+    support: Support;
+}
+export type BaselineEnum = "high" | "low";
+export interface Status {
+    /**
+     * Whether the feature is Baseline (low substatus), Baseline (high substatus), or not (false)
+     */
+    baseline: boolean | BaselineEnum;
+    /**
+     * Date the feature achieved Baseline high status
+     */
+    baseline_high_date?: string;
+    /**
+     * Date the feature achieved Baseline low status
+     */
+    baseline_low_date?: string;
+    /**
+     * Browser versions that most-recently introduced the feature
+     */
+    support: Support;
+    [property: string]: any;
+}
+/**
+ * Browser versions that most-recently introduced the feature
+ */
+export interface Support {
+    chrome?: string;
+    chrome_android?: string;
+    edge?: string;
+    firefox?: string;
+    firefox_android?: string;
+    safari?: string;
+    safari_ios?: string;
+}
+export interface GroupData {
+    /**
+     * Short name
+     */
+    name: string;
+    /**
+     * Identifier of parent group
+     */
+    parent?: string;
+}
+export interface SnapshotData {
+    /**
+     * Short name
+     */
+    name: string;
+    /**
+     * Specification
+     */
+    spec: string;
+}