@espressif/rainmaker-admin-sdk 1.2.0 → 1.3.0

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

@@ -3,6 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+import type { ESPAPISuccessResponse } from "./api.cjs";
 /** Parameters for listing admin nodes. */
 export interface GetAdminNodesParams {
     /** Maximum number of records to return. */
@@ -34,11 +35,40 @@ export interface GetAdminNodesParams {
 }
 /** Parameters for activating or deactivating nodes. */
 export interface ActivateDeactivateNodesParams {
-    /** ID of the node to activate or deactivate. */
-    node_id: string;
-    /** Whether to activate (true) or deactivate (false) the node. */
+    /**
+     * IDs of the nodes to activate or deactivate. At most
+     * `MAX_NODE_ACTIVATION_BATCH_SIZE` (25) per request.
+     */
+    node_ids: string[];
+    /** Whether to activate (true) or deactivate (false) the nodes. */
     activate: boolean;
 }
+/** Per-node success entry in a 207 activation response. */
+export interface NodeActivationSuccessResult {
+    node_id: string;
+    status: "success";
+    description: string;
+}
+/** Per-node failure entry in a 207 activation response. */
+export interface NodeActivationFailureResult {
+    node_id: string;
+    status: "failure";
+    error_code: number;
+    description: string;
+}
+/**
+ * 207 Multi-Status response from `PUT admin/nodes`, returned when the
+ * per-node outcomes differ.
+ */
+export interface NodeActivationMultiStatusResponse {
+    responses: Array<NodeActivationSuccessResult | NodeActivationFailureResult>;
+}
+/**
+ * Response from `activateDeactivateNodes`. When every node has the same
+ * outcome the backend returns a single 200 success; otherwise 207 with
+ * per-node results. A uniform failure rejects with `ESPAPIError`.
+ */
+export type ActivateDeactivateNodesResponse = ESPAPISuccessResponse | NodeActivationMultiStatusResponse;
 /** Parameters for listing node tags or tag values. */
 export interface GetNodeTagsParams {
     /** Filter by tag name to retrieve its associated tag values. */

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

@@ -29,7 +29,7 @@ export type { GetDashboardUpdateStatusResponse, GetDashboardVersionMappingRespon
 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";
-export type { GetCommonCustomDataResponse } from "./common_custom_data.cjs";
+export type { CommonCustomDataItem, GetCommonCustomDataResponse, } from "./common_custom_data.cjs";
 export type { GetDeploymentSettingsResponse, GetRbacDeploymentSettingResponse, RbacConfigurationValue, } from "./deployment_setting.cjs";
 export type { GetNotificationsResponse } from "./configuration.cjs";
 export type { GetIoTDeviceRateRuleResponse } from "./iot_device_rate_limit.cjs";
@@ -38,6 +38,7 @@ export type { CustomMessageTemplateInfo, GetCustomMessageTemplatesResponse, } fr
 export type { MobilePlatformInfo, CreateMobilePlatformResponse, GetMobilePlatformsResponse, } from "./mobile_platform.cjs";
 export type { PassthroughConfigInfo, CreatePassthroughConfigResponse, GetPassthroughConfigResponse, } from "./passthrough.cjs";
 export type { GetNodeCACertificateResponse } from "./node_certificate_ca.cjs";
+export type { InitiateClaimResponse, VerifyClaimResponse } from "./claim.cjs";
 export type { WebhookIntegrationInfo, GetWebhookIntegrationsResponse, WebhookEventMappingInfo, GetWebhookEventMappingResponse, } from "./webhook.cjs";
 export type { StatsCount, StatsObject, GetStatsInfoResponse, } from "./statistical_service.cjs";
 export type { MailFailureInfo, GetMailFailuresResponse } from "./mail_failure.cjs";

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

@@ -63,8 +63,11 @@ export interface WebhookIntegrationInfo {
 }
 /** Response containing a list of webhook integrations. */
 export interface GetWebhookIntegrationsResponse {
-    /** Array of webhook integration details. */
-    webhooks_endpoints?: WebhookIntegrationInfo[];
+    /**
+     * Array of webhook integration details.
+     * The backend returns `null` when no integrations are configured.
+     */
+    integration_info_list?: WebhookIntegrationInfo[] | null;
 }
 /** Details of a webhook event mapping. */
 export interface WebhookEventMappingInfo {

package/dist/types-cjs/utils/constants.d.cts

@@ -94,6 +94,8 @@ declare const APIEndpoints: {
     readonly ADMIN_MATTER_BATCH: "admin/matter/batch";
     readonly ADMIN_MATTER_BATCH_NODES: "admin/matter/batch/nodes";
     readonly ADMIN_MAIL_FAILURES: "admin/mail_failures";
+    readonly CLAIM_INITIATE: "claim/initiate";
+    readonly CLAIM_VERIFY: "claim/verify";
 };
 declare const StorageKeys: {
     readonly ACCESSTOKEN: "com.esprmbase.accessToken";
@@ -104,6 +106,8 @@ declare const ConfigErrorCodes: {
     readonly SDK_NOT_CONFIGURED: "SDK_NOT_CONFIGURED";
     readonly INVALID_CONFIG_OBJECT: "INVALID_CONFIG_OBJECT";
     readonly INVALID_BASE_URL: "INVALID_BASE_URL";
+    readonly INVALID_CLAIMING_BASE_URL: "INVALID_CLAIMING_BASE_URL";
+    readonly CLAIMING_NOT_CONFIGURED: "CLAIMING_NOT_CONFIGURED";
 };
 declare const ValidationErrorCodes: {
     readonly MISSING_LOGIN_PASSWORD: "MISSING_LOGIN_PASSWORD";
@@ -151,6 +155,13 @@ declare const APICallValidationErrorCodes: {
     readonly MISSING_BATCH_ID: "MISSING_BATCH_ID";
     readonly MISSING_CANCEL_COMMAND_SCOPE: "MISSING_CANCEL_COMMAND_SCOPE";
     readonly CMD_ID_REQUIRES_NODE_ID: "CMD_ID_REQUIRES_NODE_ID";
+    readonly MISSING_COMMON_CUSTOM_DATA_NAME: "MISSING_COMMON_CUSTOM_DATA_NAME";
+    readonly MISSING_COMMON_CUSTOM_DATA_VALUE: "MISSING_COMMON_CUSTOM_DATA_VALUE";
+    readonly MISSING_MAC_ADDRESS: "MISSING_MAC_ADDRESS";
+    readonly MISSING_CLAIM_PLATFORM: "MISSING_CLAIM_PLATFORM";
+    readonly MISSING_CSR: "MISSING_CSR";
+    readonly MISSING_NODE_IDS: "MISSING_NODE_IDS";
+    readonly TOO_MANY_NODE_IDS: "TOO_MANY_NODE_IDS";
 };
 declare const TokenErrorCodes: {
     readonly MISSING_ACCESS_TOKEN: "MISSING_ACCESS_TOKEN";
@@ -176,9 +187,11 @@ declare const DEFAULT_REST_API_VERSION = "v1";
 declare const DEFAULT_REQUEST_TIMEOUT_MS = 30000;
 /** Tokens expiring within this many seconds are refreshed proactively. */
 declare const TOKEN_EXPIRY_MARGIN_SECONDS = 30;
+/** Backend limit on node IDs per `PUT admin/nodes` activation request. */
+declare const MAX_NODE_ACTIVATION_BATCH_SIZE = 25;
 /** errorCode values the SDK itself sets on ESPAPIError for non-HTTP failures. */
 declare const APIErrorCodes: {
     readonly REQUEST_TIMEOUT: "REQUEST_TIMEOUT";
     readonly NETWORK_ERROR: "NETWORK_ERROR";
 };
-export { HTTPMethods, APIEndpoints, StorageKeys, ConfigErrorCodes, ValidationErrorCodes, StorageAdapterErrorCodes, APICallValidationErrorCodes, TokenErrorCodes, ErrorLabels, HTTPStatusCodes, AdditionalInfo, DEFAULT_REST_API_VERSION, DEFAULT_REQUEST_TIMEOUT_MS, TOKEN_EXPIRY_MARGIN_SECONDS, APIErrorCodes, };
+export { HTTPMethods, APIEndpoints, StorageKeys, ConfigErrorCodes, ValidationErrorCodes, StorageAdapterErrorCodes, APICallValidationErrorCodes, TokenErrorCodes, ErrorLabels, HTTPStatusCodes, AdditionalInfo, DEFAULT_REST_API_VERSION, DEFAULT_REQUEST_TIMEOUT_MS, TOKEN_EXPIRY_MARGIN_SECONDS, APIErrorCodes, MAX_NODE_ACTIVATION_BATCH_SIZE, };

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

@@ -7,6 +7,8 @@ declare const configErrorMessages: {
     SDK_NOT_CONFIGURED: string;
     INVALID_CONFIG_OBJECT: string;
     INVALID_BASE_URL: string;
+    INVALID_CLAIMING_BASE_URL: string;
+    CLAIMING_NOT_CONFIGURED: string;
 };
 declare const validationErrorMessages: {
     MISSING_LOGIN_PASSWORD: string;
@@ -18,6 +20,8 @@ declare const storageAdapterErrorMessages: {
 };
 declare const apiCallValidationErrorMessages: {
     MISSING_NODE_ID: string;
+    MISSING_NODE_IDS: string;
+    TOO_MANY_NODE_IDS: string;
     MISSING_OTA_IMAGE_ID: string;
     MISSING_ARCHIVE_FLAG: string;
     MISSING_OTA_JOB_ID: string;
@@ -54,6 +58,11 @@ declare const apiCallValidationErrorMessages: {
     MISSING_BATCH_ID: string;
     MISSING_CANCEL_COMMAND_SCOPE: string;
     CMD_ID_REQUIRES_NODE_ID: string;
+    MISSING_COMMON_CUSTOM_DATA_NAME: string;
+    MISSING_COMMON_CUSTOM_DATA_VALUE: string;
+    MISSING_MAC_ADDRESS: string;
+    MISSING_CLAIM_PLATFORM: string;
+    MISSING_CSR: string;
 };
 declare const tokenErrorMessages: {
     MISSING_ACCESS_TOKEN: string;

package/dist/types-cjs/utils/validator/ConfigValidator.d.cts

@@ -7,5 +7,6 @@ import { ESPRMBaseConfig } from "../../types/config.cjs";
 export declare class ConfigValidator {
     static validateConfig(config: ESPRMBaseConfig): void;
     private static validateConfigObject;
+    private static validateClaimingBaseUrl;
     private static validateBaseUrl;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@espressif/rainmaker-admin-sdk",
-  "version": "1.2.0",
+  "version": "1.3.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",
@@ -527,6 +527,16 @@
         "default": "./dist/cjs/entries/ESPRMBase.cjs"
       }
     },
+    "./ESPRMClaim": {
+      "import": {
+        "types": "./dist/types/entries/ESPRMClaim.d.ts",
+        "default": "./dist/esm/entries/ESPRMClaim.js"
+      },
+      "require": {
+        "types": "./dist/types-cjs/entries/ESPRMClaim.d.cts",
+        "default": "./dist/cjs/entries/ESPRMClaim.cjs"
+      }
+    },
     "./ESPRMUser": {
       "import": {
         "types": "./dist/types/entries/ESPRMUser.d.ts",