@matter/thread-br-client 0.0.1

package/src/index.ts

@@ -0,0 +1,93 @@
+/**
+ * @license
+ * Copyright 2022-2026 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * `@matter/thread-br-client` — Thread Border Router discovery, dataset codec, and
+ * read-only network diagnostics (MeshCoP/CoAP over DTLS-EC-JPAKE, and OTBR REST).
+ * See the package README for a consumer getting-started.
+ */
+export { BorderRouterRegistry } from "./discovery/index.js";
+export type { BorderRouterEntry } from "./discovery/index.js";
+
+export {
+    MeshCopTlvType,
+    MeshCopTlvTypeName,
+    OperationalDataset,
+    SecurityPolicy,
+    ThreadDatasetError,
+} from "./dataset/index.js";
+
+export { ThreadCredentialsRegistry } from "./credentials/index.js";
+export type { ThreadNetworkCredentials } from "./credentials/index.js";
+
+export { ThreadTlvError } from "./tlv/BasicTlvCodec.js";
+export { NetworkDiagTlvType, NetworkDiagTlvTypeName } from "./tlv/networkDiagTlvTypes.js";
+
+export {
+    ALL_THREAD_NODES_REALM_LOCAL,
+    ALL_THREAD_ROUTERS_REALM_LOCAL,
+    deriveMeshLocalAddress,
+    formatIp6,
+} from "./util/meshLocalAddr.js";
+
+// Diagnostics: the source abstraction, response shape, and its structured sub-types.
+export { DefaultTlvSet, MeshCopDiagnosticSource, ThreadDiagError, connectMeshcop } from "./diagnostic/index.js";
+export type {
+    ConnectMeshcopOpts,
+    DiagnosticResponse,
+    DiagnosticSource,
+    EnergyScanEntry,
+    EnergyScanOpts,
+    MeshcopHandle,
+    PanIdConflict,
+    PanIdQueryOpts,
+    QueryMulticastHandle,
+    QueryMulticastOptions,
+} from "./diagnostic/index.js";
+
+// DiagnosticResponse field types, so consumers can name them without deep imports.
+export type {
+    ChildTableEntry,
+    Connectivity,
+    LeaderData,
+    MacCounters,
+    MleCounters,
+    Mode,
+    ParentPriority,
+    Route64,
+    Route64Entry,
+} from "./tlv/diag/index.js";
+
+export { Pskc } from "./crypto/index.js";
+
+export { DtlsError, connectDtls } from "./dtls/channel/index.js";
+export type { DtlsChannel, DtlsConnectOpts } from "./dtls/channel/index.js";
+
+export {
+    Commissioner,
+    CommissionerKeepAliveError,
+    CommissionerProtocolError,
+    CommissionerRejectedError,
+    CommissionerTimeoutError,
+} from "./commissioner/index.js";
+export type { CommissionerOpts } from "./commissioner/index.js";
+
+export { CoapTimeoutError } from "./coap/index.js";
+
+export { OtbrRestClient, OtbrRestDiagnosticSource, OtbrRestError, OtbrRestProbe } from "./otbr-rest/index.js";
+export type {
+    OtbrDatasetHex,
+    OtbrJoiner,
+    OtbrLeaderData,
+    OtbrNodeInfo,
+    OtbrRestCapability,
+    OtbrRestClientOptions,
+    OtbrRestErrorCode,
+    OtbrRestErrorOptions,
+} from "./otbr-rest/index.js";
+
+export { ExtPanIdLockManager, decodeStateBitmap, rankBrs, selectBr, selectSource } from "./selection/index.js";
+export type { DecodedStateBitmap, SelectSourceOpts } from "./selection/index.js";

package/src/otbr-rest/OtbrRestCapability.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2022-2026 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Snapshot of an OTBR REST endpoint as observed by {@link OtbrRestProbe}.
+ *
+ * `keyFormat` reflects the case convention the BR's REST surface uses on the
+ * wire (older OTBR builds = pascal, post-2024 builds = camel). The probe
+ * detects this from the presence/absence of `/api/actions` — see
+ * python-otbr-api `_async_detect_case`.
+ */
+export interface OtbrRestCapability {
+    baseUrl: string;
+    keyFormat: "camel" | "pascal";
+    apiVersion?: string;
+    probedAt: number;
+    networkName: string;
+    extPanId: Uint8Array;
+}