@hsuite/smart-engines-sdk 4.1.0 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 5.0.0 — 2026-06-27
+
+### Breaking changes
+
+- **Root `CreateAccountRequest` / `CreateTokenRequest` now refer to the BaaS shapes.** These exports previously pointed to the legacy validator-direct request types used by `SmartEngineClient.createAccount` / `createToken`. They now point to the BaaS request types consumed by `BaasClient.entities`. If you need the validator-direct request types, import `ValidatorCreateAccountRequest` and `ValidatorCreateTokenRequest` from the SDK root.
+- **`EntityCreationResult.agentId` is now required.** The field was optional in 4.2.0; it is now guaranteed on normalized results and is backfilled from `entityId` when the host response omits it. Callers constructing this type directly must now include `agentId`.
+
+### Added
+
+- **Exported client interfaces:** `IBaasClient`, `IEntitiesClient`, and `IRulesClient` are now part of the public surface.
+- **Exported `BatchInnerTransaction`** as an alias for `PreparedTransaction`.
+- **BaaS and validator-direct request types are re-exported from the root.** This includes `CreateAccountRequest`, `CreateTokenRequest`, `CreateAgentRequest`, `CreateTopicRequest`, `ValidatorCreateAccountRequest`, and `ValidatorCreateTokenRequest`.
+- **`EntitiesClient` response normalization.** `getById`, `getByRuleRef`, `lookup`, and create/prepare methods now normalize host responses to the stable `EntityInfo` and `EntityCreationResult` shapes.
+
+## 4.2.0 — 2026-06-26
+
+### Added
+
+- **Two-phase EXECUTABLE-agent surface (additive, non-breaking).** Reflects the host change that promotes a payer-funded XRPL agent into an executable AGENT record during the execute-create/finalize half. Lets the app-as-proxy consumer drive the full prepare → fund → execute agent flow type-safely.
+  - **`EntityCreationResult.agentId?: string` + `status?: string`.** The host now merges `{ agentId, status }` additively onto the execute-create envelope once the funded entity is promoted to an agent record (`executeCreateAgent`, and the convenience `createAgent` on payer-funded chains). Present ONLY on the agent execute/finalize path; undefined for non-agent entity types and on the prepare half. Field names + `string` types match the host controller's `executeCreate` return (`apps/smart-host/.../entities.controller.ts`) verbatim.
+  - **`CreateAgentRequest.rulesConfig?: Record<string, unknown>` + `capabilities?: string[]`.** Carried through `prepareCreateAgent` (which already forwards the whole request body) so the host can stash them VERBATIM on the PENDING registry row at prepare and recover them at execute to mint the agent record — avoiding a `rulesHash` divergence from re-deriving them from the bound rule. Field names + types mirror the host `PrepareCreateDto` / `entity-registry.schema.ts` verbatim. Optional/additive; ignored by the legacy synchronous `createAgent` and by non-agent entity types.
+  - **App-as-payer `fundWith` documented.** `CreateAgentRequest.fundWith` now documents that a smart-app may supply a SERVER-SIDE `fundWith` that signs the prepared payer `Payment` with the app's OWN treasury key and sets `payerAccountId` to that treasury account. No new method — the existing `prepareCreateAgent` → `fundWith` → `executeCreateAgent` sequence already supports an app funding an agent on a customer's behalf.
+
 ## 4.1.0 — 2026-06-25
 
 ### Added