@revoengine/sdk 1.5.7 → 1.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,12 +6,12 @@ Revo-hosted `CUSTOM_NODEJS` components and standalone Node.js applications.
6
6
 
7
7
  Requirements: Node.js 22 or newer.
8
8
 
9
- ## SDK 1.5.7 compatibility
9
+ ## SDK 1.6.2 compatibility
10
10
 
11
11
  This release synchronizes the complete public SDK contract with the current
12
12
  platform low-code declarations. Remote calls require a platform runtime that admits
13
13
  the bundled contract revision; publishing the SDK alone does not deploy that runtime.
14
- Use SDK 1.0.1 with older deployments until their platform contract is upgraded.
14
+ Use the SDK version supported by the target platform deployment until its contract is upgraded.
15
15
 
16
16
  HTTP Storage requests/responses now use `requestType: 'storage'` and
17
17
  `responseType: 'storage'`, with flat Storage-only `source` / `target` objects.
@@ -25,9 +25,26 @@ The `transport` namespace exposes `sftpImport`, `sftpExport`, and `sftpCommands`
25
25
  with active Secret names or IDs instead of inline credentials. Storage references
26
26
  use the same namespace and effective access rules as other file operations.
27
27
  Legacy SFTP helpers and the removed thread-goal methods are not exposed by the
28
- current SDK contract. Refer to the [transfer guide](https://docs.revoengine.com/build/transport)
28
+ current SDK contract. Refer to the [transfer guide](https://docs.revoengine.com/low-code/sftp)
29
29
  for Secret formats and file-transfer examples.
30
30
 
31
+ SDK 1.6.2 retains portable Component digest declarations and one readable-relation
32
+ contract for Databases, live Views, and Materialized Views. Use `api.exportDatabase()`
33
+ for all three relation types. `api.getDatabaseViewData()` remains a deprecated
34
+ read alias; `api.exportDatabaseView()` and separate REST View export operations
35
+ are removed. Existing integrations should update these calls before rollout.
36
+
37
+ Database exports can select CSV, TSV, NDJSON, or XLSX. An asynchronous export
38
+ returns its job ID for operation tracking. The import workflow starts with
39
+ `api.importDatabase()`, then permits a reviewed mapping update and an explicit
40
+ `api.commitDatabaseImport()` after preview validation. The generated declarations
41
+ describe the current request and response shapes; the platform still enforces
42
+ permissions and validates source and target state before committing an import.
43
+
44
+ Remote MCP server configurations in this contract use public HTTPS destinations.
45
+ Private-network access is not an accepted SDK setting; review the server URL,
46
+ provider consent, Vault binding, and tool permissions before enabling a plugin.
47
+
31
48
  ## Choose your runtime
32
49
 
33
50
  | Environment | How to start | Authentication |
@@ -59,7 +76,7 @@ RevoEngine pins that version again in the deployment package and injects the
59
76
  runtime into the component entrypoint. Component code does not construct a
60
77
  `RevoClient`.
61
78
 
62
- The platform chooses the hosted package version; publishing SDK 1.5.7 does not
79
+ The platform chooses the hosted package version; publishing SDK 1.6.2 does not
63
80
  upgrade existing hosted deployments or their generated package pins.
64
81
 
65
82
  Hosted user code receives neither a tenant API key nor the private runtime