🤖 Merge PR DefinitelyTyped#74385 Fontkit: add COLR, CPAL and Glyph .layers by @danmarshall

Author: danmarshall

types/fontkit/fontkit-tests.ts

@@ -90,3 +90,30 @@ openV2.then(font => {
         font.getFont("hhe"); // $ExpectType Font | null
     }
 });
+
+// ----------------------------
+// API: Font.COLR and Font.CPAL
+// ----------------------------
+openV2.then(font => {
+    if (!isCollection(font)) {
+        font.COLR?.version; // $ExpectType number | undefined
+        font.COLR?.baseGlyphRecord[0].gid; // $ExpectType number | undefined
+        font.COLR?.layerRecords[0].paletteIndex; // $ExpectType number | undefined
+
+        font.CPAL?.numPalettes; // $ExpectType number | undefined
+        font.CPAL?.colorRecords[0].red; // $ExpectType number | undefined
+        font.CPAL?.colorRecords[0].alpha; // $ExpectType number | undefined
+    }
+});
+
+// ------------------
+// API: Glyph.layers
+// ------------------
+openV2.then(font => {
+    if (!isCollection(font)) {
+        const glyph = font.glyphForCodePoint(0x1F600);
+        glyph.layers?.[0].glyph; // $ExpectType Glyph | undefined
+        glyph.layers?.[0].color.red; // $ExpectType number | undefined
+        glyph.layers?.[0].color.alpha; // $ExpectType number | undefined
+    }
+});

types/fontkit/index.d.ts

@@ -38,6 +38,10 @@ export interface Font {
     "OS/2": Os2Table;
     /** the font's horizontal header table consisting of information needed to layout fonts with horizontal characters    */
     hhea: HHEA;
+    /** the color table containing layer records for color glyphs (optional, present in fonts with color glyphs) */
+    COLR?: COLRTable;
+    /** the color palette table containing color definitions (optional, present in fonts with color glyphs) */
+    CPAL?: CPALTable;
 
     /** the number of glyphs in the font */
     numGlyphs: number;
@@ -243,6 +247,12 @@ export interface Glyph {
 
     /**  The glyph's name. Commonly the character, or 'space' or UTF**** */
     name: string;
+
+    /**
+     * For COLR glyphs, an array of objects containing the glyph and color for each layer.
+     * Each layer has a `glyph` property with the glyph object and a `color` property with RGBA values.
+     */
+    layers?: Array<{ glyph: Glyph; color: { red: number; green: number; blue: number; alpha: number } }>;
 }
 
 /**
@@ -373,6 +383,35 @@ export interface HHEA {
     numberOfMetrics: number;
 }
 
+export interface COLRTable {
+    version: number;
+    numBaseGlyphRecords: number;
+    baseGlyphRecord: Array<{
+        gid: number;
+        firstLayerIndex: number;
+        numLayers: number;
+    }>;
+    layerRecords: Array<{
+        gid: number;
+        paletteIndex: number;
+    }>;
+    numLayerRecords: number;
+}
+
+export interface CPALTable {
+    version: number;
+    numPaletteEntries: number;
+    numPalettes: number;
+    numColorRecords: number;
+    colorRecords: Array<{
+        red: number;
+        green: number;
+        blue: number;
+        alpha: number;
+    }>;
+    colorRecordIndices: number[];
+}
+
 export interface FontCollection {
     type: "TTC" | "DFont";
     getFont(name: string): Font | null;