Add redirect feature schema types

Author: ddbeck

schemas/data.schema.json

@@ -44,7 +44,17 @@
       "description": "Feature identifiers and data",
       "type": "object",
       "additionalProperties": {
-        "$ref": "#/definitions/FeatureData"
+        "oneOf": [
+          {
+            "$ref": "#/definitions/FeatureData"
+          },
+          {
+            "$ref": "#/definitions/FeatureMovedData"
+          },
+          {
+            "$ref": "#/definitions/FeatureSplitData"
+          }
+        ]
       }
     },
     "groups": {
@@ -176,6 +186,50 @@
       "required": ["version", "date"],
       "additionalProperties": false
     },
+    "FeatureMovedData": {
+      "description": "A feature has permanently moved to exactly one other ID",
+      "type": "object",
+      "properties": {
+        "redirect": {
+          "type": "object",
+          "properties": {
+            "reason": {
+              "const": "moved"
+            },
+            "target": {
+              "description": "The new ID for this feature",
+              "type": "string"
+            }
+          },
+          "required": ["reason", "target"],
+          "additionalProperties": false
+        }
+      },
+      "required": ["redirect"],
+      "additionalProperties": false
+    },
+    "FeatureSplitData": {
+      "description": "A feature has split into two or more other features",
+      "type": "object",
+      "properties": {
+        "redirect": {
+          "type": "object",
+          "properties": {
+            "reason": {
+              "const": "split"
+            },
+            "targets": {
+              "description": "The new IDs for this feature",
+              "$ref": "#/definitions/Strings"
+            }
+          },
+          "required": ["reason", "targets"],
+          "additionalProperties": false
+        }
+      },
+      "required": ["redirect"],
+      "additionalProperties": false
+    },
     "Status": {
       "type": "object",
       "properties": {

types.quicktype.ts

@@ -60,6 +60,10 @@ export interface Release {
 
 /**
  * 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 {
   /**
@@ -73,11 +77,11 @@ export interface FeatureData {
   /**
    * Short description of the feature, as a plain text string
    */
-  description: string;
+  description?: string;
   /**
    * Short description of the feature, as an HTML string
    */
-  description_html: string;
+  description_html?: string;
   /**
    * Whether developers are formally discouraged from using this feature
    */
@@ -89,20 +93,21 @@ export interface FeatureData {
   /**
    * Short name
    */
-  name: string;
+  name?: string;
   /**
    * Snapshot identifier(s)
    */
   snapshot?: string[] | string;
   /**
    * Specification URL(s)
    */
-  spec: string[] | string;
+  spec?: string[] | string;
   /**
    * Whether a feature is considered a "Baseline" web platform feature and when it achieved
    * that status
    */
   status?: StatusHeadline;
+  redirect?: Redirect;
   [property: string]: any;
 }
 
@@ -121,6 +126,20 @@ export interface Discouraged {
   alternatives?: string[];
 }
 
+export interface Redirect {
+  reason: Reason;
+  /**
+   * The new ID for this feature
+   */
+  target?: string;
+  /**
+   * The new IDs for this feature
+   */
+  targets?: string[];
+}
+
+export type Reason = "moved" | "split";
+
 /**
  * Whether a feature is considered a "Baseline" web platform feature and when it achieved
  * that status

types.ts

@@ -11,6 +11,7 @@ import type {
   GroupData,
   FeatureData as QuicktypeMonolithicFeatureData,
   WebFeaturesData as QuicktypeWebFeaturesData,
+  Redirect,
   Release,
   SnapshotData,
   Status,
@@ -34,7 +35,9 @@ export type {
 
 export interface WebFeaturesData
   extends Pick<QuicktypeWebFeaturesData, "browsers" | "groups" | "snapshots"> {
-  features: { [key: string]: FeatureData };
+  features: {
+    [key: string]: FeatureData | FeatureMovedData | FeatureSplitData;
+  };
 }
 
 export type FeatureData = Required<
@@ -50,6 +53,28 @@ export type FeatureData = Required<
     >
   >;
 
+export type FeatureRedirectData = Required<
+  Pick<QuicktypeMonolithicFeatureData, "redirect">
+>;
+
+export interface Moved extends Exclude<Redirect, "targets"> {
+  reason: "moved";
+  target: Redirect["target"];
+}
+
+export interface Split extends Exclude<Redirect, "target"> {
+  reason: "split";
+  targets: Redirect["targets"];
+}
+
+export interface FeatureMovedData extends FeatureRedirectData {
+  redirect: Moved;
+}
+
+export interface FeatureSplitData extends FeatureRedirectData {
+  redirect: Split;
+}
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const t1: FeatureData = {
   name: "Test",