@espressif/rainmaker-admin-sdk 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -3,6 +3,32 @@
 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.6.0] - 2026-10-08
+
+Minor release that makes the dashboard update endpoints usable from the
+dashboards: the update check now sends the `current_version` the backend
+requires, and the version mapping accepts its filters. Existing calls are
+unchanged; `getDashboardUpdateStatus()` is deprecated because it could never
+succeed.
+
+### Added
+
+- `ESPRMAdminDashboard.checkDashboardUpdate({ current_version })` checks for a
+  newer dashboard (`GET admin/dashboard/update?current_version=`). Returns
+  `{ version, backend_updated }` when one exists, otherwise a plain success
+  response.
+- `ESPRMAdminDashboard.getDashboardVersionMapping({ type, version })` accepts
+  optional filters. Calling it without arguments is unchanged.
+- Types `CheckDashboardUpdateParams`, `CheckDashboardUpdateResponse`,
+  `DashboardUpdateAvailable`, `GetDashboardVersionMappingParams` and
+  `DashboardVersionMappingType`.
+
+### Deprecated
+
+- `ESPRMAdminDashboard.getDashboardUpdateStatus()` sends no `current_version`,
+  which the backend requires, so it always fails with error code `110001`. Use
+  `checkDashboardUpdate` instead.
+
 ## [1.5.0] - 2026-10-08
 
 Minor release that lets callers fetch a single deployment capability by name,

package/dist/cjs/entries/ESPRMAdminDashboard.cjs

@@ -7,6 +7,7 @@
 
 require('../methods/ESPRMAdminDashboard/UpdateDashboard.cjs');
 require('../methods/ESPRMAdminDashboard/GetDashboardUpdateStatus.cjs');
+require('../methods/ESPRMAdminDashboard/CheckDashboardUpdate.cjs');
 require('../methods/ESPRMAdminDashboard/GetDashboardVersionMapping.cjs');
 var ESPRMAdminDashboard = require('../ESPRMAdminDashboard.cjs');
 

package/dist/cjs/index.cjs

@@ -155,6 +155,7 @@ require('./methods/ESPRMAdminMessageTemplate/DeleteMessageTemplate.cjs');
 require('./methods/ESPRMAdminMessageTemplate/GetVerifiedEmails.cjs');
 require('./methods/ESPRMAdminDashboard/UpdateDashboard.cjs');
 require('./methods/ESPRMAdminDashboard/GetDashboardUpdateStatus.cjs');
+require('./methods/ESPRMAdminDashboard/CheckDashboardUpdate.cjs');
 require('./methods/ESPRMAdminDashboard/GetDashboardVersionMapping.cjs');
 require('./methods/ESPRMAdminLicense/UploadLicenseFile.cjs');
 require('./methods/ESPRMAdminLicense/GetLicenseFile.cjs');

package/dist/cjs/methods/ESPRMAdminDashboard/CheckDashboardUpdate.cjs

@@ -0,0 +1,20 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+'use strict';
+
+var ESPRMAdminDashboard = require('../../ESPRMAdminDashboard.cjs');
+var ESPRMAPIManager = require('../../services/ESPRMAPIManager.cjs');
+var constants = require('../../utils/constants.cjs');
+
+ESPRMAdminDashboard.ESPRMAdminDashboard.prototype.checkDashboardUpdate = async function (params) {
+    const requestConfig = {
+        url: constants.APIEndpoints.ADMIN_DASHBOARD_UPDATE,
+        method: constants.HTTPMethods.GET,
+        params,
+    };
+    const response = await ESPRMAPIManager.ESPRMAPIManager.authorizeRequest(requestConfig);
+    return response;
+};

package/dist/cjs/methods/ESPRMAdminDashboard/GetDashboardVersionMapping.cjs

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

package/dist/esm/entries/ESPRMAdminDashboard.js

@@ -5,5 +5,6 @@
  */
 import '../methods/ESPRMAdminDashboard/UpdateDashboard.js';
 import '../methods/ESPRMAdminDashboard/GetDashboardUpdateStatus.js';
+import '../methods/ESPRMAdminDashboard/CheckDashboardUpdate.js';
 import '../methods/ESPRMAdminDashboard/GetDashboardVersionMapping.js';
 export { ESPRMAdminDashboard } from '../ESPRMAdminDashboard.js';

package/dist/esm/index.js

@@ -153,6 +153,7 @@ import './methods/ESPRMAdminMessageTemplate/DeleteMessageTemplate.js';
 import './methods/ESPRMAdminMessageTemplate/GetVerifiedEmails.js';
 import './methods/ESPRMAdminDashboard/UpdateDashboard.js';
 import './methods/ESPRMAdminDashboard/GetDashboardUpdateStatus.js';
+import './methods/ESPRMAdminDashboard/CheckDashboardUpdate.js';
 import './methods/ESPRMAdminDashboard/GetDashboardVersionMapping.js';
 import './methods/ESPRMAdminLicense/UploadLicenseFile.js';
 import './methods/ESPRMAdminLicense/GetLicenseFile.js';

package/dist/esm/methods/ESPRMAdminDashboard/CheckDashboardUpdate.js

@@ -0,0 +1,18 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPRMAdminDashboard } from '../../ESPRMAdminDashboard.js';
+import { ESPRMAPIManager } from '../../services/ESPRMAPIManager.js';
+import { HTTPMethods, APIEndpoints } from '../../utils/constants.js';
+
+ESPRMAdminDashboard.prototype.checkDashboardUpdate = async function (params) {
+    const requestConfig = {
+        url: APIEndpoints.ADMIN_DASHBOARD_UPDATE,
+        method: HTTPMethods.GET,
+        params,
+    };
+    const response = await ESPRMAPIManager.authorizeRequest(requestConfig);
+    return response;
+};

package/dist/esm/methods/ESPRMAdminDashboard/GetDashboardVersionMapping.js

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

package/dist/types/methods/ESPRMAdminDashboard/CheckDashboardUpdate.d.ts

@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { CheckDashboardUpdateParams, CheckDashboardUpdateResponse } from "../../types/dashboard.js";
+declare module "../../ESPRMAdminDashboard.js" {
+    interface ESPRMAdminDashboard {
+        /**
+         * Checks whether a newer dashboard version is published for this deployment.
+         *
+         * @param params - The dashboard version currently deployed.
+         * @returns `DashboardUpdateAvailable` when an update exists, otherwise a
+         * plain success response. The backend rejects a missing or malformed
+         * `current_version` with error code 110001.
+         */
+        checkDashboardUpdate(params: CheckDashboardUpdateParams): Promise<CheckDashboardUpdateResponse>;
+    }
+}

package/dist/types/methods/ESPRMAdminDashboard/GetDashboardUpdateStatus.d.ts

@@ -9,6 +9,8 @@ declare module "../../ESPRMAdminDashboard.js" {
         /**
          * Retrieves the current status of a dashboard update operation.
          *
+         * @deprecated Sends no `current_version`, which the backend requires, so
+         * it always fails with error code 110001. Use `checkDashboardUpdate`.
          * @returns The dashboard update status response.
          */
         getDashboardUpdateStatus(): Promise<GetDashboardUpdateStatusResponse>;

package/dist/types/methods/ESPRMAdminDashboard/GetDashboardVersionMapping.d.ts

@@ -3,14 +3,16 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { GetDashboardVersionMappingResponse } from "../../types/dashboard.js";
+import { GetDashboardVersionMappingParams, GetDashboardVersionMappingResponse } from "../../types/dashboard.js";
 declare module "../../ESPRMAdminDashboard.js" {
     interface ESPRMAdminDashboard {
         /**
          * Retrieves the version mapping for the dashboard, showing available versions and their associations.
          *
+         * @param params - Optional filter. `version` is only honoured together with
+         * `type`. Supported only on SAM deployments; others get error code 110010.
          * @returns The dashboard version mapping response.
          */
-        getDashboardVersionMapping(): Promise<GetDashboardVersionMappingResponse>;
+        getDashboardVersionMapping(params?: GetDashboardVersionMappingParams): Promise<GetDashboardVersionMappingResponse>;
     }
 }

package/dist/types/methods/ESPRMAdminDashboard/index.d.ts

@@ -5,4 +5,5 @@
  */
 import "./UpdateDashboard.js";
 import "./GetDashboardUpdateStatus.js";
+import "./CheckDashboardUpdate.js";
 import "./GetDashboardVersionMapping.js";

package/dist/types/types/dashboard.d.ts

@@ -3,6 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+import { ESPAPISuccessResponse } from "./api.js";
 /** Request body for updating the dashboard version. */
 export interface UpdateDashboardRequest {
     /** The target dashboard version. */
@@ -14,10 +15,36 @@ export interface GetDashboardUpdateStatusResponse {
     version?: string;
     [key: string]: unknown;
 }
+/** Query parameters for checking dashboard updates. */
+export interface CheckDashboardUpdateParams {
+    /** The dashboard version currently deployed, e.g. `"2.6.0"`. */
+    current_version: string;
+}
+/** Returned when a newer dashboard version is published. */
+export interface DashboardUpdateAvailable {
+    /** The latest published dashboard version. */
+    version: string;
+    /** Whether the backend is already on a version that supports `version`. */
+    backend_updated: boolean;
+}
+/**
+ * Response of the dashboard update check. When no newer version exists the
+ * backend returns a plain success response instead of `DashboardUpdateAvailable`.
+ */
+export type CheckDashboardUpdateResponse = DashboardUpdateAvailable | ESPAPISuccessResponse;
+/** Which side of the version mapping to filter on. */
+export type DashboardVersionMappingType = "backend" | "frontend";
+/** Query parameters for the dashboard version mapping. */
+export interface GetDashboardVersionMappingParams {
+    /** Return only this side of the mapping. */
+    type?: DashboardVersionMappingType;
+    /** Return only the entry for this version. Requires `type`. */
+    version?: string;
+}
 /** Response containing dashboard version compatibility mappings. */
 export interface GetDashboardVersionMappingResponse {
-    /** Backend version compatibility mapping. */
+    /** Backend version to compatible dashboard versions. */
     backend?: Record<string, string[]>;
-    /** Frontend version compatibility mapping. */
+    /** Dashboard version to compatible backend versions. */
     frontend?: Record<string, string[]>;
 }

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

@@ -26,7 +26,7 @@ export type { CreateCognitoAppClientRequest, UpdateCognitoAppClientRequest, GetC
 export type { CreateCognitoDomainRequest, GetCognitoDomainParams, DeleteCognitoDomainParams, } from "./cognito_domain.js";
 export type { CreateIdentityProviderRequest, UpdateIdentityProviderRequest, GetIdentityProvidersParams, DeleteIdentityProviderParams, } from "./identity_provider.js";
 export type { CreateMessageTemplateRequest, UpdateMessageTemplateRequest, GetMessageTemplatesParams, DeleteMessageTemplateParams, } from "./message_template.js";
-export type { UpdateDashboardRequest } from "./dashboard.js";
+export type { UpdateDashboardRequest, CheckDashboardUpdateParams, DashboardVersionMappingType, GetDashboardVersionMappingParams, } from "./dashboard.js";
 export type { UploadLicenseFileRequest, GetLicenseFileParams } from "./license.js";
 export type { GenerateNodeIdsRequest, GetNodeIdsParams, GetNodeCertificatesParams, RegisterNodeCertificatesRequest, GetNodeCertificateRegistrationParams, } from "./node_registration.js";
 export type { ChangeSuperAdminRequest } from "./super_admin.js";

package/dist/types/types/output.d.ts

@@ -25,7 +25,7 @@ export type { CognitoAppClientInfo, GetCognitoAppClientsResponse, } from "./cogn
 export type { GetCognitoDomainResponse } from "./cognito_domain.js";
 export type { GetIdentityProvidersResponse } from "./identity_provider.js";
 export type { MessageTemplateInfo, GetMessageTemplatesResponse, GetVerifiedEmailsResponse, } from "./message_template.js";
-export type { GetDashboardUpdateStatusResponse, GetDashboardVersionMappingResponse, } from "./dashboard.js";
+export type { GetDashboardUpdateStatusResponse, GetDashboardVersionMappingResponse, CheckDashboardUpdateResponse, DashboardUpdateAvailable, } from "./dashboard.js";
 export type { LicenseFileInfo, GetLicenseFileResponse, GetLicenseQuotaResponse, } from "./license.js";
 export type { GenerateNodeIdsResponse, GetNodeIdsResponse, NodeCertificateInfo, GetNodeCertificatesResponse, NodeCertificateRegistrationStatusResponse, GetMQTTHostResponse, } from "./node_registration.js";
 export type { GetDeploymentDetailsResponse } from "./deployment_details.js";

package/dist/types-cjs/methods/ESPRMAdminDashboard/CheckDashboardUpdate.d.cts

@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { CheckDashboardUpdateParams, CheckDashboardUpdateResponse } from "../../types/dashboard.cjs";
+declare module "../../ESPRMAdminDashboard.cjs" {
+    interface ESPRMAdminDashboard {
+        /**
+         * Checks whether a newer dashboard version is published for this deployment.
+         *
+         * @param params - The dashboard version currently deployed.
+         * @returns `DashboardUpdateAvailable` when an update exists, otherwise a
+         * plain success response. The backend rejects a missing or malformed
+         * `current_version` with error code 110001.
+         */
+        checkDashboardUpdate(params: CheckDashboardUpdateParams): Promise<CheckDashboardUpdateResponse>;
+    }
+}

package/dist/types-cjs/methods/ESPRMAdminDashboard/GetDashboardUpdateStatus.d.cts

@@ -9,6 +9,8 @@ declare module "../../ESPRMAdminDashboard.cjs" {
         /**
          * Retrieves the current status of a dashboard update operation.
          *
+         * @deprecated Sends no `current_version`, which the backend requires, so
+         * it always fails with error code 110001. Use `checkDashboardUpdate`.
          * @returns The dashboard update status response.
          */
         getDashboardUpdateStatus(): Promise<GetDashboardUpdateStatusResponse>;

package/dist/types-cjs/methods/ESPRMAdminDashboard/GetDashboardVersionMapping.d.cts

@@ -3,14 +3,16 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { GetDashboardVersionMappingResponse } from "../../types/dashboard.cjs";
+import { GetDashboardVersionMappingParams, GetDashboardVersionMappingResponse } from "../../types/dashboard.cjs";
 declare module "../../ESPRMAdminDashboard.cjs" {
     interface ESPRMAdminDashboard {
         /**
          * Retrieves the version mapping for the dashboard, showing available versions and their associations.
          *
+         * @param params - Optional filter. `version` is only honoured together with
+         * `type`. Supported only on SAM deployments; others get error code 110010.
          * @returns The dashboard version mapping response.
          */
-        getDashboardVersionMapping(): Promise<GetDashboardVersionMappingResponse>;
+        getDashboardVersionMapping(params?: GetDashboardVersionMappingParams): Promise<GetDashboardVersionMappingResponse>;
     }
 }

package/dist/types-cjs/methods/ESPRMAdminDashboard/index.d.cts

@@ -5,4 +5,5 @@
  */
 import "./UpdateDashboard.cjs";
 import "./GetDashboardUpdateStatus.cjs";
+import "./CheckDashboardUpdate.cjs";
 import "./GetDashboardVersionMapping.cjs";

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

@@ -3,6 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+import { ESPAPISuccessResponse } from "./api.cjs";
 /** Request body for updating the dashboard version. */
 export interface UpdateDashboardRequest {
     /** The target dashboard version. */
@@ -14,10 +15,36 @@ export interface GetDashboardUpdateStatusResponse {
     version?: string;
     [key: string]: unknown;
 }
+/** Query parameters for checking dashboard updates. */
+export interface CheckDashboardUpdateParams {
+    /** The dashboard version currently deployed, e.g. `"2.6.0"`. */
+    current_version: string;
+}
+/** Returned when a newer dashboard version is published. */
+export interface DashboardUpdateAvailable {
+    /** The latest published dashboard version. */
+    version: string;
+    /** Whether the backend is already on a version that supports `version`. */
+    backend_updated: boolean;
+}
+/**
+ * Response of the dashboard update check. When no newer version exists the
+ * backend returns a plain success response instead of `DashboardUpdateAvailable`.
+ */
+export type CheckDashboardUpdateResponse = DashboardUpdateAvailable | ESPAPISuccessResponse;
+/** Which side of the version mapping to filter on. */
+export type DashboardVersionMappingType = "backend" | "frontend";
+/** Query parameters for the dashboard version mapping. */
+export interface GetDashboardVersionMappingParams {
+    /** Return only this side of the mapping. */
+    type?: DashboardVersionMappingType;
+    /** Return only the entry for this version. Requires `type`. */
+    version?: string;
+}
 /** Response containing dashboard version compatibility mappings. */
 export interface GetDashboardVersionMappingResponse {
-    /** Backend version compatibility mapping. */
+    /** Backend version to compatible dashboard versions. */
     backend?: Record<string, string[]>;
-    /** Frontend version compatibility mapping. */
+    /** Dashboard version to compatible backend versions. */
     frontend?: Record<string, string[]>;
 }

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

@@ -26,7 +26,7 @@ export type { CreateCognitoAppClientRequest, UpdateCognitoAppClientRequest, GetC
 export type { CreateCognitoDomainRequest, GetCognitoDomainParams, DeleteCognitoDomainParams, } from "./cognito_domain.cjs";
 export type { CreateIdentityProviderRequest, UpdateIdentityProviderRequest, GetIdentityProvidersParams, DeleteIdentityProviderParams, } from "./identity_provider.cjs";
 export type { CreateMessageTemplateRequest, UpdateMessageTemplateRequest, GetMessageTemplatesParams, DeleteMessageTemplateParams, } from "./message_template.cjs";
-export type { UpdateDashboardRequest } from "./dashboard.cjs";
+export type { UpdateDashboardRequest, CheckDashboardUpdateParams, DashboardVersionMappingType, GetDashboardVersionMappingParams, } from "./dashboard.cjs";
 export type { UploadLicenseFileRequest, GetLicenseFileParams } from "./license.cjs";
 export type { GenerateNodeIdsRequest, GetNodeIdsParams, GetNodeCertificatesParams, RegisterNodeCertificatesRequest, GetNodeCertificateRegistrationParams, } from "./node_registration.cjs";
 export type { ChangeSuperAdminRequest } from "./super_admin.cjs";

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

@@ -25,7 +25,7 @@ export type { CognitoAppClientInfo, GetCognitoAppClientsResponse, } from "./cogn
 export type { GetCognitoDomainResponse } from "./cognito_domain.cjs";
 export type { GetIdentityProvidersResponse } from "./identity_provider.cjs";
 export type { MessageTemplateInfo, GetMessageTemplatesResponse, GetVerifiedEmailsResponse, } from "./message_template.cjs";
-export type { GetDashboardUpdateStatusResponse, GetDashboardVersionMappingResponse, } from "./dashboard.cjs";
+export type { GetDashboardUpdateStatusResponse, GetDashboardVersionMappingResponse, CheckDashboardUpdateResponse, DashboardUpdateAvailable, } from "./dashboard.cjs";
 export type { LicenseFileInfo, GetLicenseFileResponse, GetLicenseQuotaResponse, } from "./license.cjs";
 export type { GenerateNodeIdsResponse, GetNodeIdsResponse, NodeCertificateInfo, GetNodeCertificatesResponse, NodeCertificateRegistrationStatusResponse, GetMQTTHostResponse, } from "./node_registration.cjs";
 export type { GetDeploymentDetailsResponse } from "./deployment_details.cjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@espressif/rainmaker-admin-sdk",
-  "version": "1.5.0",
+  "version": "1.6.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",