feat: add highlight_reel (Sticker field 11), make paintwear nullable, add csfloat test vectors

Author: vlydev

src/InspectLink.php

@@ -32,7 +32,7 @@ final class InspectLink
      */
     public static function serialize(ItemPreviewData $data): string
     {
-        if ($data->paintwear < 0.0 || $data->paintwear > 1.0) {
+        if ($data->paintwear !== null && ($data->paintwear < 0.0 || $data->paintwear > 1.0)) {
             throw new \InvalidArgumentException(
                 sprintf('paintwear must be in [0.0, 1.0], got %f', $data->paintwear),
             );
@@ -216,6 +216,10 @@ private static function encodeSticker(Sticker $s): string
 
         $w->writeUint32(10, $s->pattern);
 
+        if ($s->highlightReel !== null) {
+            $w->writeUint32(11, $s->highlightReel);
+        }
+
         return $w->toBytes();
     }
 
@@ -236,6 +240,7 @@ private static function decodeSticker(string $data): Sticker
                 8 => $s->offsetY = (float) unpack('f', $f['value'])[1],
                 9 => $s->offsetZ = (float) unpack('f', $f['value'])[1],
                 10 => $s->pattern = $f['value'],
+                11 => $s->highlightReel = $f['value'],
                 default => null,
             };
         }
@@ -257,9 +262,11 @@ private static function encodeItem(ItemPreviewData $item): string
         $w->writeUint32(5, $item->rarity);
         $w->writeUint32(6, $item->quality);
 
-        // paintwear: float32 reinterpreted as uint32 varint
-        $pwUint32 = self::float32ToUint32($item->paintwear);
-        $w->writeUint32(7, $pwUint32);
+        // paintwear: float32 reinterpreted as uint32 varint (only written if set)
+        if ($item->paintwear !== null) {
+            $pwUint32 = self::float32ToUint32($item->paintwear);
+            $w->writeUint32(7, $pwUint32);
+        }
 
         $w->writeUint32(8, $item->paintseed);
         $w->writeUint32(9, $item->killeaterscoretype);

src/ItemPreviewData.php

@@ -28,7 +28,7 @@ public function __construct(
         public int $paintindex = 0,
         public int $rarity = 0,
         public int $quality = 0,
-        public float $paintwear = 0.0,
+        public ?float $paintwear = null,
         public int $paintseed = 0,
         public int $killeaterscoretype = 0,
         public int $killeatervalue = 0,

src/Sticker.php

@@ -23,5 +23,6 @@ public function __construct(
         public ?float $offsetY = null,
         public ?float $offsetZ = null,
         public int $pattern = 0,
+        public ?int $highlightReel = null,
     ) {}
 }

tests/InspectLinkTest.php

@@ -451,4 +451,123 @@ public function testSerializeCustomnameMaxLength(): void
         $result = InspectLink::serialize(new ItemPreviewData(customname: str_repeat('A', 100)));
         $this->assertStringStartsWith('00', $result);
     }
+
+    // -----------------------------------------------------------------------
+    // New test vectors from csfloat/cs-inspect-serializer gen.test.ts
+    // -----------------------------------------------------------------------
+
+    /** CSFloat vector A — no stickers, paintwear ≈ 0.6337 */
+    private const CSFLOAT_A = '00180720DA03280638FBEE88F90340B2026BC03C96';
+
+    /** CSFloat vector B — 4 stickers id=76 each, paintwear ≈ 0.99 */
+    private const CSFLOAT_B = '00180720C80A280638A4E1F5FB03409A0562040800104C62040801104C62040802104C62040803104C6D4F5E30';
+
+    /** CSFloat vector C — keychain item (defindex=1355), highlight_reel=345 */
+    private const CSFLOAT_C = 'A2B2A2BA69A882A28AA192AECAA2D2B700A3A5AAA2B286FA7BA0D684BE72';
+
+    public function testCsfloatA_Defindex(): void
+    {
+        $this->assertSame(7, InspectLink::deserialize(self::CSFLOAT_A)->defindex);
+    }
+
+    public function testCsfloatA_Paintindex(): void
+    {
+        $this->assertSame(474, InspectLink::deserialize(self::CSFLOAT_A)->paintindex);
+    }
+
+    public function testCsfloatA_Paintseed(): void
+    {
+        $this->assertSame(306, InspectLink::deserialize(self::CSFLOAT_A)->paintseed);
+    }
+
+    public function testCsfloatA_Rarity(): void
+    {
+        $this->assertSame(6, InspectLink::deserialize(self::CSFLOAT_A)->rarity);
+    }
+
+    public function testCsfloatA_Paintwear(): void
+    {
+        $item = InspectLink::deserialize(self::CSFLOAT_A);
+        $this->assertNotNull($item->paintwear);
+        $this->assertEqualsWithDelta(0.6337, $item->paintwear, 0.001);
+    }
+
+    public function testCsfloatB_StickerCount(): void
+    {
+        $this->assertCount(4, InspectLink::deserialize(self::CSFLOAT_B)->stickers);
+    }
+
+    public function testCsfloatB_StickerIds(): void
+    {
+        $stickers = InspectLink::deserialize(self::CSFLOAT_B)->stickers;
+        foreach ($stickers as $s) {
+            $this->assertSame(76, $s->stickerId);
+        }
+    }
+
+    public function testCsfloatB_Paintindex(): void
+    {
+        $this->assertSame(1352, InspectLink::deserialize(self::CSFLOAT_B)->paintindex);
+    }
+
+    public function testCsfloatB_Paintwear(): void
+    {
+        $item = InspectLink::deserialize(self::CSFLOAT_B);
+        $this->assertNotNull($item->paintwear);
+        $this->assertEqualsWithDelta(0.99, $item->paintwear, 0.001);
+    }
+
+    public function testCsfloatC_Defindex(): void
+    {
+        $this->assertSame(1355, InspectLink::deserialize(self::CSFLOAT_C)->defindex);
+    }
+
+    public function testCsfloatC_Quality(): void
+    {
+        $this->assertSame(12, InspectLink::deserialize(self::CSFLOAT_C)->quality);
+    }
+
+    public function testCsfloatC_KeychainHighlightReel(): void
+    {
+        $keychains = InspectLink::deserialize(self::CSFLOAT_C)->keychains;
+        $this->assertCount(1, $keychains);
+        $this->assertSame(345, $keychains[0]->highlightReel);
+    }
+
+    public function testCsfloatC_NoPaintwear(): void
+    {
+        // keychain items have no wear — field 7 not present in proto
+        $this->assertNull(InspectLink::deserialize(self::CSFLOAT_C)->paintwear);
+    }
+
+    // -----------------------------------------------------------------------
+    // Roundtrip: highlight_reel and nullable paintwear
+    // -----------------------------------------------------------------------
+
+    public function testRoundtrip_HighlightReel(): void
+    {
+        $data = new ItemPreviewData(
+            defindex: 7,
+            keychains: [new Sticker(slot: 0, stickerId: 36, highlightReel: 345)],
+        );
+        $result = InspectLink::deserialize(InspectLink::serialize($data));
+        $this->assertCount(1, $result->keychains);
+        $this->assertSame(345, $result->keychains[0]->highlightReel);
+    }
+
+    public function testRoundtrip_NullPaintwear(): void
+    {
+        $data = new ItemPreviewData(defindex: 7, paintwear: null);
+        $result = InspectLink::deserialize(InspectLink::serialize($data));
+        $this->assertNull($result->paintwear);
+    }
+
+    public function testSerialize_NullPaintwearProducesFewerBytes(): void
+    {
+        // An item with null paintwear omits field 7 entirely; a non-zero float value writes it.
+        // (0.0 also omits field 7 due to proto3 default-value skipping, so compare against 0.5.)
+        $withNull = InspectLink::serialize(new ItemPreviewData(defindex: 7, paintwear: null));
+        $withFloat = InspectLink::serialize(new ItemPreviewData(defindex: 7, paintwear: 0.5));
+        $this->assertLessThan(strlen($withFloat), strlen($withNull));
+    }
 }