@espressif/rainmaker-admin-sdk 1.0.0

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

@@ -0,0 +1,180 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+declare const HTTPMethods: {
+    readonly GET: "GET";
+    readonly PUT: "PUT";
+    readonly POST: "POST";
+    readonly DELETE: "DELETE";
+};
+declare const APIEndpoints: {
+    readonly USER: "user2";
+    readonly FORGOTPASSWORD: "forgotpassword2";
+    readonly LOGIN: "login2";
+    readonly PASSWORD: "password2";
+    readonly LOGOUT: "logout2";
+    readonly ADMIN_USER: "admin/user2";
+    readonly ADMIN_USER_SUMMARY: "admin/user2/summary";
+    readonly ADMIN_NODES: "admin/nodes";
+    readonly ADMIN_NODE_TAGS: "admin/nodes/tags";
+    readonly ADMIN_OTA_IMAGE: "admin/otaimage";
+    readonly ADMIN_OTA_IMAGE_UPLOAD_REQUEST: "admin/otaimage/upload_request";
+    readonly ADMIN_OTA_IMAGE_UPLOAD_CONFIRM: "admin/otaimage/upload_confirm";
+    readonly ADMIN_OTA_IMAGE_PACKAGE_UPLOAD: "admin/otaimage/package/upload";
+    readonly ADMIN_OTA_IMAGE_PACKAGE: "admin/otaimage/package";
+    readonly ADMIN_OTA_JOB: "admin/otajob";
+    readonly ADMIN_OTA_JOB_STATUS: "admin/otajob/status";
+    readonly ADMIN_OTA_JOB_STATUS_SUMMARY: "admin/otajob/status/summary";
+    readonly ADMIN_OTA_JOB_ACTION: "admin/otajob";
+    readonly ADMIN_NODE_GROUP: "admin/node_group";
+    readonly ADMIN_TAGS: "admin/tags";
+    readonly ADMIN_TAG_NAMES: "admin/tags/names";
+    readonly ADMIN_CMD: "admin/nodes/cmd";
+    readonly ADMIN_EVENT_FILTER: "admin/event_filter";
+    readonly ADMIN_TSDATA: "admin/nodes/tsdata";
+    readonly ADMIN_SIMPLE_TSDATA: "admin/nodes/simple_tsdata";
+    readonly ADMIN_CUSTOM_DATA: "admin/custom_data";
+    readonly ADMIN_ROLE: "admin/role";
+    readonly ADMIN_POLICY: "admin/policy";
+    readonly ADMIN_USER_ROLE: "admin/user_role";
+    readonly ADMIN_KEY: "admin/key";
+    readonly ADMIN_SECURE_SIGN: "admin/secure_sign";
+    readonly ADMIN_SECURE_SIGN_IMAGES: "admin/secure_sign/signed_images";
+    readonly ADMIN_SECURE_SIGN_KEYS: "admin/secure_sign/signing_keys";
+    readonly ADMIN_FILE: "admin/file";
+    readonly ADMIN_FILE_UPLOAD_REQUEST: "admin/file/upload_request";
+    readonly ADMIN_FILE_UPLOAD_CONFIRM: "admin/file/upload_confirm";
+    readonly ADMIN_USER_NODES: "admin/user/nodes";
+    readonly ADMIN_USER_NODES_HISTORY: "admin/user/nodes/history";
+    readonly ADMIN_API_PATHS: "admin/api_paths_methods";
+    readonly ADMIN_COGNITO_APPCLIENT: "admin/cognito_appclient";
+    readonly ADMIN_COGNITO_DOMAIN: "admin/cognito_domain";
+    readonly ADMIN_IDENTITY_PROVIDER: "admin/identity_provider";
+    readonly ADMIN_MESSAGE_TEMPLATE: "admin/message_template";
+    readonly ADMIN_SES_VERIFIED_EMAIL: "admin/ses_verified_email";
+    readonly ADMIN_DASHBOARD_UPDATE: "admin/dashboard/update";
+    readonly ADMIN_DASHBOARD_VERSION_MAPPING: "admin/dashboard/update/version_mapping";
+    readonly ADMIN_UPDATE_APIGATEWAY: "admin/update_apigateway";
+    readonly ADMIN_TERMS_POLICY: "admin/terms_policy";
+    readonly ADMIN_CLOUDWATCH_LOG: "admin/cloudwatchlog";
+    readonly ADMIN_LOGS: "admin/logs";
+    readonly ADMIN_DEPLOYMENT_CAPABILITIES: "admin/deployment_capabilities";
+    readonly ADMIN_LICENSE_FILE: "admin/license_file";
+    readonly ADMIN_LICENSE_QUOTA: "admin/license_quota";
+    readonly ADMIN_MQTT_HOST: "admin/mqtt_host";
+    readonly ADMIN_CUSTOM_MQTT_HOST: "admin/custom_mqtt_host";
+    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_API_STATS: "admin/api_stats";
+    readonly ADMIN_MQTT_STATS: "admin/mqtt_stats";
+    readonly ADMIN_CHANGE_SUPER_ADMIN: "admin/change_super_admin";
+    readonly ADMIN_CHANGE_SENDER_EMAIL: "admin/change_sender_email";
+    readonly ADMIN_NODE_PARAMS: "admin/user/nodes/params";
+    readonly ADMIN_COMMON_CUSTOM_DATA: "admin/common_custom_data";
+    readonly ADMIN_DEPLOYMENT_DETAILS: "admin/rainmaker_deployment_details";
+    readonly ADMIN_DEPLOYMENT_SETTINGS: "admin/deployment_settings";
+    readonly ADMIN_DEPLOYMENT_SETTINGS_CONFIG: "admin/deployment_settings/config";
+    readonly ADMIN_NOTIFICATIONS: "admin/notifications";
+    readonly ADMIN_IOT_DEVICE_RATE_RULE: "admin/iot_device_rate_rule";
+    readonly ADMIN_PUSH_NOTIFICATION_TEMPLATE: "admin/push_notification/custom_message_template";
+    readonly ADMIN_MOBILE_PLATFORM: "admin/push_notification/mobile_platform";
+    readonly ADMIN_PUBLISH_MESSAGE: "admin/push_notification/publish_message";
+    readonly ADMIN_PASSTHROUGH_CONFIG: "admin/passthrough/config";
+    readonly ADMIN_NODE_CA_CERTIFICATE: "admin/node_ca_certificate";
+    readonly ADMIN_WEBHOOK_INTEGRATION: "admin/webhook_integration";
+    readonly ADMIN_WEBHOOK_EVENT_MAPPING: "admin/webhook_event_mapping";
+    readonly ADMIN_STATS_INFO: "admin/stats_info";
+    readonly ADMIN_STATS_INIT: "admin/stats_init";
+    readonly ADMIN_API_RATE_LIMIT: "admin/api_rate_limit";
+    readonly ADMIN_MATTER_AUTH: "admin/matter/auth";
+    readonly ADMIN_MATTER_BATCH: "admin/matter/batch";
+    readonly ADMIN_MATTER_BATCH_NODES: "admin/matter/batch/nodes";
+    readonly ADMIN_MAIL_FAILURES: "admin/mail_failures";
+};
+declare const StorageKeys: {
+    readonly ACCESSTOKEN: "com.esprmbase.accessToken";
+    readonly IDTOKEN: "com.esprmbase.idToken";
+    readonly REFRESHTOKEN: "com.esprmbase.refreshToken";
+};
+declare const ConfigErrorCodes: {
+    readonly SDK_NOT_CONFIGURED: "SDK_NOT_CONFIGURED";
+    readonly INVALID_CONFIG_OBJECT: "INVALID_CONFIG_OBJECT";
+    readonly INVALID_BASE_URL: "INVALID_BASE_URL";
+};
+declare const ValidationErrorCodes: {
+    readonly MISSING_LOGIN_PASSWORD: "MISSING_LOGIN_PASSWORD";
+    readonly MISSING_USERNAME: "MISSING_USERNAME";
+    readonly MISSING_VERIFICATION_CODE: "MISSING_VERIFICATION_CODE";
+};
+declare const StorageAdapterErrorCodes: {
+    readonly UNSUPPORTED_DEFAULT_STORAGE_ADAPTER_API: "UNSUPPORTED_DEFAULT_STORAGE_ADAPTER_API";
+};
+declare const APICallValidationErrorCodes: {
+    readonly MISSING_NODE_ID: "MISSING_NODE_ID";
+    readonly MISSING_OTA_IMAGE_ID: "MISSING_OTA_IMAGE_ID";
+    readonly MISSING_OTA_JOB_ID: "MISSING_OTA_JOB_ID";
+    readonly MISSING_GROUP_ID: "MISSING_GROUP_ID";
+    readonly MISSING_GROUP_NAME: "MISSING_GROUP_NAME";
+    readonly MISSING_USER_NAME: "MISSING_USER_NAME";
+    readonly MISSING_RESOURCE_TYPE: "MISSING_RESOURCE_TYPE";
+    readonly MISSING_RESOURCE_ID: "MISSING_RESOURCE_ID";
+    readonly MISSING_EVENT_TYPE: "MISSING_EVENT_TYPE";
+    readonly MISSING_ENTITY_ID: "MISSING_ENTITY_ID";
+    readonly MISSING_ENTITY_TYPE: "MISSING_ENTITY_TYPE";
+    readonly MISSING_ROLE_NAME: "MISSING_ROLE_NAME";
+    readonly MISSING_POLICY_NAME: "MISSING_POLICY_NAME";
+    readonly MISSING_KEY_NAME: "MISSING_KEY_NAME";
+    readonly MISSING_FILE_NAME: "MISSING_FILE_NAME";
+    readonly MISSING_FILE_ID: "MISSING_FILE_ID";
+    readonly MISSING_REQUEST_ID: "MISSING_REQUEST_ID";
+    readonly MISSING_CLIENT_ID: "MISSING_CLIENT_ID";
+    readonly MISSING_CLIENT_NAME: "MISSING_CLIENT_NAME";
+    readonly MISSING_DOMAIN_PREFIX: "MISSING_DOMAIN_PREFIX";
+    readonly MISSING_PROVIDER_NAME: "MISSING_PROVIDER_NAME";
+    readonly MISSING_PROVIDER_TYPE: "MISSING_PROVIDER_TYPE";
+    readonly MISSING_TEMPLATE_ID: "MISSING_TEMPLATE_ID";
+    readonly MISSING_SERVICE_NAME: "MISSING_SERVICE_NAME";
+    readonly MISSING_SERVICE_ID: "MISSING_SERVICE_ID";
+    readonly MISSING_SERVICE: "MISSING_SERVICE";
+    readonly MISSING_ENDPOINT_NAME: "MISSING_ENDPOINT_NAME";
+    readonly MISSING_WEBHOOK_NAME: "MISSING_WEBHOOK_NAME";
+    readonly MISSING_EVENT_NAME: "MISSING_EVENT_NAME";
+    readonly MISSING_NEW_SUPER_ADMIN_EMAIL: "MISSING_NEW_SUPER_ADMIN_EMAIL";
+    readonly MISSING_SENDER_EMAIL: "MISSING_SENDER_EMAIL";
+    readonly MISSING_PLATFORM_NAME: "MISSING_PLATFORM_NAME";
+    readonly MISSING_PLATFORM_APPLICATION_ARN: "MISSING_PLATFORM_APPLICATION_ARN";
+    readonly MISSING_BATCH_ID: "MISSING_BATCH_ID";
+};
+declare const TokenErrorCodes: {
+    readonly MISSING_ACCESS_TOKEN: "MISSING_ACCESS_TOKEN";
+    readonly MISSING_REFRESH_TOKEN: "MISSING_REFRESH_TOKEN";
+    readonly EXTEND_SESSION_FAILED: "EXTEND_SESSION_FAILED";
+    readonly MALFORMED_TOKEN: "MALFORMED_TOKEN";
+};
+declare const ErrorLabels: {
+    readonly ESPAPICallValidationError: "ESPAPICallValidationError";
+    readonly ESPConfigError: "ESPConfigError";
+    readonly ESPTokenError: "ESPTokenError";
+    readonly ESPStorageAdapterError: "ESPStorageAdapterError";
+    readonly ESPValidationError: "ESPValidationError";
+};
+declare const HTTPStatusCodes: {
+    readonly UNAUTHORIZED: 401;
+};
+declare const AdditionalInfo: {
+    readonly AUTHENTICATION_REQUIRED: "Please login again or re-authenticate";
+};
+declare const DEFAULT_REST_API_VERSION = "v1";
+/** Default per-request timeout (ms). Override via ESPRMBaseConfig.timeoutMs. */
+declare const DEFAULT_REQUEST_TIMEOUT_MS = 30000;
+/** Tokens expiring within this many seconds are refreshed proactively. */
+declare const TOKEN_EXPIRY_MARGIN_SECONDS = 30;
+/** 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, };

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

@@ -0,0 +1,10 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { apiCallValidationErrorMessages } from "./errorMessages.cjs";
+import { ESPBaseError } from "./ESPBaseError.cjs";
+export declare class ESPAPICallValidationError extends ESPBaseError {
+    constructor(code: keyof typeof apiCallValidationErrorMessages);
+}

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

@@ -0,0 +1,10 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare class ESPBaseError extends Error {
+    code: string;
+    label: string;
+    constructor(label: string, code: string, errorMessages: Record<string, string>, defaultMessage?: string);
+}

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

@@ -0,0 +1,10 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { configErrorMessages } from "./errorMessages.cjs";
+import { ESPBaseError } from "./ESPBaseError.cjs";
+export declare class ESPConfigError extends ESPBaseError {
+    constructor(code: keyof typeof configErrorMessages);
+}

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

@@ -0,0 +1,10 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { storageAdapterErrorMessages } from "./errorMessages.cjs";
+import { ESPBaseError } from "./ESPBaseError.cjs";
+export declare class ESPStorageAdapterError extends ESPBaseError {
+    constructor(code: keyof typeof storageAdapterErrorMessages);
+}

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

@@ -0,0 +1,10 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { tokenErrorMessages } from "./errorMessages.cjs";
+import { ESPBaseError } from "./ESPBaseError.cjs";
+export declare class ESPTokenError extends ESPBaseError {
+    constructor(code: keyof typeof tokenErrorMessages);
+}

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

@@ -0,0 +1,10 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { validationErrorMessages } from "./errorMessages.cjs";
+import { ESPBaseError } from "./ESPBaseError.cjs";
+export declare class ESPValidationError extends ESPBaseError {
+    constructor(code: keyof typeof validationErrorMessages);
+}

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

@@ -0,0 +1,10 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export { ESPConfigError } from "./ESPConfigError.cjs";
+export { ESPValidationError } from "./ESPValidationError.cjs";
+export { ESPStorageAdapterError } from "./ESPStorageAdapterError.cjs";
+export { ESPAPICallValidationError } from "./ESPAPICallValidationError.cjs";
+export { ESPTokenError } from "./ESPTokenError.cjs";

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

@@ -0,0 +1,65 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+declare const configErrorMessages: {
+    SDK_NOT_CONFIGURED: string;
+    INVALID_CONFIG_OBJECT: string;
+    INVALID_BASE_URL: string;
+};
+declare const validationErrorMessages: {
+    MISSING_LOGIN_PASSWORD: string;
+    MISSING_USERNAME: string;
+    MISSING_VERIFICATION_CODE: string;
+};
+declare const storageAdapterErrorMessages: {
+    UNSUPPORTED_DEFAULT_STORAGE_ADAPTER_API: string;
+};
+declare const apiCallValidationErrorMessages: {
+    MISSING_NODE_ID: string;
+    MISSING_OTA_IMAGE_ID: string;
+    MISSING_OTA_JOB_ID: string;
+    MISSING_GROUP_ID: string;
+    MISSING_GROUP_NAME: string;
+    MISSING_USER_NAME: string;
+    MISSING_RESOURCE_TYPE: string;
+    MISSING_RESOURCE_ID: string;
+    MISSING_EVENT_TYPE: string;
+    MISSING_ENTITY_ID: string;
+    MISSING_ENTITY_TYPE: string;
+    MISSING_ROLE_NAME: string;
+    MISSING_POLICY_NAME: string;
+    MISSING_KEY_NAME: string;
+    MISSING_FILE_NAME: string;
+    MISSING_FILE_ID: string;
+    MISSING_REQUEST_ID: string;
+    MISSING_CLIENT_ID: string;
+    MISSING_CLIENT_NAME: string;
+    MISSING_DOMAIN_PREFIX: string;
+    MISSING_PROVIDER_NAME: string;
+    MISSING_PROVIDER_TYPE: string;
+    MISSING_TEMPLATE_ID: string;
+    MISSING_SERVICE_NAME: string;
+    MISSING_SERVICE_ID: string;
+    MISSING_SERVICE: string;
+    MISSING_ENDPOINT_NAME: string;
+    MISSING_WEBHOOK_NAME: string;
+    MISSING_EVENT_NAME: string;
+    MISSING_NEW_SUPER_ADMIN_EMAIL: string;
+    MISSING_SENDER_EMAIL: string;
+    MISSING_PLATFORM_NAME: string;
+    MISSING_PLATFORM_APPLICATION_ARN: string;
+    MISSING_BATCH_ID: string;
+};
+declare const tokenErrorMessages: {
+    MISSING_ACCESS_TOKEN: string;
+    MISSING_REFRESH_TOKEN: string;
+    EXTEND_SESSION_FAILED: string;
+    MALFORMED_TOKEN: string;
+};
+declare const defaultErrorMessages: {
+    UNKNOWN_ERROR: string;
+    CONFIGURATION_ERROR: string;
+};
+export { configErrorMessages, validationErrorMessages, storageAdapterErrorMessages, apiCallValidationErrorMessages, tokenErrorMessages, defaultErrorMessages, };

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

@@ -0,0 +1,13 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPAPIError } from "../../types/api.cjs";
+interface RawAPIErrorBody {
+    status?: string;
+    error_code?: string;
+    description?: string;
+}
+declare const parseAPIErrorResponse: (error: RawAPIErrorBody, statusCode: number) => ESPAPIError;
+export { parseAPIErrorResponse };

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

@@ -0,0 +1,8 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export * from "./constants.cjs";
+export * from "./validator/validators.cjs";
+export { ESPBaseError } from "./error/ESPBaseError.cjs";

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

@@ -0,0 +1,11 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ESPRMBaseConfig } from "../../types/config.cjs";
+export declare class ConfigValidator {
+    static validateConfig(config: ESPRMBaseConfig): void;
+    private static validateConfigObject;
+    private static validateBaseUrl;
+}

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

@@ -0,0 +1,9 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+declare const isValidUrl: (url: string) => boolean;
+declare const isNonEmptyString: (value: unknown) => boolean;
+declare const isValidObject: (obj: unknown) => boolean;
+export { isValidUrl, isNonEmptyString, isValidObject };