ntcore-ts-client/CHANGELOG.md

A TypeScript library for communication over [WPILib's NetworkTables 4.1 protocol](https://github.com/wpilibsuite/allwpilib/blob/main/ntcore/doc/networktables4.adoc).

# Changelog

Note: there may be breaking changes between each beta version, but if a breaking change is introduced out of beta, it will be a major version change

## 3.1.3

- Hotfix: Fix `raw` type number to be `5` instead of `3`
- Updated dependencies

### Non-library changes

- Swap from jest to vitest

## 3.1.2

- Hotfix: WPILib 2025.2.1 needs a subscription after publish to receive the announcement. Implements this hotfix and other small null-check fixes.

## 3.1.1

- Hotfix: export modules correctly and fix doc generation

## 3.1.0

- Fix 2025 Robot issues

  - Fixes publisher and subscriber ID generations to start counting at 0. Avoids integer overflows.
  - Remove RTT websocket that is unnecessary since the client can respond to PING and PONG messages

- Fix timeout for publishing pre-connection to wait for robot connection

## 3.0.0-beta.1

### Breaking Changes

- **BREAKING CHANGE: Remove immediateNotify from subscribe**
  - This complicated prefix topics and was not a very valuable feature
  - Workaround: you can manually call the subscription's callback yourself after subscribing

### Changes

- Add prefix topic support
  - You can now subscribe to multiple topics with a single subscription
  - This is done by creating a topic with a prefix, and then subscribing to that topic
  - For example, if you have topics `/MyTable/Accelerometer/X`, `/MyTable/Accelerometer/Y`, and `/MyTable/Accelerometer/Z`, you can create a prefix topic `/MyTable/Accelerometer/` and subscribe to that to get notifications for all three subtopics

## 2.0.0

### Breaking Changes

- **BREAKING CHANGE: Drop support for v4.0**
  - The API now requires NT v4.1 to function
- **BRAKING CHANGE: publish and setProperties are now asynchronous**
  - Please await these calls to know when the changes take effect
    - After awaiting publish, it is safe to set new values to the topic

### Changes

- Add support for v4.1
  - No support for PING/PONG messages - Node/JS limitation
  - No support added yet for cached messages
- Updated dependencies

## 1.0.0

### Breaking Changes

- **BREAKING CHANGE: removed NetworkTables.createInstance\*()**
  - Please use NetworkTables.getInstanceByTeam() and NetworkTables.getInstanceByURI()
- **BREAKING CHANGE: removed NetworkTableTypeInfos**
  - Fixed typo: now called `NetworkTablesTypeInfos` (NetworkTables plural! With **S**!)

## 0.2.2

### Changes

- Updated dependencies
- Existing topics are type checked better

## 0.2.1

### Changes

- Updated dependencies and changelog

## 0.2.0

### Breaking Changes

- **BREAKING CHANGE: deprecated NetworkTables.createInstance\*()**
  - Please use NetworkTables.getInstanceByTeam() and NetworkTables.getInstanceByURI()
- **BREAKING CHANGE: removed NetworkTables.getInstance() and NetworkTables.getServerURL()**
- **BREAKING CHANGE: deprecated NetworkTableTypeInfos**
  - Fixed typo: now called `NetworkTablesTypeInfos` (NetworkTables plural! With **S**!)

### New Features

- feat: allow multiple connections

### Bug fixes

- fix: rename NetworkTableTypeInfos to NetworkTablesTypeInfos
- fix: connect to the correct mDNS address
  - We were trying to connect to `roborio-frc-<team>.local` instead of `roborio-<team>-frc.local`
- fix: bug with creating instance on same URI w/ different port
- fix: queue value to published topic w/o server connection

### Misc commits

- chore: bump version

- chore: update deps
- style: prepend nt client id with `ntcore-ts-`
- chore: update deps
- chore: bump version to 0.2.0

### Non-library changes

- Improve docs by @Pokesi in <https://github.com/cjlawson02/ntcore-ts-client/pull/15>

- fix(ci): temporarily disable linting through CI by @cjlawson02 in <https://github.com/cjlawson02/ntcore-ts-client/pull/16>
- chore: upgrade tslib and dev deps by @cjlawson02 in <https://github.com/cjlawson02/ntcore-ts-client/pull/17>
- feat(dev): add commitlint for conventional commits enforcement by @cjlawson02 in <https://github.com/cjlawson02/ntcore-ts-client/pull/18>
- build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.48.2 to 5.49.0 by @dependabot in <https://github.com/cjlawson02/ntcore-ts-client/pull/20>
- build(deps-dev): bump @typescript-eslint/parser from 5.48.2 to 5.49.0 by @dependabot in <https://github.com/cjlawson02/ntcore-ts-client/pull/19>
- build(deps-dev): bump eslint-plugin-jsdoc from 39.6.7 to 40.0.0 by @dependabot in <https://github.com/cjlawson02/ntcore-ts-client/pull/27>
- build(deps): bump tslib from 2.4.1 to 2.5.0 by @dependabot in <https://github.com/cjlawson02/ntcore-ts-client/pull/25>
- build(deps-dev): bump jest and @types/jest by @dependabot in <https://github.com/cjlawson02/ntcore-ts-client/pull/28>

## 0.0.1-beta.5

- Breaking changes:
  - renamed NetworkTableTypes to NetworkTablesTypes

## 0.0.1-beta.4

- Note: beta.1-beta.3 were tests of publishing to NPM and small fixes
- Fixed dependency issue
- Added keywords
- Breaking changes:
  - renamed Topic to NetworkTablesTopic
  - renamed NetworkTableTypeInfo to NetworkTablesTypeInfo
  - Moved to ES5/CommonJS compiling

## 0.0.1-beta.0

- Initial Release