@espressif/rainmaker-neo-base-sdk 1.0.0

package/dist/types/utils/constants.d.ts

@@ -0,0 +1,825 @@
+/**
+ * An object containing the HTTP methods commonly used in API requests.
+ *
+ * @enum {string}
+ */
+declare const HTTPMethods: {
+    /** Represents the GET HTTP method. */
+    GET: string;
+    /** Represents the PUT HTTP method. */
+    PUT: string;
+    /** Represents the POST HTTP method. */
+    POST: string;
+    /** Represents the DELETE HTTP method. */
+    DELETE: string;
+};
+/**
+ * An object containing the API endpoint paths used in the application.
+ *
+ * @enum {string}
+ */
+declare const APIEndpoints: {
+    /** The endpoint for user operations. */
+    USER: string;
+    /** The endpoint for password recovery. */
+    FORGOTPASSWORD: string;
+    /** The endpoint for user login. */
+    LOGIN: string;
+    /** The endpoint for password operations. */
+    PASSWORD: string;
+    /** The endpoint for user logout. */
+    LOGOUT: string;
+    /** The endpoint for token operations. */
+    TOKEN: string;
+    /** The endpoint for user node groups. */
+    USER_GROUP: string;
+    /** The endpoint for user nodes mapping. */
+    USER_NODE_MAP: string;
+    /** The endpoint for user nodes. */
+    USER_NODE: string;
+    /** The endpoint for user nodes params. */
+    USER_NODE_PARAM: string;
+    /** The endpoint for user node status. */
+    USER_NODE_STATUS: string;
+    /** The endpoint for user node config. */
+    USER_NODE_CONFIG: string;
+    /** The endpoint for user node sharing. */
+    USER_NODE_SHARING: string;
+    /** The endpoint for user node sharing requests/invitations. */
+    USER_NODE_SHARING_REQUESTS: string;
+    /** The endpoint for user node group sharing info. */
+    USER_GROUP_SHARING: string;
+    /** The endpoint for user node group sharing requests/invitations. */
+    USER_GROUP_SHARING_REQUESTS: string;
+    /** The endpoint for user push notifications mobile platform endpoint. */
+    USER_PUSH_NOTIFICATION_MOBILE_PLATFORM_ENDPOINT: string;
+    /** @deprecated moved to APIPathV1.ASSUME_ROLE */
+    ASSUME_ROLE: string;
+    /** @deprecated moved to APIPathV1.USER_CREDENTIALS */
+    USER_CREDENTIALS: string;
+    INITIATE_NODE_ASSOCIATION: string;
+    VERIFY_NODE_ASSOCIATION: string;
+    REGISTER_CLIENT: string;
+    REGISTER_SUB: string;
+    ALEXA_CONFIG: string;
+};
+/**
+ * Storage keys use namespacing: rmneo (SDK) → module → key
+ * to avoid collisions when multiple SDKs share the same storage adapter.
+ */
+declare const StorageKeys: {
+    /** rmneo.auth.* – auth tokens */
+    ACCESSTOKEN: string;
+    IDTOKEN: string;
+    REFRESHTOKEN: string;
+    USER_DEVICETOKEN_MAP: string;
+    /** rmneo.credentials.* – AWS credentials */
+    AWS_CREDENTIALS: string;
+    /** Temporary AWS credentials (e.g. from GetTemporaryAWSCredentials). */
+    TEMPORARY_AWS_CREDENTIALS: string;
+    /** rmneo.nodes.* – node-related data; use prefix + id for per-item keys */
+    /**
+     * Local-storage key prefix for cached node configs.
+     * Full key = `NODE_CONFIG_PREFIX + nodeId` (e.g. `rmneo.nodes.config.<nodeId>`).
+     * Read when `getNode` / `getNodes` are called with `cache: true`; written on
+     * every successful cloud fetch.
+     */
+    NODE_CONFIG_PREFIX: string;
+    /**
+     * Single blob storing `{ [nodeId]: string }` — the last-seen `ncfg_ver`
+     * from each node's IoT shadow. The value is a lowercase hex SHA256 of the
+     * generated node config (previously an integer timestamp; legacy numbers
+     * are normalized to strings). Used to detect schema changes and invalidate
+     * the local config cache. See `hasNcfgVersionChanged`.
+     */
+    NCFG_VERSIONS: string;
+};
+/**
+ * An object containing error codes related to configuration issues.
+ *
+ * @enum {string}
+ */
+declare const ConfigErrorCodes: {
+    /** Error code indicating the SDK is not initialized. */
+    readonly SDK_NOT_CONFIGURED: "SDK_NOT_CONFIGURED";
+    /** Error code indicating the provided configuration object is invalid. */
+    readonly INVALID_CONFIG_OBJECT: "INVALID_CONFIG_OBJECT";
+    /** Error code indicating the base URL is invalid. */
+    readonly INVALID_BASE_URL: "INVALID_BASE_URL";
+    /** Error code indicating an invalid transport mode. */
+    readonly INVALID_TRANSPORT_MODE: "INVALID_TRANSPORT_MODE";
+    /** Error code indicating the transport order is empty or not an array. */
+    readonly INVALID_TRANSPORT_ORDER: "INVALID_TRANSPORT_ORDER";
+    /** Error code indicating the AWS region is invalid. */
+    readonly INVALID_REGION: "INVALID_REGION";
+    /** Error code indicating an invalid storage adapter. */
+    readonly INVALID_STORAGE_ADAPTER: "INVALID_STORAGE_ADAPTER";
+    /** Error code indicating an invalid MQTT adapter. */
+    readonly INVALID_MQTT_ADAPTER: "INVALID_MQTT_ADAPTER";
+    /** Error code indicating the IoT endpoint is invalid or empty. */
+    readonly INVALID_IOT_ENDPOINT: "INVALID_IOT_ENDPOINT";
+    /** Error code indicating an invalid provisioning adapter. */
+    readonly INVALID_PROVISION_ADAPTER: "INVALID_PROVISION_ADAPTER";
+    /** Error code indicating an invalid local control adapter. */
+    readonly INVALID_LOCAL_CONTROL_ADAPTER: "INVALID_LOCAL_CONTROL_ADAPTER";
+    /** Error code indicating an invalid local discovery adapter. */
+    readonly INVALID_LOCAL_DISCOVERY_ADAPTER: "INVALID_LOCAL_DISCOVERY_ADAPTER";
+    /** Error code indicating the User/auth API base URL is missing or empty. */
+    readonly INVALID_USER_API_BASE: "INVALID_USER_API_BASE";
+};
+/**
+ * An object containing error codes related to validation issues.
+ *
+ * @enum {string}
+ */
+declare const ValidationErrorCodes: {
+    /** Error code indicating the login password is missing. */
+    readonly MISSING_LOGIN_PASSWORD: "MISSING_LOGIN_PASSWORD";
+};
+/**
+ * An object containing error codes related to storage adapter issues.
+ *
+ * @enum {string}
+ */
+declare const StorageAdapterErrorCodes: {
+    /** Error code indicating the default storage adapter API is unsupported. */
+    readonly UNSUPPORTED_DEFAULT_STORAGE_ADAPTER_API: "UNSUPPORTED_DEFAULT_STORAGE_ADAPTER_API";
+};
+/**
+ * An object containing error codes related to API call validation issues.
+ *
+ * @enum {string}
+ */
+declare const APICallValidationErrorCodes: {
+    /** Error code indicating the group ID is missing. */
+    readonly MISSING_GROUP_ID: "MISSING_GROUP_ID";
+    /** Error code indicating the group name is missing. */
+    readonly MISSING_GROUP_NAME: "MISSING_GROUP_NAME";
+    /** Error code indicating the node list is missing. */
+    readonly MISSING_NODE_LIST: "MISSING_NODE_LIST";
+    /** Error code indicating the node ID is missing. */
+    readonly MISSING_NODE_ID: "MISSING_NODE_ID";
+    /** Error code indicating the parent node WeakRef has been garbage collected. */
+    readonly MISSING_NODE_REF: "MISSING_NODE_REF";
+    /** Error code indicating the secret key is missing. */
+    readonly MISSING_SECRET_KEY: "MISSING_SECRET_KEY";
+    /** Error code indicating the group update info is missing. */
+    readonly MISSING_GROUP_UPDATE_INFO: "MISSING_GROUP_UPDATE_INFO";
+    /** Error code indicating the delete endpoint parameters are missing. */
+    readonly MISSING_DELETE_ENDPOINT_PARAMS: "MISSING_DELETE_ENDPOINT_PARAMS";
+    /** Error code indicating the device list refresh is required. */
+    readonly DEVICE_LIST_REFRESH_REQUIRED: "DEVICE_LIST_REFRESH_REQUIRED";
+    /** Error code indicating the node is unreachable. */
+    readonly NODE_UNREACHABLE: "NODE_UNREACHABLE";
+    /** Error code indicating invalid event type. */
+    readonly INVALID_EVENT_TYPE: "INVALID_EVENT_TYPE";
+    /** Error code indicating the base URL is missing. */
+    readonly MISSING_BASE_URL: "MISSING_BASE_URL";
+    /** Error code indicating the automation action index is invalid. */
+    readonly INVALID_ACTION_INDEX: "INVALID_ACTION_INDEX";
+    /** Error code indicating the automation ID is missing. */
+    readonly MISSING_AUTOMATION_ID: "MISSING_AUTOMATION_ID";
+    /** Error code indicating the automation name is missing. */
+    readonly MISSING_AUTOMATION_NAME: "MISSING_AUTOMATION_NAME";
+    /** Error code indicating the automation conditions are missing. */
+    readonly MISSING_AUTOMATION_CONDITIONS: "MISSING_AUTOMATION_CONDITIONS";
+    /** Error code indicating the automation actions are missing. */
+    readonly MISSING_AUTOMATION_ACTIONS: "MISSING_AUTOMATION_ACTIONS";
+    /** Error code indicating setParams was called with an empty or missing params object. */
+    readonly MISSING_PARAMS: "MISSING_PARAMS";
+    /** Error code indicating the trigger item is missing or invalid. */
+    readonly MISSING_TRIGGER: "MISSING_TRIGGER";
+    /** Error code indicating the trigger ID is missing or empty. */
+    readonly MISSING_TRIGGER_ID: "MISSING_TRIGGER_ID";
+    /** Error code indicating a trigger with the same id already exists. */
+    readonly TRIGGER_ALREADY_EXISTS: "TRIGGER_ALREADY_EXISTS";
+    /** Error code indicating the action target is invalid or missing required fields. */
+    readonly INVALID_ACTION_TARGET: "INVALID_ACTION_TARGET";
+    /** Error code indicating options.dataType is missing for a custom time-series key. */
+    readonly MISSING_TS_CUSTOM_KEY_DATA_TYPE: "MISSING_TS_CUSTOM_KEY_DATA_TYPE";
+    /** Error code indicating the time-series param carries no data type. */
+    readonly MISSING_TS_DATA_TYPE: "MISSING_TS_DATA_TYPE";
+    /** Error code indicating the time-series param was not found on the node's config. */
+    readonly TS_PARAM_NOT_FOUND: "TS_PARAM_NOT_FOUND";
+    /** Error code indicating the start time is missing for a raw time-series query. */
+    readonly MISSING_TS_START_TIME: "MISSING_TS_START_TIME";
+    /** Error code indicating the time-series aggregation window is missing or invalid. */
+    readonly INVALID_TS_WINDOW: "INVALID_TS_WINDOW";
+    /** Error code indicating the schedule item is missing or invalid. */
+    readonly MISSING_SCHEDULE: "MISSING_SCHEDULE";
+    /** Error code indicating the schedule id is missing or empty. */
+    readonly MISSING_SCHEDULE_ID: "MISSING_SCHEDULE_ID";
+    /** Error code indicating the schedules argument is not an array. */
+    readonly INVALID_SCHEDULES: "INVALID_SCHEDULES";
+    /** Error code indicating the nodeSchedules argument is not an array. */
+    readonly INVALID_NODE_SCHEDULES: "INVALID_NODE_SCHEDULES";
+    /** Error code indicating schedule.enabled is missing or not a boolean. */
+    readonly INVALID_SCHEDULE_ENABLED: "INVALID_SCHEDULE_ENABLED";
+    /** Error code indicating schedule.triggers is missing or not an array. */
+    readonly INVALID_SCHEDULE_TRIGGERS: "INVALID_SCHEDULE_TRIGGERS";
+    /** Error code indicating schedule.action is missing or not an object. */
+    readonly INVALID_SCHEDULE_ACTION: "INVALID_SCHEDULE_ACTION";
+    /** Error code indicating a schedule with the same id already exists. */
+    readonly SCHEDULE_ALREADY_EXISTS: "SCHEDULE_ALREADY_EXISTS";
+    /** Error code indicating the schedule was not found on the node. */
+    readonly SCHEDULE_NOT_FOUND: "SCHEDULE_NOT_FOUND";
+    /** Error code indicating the trigger was not found on the node. */
+    readonly TRIGGER_NOT_FOUND: "TRIGGER_NOT_FOUND";
+    /** Error code indicating the schedule's node could not be resolved. */
+    readonly SCHEDULE_NODE_NOT_FOUND: "SCHEDULE_NODE_NOT_FOUND";
+    /** Error code indicating addNode was called on a root group. */
+    readonly ADD_NODE_REQUIRES_NESTED_GROUP: "ADD_NODE_REQUIRES_NESTED_GROUP";
+    /** Error code indicating the node is already in the group. */
+    readonly NODE_ALREADY_IN_GROUP: "NODE_ALREADY_IN_GROUP";
+    /** Error code indicating the node config could not be resolved. */
+    readonly NODE_CONFIG_UNRESOLVED: "NODE_CONFIG_UNRESOLVED";
+    /** Error code indicating the user ID is missing. */
+    readonly MISSING_USER_ID: "MISSING_USER_ID";
+    /** Error code indicating the username is missing for group sharing. */
+    readonly MISSING_USERNAME: "MISSING_USERNAME";
+    /** Error code indicating removeMember was called with the current-user alias. */
+    readonly USE_LEAVE_FOR_CURRENT_USER: "USE_LEAVE_FOR_CURRENT_USER";
+};
+/**
+ * An object containing API operations.
+ *
+ * @enum {string}
+ */
+declare const APIOperations: {
+    /** Represents the add operation. */
+    readonly ADD: "add";
+    /** Represents the remove operation. */
+    readonly REMOVE: "remove";
+};
+/**
+ * An object containing error codes related to token access issues.
+ *
+ * @enum {string}
+ */
+declare const TokenErrorCodes: {
+    /** Error code indicating the access token is missing. */
+    readonly MISSING_ACCESS_TOKEN: "MISSING_ACCESS_TOKEN";
+    /** Error code indicating the ID token is missing. */
+    readonly MISSING_ID_TOKEN: "MISSING_ID_TOKEN";
+    /** Error code indicating the refresh token is missing. */
+    readonly MISSING_REFRESH_TOKEN: "MISSING_REFRESH_TOKEN";
+    /** Error code indicating the session extension failed. */
+    readonly EXTEND_SESSION_FAILED: "EXTEND_SESSION_FAILED";
+};
+/**
+ * An object containing error codes related to authentication operations.
+ *
+ * @enum {string}
+ */
+declare const AuthErrorCodes: {
+    /** Error code indicating the user is not logged in. */
+    readonly NOT_LOGGED_IN: "NOT_LOGGED_IN";
+    /** Error code indicating password recovery initiation failed. */
+    readonly FORGOT_PASSWORD_FAILED: "FORGOT_PASSWORD_FAILED";
+    /** Error code indicating loading the logged-in user failed. */
+    readonly GET_LOGGED_IN_USER_FAILED: "GET_LOGGED_IN_USER_FAILED";
+    /** Error code indicating login failed. */
+    readonly LOGIN_FAILED: "LOGIN_FAILED";
+    /** Error code indicating login/OTP response is missing required tokens. */
+    readonly LOGIN_FAILED_MISSING_TOKENS: "LOGIN_FAILED_MISSING_TOKENS";
+    /** Error code indicating token refresh response is missing required tokens. */
+    readonly TOKEN_REFRESH_FAILED_MISSING_TOKENS: "TOKEN_REFRESH_FAILED_MISSING_TOKENS";
+    /** Error code indicating OTP verification failed. */
+    readonly OTP_VERIFICATION_FAILED: "OTP_VERIFICATION_FAILED";
+    /** Error code indicating OTP verification returned no authentication result. */
+    readonly OTP_NO_AUTH_RESULT: "OTP_NO_AUTH_RESULT";
+    /** Error code indicating OTP request failed. */
+    readonly OTP_REQUEST_FAILED: "OTP_REQUEST_FAILED";
+    /** Error code indicating OTP request returned no session token. */
+    readonly OTP_SESSION_TOKEN_FAILED: "OTP_SESSION_TOKEN_FAILED";
+    /** Error code indicating sign-up failed. */
+    readonly SIGNUP_FAILED: "SIGNUP_FAILED";
+    /** Error code indicating sign-up confirmation failed. */
+    readonly CONFIRM_SIGNUP_FAILED: "CONFIRM_SIGNUP_FAILED";
+    /** Error code indicating password change failed. */
+    readonly CHANGE_PASSWORD_FAILED: "CHANGE_PASSWORD_FAILED";
+    /** Error code indicating password reset confirmation failed. */
+    readonly PASSWORD_RESET_FAILED: "PASSWORD_RESET_FAILED";
+};
+/**
+ * Fallback success messages for authentication operations.
+ */
+declare const AuthSuccessMessages: {
+    /** Message returned when the password was changed successfully. */
+    readonly PASSWORD_CHANGED: "Password has been changed successfully";
+    /** Message returned when sign-up was confirmed successfully. */
+    readonly USER_CONFIRMED: "User confirmed successfully";
+    /** Message returned when the password was reset successfully. */
+    readonly PASSWORD_RESET: "Password has been reset successfully";
+};
+/**
+ * Fallback success messages for automation operations.
+ */
+declare const AutomationSuccessMessages: {
+    /** Message returned when the condition was already present. */
+    readonly CONDITION_ALREADY_ADDED: "Condition already added";
+    /** Message returned when the automation was deleted successfully. */
+    readonly AUTOMATION_DELETED: "Automation deleted successfully";
+};
+/**
+ * Automation enable/disable status values stored by the backend.
+ */
+declare const AutomationStatusValues: {
+    /** Automation is active. */
+    readonly ENABLED: "enabled";
+    /** Automation is inactive. */
+    readonly DISABLED: "disabled";
+};
+/**
+ * Fallback success messages for group operations.
+ */
+declare const GroupSuccessMessages: {
+    /** Message returned when a node was added to the group successfully. */
+    readonly NODE_ADDED: "Node added successfully";
+    /** Message returned when a node was removed from the group successfully. */
+    readonly NODE_REMOVED: "Node removed successfully";
+    /** Message returned when the current user left the group successfully. */
+    readonly LEFT_GROUP: "Left group successfully";
+    /** Message returned when a member was removed from the group successfully. */
+    readonly MEMBER_REMOVED: "Member removed successfully";
+    /** Message returned when group parameters were set successfully. */
+    readonly PARAMS_SET: "Parameters set successfully";
+    /** Message returned when the group name was updated successfully. */
+    readonly NAME_UPDATED: "Name updated successfully";
+};
+/**
+ * Fallback success messages for node operations.
+ */
+declare const NodeSuccessMessages: {
+    /** Message returned when the node was deleted successfully. */
+    readonly NODE_DELETED: "Node deleted successfully";
+};
+/**
+ * Warning messages for best-effort node cache cleanup.
+ */
+declare const NodeWarnMessages: {
+    /** Logged when removing a cached node config fails. */
+    readonly NODE_CONFIG_CACHE_REMOVE_FAILED: "Failed to remove cached node config";
+    /** Logged when clearing the ncfg version marker fails. */
+    readonly NCFG_VERSION_MARKER_CLEAR_FAILED: "Failed to clear ncfg version marker";
+};
+/**
+ * Fallback success messages for schedule operations.
+ */
+declare const ScheduleSuccessMessages: {
+    /** Message returned when schedules were set on a node. */
+    readonly SET: "Schedules set successfully";
+    /** Message returned when all schedules on a node were deleted. */
+    readonly ALL_DELETED: "All schedules deleted successfully";
+};
+/**
+ * Error message builders for schedule batch operations.
+ */
+declare const ScheduleErrorMessages: {
+    /** Message when creating schedules failed on one or more nodes. */
+    readonly CREATE_FAILED: (failed: number, total: number, summary: string) => string;
+};
+/**
+ * Error / log messages for trigger operations.
+ */
+declare const TriggerErrorMessages: {
+    /** Logged when retrieving triggers for a node fails. */
+    readonly GET_FAILED: "getTriggers failed";
+};
+/**
+ * Error / log messages for temporary AWS credentials (POST /v1/user/credentials).
+ */
+declare const AWSCredentialsErrorMessages: {
+    /** Thrown / logged when the Cognito access token is missing from storage. */
+    readonly MISSING_ACCESS_TOKEN: "Missing access token - user must be logged in";
+    /** Thrown / logged when the Cognito ID token is missing from storage. */
+    readonly MISSING_ID_TOKEN: "Missing ID token - user must be logged in";
+    /** Thrown when the credentials API response is missing required fields. */
+    readonly INCOMPLETE_CREDENTIALS: "Incomplete AWS credentials received";
+    /** Thrown when the credentials HTTP call fails at the network layer. */
+    readonly NETWORK_ERROR: (detail: string) => string;
+    /** Thrown when the credentials response body cannot be read. */
+    readonly READ_RESPONSE_FAILED: (detail: string) => string;
+    /** Fallback when the credentials API returns a non-OK status with an empty body. */
+    readonly HTTP_ERROR: (status: number) => string;
+    /** Logged when fetchTemporaryAWSCredentials starts. */
+    readonly FETCH_CALLED: "fetchTemporaryAWSCredentials called";
+    /** Logged when temporary credentials are fetched and persisted successfully. */
+    readonly FETCH_SUCCESS: "Temporary AWS credentials fetched and saved";
+    /** Logged when the ID token is expired/invalid and a session refresh is started. */
+    readonly ID_TOKEN_REFRESH: "ID token expired or invalid; refreshing session before credentials";
+    /** Logged when retrying after a 401 expired-token response. */
+    readonly CREDENTIALS_RETRY: (attempt: number, max: number) => string;
+    /** Logged when the credentials API returns a non-retryable error. */
+    readonly API_ERROR: "API error";
+    /** Logged when incomplete credentials are received from the API. */
+    readonly INCOMPLETE_CREDENTIALS_LOG: "Incomplete credentials received";
+};
+/**
+ * Fallback success messages for trigger operations.
+ */
+declare const TriggerSuccessMessages: {
+    /** Message returned when triggers were set on a node. */
+    readonly SET: "Triggers set successfully";
+    /** Message returned when all triggers on a node were deleted. */
+    readonly ALL_DELETED: "All triggers deleted successfully";
+};
+/**
+ * Fallback success messages for sharing-request operations.
+ */
+declare const SharingSuccessMessages: {
+    /** Message returned when a sharing request was accepted successfully. */
+    readonly ACCEPTED: "Sharing request accepted";
+    /** Message returned when a sharing request was declined successfully. */
+    readonly DECLINED: "Sharing request declined";
+};
+/**
+ * Fallback success messages for integration endpoint operations.
+ */
+declare const IntegrationSuccessMessages: {
+    /** Message returned when an integration endpoint was unregistered successfully. */
+    readonly ENDPOINT_UNREGISTERED: "Endpoint unregistered successfully";
+};
+/**
+ * Path alias for the authenticated caller in group user APIs.
+ */
+declare const GroupUserAliases: {
+    /** Resolves to the authenticated caller (`DELETE .../users/me`). */
+    readonly CURRENT: "me";
+};
+/**
+ * Provision type for device provisioning flow.
+ * chal_resp = challenge-response flow (initiate → send challenge → verify → set credentials)
+ */
+declare const ProvisionType: {
+    /** Challenge-response flow: initiate, send challenge to device, verify, set network credentials */
+    readonly CHAL_RESP: "chal_resp";
+};
+/**
+ * An object containing endpoint paths.
+ */
+declare const Endpoint: {
+    /** The endpoint for local control. */
+    LOCAL_CTRL: string;
+    /** The endpoint for cloud user association. */
+    CLOUD_USER_ASSOCIATION: string;
+    /** The endpoint for challenge-response and get-node-id protocol with the device. */
+    CHALLENGE_RESPONSE: string;
+    /** The endpoint for assisted claiming. */
+    RM_CLAIM: string;
+};
+/**
+ * Assisted-claiming REST paths, on the deployment's main API and SigV4-signed
+ * like every other `/v1/*` route.
+ *
+ * Kept out of {@link APIPathV1}: the contract-coverage check validates that const
+ * against the committed OpenAPI spec, and these routes are not published there.
+ */
+declare const ClaimEndpoints: {
+    /** Assigns a node ID to a device MAC. Idempotent per device + caller. */
+    readonly CLAIM_INITIATE: "/v1/claim/initiate";
+    /** Exchanges a device CSR for a signed certificate. */
+    readonly CLAIM_VERIFY: "/v1/claim/verify";
+};
+/**
+ * Additional claim capabilities, passed by the consuming application when
+ * calling `startAssistedClaiming`.
+ *
+ * @enum {string}
+ */
+declare enum ClaimCapabilities {
+    /** Capability indicating device supports camera claiming with video streaming. */
+    CAMERA_CLAIM = "camera_claim"
+}
+/**
+ * Extra IoT policies requested per claim capability, sent as the `capabilities`
+ * array on claim/verify and re-supplied on every re-claim or the policies drop.
+ *
+ * Deliberately empty: `capabilities` is optional, and omitting it attaches no
+ * extra policies, which is correct for an ordinary device. Documented values are
+ * `s3`, `kvs` and `bridge`; which one a capability needs is a deployment
+ * decision, so entries are added only once confirmed.
+ */
+declare const ClaimCapabilityPolicies: Partial<Record<ClaimCapabilities, readonly string[]>>;
+/** Separators accepted in a device MAC address, stripped before sending. */
+declare const CLAIM_MAC_SEPARATORS: RegExp;
+/** Valid MAC lengths after separators are stripped, per the claiming contract. */
+declare const CLAIM_MAC_HEX_LENGTHS: readonly [12, 16];
+/**
+ * Keys a device may use for its MAC in the claim-start payload, checked in order.
+ * The firmware payload is not part of the cloud contract, so several spellings
+ * are tolerated.
+ */
+declare const CLAIM_DEVICE_MAC_KEYS: readonly ["mac_addr", "macAddr", "mac", "MAC", "mac_address"];
+/** Keys a device may use for its CSR in the claim payload, checked in order. */
+declare const CLAIM_DEVICE_CSR_KEYS: readonly ["csr", "CSR", "csr_pem"];
+/**
+ * An object containing error codes related to claiming issues.
+ *
+ * @enum {string}
+ */
+declare const ClaimErrorCodes: {
+    /** Error code indicating claiming start failed. */
+    readonly CLAIM_START_FAILED: "CLAIM_START_FAILED";
+    /** Error code indicating claiming was aborted. */
+    readonly CLAIM_ABORTED: "CLAIM_ABORTED";
+    /** Error code indicating claiming API call failed. */
+    readonly CLAIM_API_FAILED: "CLAIM_API_FAILED";
+    /** Error code indicating the claiming service host is not configured yet. */
+    readonly CLAIM_API_NOT_CONFIGURED: "CLAIM_API_NOT_CONFIGURED";
+    /** Error code indicating the device did not report a usable MAC address. */
+    readonly DEVICE_MAC_UNAVAILABLE: "DEVICE_MAC_UNAVAILABLE";
+    /** Error code indicating CSR retrieval from the device failed. */
+    readonly CSR_RETRIEVAL_FAILED: "CSR_RETRIEVAL_FAILED";
+    /** Error code indicating sending the certificate to the device failed. */
+    readonly CERTIFICATE_SEND_FAILED: "CERTIFICATE_SEND_FAILED";
+    /** Error code indicating the device stopped making progress while streaming the CSR. */
+    readonly CSR_STALLED: "CSR_STALLED";
+};
+/**
+ * An object containing claiming progress messages.
+ */
+declare const ClaimProgressMessages: {
+    /** Message indicating claiming start. */
+    readonly CLAIM_STARTING: "Starting assisted claiming...";
+    /** Message indicating claim start request sent. */
+    readonly CLAIM_START_SENT: "Claim start request sent to device.";
+    /** Message indicating device info received from the device. */
+    readonly DEVICE_INFO_RECEIVED: "Device info received.";
+    /** Message indicating claim init API call. */
+    readonly CLAIM_INIT_API: "Sending device info to cloud...";
+    /** Message indicating claim init sent to device. */
+    readonly CLAIM_INIT_SENT: "Claim init sent to device.";
+    /** Message indicating CSR retrieval from the device. */
+    readonly CSR_RETRIEVING: "Retrieving CSR from device...";
+    /** Message indicating CSR received from the device. */
+    readonly CSR_RECEIVED: "CSR received from device.";
+    /** Message indicating claim verify API call. */
+    readonly CLAIM_VERIFY_API: "Sending CSR to cloud for verification...";
+    /** Message indicating the certificate was received from the cloud. */
+    readonly CERTIFICATE_RECEIVED: "Certificate received from cloud.";
+    /** Message indicating the certificate is being sent to the device. */
+    readonly CERTIFICATE_SENDING: "Sending certificate to device...";
+    /** Message indicating claiming completed successfully. */
+    readonly CLAIM_SUCCESS: "Assisted claiming completed successfully.";
+    /** Message indicating claiming failed. */
+    readonly CLAIM_FAILED: "Assisted claiming failed.";
+};
+/**
+ * Bounds the CSR retrieval loop, so firmware that reports Success without
+ * advancing cannot hang the flow.
+ */
+declare const CLAIM_CSR_MAX_CHUNKS = 128;
+/**
+ * Maximum bytes per claim fragment. A hard ceiling, not a tunable default: the
+ * device answers an oversized fragment with `NoMemory`.
+ */
+declare const CLAIM_MAX_FRAGMENT_SIZE = 200;
+/**
+ * An object containing error codes related to provisioning issues.
+ *
+ * @enum {string}
+ */
+declare const ProvErrorCodes: {
+    /** Error code indicating the provision type is invalid. */
+    readonly INVALID_PROVISION_TYPE: "INVALID_PROVISION_TYPE";
+    /** Error code indicating the provisioning adapter is missing. */
+    readonly MISSING_PROV_ADAPTER: "MISSING_PROV_ADAPTER";
+    /** Error code indicating the node ID is missing. */
+    readonly MISSING_NODE_ID: "MISSING_NODE_ID";
+    /** Error code indicating the ID token is missing. */
+    readonly MISSING_ID_TOKEN: "MISSING_ID_TOKEN";
+    /** Error code indicating the provisioning failed. */
+    readonly FAILED_PROV: "FAILED_PROV";
+    /** Error code indicating the user device association failed. */
+    readonly FAILED_USER_DEVICE_ASSOCIATION: "FAILED_USER_DEVICE_ASSOCIATION";
+    /** Error code indicating the user node mapping request creation failed. */
+    readonly FAILED_USER_NODE_MAPPING_REQUEST_CREATION: "FAILED_USER_NODE_MAPPING_REQUEST_CREATION";
+    /** Error code indicating the user node mapping cloud timeout. */
+    readonly FAILED_USER_NODE_MAPPING_CLOUD_TIMEOUT: "FAILED_USER_NODE_MAPPING_CLOUD_TIMEOUT";
+    /** Error code indicating the challenge response failed. */
+    readonly FAILED_CHALLENGE_RESPONSE: "FAILED_CHALLENGE_RESPONSE";
+    /** Error code indicating the mapping response is invalid. */
+    readonly INVALID_MAPPING_RESPONSE: "INVALID_MAPPING_RESPONSE";
+    /** Error code indicating the device challenge response failed. */
+    readonly DEVICE_CHALLENGE_RESPONSE_FAILED: "DEVICE_CHALLENGE_RESPONSE_FAILED";
+    /** Error code indicating the challenge response format is invalid. */
+    readonly INVALID_CHALLENGE_RESPONSE_FORMAT: "INVALID_CHALLENGE_RESPONSE_FORMAT";
+    /** Error code indicating the verify node mapping failed. */
+    readonly VERIFY_NODE_MAPPING_FAILED: "VERIFY_NODE_MAPPING_FAILED";
+    /** Error code indicating the set network credentials failed. */
+    readonly SET_NETWORK_CREDENTIALS_FAILED: "SET_NETWORK_CREDENTIALS_FAILED";
+    /** Error code indicating the node did not come online within the timeout. */
+    readonly NODE_ONLINE_TIMEOUT: "NODE_ONLINE_TIMEOUT";
+};
+/**
+ * An object containing service types.
+ *
+ * @enum {string}
+ */
+declare const ServiceType: {
+    /** Represents the ESP local control TCP service type. */
+    ESP_LOCAL_CTRL_TCP: string;
+};
+/**
+ * An object containing protocol types.
+ *
+ * @enum {string}
+ */
+declare const ProtocolType: {
+    /** Represents the DNS-SD protocol type. */
+    PROTOCOL_DNS_SD: string;
+};
+/**
+ * An object containing status messages.
+ *
+ * @enum {string}
+ */
+declare const StatusMessage: {
+    /** Represents a success status. */
+    SUCCESS: string;
+    /** Represents a confirmed status. */
+    CONFIRMED: string;
+    /** Represents a timed out status. */
+    TIMEDOUT: string;
+};
+/** The default REST API version. */
+declare const DEFAULT_REST_API_VERSION = "v1";
+/** The SDK version from package.json */
+declare const SDK_VERSION = "1.0.0";
+/**
+ * An object containing ESP service types.
+ *
+ * @enum {string}
+ */
+declare const ESPServiceType: {
+    /** Represents the local control service type. */
+    LOCAL_CONTROL: string;
+};
+/**
+ * An object containing ESP service parameter types.
+ */
+declare const ESPServiceParamType: {
+    /** Represents the local control parameter type. */
+    LOCAL_CONTROL: {
+        /** Represents the type parameter. */
+        TYPE: string;
+        /** Represents the POP parameter (SEC-1). */
+        POP: string;
+        /** Represents the username parameter (SEC-2 / SRP6a). */
+        USERNAME: string;
+    };
+};
+/**
+ * An object containing ESP provisioning progress messages.
+ */
+declare const ESPProvProgressMessages: {
+    /** Message indicating the start of user device association. */
+    START_ASSOCIATION: string;
+    /** Message indicating the association config request creation. */
+    ASSOCIATION_CONFIG_CREATED: string;
+    /** Message indicating the sending of association config request. */
+    SENDING_ASSOCIATION_CONFIG: string;
+    /** Message indicating the successful sending of association config request. */
+    ASSOCIATION_CONFIG_SENT: string;
+    /** Message indicating the successful device provisioning. */
+    DEVICE_PROVISIONED: string;
+    /** Message indicating the successful user node mapping. */
+    USER_NODE_MAPPING_SUCCEED: string;
+    /** Message indicating the decoding of response data. */
+    DECODING_RESPONSE_DATA: string;
+    /** Message indicating the successful decoding of NodeId from response data. */
+    DECODED_NODE_ID: string;
+    /** Message indicating initiating node association on server. */
+    INITIATING_NODE_ASSOCIATION: string;
+    /** Message indicating sending challenge to device. */
+    SENDING_CHALLENGE_TO_DEVICE: string;
+    /** Message indicating verifying node association on server. */
+    VERIFYING_NODE_ASSOCIATION: string;
+    /** Message indicating setting network credentials. */
+    SETTING_NETWORK_CREDENTIALS: string;
+    /** Message indicating waiting for the device to come online after WiFi provisioning. */
+    WAITING_FOR_ONLINE: string;
+};
+declare const ErrorLabels: {
+    ESPAPICallValidationError: string;
+    ESPConfigError: string;
+    ESPClaimError: string;
+    ESPProvError: string;
+    ESPTokenError: string;
+    ESPStorageAdapterError: string;
+    ESPValidationError: string;
+};
+/**
+ * Centralized v1 API path literals and path builder functions.
+ * Use these instead of hard-coding path strings to simplify future path changes (e.g. /v1 → /v2).
+ */
+declare const APIPathV1: {
+    /** POST /v1/assumed-roles */
+    readonly ASSUME_ROLE: "/v1/assumed-roles";
+    /** POST /v1/user/credentials (main API, not the user-auth API) */
+    readonly USER_CREDENTIALS: "/v1/user/credentials";
+    /** GET/POST /v1/groups */
+    readonly GROUPS: "/v1/groups";
+    /** GET /v1/integrations — list configured integrations (non-admin) */
+    readonly INTEGRATIONS: "/v1/integrations";
+    /** PUT register endpoint — /v1/integrations/{integrationId}/endpoints */
+    readonly integrationEndpoints: (integrationId: string) => string;
+    /** DELETE unregister endpoint — /v1/integrations/{integrationId}/endpoints/{endpointId} */
+    readonly integrationEndpoint: (integrationId: string, endpointId: string) => string;
+    /** GET /v1/sharing-requests/received — list sharing requests for the current user */
+    readonly SHARING_REQUESTS_RECEIVED: "/v1/sharing-requests/received";
+    /** POST /v1/sharing-requests/{requestId}/accept */
+    readonly sharingRequestAccept: (requestId: string) => string;
+    /** POST /v1/sharing-requests/{requestId}/reject */
+    readonly sharingRequestReject: (requestId: string) => string;
+    /** POST /v1/user/auth/signup */
+    readonly USER_AUTH_SIGNUP: "/v1/user/auth/signup";
+    /** POST /v1/user/auth/signup/verify */
+    readonly USER_AUTH_SIGNUP_VERIFY: "/v1/user/auth/signup/verify";
+    /** POST /v1/user/auth/token */
+    readonly USER_AUTH_TOKEN: "/v1/user/auth/token";
+    /** POST /v1/user/auth/token/refresh */
+    readonly USER_AUTH_TOKEN_REFRESH: "/v1/user/auth/token/refresh";
+    /** POST /v1/user/auth/password-recovery */
+    readonly USER_AUTH_PASSWORD_RECOVERY: "/v1/user/auth/password-recovery";
+    /** POST /v1/user/auth/password-recovery/confirmation */
+    readonly USER_AUTH_PASSWORD_RECOVERY_CONFIRMATION: "/v1/user/auth/password-recovery/confirmation";
+    /** POST /v1/user/auth/password */
+    readonly USER_AUTH_PASSWORD: "/v1/user/auth/password";
+    /** POST /v1/user/auth/signout */
+    readonly USER_AUTH_SIGNOUT: "/v1/user/auth/signout";
+    /** GET /v1/users/{userId} — user profile (`me` for the authenticated caller) */
+    readonly user: (userId: string) => string;
+    /** /v1/groups/{groupId} */
+    readonly group: (groupId: string) => string;
+    /** /v1/groups/{groupId}/node-assoc-requests */
+    readonly groupNodeAssocRequests: (groupId: string) => string;
+    /** /v1/groups/{groupId}/node-assoc-requests/{requestId}/verify - Challenge_response (traditional) or nocsr_elements (Matter) */
+    readonly groupNodeAssocVerify: (groupId: string, requestId: string) => string;
+    /** POST /v1/groups/{groupId}/node-assoc-requests/{requestId}/confirm - Confirms user-node mapping (Matter commissioning) */
+    readonly groupNodeAssocConfirm: (groupId: string, requestId: string) => string;
+    /** /v1/groups/{groupId}/subgroups */
+    readonly groupSubgroups: (groupId: string) => string;
+    /** /v1/groups/{groupId}/subgroups/{subgroupId} */
+    readonly groupSubgroup: (groupId: string, subgroupId: string) => string;
+    /** /v1/groups/{groupId}/subgroups/{subgroupId}/sharing-requests */
+    readonly groupSubgroupSharingRequests: (groupId: string, subgroupId: string) => string;
+    /** /v1/groups/{groupId}/subgroups/{subgroupId}/nodes/{nodeId} */
+    readonly groupSubgroupNode: (groupId: string, subgroupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/sharing-requests */
+    readonly groupSharingRequests: (groupId: string) => string;
+    /** GET /v1/groups/{groupId}/users — list users with access to the group */
+    readonly groupUsers: (groupId: string) => string;
+    /** /v1/groups/{groupId}/users/{userId} - Remove member (use 'me' to leave) */
+    readonly groupUser: (groupId: string, userId: string) => string;
+    /** GET /v1/groups/{groupId}/subgroups/{subgroupId}/users — list users with access to the subgroup */
+    readonly groupSubgroupUsers: (groupId: string, subgroupId: string) => string;
+    /** /v1/groups/{groupId}/subgroups/{subgroupId}/users/{userId} - Remove member (use 'me' to leave) */
+    readonly groupSubgroupUser: (groupId: string, subgroupId: string, userId: string) => string;
+    /** DELETE /v1/groups/{groupId}/nodes/{nodeId} - Remove node from group (disassociation) */
+    readonly groupNode: (groupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/nodes/{nodeId}/config */
+    readonly groupNodeConfig: (groupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/nodes/{nodeId}/triggers */
+    readonly groupNodeTriggers: (groupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/nodes/{nodeId}/schedules */
+    readonly groupNodeSchedules: (groupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/nodes/{nodeId}/timeseries/raw */
+    readonly groupNodeTimeseriesRaw: (groupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/nodes/{nodeId}/timeseries/latest */
+    readonly groupNodeTimeseriesLatest: (groupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/nodes/{nodeId}/timeseries/aggregates */
+    readonly groupNodeTimeseriesAggregates: (groupId: string, nodeId: string) => string;
+    /** /v1/groups/{groupId}/service/automations */
+    readonly groupAutomation: (groupId: string) => string;
+    /** /v1/groups/{groupId}/service/automations/{automationId} */
+    readonly groupAutomationId: (groupId: string, automationId: string) => string;
+    /** POST /v1/groups/{groupId}/node-assoc-requests - Initiates user node mapping */
+    readonly USER_NODE_MAPPING_INITIATE: (groupId: string) => string;
+    /** POST /v1/groups/{groupId}/node-assoc-requests/{requestId}/verify - Verifies user node mapping */
+    readonly USER_NODE_MAPPING_VERIFY: (groupId: string, requestId: string) => string;
+};
+export { HTTPMethods, APIEndpoints, APIPathV1, StorageKeys, ValidationErrorCodes, StorageAdapterErrorCodes, ConfigErrorCodes, APICallValidationErrorCodes, APIOperations, TokenErrorCodes, AuthErrorCodes, AuthSuccessMessages, AutomationSuccessMessages, AutomationStatusValues, GroupSuccessMessages, NodeSuccessMessages, NodeWarnMessages, ScheduleSuccessMessages, ScheduleErrorMessages, TriggerErrorMessages, TriggerSuccessMessages, SharingSuccessMessages, IntegrationSuccessMessages, AWSCredentialsErrorMessages, GroupUserAliases, Endpoint, ProvisionType, ProvErrorCodes, ServiceType, ProtocolType, StatusMessage, DEFAULT_REST_API_VERSION, ESPServiceType, ESPServiceParamType, ESPProvProgressMessages, ErrorLabels, SDK_VERSION, ClaimEndpoints, ClaimCapabilities, ClaimCapabilityPolicies, ClaimErrorCodes, ClaimProgressMessages, CLAIM_CSR_MAX_CHUNKS, CLAIM_MAX_FRAGMENT_SIZE, CLAIM_MAC_SEPARATORS, CLAIM_MAC_HEX_LENGTHS, CLAIM_DEVICE_MAC_KEYS, CLAIM_DEVICE_CSR_KEYS, };
+export declare enum ESPRMNeoErrorCodes {
+    SDK_NOT_CONFIGURED = "SDK_NOT_CONFIGURED",
+    INVALID_CREDENTIALS = "INVALID_CREDENTIALS",
+    USER_NOT_CONFIRMED = "USER_NOT_CONFIRMED",
+    USER_NOT_FOUND = "USER_NOT_FOUND"
+}
+export declare enum ESPRMNeoStorageKeys {
+    ACCESS_TOKEN = "ESPRMNeo_ACCESS_TOKEN",
+    ID_TOKEN = "ESPRMNeo_ID_TOKEN",
+    REFRESH_TOKEN = "ESPRMNeo_REFRESH_TOKEN"
+}
+/**
+ * Stable identifier(s) for subscription channels that this SDK ships and
+ * registers with the {@link ESPRMNeoSubscriptionManager}.
+ *
+ * Only channels shipped by this SDK are listed here. External channel
+ * implementations define and own their own channel ids.
+ */
+export declare const SubscriptionChannelIds: {
+    /** MQTT (AWS IoT Device Shadow) channel — shipped by the base Neo SDK. */
+    readonly MQTT: "mqtt";
+};