@espressif/rainmaker-admin-sdk 1.1.1 → 1.3.0

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

@@ -34,13 +34,73 @@ export interface GetNodeCertificatesParams {
     /** The maximum number of records to return. */
     num_records?: number;
 }
-/** Request body for registering node certificates. */
+/** Parameters for fetching a pre-signed URL to upload a node certificates CSV. */
+export interface GetNodeCertificateUploadUrlParams {
+    /** Name of the CSV file to upload. */
+    file_name: string;
+}
+/** Response containing the pre-signed upload URL for a node certificates CSV. */
+export interface NodeCertificateUploadUrlResponse {
+    /** The API call status. */
+    status: string;
+    /** Pre-signed S3 PUT URL (valid for 1 hour). Upload without an `Authorization` header. */
+    url: string;
+    /** ID of the registration request; pass it to `registerNodeCertificates`. */
+    request_id: string;
+}
+/**
+ * Request body for registering node certificates from an uploaded CSV.
+ *
+ * Upload the CSV to the URL from `getNodeCertificateUploadUrl` first, then
+ * trigger the registration with the same `request_id`.
+ */
 export interface RegisterNodeCertificatesRequest {
-    /** List of node IDs to register certificates for. */
-    node_ids: string[];
-    /** List of certificates corresponding to the node IDs. */
-    certs: string[];
-    [key: string]: unknown;
+    /** Name of the uploaded CSV file. */
+    file_name: string;
+    /** Hex MD5 digest of the uploaded CSV file. */
+    file_md5: string;
+    /** Request ID returned by `getNodeCertificateUploadUrl`. */
+    request_id: string;
+    /**
+     * The caller's refresh token. The backend requires it and uses it to add
+     * the registered nodes to their group.
+     */
+    refresh_token: string;
+    /** The node type. */
+    type?: string;
+    /** The node model. */
+    model?: string;
+    /** The node subtype. */
+    subtype?: string;
+    /**
+     * Group to add the nodes to. When omitted, the backend creates a group named
+     * after the type/model and the current date.
+     */
+    group_name?: string;
+    /** ID of the parent group when `group_name` is a subgroup. Takes precedence over `parent_group_name`. */
+    parent_group_id?: string;
+    /** Name of the parent group when `group_name` is a subgroup. */
+    parent_group_name?: string;
+    /**
+     * Comma-separated tags. Static tags are `key:value`; CSV-column tags are
+     * `key:@column` and take each node's value from that CSV column.
+     */
+    tags?: string;
+    /** Ignore duplicate node registrations and update existing certificates. */
+    force?: boolean;
+    /** Only update type, model, subtype and tags of existing nodes. Cannot be combined with `node_policies`. */
+    update_nodes?: boolean;
+    /** Comma-separated IoT policies to attach: `mqtt`, `videostream`. */
+    node_policies?: string;
+    /** The tenant ID, required when multi-tenancy is enabled. */
+    tenant_id?: string;
+}
+/** Response returned after triggering a node certificate registration. */
+export interface RegisterNodeCertificatesResponse {
+    /** The API call status. */
+    status: string;
+    /** ID of the registration request. */
+    request_id: string;
 }
 /** Parameters for checking node certificate registration status. */
 export interface GetNodeCertificateRegistrationParams {
@@ -85,17 +145,109 @@ export interface GetNodeCertificatesResponse {
     /** The total number of certificates. */
     total?: number;
 }
-/** Response containing node certificate registration status. */
+/**
+ * Response containing node certificate registration status.
+ *
+ * Unlike `getNodeRegistrationRequest`, this call checks the batch job and
+ * reports `failure` when it has died while the request was still `requested`.
+ */
 export interface NodeCertificateRegistrationStatusResponse {
-    /** The registration request ID. */
-    request_id?: string;
     /** The registration status. */
-    status?: string;
-    [key: string]: unknown;
+    status: NodeRegistrationRequestStatus;
+    /** Number of nodes registered so far. */
+    completed_count?: number;
+    /** Total number of nodes in the request. */
+    total_count?: number;
+    /** Failure reason, when the request failed. */
+    description?: string;
+    /** Nodes that failed to register, as reported by the backend. */
+    failed_registration?: string;
+    /** Name of the group the nodes are added to. */
+    group_name?: string;
+    /** ID of the group the nodes are added to. */
+    group_id?: string;
 }
-/** Response containing the MQTT host endpoint. */
+/** Response containing the deployment's node endpoints. */
 export interface GetMQTTHostResponse {
     /** The MQTT broker host address. */
     mqtt_host?: string;
+    /** The AWS IoT credential provider endpoint (written to node NVS as `mqtt_cred_host`). */
+    mqtt_cred_host?: string;
+    /** The HTTPS node endpoint, when the deployment has one configured. */
+    https_host?: string;
     [key: string]: unknown;
 }
+/**
+ * Status of a node certificate registration request.
+ *
+ * `failed` and `failure` both mean the request failed: the backend writes
+ * `failed` when submitting the batch job fails and `failure` when the batch
+ * job itself fails.
+ */
+export type NodeRegistrationRequestStatus = "requested" | "in_progress" | "success" | "failed" | "failure";
+/** Parameters for listing node certificate registration requests. */
+export interface ListNodeRegistrationRequestsParams {
+    /** Filter results by request status. */
+    status?: NodeRegistrationRequestStatus;
+    /** The maximum number of records to return (the backend caps this at 25). */
+    num_records?: number;
+    /** The `next_id` from the previous response, to fetch the next page. */
+    start_id?: string;
+}
+/** A node certificate registration request, as returned in the list. */
+export interface NodeRegistrationRequest {
+    /** The registration request ID. */
+    request_id: string;
+    /** The request status. */
+    status: NodeRegistrationRequestStatus;
+    /** Name of the uploaded certificates CSV file. */
+    file_name?: string;
+    /** Time the request was created, in epoch seconds. */
+    request_timestamp?: number;
+    /** Number of nodes registered so far. */
+    completed_count?: number;
+    /** Total number of nodes in the request. */
+    total_count?: number;
+}
+/** Response containing a page of node certificate registration requests. */
+export interface ListNodeRegistrationRequestsResponse {
+    /** The API call status. */
+    status: string;
+    /** Registration requests, newest first. */
+    requests?: NodeRegistrationRequest[];
+    /** Pagination cursor for the next page; absent on the last page. */
+    next_id?: string;
+}
+/** Full detail of a single node certificate registration request. */
+export interface NodeRegistrationRequestDetail extends NodeRegistrationRequest {
+    /** Pre-signed download URL of the original CSV (valid for 1 hour). */
+    url?: string;
+    /** Additional context from the backend, e.g. a batch job failure reason. */
+    additional_comments?: string;
+    /** Number of nodes that failed to register (omitted when 0). */
+    failed_registration_count?: number;
+    /** Name of the group the nodes were added to. */
+    group_name?: string;
+    /** ID of the group the nodes were added to. */
+    group_id?: string;
+    /** The node type. */
+    type?: string;
+    /** The node model. */
+    model?: string;
+    /** The node subtype. */
+    subtype?: string;
+    /** ID of the parent group. */
+    parent_group_id?: string;
+    /** Name of the parent group. */
+    parent_group_name?: string;
+    /** Comma-separated `key:value` tags applied to the nodes. */
+    tags?: string;
+    /** Whether existing registrations were overwritten. */
+    force?: boolean;
+    /** Whether existing nodes were updated. */
+    update_nodes?: boolean;
+    /** The tenant ID. */
+    tenant_id?: string;
+    /** Policies attached to the nodes. */
+    node_policies?: string;
+}

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

@@ -10,7 +10,7 @@ export type { AdminNodeInfo, AdminNodeListResponse, GetNodeTagsResponse, NodeSta
 export type { OTAImageInfo, OTAImageRelatedFile, OTAImageCreateResponse, GetOTAImagesResponse, OTAImageUploadUrlResponse, ConfirmOTAImageUploadResponse, OTAPackageUploadUrlResponse, ConfirmOTAPackageUploadResponse, OTAJobInfo, OTAJobCreateResponse, OTAJobUpdateResponse, OTAJobRetriggerResponse, GetOTAJobsResponse, NodeOTAJobStatusEntry, OTAJobStatusResponse, OTAJobStatusSummaryResponse, } from "./ota.cjs";
 export type { AdminGroupInfo, CreateAdminGroupResponse, GetAdminGroupsResponse, } from "./group.cjs";
 export type { TagResourceInfo, GetAdminTagsResponse, GetTagNamesResponse, } from "./tag.cjs";
-export type { CommandRequestInfo, GetCommandRequestsResponse, AddCommandRequestResponse, } from "./command_response.cjs";
+export type { CommandRequestInfo, GetCommandRequestsResponse, AddCommandRequestResponse, CancelCommandRequestsResponse, CommandRequestDataError, } from "./command_response.cjs";
 export type { EventFilterInfo, GetEventFiltersResponse } from "./event_filter.cjs";
 export type { TimeSeriesParamData, TimeSeriesNodeData, GetTimeSeriesDataResponse, GetSimpleTimeSeriesDataResponse, } from "./time_series.cjs";
 export type { CustomDataResponse } from "./custom_data.cjs";
@@ -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

@@ -68,6 +68,7 @@ declare const APIEndpoints: {
     readonly ADMIN_NODE_IDS: "admin/node_ids";
     readonly ADMIN_NODE_CERTIFICATES: "admin/node_certificates";
     readonly ADMIN_NODE_CERTIFICATES_REGISTER: "admin/node_certificates/register";
+    readonly ADMIN_NODE_REGISTRATION_REQUESTS: "admin/node_registrations/requests";
     readonly ADMIN_API_STATS: "admin/api_stats";
     readonly ADMIN_MQTT_STATS: "admin/mqtt_stats";
     readonly ADMIN_CHANGE_SUPER_ADMIN: "admin/change_super_admin";
@@ -93,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";
@@ -103,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";
@@ -148,6 +153,15 @@ declare const APICallValidationErrorCodes: {
     readonly MISSING_PLATFORM_NAME: "MISSING_PLATFORM_NAME";
     readonly MISSING_PLATFORM_APPLICATION_ARN: "MISSING_PLATFORM_APPLICATION_ARN";
     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";
@@ -173,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;
@@ -52,6 +56,13 @@ declare const apiCallValidationErrorMessages: {
     MISSING_PLATFORM_NAME: string;
     MISSING_PLATFORM_APPLICATION_ARN: string;
     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.1.1",
+  "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",