@espressif/rainmaker-admin-sdk 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,205 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and follows the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
+
+## [Unreleased]
+
+## [1.0.0] - 2026-09-07
+
+First public release on npm.
+
+### Added
+
+- **User Node History API**
+  - Added `getUserNodeHistory()` method on `ESPRMAdminUser` for fetching paginated node association history.
+
+- **User Summary API**
+  - Added `getUserSummary()` method on `ESPRMAdminUser` for retrieving active user counts since a given timestamp.
+
+- **Request timeouts**
+  - `ESPRMBase.configure({ timeoutMs })` sets a default per-request timeout (30 s by default, `0` disables). Timed-out and failed network requests reject with an `ESPAPIError` whose `errorCode` is `REQUEST_TIMEOUT` or `NETWORK_ERROR`.
+
+- **Token persistence API**
+  - Added `ESPRMUser.storeTokens()`; `ESPRMUser.clearAllTokens()` now returns a promise that resolves once storage is updated.
+
+### Changed
+
+- **Licensing and attribution**
+  - Every file in the published `dist/` (JavaScript and declarations) now carries the SPDX Apache-2.0 copyright header; previously the build stripped it from declarations and some chunks.
+  - `LICENSE` and `NOTICE` copyright year updated to 2026, matching the README.
+  - Added `npm run check:licenses`, a dependency license gate that also enforces the zero-runtime-dependency guarantee; it runs in CI.
+
+- **Sub-path exports**
+  - Every `@espressif/rainmaker-admin-sdk/<Class>` sub-path is now self-contained: importing it alone registers the class's methods. Previously the methods were only attached after importing the package root.
+
+- **Type declarations**
+  - Declarations resolve under TypeScript `node16`/`nodenext` as well as `bundler`; CommonJS consumers get dedicated `.d.cts` declarations.
+
+- **Token handling**
+  - Access tokens are refreshed 30 s before expiry; concurrent calls share a single refresh request.
+  - JWT payloads are decoded as base64url/UTF-8 (previously plain `atob`).
+  - `getLoggedInUser()` returns `null` instead of throwing when the stored session cannot be restored.
+
+- **Errors**
+  - Calling any API before `ESPRMBase.configure()` throws `ESPConfigError` (`SDK_NOT_CONFIGURED`) instead of an internal `TypeError`.
+
+- **API Statistics**
+  - Replaced generic response type with strongly-typed `APIStatisticsBucket`, `APIStatisticsSeries`, and `APIStatisticsValuePoint`.
+  - Added `api_path`, `fw_version`, `aggregation_interval`, and `group_by` query parameters.
+
+- **MQTT Statistics**
+  - Added generic type parameter to `getMQTTStatistics<TResponse>()` supporting raw message payloads.
+  - Replaced generic response with strongly-typed `MQTTStatisticsBucket`, `MQTTStatisticsSeries`, and `MQTTStatisticsValuePoint` types.
+  - Added `topic_name`, `node_id`, `fw_version`, `aggregation_interval`, and `group_by` query parameters.
+
+- **Cognito App Client**
+  - `updateCognitoAppClient()` now accepts optional query parameters for target user pool selection.
+
+- **Cognito Domain**
+  - `createCognitoDomain()` now accepts optional query parameters.
+
+- **Custom Message Template**
+  - `updateCustomMessageTemplate()` refactored to send `event_type` as a query parameter; added `message_title` field.
+  - `DeleteCustomMessageTemplateParams` expanded with `reset_to_default` and `reset_priority` flags.
+
+- **Message Template**
+  - Migrated from event-based to template-type-based model (`template_type`, `locale`, `message_subject`, `message_text`).
+
+- **Publish Message**
+  - `publishMessage()` now accepts optional query parameters with `send_data_only` flag.
+
+- **Sender Email**
+  - `ChangeSenderEmailRequest` refactored into a discriminated union supporting two-step verification flow.
+
+- **Super Admin**
+  - `ChangeSuperAdminRequest` refactored into a discriminated union for two-step transfer flow with verification codes.
+
+- **Deployment Details**
+  - Replaced generic response type with fully typed `GetDeploymentDetailsResponse`.
+  - Added `GetDeploymentDetailsParams` with `pre_requisite` and `email_mobile_userpool`.
+
+- **Deployment Settings**
+  - Added `RbacConfigurationValue` and `GetRbacDeploymentSettingResponse` types for RBAC settings.
+
+### Fixed
+
+- **Deployment settings**
+  - The `service` path segment in `getDeploymentSettings()` / `updateDeploymentConfig()` is now URL-encoded.
+
+### Security
+
+- The published package no longer contains source maps (`.map` files with inline source).
+- `logout()` now clears the stored tokens even when the logout request fails (timeout, offline, 5xx). Previously a failed request left the access, ID and refresh tokens in storage.
+- Requests are sent with `redirect: "error"`. The API never redirects; following one could have re-sent a request body (login password, refresh token) to another host.
+- `getLoggedInUser()` reuses a refresh already in flight from `authorizeRequest()` instead of sending the same refresh token twice in parallel.
+- `ESPRMUser.userId` is reset when the session is cleared, so it no longer reports the previous user after logout.
+
+### Removed
+
+- The `prepare` script (introduced in v0.5.0 for git-URL installs). Install from the npm registry instead.
+
+## [v0.5.0]
+
+### Fixed
+
+- **Build Configuration**
+  - Fixed build issue by adding `prepare` script to `package.json`.
+  - Corrected `files` field from `"dist/*"` to `"dist"` for proper package contents.
+
+## [v0.4.0]
+
+### Changed
+
+- **Build Pipeline**
+  - Replaced `rollup-plugin-typescript2` with `@rollup/plugin-typescript`.
+  - Added separate `tsconfig.dts.json` for declaration-only emit.
+  - Deduplicated Rollup plugin configuration between ESM and CJS outputs.
+
+- **Dependencies**
+  - Removed unnecessary dependencies.
+  - Standardized on npm (removed `yarn.lock`).
+
+## [v0.3.0]
+
+### Added
+
+- **OTA Image Upload Workflow**
+  - Added `getUploadUrl()`, `confirmUpload()`, `getPackageUploadUrl()`, and `confirmPackageUpload()` methods.
+
+- **OTA Job Status Summary**
+  - Added `getJobStatusSummary()` method for retrieving OTA job status summaries.
+
+### Changed
+
+- **Group Management**
+  - `CreateGroup`: Added error handling with `error_code` propagation.
+  - `UpdateGroup`: Fixed request to send `group_id` as a query parameter.
+
+- **Key Management**
+  - `CreateKey`: Added error handling with `error_code` propagation.
+  - `GetKeys`: Return type changed from `KeyInfo[]` to paginated `GetKeysResponse`.
+
+- **Node Management**
+  - `GetNodeTags`: Accepts optional `GetNodeTagsParams` for filtering and pagination.
+
+- **OTA Management**
+  - `CreateOTAJob`: Signature refactored to separate body and query options; expanded with `ota_job_name`, `groups`, `priority`, `timeout`, `metadata`, `secure_boot`, and `network_serialisation`.
+
+- **Type Definitions**
+  - Expanded types for files, groups, keys, nodes, OTA, secure sign, and user nodes.
+
+## [v0.2.0]
+
+### Changed
+
+- Version bump with no functional changes.
+
+## [0.1.0]
+
+### Added
+
+- **Core SDK**
+  - `ESPRMBase` configuration and initialization.
+  - `ESPRMAuth` authentication module with login, signup, forgot password, and token management.
+  - `ESPRMUser` module with profile management, session handling, and token refresh.
+  - `ESPRMAPIManager` singleton HTTP client using the Fetch API.
+  - `ESPRMStorage` pluggable storage adapter with localStorage default.
+  - Custom error hierarchy: `ESPBaseError`, `ESPConfigError`, `ESPValidationError`, `ESPAPICallValidationError`, `ESPTokenError`, `ESPStorageAdapterError`.
+
+- **Admin API Modules**
+  - Node management: listing, tags, activation, command requests, time series data.
+  - User management: CRUD, node associations.
+  - Group management: CRUD operations.
+  - OTA: image and job management.
+  - Key management and secure signing.
+  - Tag management with attach/detach.
+  - Event filter management.
+  - File upload management.
+  - RBAC: roles, policies, user roles.
+  - Custom data management.
+
+- **Super Admin API Modules**
+  - API Gateway, API Rate Limit, API Statistics, MQTT Statistics.
+  - Cognito: App Client and Domain management.
+  - Identity Provider management.
+  - Message and Custom Message Template management.
+  - Mobile Platform and Push Notification management.
+  - Deployment: capabilities, details, and settings.
+  - License management.
+  - Cloudwatch Log, Log Config, Mail Failures.
+  - Sender Email, Super Admin transfer.
+  - Terms Policy, Dashboard updates.
+  - IoT Device Rate Limit, Passthrough Config.
+  - Node Registration and Certificate management.
+  - Webhook integration and event mapping.
+  - Statistical Service.
+  - Matter authentication and batch management.
+
+- **Infrastructure**
+  - Rollup-based build producing dual ESM and CJS outputs with source maps.
+  - TypeScript strict mode with separate declaration generation.
+  - Auto-generated conditional exports map (`generate-exports.js`).
+  - Integration test suite (Vitest).
+  - Documentation site with TypeDoc API reference.
+  - Prettier formatting.

package/LICENSE

@@ -0,0 +1,201 @@
+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/NOTICE

@@ -0,0 +1,20 @@
+@espressif/rainmaker-admin-sdk
+Copyright 2026 Espressif Systems (Shanghai) CO LTD
+
+This product is licensed under the Apache License, Version 2.0 (see the
+LICENSE file). The following notices apply to material distributed with it.
+
+--------------------------------------------------------------------------------
+Trademarks
+--------------------------------------------------------------------------------
+"Espressif", the Espressif logo, and "ESP RainMaker" are trademarks of
+Espressif Systems (Shanghai) CO LTD. The Apache-2.0 license does not grant any
+trademark rights (see Section 6 of the License); redistribution or use of these
+marks must not imply endorsement by, or affiliation with, Espressif without
+permission.
+
+--------------------------------------------------------------------------------
+Third-party software
+--------------------------------------------------------------------------------
+This package has zero runtime dependencies. Development and test dependencies
+are installed separately via npm and remain under their own licenses.