@espressif/rainmaker-neo-base-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Espressif Systems \(Shanghai\) CO LTD
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,206 @@
+# ESP RainMaker Neo TypeScript SDK
+
+**RainMaker Neo** (short: **RMNeo**) is Espressif’s AIoT stack. `@espressif/rainmaker-neo-base-sdk` is the TypeScript SDK that powers JavaScript-based apps integrating with RainMaker Neo — authentication, groups/nodes, device provisioning, real-time MQTT control, and group sharing.
+
+## Table of Contents
+
+- [Key Features](#key-features)
+- [Requirements](#requirements)
+- [Installation](#installation)
+  - [Local development](#local-development)
+- [Quick Start](#quick-start)
+- [Examples](#examples)
+  - [Login and user info](#login-and-user-info)
+  - [Connect MQTT and control a node](#connect-mqtt-and-control-a-node)
+  - [Group-wide control](#group-wide-control)
+  - [Create groups and share](#create-groups-and-share)
+  - [Accept a sharing request](#accept-a-sharing-request)
+  - [Provision a device](#provision-a-device)
+- [API Documentation](#api-documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Key Features
+
+- [x] **AWS Cognito Authentication:** Secure user authentication with automatic session management and token refresh
+- [x] **MQTT Real-time Communication:** Direct AWS IoT Core integration with automatic credential provisioning
+- [x] **Device Provisioning:** Complete device setup workflow with WiFi provisioning and cloud binding
+- [x] **Type Safety:** Full TypeScript support with comprehensive type definitions
+- [x] **Modular Design:** Clean architecture with separate modules for authentication, device management, and communication
+- [x] **Automatic Storage:** Seamless data persistence via app-supplied storage adapters
+- [x] **Error Handling:** Comprehensive error handling with detailed logging
+
+## Requirements
+
+- **Node.js** 18+
+- **TypeScript** 5+ (recommended)
+
+## Installation
+
+```bash
+npm install @espressif/rainmaker-neo-base-sdk
+# or
+yarn add @espressif/rainmaker-neo-base-sdk
+# or
+pnpm add @espressif/rainmaker-neo-base-sdk
+```
+
+### Local development
+
+```bash
+npm install
+npm run build
+npm pack
+# in your app:
+npm install <PATH_TO_PACK_TARBALL_FILE>
+```
+
+## Quick Start
+
+```typescript
+import { ESPRMNeoBase } from "@espressif/rainmaker-neo-base-sdk";
+
+ESPRMNeoBase.init({
+  baseUrl: "https://your-api-gateway.amazonaws.com/prod",
+  userApiBase: "https://your-user-api-gateway.amazonaws.com/prod",
+  identityId: "your-identity-pool-id",
+  awsRegion: "us-east-1",
+  userPoolId: "your-user-pool-id",
+  clientId: "your-cognito-client-id",
+  iotEndpoint: "xxxxxxxx-ats.iot.us-east-1.amazonaws.com",
+  // Optional adapters (provided by your app):
+  // mqttAdapter, customStorageAdapter, provisionAdapter, ...
+});
+
+const auth = ESPRMNeoBase.getAuthInstance();
+const user = await auth.login("user@example.com", "password");
+
+await user.getTemporaryAWSCredentials();
+const connected = await user.connectMQTT();
+```
+
+## Examples
+
+### Login and user info
+
+```typescript
+import { ESPRMNeoBase } from "@espressif/rainmaker-neo-base-sdk";
+
+const auth = ESPRMNeoBase.getAuthInstance();
+const user = await auth.login("user@example.com", "password");
+
+const info = await user.getUserInfo();
+console.log(info);
+```
+
+### Connect MQTT and control a node
+
+```typescript
+await user.getTemporaryAWSCredentials();
+await user.connectMQTT();
+
+const groups = await user.getGroups();
+const home = groups[0];
+const node = await home.getNode("your-node-id");
+
+// Device params
+const light = node.devices.find((d) => d.name === "Light");
+const power = light?.params.find((p) => p.id === "Power");
+const brightness = light?.params.find((p) => p.id === "Brightness");
+
+await power?.setValue(true);
+await brightness?.setValue(80);
+
+// Service params (e.g. Time)
+const time = node.services.find((s) => s.name === "Time");
+const tz = time?.params.find((p) => p.id === "TZ");
+await tz?.setValue("Asia/Shanghai");
+```
+
+### Group-wide control
+
+```typescript
+// Broadcasts the same command to every node in the group
+await home.setParams({
+  Light: {
+    Power: false,
+  },
+});
+```
+
+### Create groups and share
+
+```typescript
+// High-level group: location / site / home
+const home = await user.createGroup("Home");
+
+// Rooms as subgroups under the home
+const livingRoom = await home.createSubGroup("Living Room");
+const bedroom = await home.createSubGroup("Bedroom");
+
+// Share the home (or a room subgroup) with another user
+await home.share({
+  userCode: "ABCD1234",
+  accessType: "secondary",
+});
+```
+
+### Accept a sharing request
+
+```typescript
+const requests = await user.listSharingRequests();
+
+for (const request of requests) {
+  await request.accept();
+}
+```
+
+### Provision a device
+
+```typescript
+import { ESPDevice } from "@espressif/rainmaker-neo-base-sdk";
+
+const device = new ESPDevice({
+  name: "PROV_XXXXXX",
+  transport: "ble",
+  security: 1,
+});
+
+await device.connect();
+
+const networks = await device.scanWifiList();
+console.log(networks);
+
+const nodeId = await device.provision(
+  "HomeWiFi",
+  "wifi-password",
+  (progress) => console.log(progress.description),
+  livingRoom.groupId // associate with a room subgroup
+);
+
+console.log("Provisioned node:", nodeId);
+await device.disconnect();
+```
+
+## API Documentation
+
+Generate local docs from JSDoc:
+
+```bash
+npm run genDocs
+```
+
+Open `docs/index.html` in a browser. Docs are generated with [TypeDoc](https://typedoc.org/).
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit and push your changes
+4. Open a Pull Request
+
+See [Changelog](CHANGELOG.md) for release notes.
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).

package/dist/cjs/ESPDevice.js

@@ -0,0 +1,35 @@
+'use strict';
+
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+// Lazy require to avoid circular dependency: ESPDevice -> ESPRMNeoBase -> (index) -> ESPDevice
+function getESPRMNeoBase() {
+    return require("./ESPRMNeoBase").ESPRMNeoBase;
+}
+/**
+ * Represents an ESP device for provisioning and local communication.
+ * Provides methods for device discovery and WiFi provisioning.
+ */
+class ESPDevice {
+    _espProvisionAdapter;
+    get ESPProvisionAdapter() {
+        if (!this._espProvisionAdapter) {
+            this._espProvisionAdapter = getESPRMNeoBase().getProvisionAdapter();
+        }
+        return this._espProvisionAdapter;
+    }
+    name;
+    transport;
+    security;
+    constructor(deviceConfig) {
+        this.name = deviceConfig.name;
+        this.transport = deviceConfig.transport;
+        this.security = deviceConfig.security;
+    }
+}
+
+exports.ESPDevice = ESPDevice;
+//# sourceMappingURL=ESPDevice.js.map

package/dist/cjs/ESPDevice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ESPDevice.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/ESPRMNeoAuth.js

@@ -0,0 +1,61 @@
+'use strict';
+
+var ESPRMNeoAPIManager = require('./services/ESPRMNeoAPIManager.js');
+var logger$1 = require('./utils/logger.js');
+var constants = require('./utils/constants.js');
+var errorMessages = require('./utils/error/errorMessages.js');
+var ESPAuthError = require('./utils/error/ESPAuthError.js');
+
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const logger = new logger$1.Logger("ESPRMNeoAuth");
+/**
+ * The `ESPRMNeoAuth` class provides authentication functionality via the
+ * RainMaker User Auth API. Key features include:
+ *
+ * - **Sign-Up Process**: Methods to send sign-up codes and confirm user registration.
+ * - **Password Management**: Support for password recovery, setting new passwords, and login with credentials.
+ * - **Session Management**: Provides functionality to fetch details of the currently logged-in user.
+ */
+class ESPRMNeoAuth {
+    _config;
+    constructor(config) {
+        this._config = config;
+    }
+    /**
+     * Returns the SDK config this auth instance was constructed with.
+     * Prefer this over {@link ESPRMNeoBase.getConfig} in auth method implementations.
+     */
+    getConfig() {
+        return this._config;
+    }
+    /**
+     * Gets refreshed tokens using a refresh token without persisting them.
+     *
+     * Calls `POST /v1/user/auth/token/refresh` (unauthenticated; the backend
+     * validates `refresh_token` in the body only).
+     */
+    static async getRefreshedTokens(refreshToken) {
+        const api = ESPRMNeoAPIManager.ESPRMNeoAPIManager.getInstance();
+        logger.debug("getRefreshedTokens (token/refresh)", {
+            refresh_token: refreshToken.substring(0, 20) + "...",
+        });
+        const requestBody = { refresh_token: refreshToken };
+        const apiResponse = await api.postUserApi(constants.APIPathV1.USER_AUTH_TOKEN_REFRESH, requestBody);
+        if (!apiResponse?.access_token || !apiResponse?.id_token) {
+            throw new ESPAuthError.ESPAuthError(constants.AuthErrorCodes.TOKEN_REFRESH_FAILED_MISSING_TOKENS, errorMessages.authErrorMessages.TOKEN_REFRESH_FAILED_MISSING_TOKENS, apiResponse);
+        }
+        return {
+            accessToken: apiResponse.access_token,
+            idToken: apiResponse.id_token,
+            refreshToken,
+        };
+    }
+}
+
+exports.ESPAuthError = ESPAuthError.ESPAuthError;
+exports.ESPRMNeoAuth = ESPRMNeoAuth;
+//# sourceMappingURL=ESPRMNeoAuth.js.map

package/dist/cjs/ESPRMNeoAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ESPRMNeoAuth.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/ESPRMNeoAutomation.js

@@ -0,0 +1,48 @@
+'use strict';
+
+var constants = require('./utils/constants.js');
+var ESPAPICallValidationError = require('./utils/error/ESPAPICallValidationError.js');
+
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Represents an automation in the ESP Rainmaker Neo SDK.
+ * Provides instance methods for automation operations.
+ */
+class ESPRMNeoAutomation {
+    id;
+    groupId;
+    name;
+    conditions;
+    actions;
+    /** Enable/disable flag. Defaults to "enabled" when absent (backend default). */
+    status;
+    retrigger;
+    constructor(data, group) {
+        if (!data.id) {
+            throw new ESPAPICallValidationError.ESPAPICallValidationError(constants.APICallValidationErrorCodes.MISSING_AUTOMATION_ID);
+        }
+        if (!data.name) {
+            throw new ESPAPICallValidationError.ESPAPICallValidationError(constants.APICallValidationErrorCodes.MISSING_AUTOMATION_NAME);
+        }
+        if (!data.conditions) {
+            throw new ESPAPICallValidationError.ESPAPICallValidationError(constants.APICallValidationErrorCodes.MISSING_AUTOMATION_CONDITIONS);
+        }
+        if (!data.actions) {
+            throw new ESPAPICallValidationError.ESPAPICallValidationError(constants.APICallValidationErrorCodes.MISSING_AUTOMATION_ACTIONS);
+        }
+        this.id = data.id;
+        this.groupId = group.groupId;
+        this.name = data.name;
+        this.conditions = data.conditions;
+        this.actions = data.actions;
+        this.status = data.status ?? constants.AutomationStatusValues.ENABLED;
+        this.retrigger = data.retrigger;
+    }
+}
+
+exports.ESPRMNeoAutomation = ESPRMNeoAutomation;
+//# sourceMappingURL=ESPRMNeoAutomation.js.map

package/dist/cjs/ESPRMNeoAutomation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ESPRMNeoAutomation.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}