@espressif/rainmaker-admin-sdk 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -3,6 +3,31 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and follows the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
 
+## [1.5.0] - 2026-10-08
+
+Minor release that lets callers fetch a single deployment capability by name,
+which the dashboards use to read the ESP Insights URL. Calling
+`getDeploymentCapabilities()` without arguments is unchanged; the two type
+corrections below are fixes, one of which changes `errorCode` at runtime.
+
+### Added
+
+- `ESPRMAdminDeploymentCapability.getDeploymentCapabilities({ name })` fetches
+  a single capability by name (`GET admin/deployment_capabilities?name=`).
+  The parameter is optional; calling it without arguments is unchanged. The
+  backend rejects an unknown name with error code `122005`.
+- Type `GetDeploymentCapabilitiesParams`.
+
+### Fixed
+
+- `GetDeploymentCapabilitiesResponse` is now `DeploymentCapabilityInfo[]`. The
+  backend has always returned a top-level array; the old
+  `{ capabilities: [...] }` shape never matched the response.
+- `ESPAPIError.errorCode` is now always a string, as its type declares. The
+  RainMaker backend sends `error_code` as a number, which the SDK passed
+  through unchanged, so `errorCode === "122005"` was false at runtime. Callers
+  that compared against a number must compare against the string instead.
+
 ## [1.4.0] - 2026-10-07
 
 Minor release that adds OAuth 2.0 authorization-code login, so dashboards can

package/dist/cjs/methods/ESPRMAdminDeploymentCapability/GetDeploymentCapabilities.cjs

@@ -10,10 +10,11 @@ var ESPRMAPIManager = require('../../services/ESPRMAPIManager.cjs');
 var constants = require('../../utils/constants.cjs');
 
 ESPRMAdminDeploymentCapability.ESPRMAdminDeploymentCapability.prototype.getDeploymentCapabilities =
-    async function () {
+    async function (params) {
         const requestConfig = {
             url: constants.APIEndpoints.ADMIN_DEPLOYMENT_CAPABILITIES,
             method: constants.HTTPMethods.GET,
+            ...(params && { params }),
         };
         const response = await ESPRMAPIManager.ESPRMAPIManager.authorizeRequest(requestConfig);
         return response;

package/dist/cjs/utils/error/parser.cjs

@@ -11,7 +11,7 @@ const parseAPIErrorResponse = (error, statusCode) => {
     let description = "An error has occurred";
     if (error) {
         status = error.status ?? "";
-        errorCode = error.error_code ?? error.error ?? "";
+        errorCode = String(error.error_code ?? error.error ?? "");
         description =
             error.description ?? error.error_description ?? "An error has occurred";
     }

package/dist/esm/methods/ESPRMAdminDeploymentCapability/GetDeploymentCapabilities.js

@@ -8,10 +8,11 @@ import { ESPRMAPIManager } from '../../services/ESPRMAPIManager.js';
 import { HTTPMethods, APIEndpoints } from '../../utils/constants.js';
 
 ESPRMAdminDeploymentCapability.prototype.getDeploymentCapabilities =
-    async function () {
+    async function (params) {
         const requestConfig = {
             url: APIEndpoints.ADMIN_DEPLOYMENT_CAPABILITIES,
             method: HTTPMethods.GET,
+            ...(params && { params }),
         };
         const response = await ESPRMAPIManager.authorizeRequest(requestConfig);
         return response;

package/dist/esm/utils/error/parser.js

@@ -9,7 +9,7 @@ const parseAPIErrorResponse = (error, statusCode) => {
     let description = "An error has occurred";
     if (error) {
         status = error.status ?? "";
-        errorCode = error.error_code ?? error.error ?? "";
+        errorCode = String(error.error_code ?? error.error ?? "");
         description =
             error.description ?? error.error_description ?? "An error has occurred";
     }

package/dist/types/methods/ESPRMAdminDeploymentCapability/GetDeploymentCapabilities.d.ts

@@ -3,14 +3,16 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { GetDeploymentCapabilitiesResponse } from "../../types/deployment_capability.js";
+import { GetDeploymentCapabilitiesParams, GetDeploymentCapabilitiesResponse } from "../../types/deployment_capability.js";
 declare module "../../ESPRMAdminDeploymentCapability.js" {
     interface ESPRMAdminDeploymentCapability {
         /**
-         * Retrieves the list of deployment capabilities available for the current deployment.
+         * Retrieves the deployment capabilities of the current deployment.
          *
-         * @returns The deployment capabilities response.
+         * @param params - Optional filter. Pass `name` to fetch a single capability.
+         * @returns The matching capabilities. The backend rejects an unknown `name`
+         * with error code 122005 instead of returning an empty list.
          */
-        getDeploymentCapabilities(): Promise<GetDeploymentCapabilitiesResponse>;
+        getDeploymentCapabilities(params?: GetDeploymentCapabilitiesParams): Promise<GetDeploymentCapabilitiesResponse>;
     }
 }

package/dist/types/types/deployment_capability.d.ts

@@ -17,9 +17,10 @@ export interface DeploymentCapabilityInfo {
     /** The capability value. */
     value?: string;
 }
-/** Response containing deployment capabilities. */
-export interface GetDeploymentCapabilitiesResponse {
-    /** List of deployment capabilities. */
-    capabilities?: DeploymentCapabilityInfo[];
-    [key: string]: unknown;
+/** Query parameters for fetching deployment capabilities. */
+export interface GetDeploymentCapabilitiesParams {
+    /** Fetch only the capability with this name. */
+    name?: string;
 }
+/** Deployment capabilities, returned by the backend as a top-level array. */
+export type GetDeploymentCapabilitiesResponse = DeploymentCapabilityInfo[];

package/dist/types/types/input.d.ts

@@ -49,7 +49,7 @@ export type { GetMailFailuresParams } from "./mail_failure.js";
 export type { UpdateTermsPolicyRequest, GetTermsPolicyParams, DeleteTermsPolicyParams, } from "./terms_policy.js";
 export type { AddCloudwatchLogUserRequest } from "./cloudwatch_log.js";
 export type { UpdateLogConfigRequest } from "./log_config.js";
-export type { UpdateDeploymentCapabilityRequest } from "./deployment_capability.js";
+export type { GetDeploymentCapabilitiesParams, UpdateDeploymentCapabilityRequest, } from "./deployment_capability.js";
 export type { GetAPIStatisticsParams } from "./api_statistics.js";
 export type { GetMQTTStatisticsParams } from "./mqtt_statistics.js";
 export type { CreateMatterAuthRequest, CreateMatterBatchRequest, UpdateMatterBatchRequest, GetMatterBatchParams, GetMatterBatchNodesParams, } from "./matter.js";

package/dist/types/utils/error/parser.d.ts

@@ -6,7 +6,8 @@
 import { ESPAPIError } from "../../types/api.js";
 interface RawAPIErrorBody {
     status?: string;
-    error_code?: string;
+    /** The RainMaker backend sends a number; some endpoints send a string. */
+    error_code?: string | number;
     description?: string;
     /** RFC 6749 error code, returned by the OAuth endpoints instead of `error_code`. */
     error?: string;

package/dist/types-cjs/methods/ESPRMAdminDeploymentCapability/GetDeploymentCapabilities.d.cts

@@ -3,14 +3,16 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { GetDeploymentCapabilitiesResponse } from "../../types/deployment_capability.cjs";
+import { GetDeploymentCapabilitiesParams, GetDeploymentCapabilitiesResponse } from "../../types/deployment_capability.cjs";
 declare module "../../ESPRMAdminDeploymentCapability.cjs" {
     interface ESPRMAdminDeploymentCapability {
         /**
-         * Retrieves the list of deployment capabilities available for the current deployment.
+         * Retrieves the deployment capabilities of the current deployment.
          *
-         * @returns The deployment capabilities response.
+         * @param params - Optional filter. Pass `name` to fetch a single capability.
+         * @returns The matching capabilities. The backend rejects an unknown `name`
+         * with error code 122005 instead of returning an empty list.
          */
-        getDeploymentCapabilities(): Promise<GetDeploymentCapabilitiesResponse>;
+        getDeploymentCapabilities(params?: GetDeploymentCapabilitiesParams): Promise<GetDeploymentCapabilitiesResponse>;
     }
 }

package/dist/types-cjs/types/deployment_capability.d.cts

@@ -17,9 +17,10 @@ export interface DeploymentCapabilityInfo {
     /** The capability value. */
     value?: string;
 }
-/** Response containing deployment capabilities. */
-export interface GetDeploymentCapabilitiesResponse {
-    /** List of deployment capabilities. */
-    capabilities?: DeploymentCapabilityInfo[];
-    [key: string]: unknown;
+/** Query parameters for fetching deployment capabilities. */
+export interface GetDeploymentCapabilitiesParams {
+    /** Fetch only the capability with this name. */
+    name?: string;
 }
+/** Deployment capabilities, returned by the backend as a top-level array. */
+export type GetDeploymentCapabilitiesResponse = DeploymentCapabilityInfo[];

package/dist/types-cjs/types/input.d.cts

@@ -49,7 +49,7 @@ export type { GetMailFailuresParams } from "./mail_failure.cjs";
 export type { UpdateTermsPolicyRequest, GetTermsPolicyParams, DeleteTermsPolicyParams, } from "./terms_policy.cjs";
 export type { AddCloudwatchLogUserRequest } from "./cloudwatch_log.cjs";
 export type { UpdateLogConfigRequest } from "./log_config.cjs";
-export type { UpdateDeploymentCapabilityRequest } from "./deployment_capability.cjs";
+export type { GetDeploymentCapabilitiesParams, UpdateDeploymentCapabilityRequest, } from "./deployment_capability.cjs";
 export type { GetAPIStatisticsParams } from "./api_statistics.cjs";
 export type { GetMQTTStatisticsParams } from "./mqtt_statistics.cjs";
 export type { CreateMatterAuthRequest, CreateMatterBatchRequest, UpdateMatterBatchRequest, GetMatterBatchParams, GetMatterBatchNodesParams, } from "./matter.cjs";

package/dist/types-cjs/utils/error/parser.d.cts

@@ -6,7 +6,8 @@
 import { ESPAPIError } from "../../types/api.cjs";
 interface RawAPIErrorBody {
     status?: string;
-    error_code?: string;
+    /** The RainMaker backend sends a number; some endpoints send a string. */
+    error_code?: string | number;
     description?: string;
     /** RFC 6749 error code, returned by the OAuth endpoints instead of `error_code`. */
     error?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@espressif/rainmaker-admin-sdk",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Espressif's Rainmaker Admin SDK enables seamless integration of admin applications with the ESP Rainmaker ecosystem.",
   "license": "Apache-2.0",
   "author": "Espressif Systems (Shanghai) CO LTD",