Repository navigation
Releases
v5.1.1 — Dependency and data refresh
Security
- Refreshed the lockfile with
npm audit fix, resolving advisories in transitiveip-address(runtime),handlebarsandsource-map-js(development only). - Known remaining runtime advisory:
adm-zip< 0.6 throughsteam-user5.3.0, which still requires^0.5.10. No compatible upstream fix is available yet. Other remaining advisories affect development tooling only (Jest, ESLint and VitePress dependency chains) and have no non-breaking fix.
Changed
- Minimum node-cs2 dependency is 2.7.1, which syncs CS2 protobufs through November 11, 2026 and moves node-cs2 to protobufjs 8. No Game Coordinator or inspect messages changed;
CEconItemPreviewDataBlockstill matches upstream. - Updated locked dependencies within their existing ranges, including
commander15.1.0,eslint10.14.0, TypeScript ESLint 8.72.2 andts-jest29.4.15. TypeScript stays on 6.0.3. - Re-pinned the ByMykel snapshot to
9282a816. Generated paint enums, weapon types and versioned item data are unchanged apart from the snapshot hash.
v5.1.0 — Browser core, batch inspection and lossless item tools
New APIs
cs2-inspect-lib/core: browser-safe embedded-link codecs and item tools, with no node-cs2 or steam-user imports.cs2-inspect-lib/steam: explicit authenticated functionality; existing root imports remain supported.inspectBatch: mixed embedded and legacy links, ordered per-item results, progress, cancellation and duplicate suppression through the existing queue.- Separate wire and game-data validation using a versioned weapon/paint/wear snapshot, with an explicit permissive mode for new items.
- Semantic item comparison, structured link diagnostics and immutable lossless protobuf editing, including preservation of nested unknown attachment fields.
Compatibility and migration
Use /core in browser projects. Root imports, existing overloads and historical dist/* imports remain available. Strict document decoding validates CRC; the historical decoder retains its previous behavior. Editing preserves untouched protobuf segments, not necessarily the complete encoded URL. See the item-tools guide for resource limits, field occurrence rules and nested preservation guarantees.
The node-cs2 minimum is now 2.6.0, already published. Sent requests with uncertain outcomes are quarantined for that client lifetime; reconnecting does not make automatic retries safe. Cancelling a sent batch read stops the caller waiting while the underlying queue slot remains occupied until response or timeout. Errors retain the upstream structured cause and message.
Validation
- 520 tests; build, lint, strict TypeScript usage tests, pinned game-data generation and documentation build pass.
- Packed npm consumers tested on Node 22.12, 24 and 26 against published node-cs2 2.6.0.
- All 56 independent shared fixtures agree semantically across both libraries. Coverage includes uint64 boundaries, float32, Unicode/repeated names, stickers, charms, opaque bytes, nested unknown fields and malformed payloads.
- Package contents, exports, declarations and CLI verified; browser bundle executes without Buffer or Steam dependencies.
Authenticated Steam/GC behavior remains unverified. No authenticated mutation or sanitized live replay was available. Offline fixture coverage does not establish server acceptance.
v5.0.0 — Protocol, weapon data and reliability
v5.0.0 - Protocol, weapon data and reliability
Release date: 2026-09-27
Migration
- Review corrected default glove IDs: T is 5028 and CT is 5029.
- Numeric inputs must fit their protobuf ranges; use bigint for uint64 IDs beyond the safe integer range.
- Validation now applies by default in direct encoding/decoding helpers. Custom-name limits count UTF-8 bytes.
- Existing flat paint constants remain available; use WeaponPaints and WeaponEconItem for weapon-specific typing.
Added
- Per-weapon
WeaponPaintsmaps with one name per paint index,PaintFor<W>paint types and correlatedWeaponEconItem<W>item types. Existing flat WeaponPaint constants remain compatible. - Refreshed WeaponPaint and WeaponType from a pinned ByMykel snapshot: 2,126 skins, 75 weapon definitions and 2,300 paint names including aliases.
- Readable Doppler phase and accent-normalized paint aliases, while retaining all historical paint names and values.
- Weapon-aware
getPaintName(index, weapon)and numeric defindex support ingetPaintsByWeapon. - Offline catalog snapshot, generation checks and exhaustive weapon/paint pair coverage tests.
- Hand-written VitePress documentation with local search, task-oriented guides, CLI examples and protocol migration notes.
- September 25, 2026 inspection fields from node-cs2 2.5.0: repeated
customnames, uint32pet_food_expiration_date, and binaryblobdata, including Steam result conversion and validation. - Decoding for checksum-valid nonzero XOR-mask inspect tokens, retaining historical zero-mask and unprefixed input support.
Changed
- Match Steam inspection responses by asset through node-cs2's Promise API; observe late upstream rejections instead of leaving them unhandled.
- Recover from empty expired queues, reject pending work on disconnect, cancel queue delays and guard old workers/GC events across reconnects.
- Reject non-finite/fractional/out-of-range numeric fields, unsafe numeric item IDs and overflowing protobuf varints; unknown varints can now span uint64.
- Apply default validation in direct decoders and item encoding, honor config-only inspect options, and propagate configured URL/name limits.
- Measure custom-name limits in UTF-8 bytes consistently. Inputs that previously encoded corrupt values or undecodable names now fail early.
- Generated flat paint enums now express shared values as aliases, avoiding duplicate numeric initializers while preserving reverse mappings.
- Corrected reversed default glove definitions:
GLOVES_T = 5028,GLOVES_CT = 5029. Consumers relying on the old values must adjust. - Fixed generation to cover weapon/paint pairs instead of deduplicating paint IDs across weapons; generation now refreshes both enums using Node/npm without requiring Bun.
getPaintIndexno longer returns a string for numeric enum keys; weapon searches use exact names and pattern searches normalize accents.- Updated direct dependencies to latest compatible stable releases and refreshed npm/Bun lockfiles. TypeScript stays on 6.0.3: latest TypeScript ESLint and ts-jest peer ranges exclude 7.x.
- Preserved
customnameas the last decoded name. Explicitcustomnamestakes precedence when encoding, including an empty array. - Replaced TypeDoc and its configuration. GitHub Pages now deploys the built VitePress site, with package tests and lint required before deployment and Node 24 in CI.
- Applied default validation and URL-length settings to the top-level URL creation helper, matching instance behavior.
- Fixed protobuf float reads from byte-array views with nonzero offsets.
Known limitations
- Offline tests do not cover live Steam authentication or GC availability.
- Latest stable VitePress 1.6.4 still includes audit findings through Vite/esbuild; latest steam-user includes findings through adm-zip. Compatible audit fixes were applied; no unsupported major overrides were introduced for these dependencies.
- Legacy zero-mask/unprefixed decoding still does not authenticate checksums.
Validation: 394 automated tests, TypeScript build/typecheck, lint, deterministic catalog check and VitePress build.
Install: npm install cs2-inspect-lib@5.0.0
v4.1.0
v4.0.0
Release date: 2026-06-11
Breaking Changes
- Raised the supported Node.js runtime to
>=22.12.0because the latestcommander@15requires it.
Changed
- Updated runtime and development dependencies to their latest versions, including
commander@15,node-cs2@2.3.0,jest@30,eslint@10,typescript@6, andtypedoc@0.28. - Added an npm override for
steam-appticket@2.0.1so the Steam dependency chain resolves to patchedprotobufjs@7.6.3. - Migrated ESLint to flat config and added a dedicated
tsconfig.test.jsonfor Jest ambient types. - Updated README badges and package metadata for the new Node.js and TypeScript baselines.
Fixed
- Corrected
CEconItemPreviewDataBlock.entindexencoding/decoding to protobufint32wire semantics instead of ZigZagsint32. - Aligned Steam inspection result conversion with the current
node-cs2@2.3.0preview fields, includingvariations,petindex,style, andupgrade_level. - Removed the stale local
node-cs2declaration shim now that the package ships its own current TypeScript declarations. - Fixed CLI integration tests to pass arguments without shell splitting and to use declared test tooling.
- Updated the exported
VERSIONconstant to matchpackage.json.
Data
- Regenerated
WeaponPaintfrom the current ByMykel CSGO-APIskins.jsondataset. - Expanded paint coverage from 1,824 to 2,073 entries, including recent paint indexes such as
AK_47_THE_OLIGARCH,AWP_THE_END,M4A4_FULL_THROTTLE, andDRIVER_GLOVES_WAVE_CHASER.
Validation
- Verified
npm run build,npm run lint,npm test -- --runInBand, andnpm audit --audit-level=low.
v3.2.2
v3.2.1 - Code Cleanup & Optimizations
What's Changed
- Eliminated URL Parsing Duplication: UrlAnalyzer class now delegates to pure functions in url-parser.ts, removing ~200 lines of duplicated parsing/formatting logic
- Centralized Constants: INSPECT_BASE constant defined once and imported everywhere (was duplicated in 3 files)
- Consolidated URL Dispatch: Extracted shared decodeMaskedFromAnalyzed() helper, removing repeated analyze-check-decode patterns across index.ts
- Deduplicated Promise Timeout: Extracted waitForReady() helper in Steam client, eliminating two identical promise-with-timeout blocks
- CRC32 Performance: Pre-computed CRC32 lookup table at module load instead of regenerating the 256-entry table on every createInspectUrl() call
- Debug-Guarded Logging: All console.log/error/warn calls in Steam client and manager now respect the enableLogging config flag via debugLog()
- Fixed processRarity() Bug: Unknown string rarity values now throw EncodingError instead of silently returning STOCK (0)
- Fixed cleanExpiredItems() Performance: Replaced O(n²) filter+indexOf+splice pattern with single O(n) reverse-iteration pass
- Fixed Redundant Hex Validation: Removed unreachable >2000 length check that shadowed the correct >4096 check
- Removed Dead Code: No-op ternary and deprecated substr() replaced with slice()
- ~330 lines removed with zero public API changes - all existing tests pass
Full Changelog: v3.2.0...v3.2.1