@matter/thread-br-client 0.0.1

package/dist/cjs/dtls/record/index.js

@@ -0,0 +1,42 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var record_exports = {};
+__export(record_exports, {
+  AntiReplayWindow: () => import_AntiReplayWindow.AntiReplayWindow,
+  ContentType: () => import_ContentType.ContentType,
+  DTLS_1_2_VERSION: () => import_DtlsRecord.DTLS_1_2_VERSION,
+  DTLS_AEAD_OVERHEAD: () => import_DtlsRecord.DTLS_AEAD_OVERHEAD,
+  DTLS_HEADER_LEN: () => import_DtlsRecord.DTLS_HEADER_LEN,
+  DTLS_MAX_FRAGMENT_LEN: () => import_DtlsRecord.DTLS_MAX_FRAGMENT_LEN,
+  DtlsCipherState: () => import_DtlsCipherState.DtlsCipherState,
+  DtlsRecord: () => import_DtlsRecord.DtlsRecord,
+  DtlsReplayError: () => import_DtlsRecord.DtlsReplayError,
+  isContentType: () => import_ContentType.isContentType
+});
+module.exports = __toCommonJS(record_exports);
+var import_AntiReplayWindow = require("./AntiReplayWindow.js");
+var import_ContentType = require("./ContentType.js");
+var import_DtlsCipherState = require("./DtlsCipherState.js");
+var import_DtlsRecord = require("./DtlsRecord.js");
+/**
+ * @license
+ * Copyright 2022-2026 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+//# sourceMappingURL=index.js.map

package/dist/cjs/dtls/record/index.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/dtls/record/index.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA,8BAAiC;AACjC,yBAA2C;AAC3C,6BAA4D;AAC5D,wBAQO;AAvBP;AAAA;AAAA;AAAA;AAAA;",
+  "names": []
+}

package/dist/cjs/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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";
+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";
+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";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,OAAO,EACH,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,kBAAkB,GACrB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AACnE,YAAY,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAE1F,OAAO,EACH,4BAA4B,EAC5B,8BAA8B,EAC9B,sBAAsB,EACtB,SAAS,GACZ,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAChH,YAAY,EACR,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,aAAa,EACb,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,qBAAqB,GACxB,MAAM,uBAAuB,CAAC;AAG/B,YAAY,EACR,eAAe,EACf,YAAY,EACZ,UAAU,EACV,WAAW,EACX,WAAW,EACX,IAAI,EACJ,cAAc,EACd,OAAO,EACP,YAAY,GACf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE5E,OAAO,EACH,YAAY,EACZ,0BAA0B,EAC1B,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,GAC3B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC9G,YAAY,EACR,cAAc,EACd,UAAU,EACV,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,GACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC/G,YAAY,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,77 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+__export(src_exports, {
+  ALL_THREAD_NODES_REALM_LOCAL: () => import_meshLocalAddr.ALL_THREAD_NODES_REALM_LOCAL,
+  ALL_THREAD_ROUTERS_REALM_LOCAL: () => import_meshLocalAddr.ALL_THREAD_ROUTERS_REALM_LOCAL,
+  BorderRouterRegistry: () => import_discovery.BorderRouterRegistry,
+  CoapTimeoutError: () => import_coap.CoapTimeoutError,
+  Commissioner: () => import_commissioner.Commissioner,
+  CommissionerKeepAliveError: () => import_commissioner.CommissionerKeepAliveError,
+  CommissionerProtocolError: () => import_commissioner.CommissionerProtocolError,
+  CommissionerRejectedError: () => import_commissioner.CommissionerRejectedError,
+  CommissionerTimeoutError: () => import_commissioner.CommissionerTimeoutError,
+  DefaultTlvSet: () => import_diagnostic.DefaultTlvSet,
+  DtlsError: () => import_channel.DtlsError,
+  ExtPanIdLockManager: () => import_selection.ExtPanIdLockManager,
+  MeshCopDiagnosticSource: () => import_diagnostic.MeshCopDiagnosticSource,
+  MeshCopTlvType: () => import_dataset.MeshCopTlvType,
+  MeshCopTlvTypeName: () => import_dataset.MeshCopTlvTypeName,
+  NetworkDiagTlvType: () => import_networkDiagTlvTypes.NetworkDiagTlvType,
+  NetworkDiagTlvTypeName: () => import_networkDiagTlvTypes.NetworkDiagTlvTypeName,
+  OperationalDataset: () => import_dataset.OperationalDataset,
+  OtbrRestClient: () => import_otbr_rest.OtbrRestClient,
+  OtbrRestDiagnosticSource: () => import_otbr_rest.OtbrRestDiagnosticSource,
+  OtbrRestError: () => import_otbr_rest.OtbrRestError,
+  OtbrRestProbe: () => import_otbr_rest.OtbrRestProbe,
+  Pskc: () => import_crypto.Pskc,
+  SecurityPolicy: () => import_dataset.SecurityPolicy,
+  ThreadCredentialsRegistry: () => import_credentials.ThreadCredentialsRegistry,
+  ThreadDatasetError: () => import_dataset.ThreadDatasetError,
+  ThreadDiagError: () => import_diagnostic.ThreadDiagError,
+  ThreadTlvError: () => import_BasicTlvCodec.ThreadTlvError,
+  connectDtls: () => import_channel.connectDtls,
+  connectMeshcop: () => import_diagnostic.connectMeshcop,
+  decodeStateBitmap: () => import_selection.decodeStateBitmap,
+  deriveMeshLocalAddress: () => import_meshLocalAddr.deriveMeshLocalAddress,
+  formatIp6: () => import_meshLocalAddr.formatIp6,
+  rankBrs: () => import_selection.rankBrs,
+  selectBr: () => import_selection.selectBr,
+  selectSource: () => import_selection.selectSource
+});
+module.exports = __toCommonJS(src_exports);
+var import_discovery = require("./discovery/index.js");
+var import_dataset = require("./dataset/index.js");
+var import_credentials = require("./credentials/index.js");
+var import_BasicTlvCodec = require("./tlv/BasicTlvCodec.js");
+var import_networkDiagTlvTypes = require("./tlv/networkDiagTlvTypes.js");
+var import_meshLocalAddr = require("./util/meshLocalAddr.js");
+var import_diagnostic = require("./diagnostic/index.js");
+var import_crypto = require("./crypto/index.js");
+var import_channel = require("./dtls/channel/index.js");
+var import_commissioner = require("./commissioner/index.js");
+var import_coap = require("./coap/index.js");
+var import_otbr_rest = require("./otbr-rest/index.js");
+var import_selection = require("./selection/index.js");
+/**
+ * @license
+ * Copyright 2022-2026 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAWA,uBAAqC;AAGrC,qBAMO;AAEP,yBAA0C;AAG1C,2BAA+B;AAC/B,iCAA2D;AAE3D,2BAKO;AAGP,wBAAwF;AA2BxF,oBAAqB;AAErB,qBAAuC;AAGvC,0BAMO;AAGP,kBAAiC;AAEjC,uBAAuF;AAYvF,uBAAwF;AA3FxF;AAAA;AAAA;AAAA;AAAA;",
+  "names": []
+}

package/dist/cjs/otbr-rest/OtbrRestCapability.d.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;
+}
+//# sourceMappingURL=OtbrRestCapability.d.ts.map

package/dist/cjs/otbr-rest/OtbrRestCapability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OtbrRestCapability.d.ts","sourceRoot":"","sources":["../../../src/otbr-rest/OtbrRestCapability.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,UAAU,CAAC;CACxB"}

package/dist/cjs/otbr-rest/OtbrRestCapability.js

@@ -0,0 +1,22 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var OtbrRestCapability_exports = {};
+module.exports = __toCommonJS(OtbrRestCapability_exports);
+/**
+ * @license
+ * Copyright 2022-2026 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+//# sourceMappingURL=OtbrRestCapability.js.map

package/dist/cjs/otbr-rest/OtbrRestCapability.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/otbr-rest/OtbrRestCapability.ts"],
+  "mappings": ";;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;",
+  "names": []
+}

package/dist/cjs/otbr-rest/OtbrRestClient.d.ts

@@ -0,0 +1,257 @@
+/**
+ * @license
+ * Copyright 2022-2026 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { OperationalDataset } from "../dataset/OperationalDataset.js";
+export interface OtbrLeaderData {
+    partitionId: number;
+    weighting: number;
+    dataVersion: number;
+    stableDataVersion: number;
+    leaderRouterId: number;
+}
+export interface OtbrNodeInfo {
+    baId: Uint8Array;
+    state: string;
+    numOfRouter: number;
+    rlocAddress: string;
+    extAddress: Uint8Array;
+    networkName: string;
+    rloc16: number;
+    leaderData: OtbrLeaderData;
+    extPanId: Uint8Array;
+}
+export interface OtbrDatasetHex {
+    activeHex?: string;
+    pendingHex?: string;
+}
+/**
+ * A joiner entry to add to the on-BR commissioner via `POST /node/commissioner/joiner`.
+ *
+ * `pskd` (the joiner passphrase) is required; provide at most one of `eui64`
+ * (EUI-64 hex, or `"*"` for any device) or `discerner` (OpenThread joiner
+ * discerner, e.g. `"0x123/12"`).
+ */
+export interface OtbrJoiner {
+    pskd: string;
+    eui64?: string;
+    discerner?: string;
+    timeoutSeconds?: number;
+}
+export interface OtbrRestClientOptions {
+    host: string;
+    port?: number;
+    timeoutMs?: number;
+}
+/**
+ * Thin HTTP client for the OpenThread Border Router (OTBR) REST API.
+ *
+ * Wraps the OTBR REST endpoints under `/node` and `/diagnostics`. All methods
+ * reject with {@link OtbrRestError} on network failure or a response that
+ * violates the expected shape. IPv6 host literals are bracket-escaped
+ * automatically; bare IPv4 hosts and hostnames are passed through unchanged.
+ *
+ * @example
+ * ```ts
+ * const client = new OtbrRestClient({ host: "fd12::1" });
+ * const info = await client.getNode();
+ * ```
+ */
+export declare class OtbrRestClient {
+    #private;
+    /**
+     * @param opts - Connection parameters; `host` is required.
+     */
+    constructor(opts: OtbrRestClientOptions);
+    get baseUrl(): string;
+    /**
+     * Fetch the current node summary from the OTBR `/node` endpoint.
+     *
+     * @returns Parsed node info with typed fields (binary fields as `Uint8Array`).
+     * @throws {@link OtbrRestError} with code `"rest_unreachable"` on network error or timeout.
+     * @throws {@link OtbrRestError} with code `"rest_protocol"` when the response is
+     *   not a valid JSON object or a required field is missing or has the wrong type.
+     */
+    getNode(): Promise<OtbrNodeInfo>;
+    /**
+     * Fetch the raw diagnostics array from the OTBR `/diagnostics` endpoint.
+     *
+     * The response is returned as-is — callers are responsible for interpreting
+     * the per-node objects. Use `OtbrRestDiagnosticSource` for a typed interface
+     * that translates this payload into `DiagnosticResponse` values.
+     *
+     * @returns Array of raw node diagnostic objects as returned by the BR.
+     * @throws {@link OtbrRestError} with code `"rest_unreachable"` on network error or timeout.
+     * @throws {@link OtbrRestError} with code `"rest_protocol"` when the response is not a JSON array.
+     */
+    getDiagnostics(): Promise<unknown[]>;
+    /**
+     * Fetch the active and pending dataset hex strings from the OTBR REST API.
+     *
+     * Each dataset is fetched independently from `/node/dataset/active` and
+     * `/node/dataset/pending`. A `204 No Content` response means the dataset is
+     * absent, in which case the corresponding field is omitted from the result.
+     *
+     * @returns Object with `activeHex` and/or `pendingHex` hex strings; fields
+     *   are absent when the BR has no dataset of that type.
+     * @throws {@link OtbrRestError} with code `"rest_unreachable"` on network error or timeout.
+     * @throws {@link OtbrRestError} with code `"rest_protocol"` on a non-2xx HTTP status.
+     */
+    getDataset(): Promise<OtbrDatasetHex>;
+    /**
+     * Fetch the node role from `/node/state` (e.g. `"router"`, `"leader"`, `"child"`, `"disabled"`).
+     *
+     * @throws {@link OtbrRestError} `"rest_unreachable"` on network error, `"rest_protocol"` on a
+     *   non-string body.
+     */
+    getState(): Promise<string>;
+    /**
+     * Fetch the Thread network name from `/node/network-name`.
+     */
+    getNetworkName(): Promise<string>;
+    /**
+     * Fetch the node's Routing Locator (RLOC) IPv6 address from `/node/rloc`.
+     */
+    getRloc(): Promise<string>;
+    /**
+     * Fetch the 16-bit RLOC from `/node/rloc16`.
+     */
+    getRloc16(): Promise<number>;
+    /**
+     * Fetch the number of routers in the Thread network from `/node/num-of-router`.
+     */
+    getNumOfRouter(): Promise<number>;
+    /**
+     * Fetch the 8-byte IEEE EUI-64 extended address from `/node/ext-address`.
+     */
+    getExtAddress(): Promise<Uint8Array>;
+    /**
+     * Fetch the 8-byte Extended PAN ID from `/node/ext-panid`.
+     */
+    getExtPanId(): Promise<Uint8Array>;
+    /**
+     * Fetch the 16-byte Border Agent ID from `/node/ba-id`.
+     *
+     * @throws {@link OtbrRestError} `"rest_unsupported"` on older firmware that lacks this endpoint (404).
+     */
+    getBorderAgentId(): Promise<Uint8Array>;
+    /**
+     * Fetch the leader data record from `/node/leader-data`.
+     */
+    getLeaderData(): Promise<OtbrLeaderData>;
+    /**
+     * Fetch and decode the active Operational Dataset from `/node/dataset/active`.
+     *
+     * @returns The decoded dataset, or `undefined` when the BR has no active dataset (204).
+     */
+    getActiveDataset(): Promise<OperationalDataset | undefined>;
+    /**
+     * Fetch and decode the pending Operational Dataset from `/node/dataset/pending`.
+     *
+     * @returns The decoded dataset, or `undefined` when the BR has no pending dataset (204).
+     */
+    getPendingDataset(): Promise<OperationalDataset | undefined>;
+    /**
+     * Fetch the RCP/co-processor version string from `/node/coprocessor/version`.
+     *
+     * @throws {@link OtbrRestError} `"rest_unsupported"` on older firmware that lacks this endpoint (404).
+     */
+    getCoprocessorVersion(): Promise<string>;
+    /**
+     * Fetch the on-BR commissioner state from `/node/commissioner/state`.
+     *
+     * @throws {@link OtbrRestError} `"rest_unsupported"` on firmware without a built-in commissioner (404).
+     */
+    getCommissionerState(): Promise<string>;
+    /**
+     * Fetch the list of pending joiners from `/node/commissioner/joiner`.
+     *
+     * The entries are returned as-is (keys normalized to camelCase); callers
+     * interpret the per-joiner objects.
+     *
+     * @throws {@link OtbrRestError} `"rest_unsupported"` on firmware without a built-in commissioner (404).
+     */
+    getJoiners(): Promise<unknown[]>;
+    /**
+     * Enable or disable the Thread interface via `PUT /node/state`.
+     *
+     * @throws {@link OtbrRestError} `"rest_conflict"` when the BR rejects the transition (409).
+     */
+    setState(enable: boolean): Promise<void>;
+    /**
+     * Set the active Operational Dataset via `PUT /node/dataset/active`.
+     *
+     * @param dataset - An {@link OperationalDataset} (encoded to TLV hex) or a raw TLV hex string.
+     * @throws {@link OtbrRestError} `"rest_conflict"` when Thread is active and the active
+     *   dataset cannot be replaced in place (409) — use {@link setPendingDataset} instead.
+     */
+    setActiveDataset(dataset: OperationalDataset | string): Promise<void>;
+    /**
+     * Clear the active Operational Dataset via `DELETE /node/dataset/active`.
+     */
+    deleteActiveDataset(): Promise<void>;
+    /**
+     * Set the pending Operational Dataset via `PUT /node/dataset/pending`.
+     *
+     * @param dataset - An {@link OperationalDataset} (encoded to TLV hex) or a raw TLV hex string.
+     */
+    setPendingDataset(dataset: OperationalDataset | string): Promise<void>;
+    /**
+     * Clear the pending Operational Dataset via `DELETE /node/dataset/pending`.
+     */
+    deletePendingDataset(): Promise<void>;
+    /**
+     * Factory-reset the Thread node via `DELETE /node`.
+     *
+     * @throws {@link OtbrRestError} `"rest_not_allowed"` when the firmware disallows factory reset (405);
+     *   `"rest_conflict"` when the interface is in a state that forbids it (409).
+     */
+    factoryReset(): Promise<void>;
+    /**
+     * Enable or disable the on-BR commissioner via `PUT /node/commissioner/state`.
+     *
+     * @throws {@link OtbrRestError} `"rest_conflict"` when the BR is not active (409);
+     *   `"rest_unsupported"` on firmware without a built-in commissioner (404).
+     */
+    setCommissionerState(enable: boolean): Promise<void>;
+    /**
+     * Add a joiner to the on-BR commissioner via `POST /node/commissioner/joiner`.
+     *
+     * Provide at most one of `eui64` or `discerner`; omit both to match any device.
+     *
+     * @throws {@link ImplementationError} when both `eui64` and `discerner` are provided.
+     * @throws {@link OtbrRestError} `"rest_conflict"` when the commissioner is not active (409).
+     */
+    addJoiner(joiner: OtbrJoiner): Promise<void>;
+    /**
+     * Remove a joiner from the on-BR commissioner via `DELETE /node/commissioner/joiner`.
+     *
+     * @param joinerId - EUI-64 hex, a discerner (`"0x…/len"`), or `"*"` to remove all joiners.
+     * @throws {@link OtbrRestError} `"rest_conflict"` when the commissioner is not active (409).
+     */
+    removeJoiner(joinerId: string): Promise<void>;
+    /**
+     * POST an action body to the OTBR `/api/actions` endpoint.
+     *
+     * Only available on camelCase (post-2024) OTBR builds — callers must guard
+     * on `OtbrRestCapability.keyFormat === "camel"` before calling this method.
+     *
+     * @param body - The action payload (e.g. `{ action: "resetNetworkDiagCounterTask" }`).
+     * @throws {@link OtbrRestError} with code `"rest_unreachable"` on network error.
+     * @throws {@link OtbrRestError} with code `"rest_protocol"` on a non-2xx response.
+     */
+    resetDiagnosticCounters(body: Record<string, unknown>): Promise<void>;
+    /**
+     * POST a `getEnergyScanTask` action to the OTBR `/api/actions` endpoint.
+     *
+     * Only available on camelCase (post-2024) OTBR builds — callers must guard
+     * on `OtbrRestCapability.keyFormat === "camel"` before calling this method.
+     *
+     * @param body - The action payload (e.g. `{ action: "getEnergyScanTask" }`).
+     * @throws {@link OtbrRestError} with code `"rest_unreachable"` on network error.
+     * @throws {@link OtbrRestError} with code `"rest_protocol"` on a non-2xx response.
+     */
+    getEnergyScanTask(body: Record<string, unknown>): Promise<void>;
+}
+//# sourceMappingURL=OtbrRestClient.d.ts.map

package/dist/cjs/otbr-rest/OtbrRestClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OtbrRestClient.d.ts","sourceRoot":"","sources":["../../../src/otbr-rest/OtbrRestClient.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAItE,MAAM,WAAW,cAAc;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,cAAc,CAAC;IAC3B,QAAQ,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAoED;;;;;;;;;;;;;GAaG;AACH,qBAAa,cAAc;;IAIvB;;OAEG;IACH,YAAY,IAAI,EAAE,qBAAqB,EAKtC;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;;;;OAOG;IACG,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAyBrC;IAED;;;;;;;;;;OAUG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAMzC;IAED;;;;;;;;;;;OAWG;IACG,UAAU,IAAI,OAAO,CAAC,cAAc,CAAC,CAO1C;IAED;;;;;OAKG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAEhC;IAED;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAEtC;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAE/B;IAED;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAEjC;IAED;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAEtC;IAED;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC,CAEzC;IAED;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,UAAU,CAAC,CAEvC;IAED;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,UAAU,CAAC,CAE5C;IAED;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,cAAc,CAAC,CAa7C;IAED;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAEhE;IAED;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAEjE;IAED;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,MAAM,CAAC,CAE7C;IAED;;;;OAIG;IACG,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CAE5C;IAED;;;;;;;OAOG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAMrC;IAED;;;;OAIG;IACG,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAK7C;IAED;;;;;;OAMG;IACG,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;IAED;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAEzC;IAED;;;;OAIG;IACG,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE3E;IAED;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;IAED;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAElC;IAED;;;;;OAKG;IACG,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAKzD;IAED;;;;;;;OAOG;IACG,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAYjD;IAED;;;;;OAKG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlD;IAmCD;;;;;;;;;OASG;IACG,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;IAED;;;;;;;;;OASG;IACG,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpE;CAwHJ"}