web-features 0.9.0 → 0.10.0

package/README.md

@@ -9,7 +9,7 @@ npm install web-features
 ```
 
 ```js
-import webFeatures from "web-features";
+import { features, groups, snapshots } from "web-features";
 ```
 
 ## Rendering Baseline statuses with `web-features`

package/index.d.ts

@@ -1,4 +1,3 @@
-/** Web platform feature */
 interface FeatureData {
     /** Short name */
     name: string;
@@ -10,14 +9,16 @@ interface FeatureData {
     alias?: string | [string, string, ...string[]];
     /** Specification */
     spec: specification_url | [specification_url, specification_url, ...specification_url[]];
+    /** Group identifier */
+    group?: string | [string, string, ...string[]];
+    /** Snapshot identifier */
+    snapshot?: string | [string, string, ...string[]];
     /** caniuse.com identifier */
     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[];
-    /** Usage stats */
-    usage_stats?: usage_stats_url | [usage_stats_url, usage_stats_url, ...usage_stats_url[]];
 }
 type browserIdentifier = "chrome" | "chrome_android" | "edge" | "firefox" | "firefox_android" | "safari" | "safari_ios";
 type BaselineHighLow = "high" | "low";
@@ -37,13 +38,27 @@ interface SupportStatus {
  * @format uri
 */
 type specification_url = string;
-/** Usage stats URL
- * @format uri
-*/
-type usage_stats_url = string;
+interface GroupData {
+    /** Short name */
+    name: string;
+    /** Identifier of parent group */
+    parent?: string;
+}
+interface SnapshotData {
+    /** Short name */
+    name: string;
+    /** Specification */
+    spec: specification_url;
+}
 
 declare const features: {
-    [id: string]: FeatureData;
+    [key: string]: FeatureData;
+};
+declare const groups: {
+    [key: string]: GroupData;
+};
+declare const snapshots: {
+    [key: string]: SnapshotData;
 };
 
-export { features as default };
+export { features, groups, snapshots };

package/index.js

@@ -1,5 +1,5 @@
 import { readFileSync } from "node:fs";
 import { fileURLToPath } from "node:url";
 const jsonPath = fileURLToPath(new URL("./index.json", import.meta.url));
-const features = JSON.parse(readFileSync(jsonPath, { encoding: "utf-8" }));
-export default features;
+const { features, groups, snapshots } = JSON.parse(readFileSync(jsonPath, { encoding: "utf-8" }));
+export { features, groups, snapshots };