@revoengine/sdk 1.6.8 → 3.0.0

package/README.md

@@ -8,10 +8,10 @@ Requirements: Node.js 22 or newer.
 
 Development and GitLab CI use Node.js 24.21.0. Run `nvm use` to select the checked-in `.nvmrc`.
 
-## SDK 1.6.8 compatibility
+## SDK 3.0.0 compatibility
 
-This release synchronizes the complete public SDK contract with the current
-platform low-code declarations. Remote calls require a platform runtime that admits
+This major release synchronizes the complete public SDK contract with RevoEngine
+1.7.1 and removes deprecated compatibility methods and legacy Files types. Remote calls require a platform runtime that admits
 the bundled contract revision; publishing the SDK alone does not deploy that runtime.
 Use the SDK version supported by the target platform deployment until its contract is upgraded.
 
@@ -38,9 +38,10 @@ for Secret formats and file-transfer examples.
 
 This release retains portable Component digest declarations and one readable-relation
 contract for Databases, live Views, and Materialized Views. Use `api.exportDatabase()`
-for all three relation types. `api.getDatabaseViewData()` remains a deprecated
-read alias; `api.exportDatabaseView()` and separate REST View export operations
-are removed. Existing integrations should update these calls before rollout.
+for all three relation types, and `api.getDatabaseData()` for structured reads.
+Account data uses `metadata` and `metadataAdvanced`; use `vault.get()` for Secret
+values and `storage.*` for file content. The instance-data source list excludes
+legacy Files resources.
 
 Database exports can select CSV, TSV, NDJSON, or XLSX. An asynchronous export
 returns its job ID for operation tracking. The import workflow starts with
@@ -56,7 +57,7 @@ Remote MCP server configurations in this contract use public HTTPS destinations.
 Private-network access is not an accepted SDK setting; review the server URL,
 provider consent, Vault binding, and tool permissions before enabling a plugin.
 
-SDK 1.6.8 adds `agents.createResponse()` and the saved Assistant conversation
+The SDK includes `agents.createResponse()` and the saved Assistant conversation
 contract: `instructions`, `contextMode` and text or validated JSON `responseFormat`.
 The typed answer is in `output.text` or `output.json`; retain the returned thread
 for an ordinary `agents.sendMessage()` continuation. Provider refusal, incomplete
@@ -145,14 +146,16 @@ JavaScript ignores the additional runtime argument.
 
 Hosted context comes from the current execution snapshot and is synchronous, just
 like the low-code surface. Only platform-backed work returns a promise.
+Account metadata is available through `currentUser.metadata` and
+`currentUser.metadataAdvanced`.
 
 ```js
 export async function init(runtime) {
-  const { api } = runtime;
+  const { api, vault } = runtime;
   const input = api.input();
   const currentUser = api.currentUser();
   const instance = api.getInstanceDetails();
-  const signingSecret = await api.getSecret('WEBHOOK_SIGNING_SECRET');
+  const signingSecret = (await vault.get('WEBHOOK_SIGNING_SECRET', { scope: 'instance' })).revision.value;
 
   api.log({
     message: 'Processing custom component',
@@ -241,7 +244,7 @@ There is no `init()` or connection method.
 ## Execute active low-code libraries
 
 `execute(code, options)` runs one transient JavaScript or TypeScript component inside
-RevoEngine. The source has the normal low-code `api` and active tenant `libs.*`
+RevoEngine. The source has the normal low-code `api` and active tenant `lib.*`
 surface. Library functions and source never move into the Node.js process; only the
 JSON-serializable request and execution result cross the runtime transport.
 
@@ -254,8 +257,8 @@ export async function init(runtime) {
   const execution = await runtime.execute(
     `
       const customerId = api.input('customerId');
-      const customer = await libs.Customers.Queries.get(customerId);
-      const balance = await libs.Billing.Balance.current(customerId);
+      const customer = await lib.Customers.Queries.get(customerId);
+      const balance = await lib.Billing.Balance.current(customerId);
       return { customer, balance };
     `,
     {
@@ -290,7 +293,7 @@ type CustomerSummary = {
 const execution = await revo.execute<CustomerSummary>(
   `
     const customerId = api.input('customerId');
-    return libs.Customers.Summary.build(customerId);
+    return lib.Customers.Summary.build(customerId);
   `,
   {
     inputs: { customerId: 'customer-1' },
@@ -304,7 +307,7 @@ console.log(execution.results);
 JavaScript is selected with `language: 'javascript'`; TypeScript is the default.
 The default timeout is 60 seconds. Standalone `executionDefaults` set reusable
 language, timeout, or memory defaults, and per-call options override them.
-One `execute()` call creates one isolated execution. Put related `libs.*`
+One `execute()` call creates one isolated execution. Put related `lib.*`
 operations in the same source when they belong to one workflow. Concurrent separate
 calls still use the SDK's automatic JSON-RPC batching but execute in separate isolates.
 Low-code runtime batches are not retried because source can perform writes.
@@ -362,11 +365,12 @@ Calls queued in the same microtask are grouped. `Promise.all` is the normal way
 to issue a batch:
 
 ```ts
-const [customers, crmToken, activeAgents] = await Promise.all([
+const [customers, crmSecret, activeAgents] = await Promise.all([
   revo.api.getDatabaseData('Customers', { take: 100 }),
-  revo.api.getSecret('CRM_API_TOKEN'),
+  revo.vault.get('CRM_API_TOKEN', { scope: 'instance' }),
   revo.agents.list(),
 ]);
+const crmToken = crmSecret.revision.value;
 ```
 
 Sequential `await` statements naturally produce separate batches:
@@ -432,7 +436,8 @@ export async function init(runtime) {
     args: { userId: currentUser.userId, instanceId, hasInput: input != null },
   });
 
-  return runtime.api.getSecret('SIGNING_SECRET');
+  const signingSecret = await runtime.vault.get('SIGNING_SECRET', { scope: 'instance' });
+  return { configured: Boolean(signingSecret.revision.value) };
 }
 ```
 

package/dist/{errors-DAkcmPyN.d.cts → errors-D_8Jrrt5.d.cts}

@@ -1,9 +1,9 @@
 import * as node_worker_threads from 'node:worker_threads';
 import { Buffer as Buffer$1 } from 'node:buffer';
 
-declare const SDK_VERSION: "1.6.8";
+declare const SDK_VERSION: "3.0.0";
 declare const PROTOCOL_VERSION: 1;
-declare const CONTRACT_REVISION: "cda216e308d857954aa46b31185a8b653015dd1e3d84996bdf3a93745e72bd43";
+declare const CONTRACT_REVISION: "a8b45833ea1fa202798a2c8c009e07955b31c0cce159767844f96b9ca85b500a";
 type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'vault' | 'serviceAccount' | 'agents' | 'lowCode';
 
 // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
@@ -422,7 +422,7 @@ interface SwaggerAssistantResponseFormatDto {
 }
 interface SwaggerAssistantThreadlessResponseContextDto {
     /** Current Revo UI component hint included in the response context. It does not automatically select tools or skills. */
-    "componentContext"?: "PREFERENCES" | "USERS" | "SERVICE_ACCOUNTS" | "GROUPS" | "ROLE_GROUPS" | "SECRETS" | "REVISIONS" | "DATABASES" | "DATABASE_OPERATIONS" | "DATABASE_VIEWS" | "DATA" | "DATA_ITEMS" | "ENDPOINTS" | "TEMPLATES" | "SCHEDULE" | "SCHEDULE_HISTORY" | "EVENTS" | "JOBS" | "AGENTS" | "AGENT_RUNS" | "AGENT_INBOX" | "AGENT_PLUGINS" | "AGENT_TERMINALS" | "WEBHOOKS" | "COMPONENTS" | "COMPONENT_ELEMENTS" | "EVENTS_HISTORY" | "USER_KEYS" | "FILES" | "STORAGE" | "REALTIME" | "LOGS" | "MONITORING" | "THREAD" | "SECURITY_SETTINGS" | "ME_SETTINGS" | "ME_KEYS" | "USER_DETAILS" | "PLAYGROUND" | "WEB_IDE";
+    "componentContext"?: "PREFERENCES" | "USERS" | "SERVICE_ACCOUNTS" | "GROUPS" | "ROLE_GROUPS" | "SECRETS" | "REVISIONS" | "DATABASES" | "DATABASE_OPERATIONS" | "DATABASE_VIEWS" | "DATA" | "DATA_ITEMS" | "ENDPOINTS" | "TEMPLATES" | "SCHEDULE" | "SCHEDULE_HISTORY" | "EVENTS" | "JOBS" | "AGENTS" | "AGENT_RUNS" | "AGENT_INBOX" | "AGENT_PLUGINS" | "AGENT_TERMINALS" | "WEBHOOKS" | "COMPONENTS" | "COMPONENT_ELEMENTS" | "EVENTS_HISTORY" | "USER_KEYS" | "STORAGE" | "REALTIME" | "LOGS" | "MONITORING" | "THREAD" | "SECURITY_SETTINGS" | "ME_SETTINGS" | "ME_KEYS" | "USER_DETAILS" | "PLAYGROUND" | "WEB_IDE";
     /** UI-level intent hint for the lightweight response. */
     "kind"?: "suggestion" | "code_refactor" | "code_explain" | "completion" | "generic";
     /** Additional UI instruction for this lightweight response. */
@@ -940,12 +940,8 @@ interface ServiceAccountCreateInput {
     "name": string;
     /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadata"?: Record<string, unknown> | null;
-    /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "metaData"?: Record<string, unknown> | null;
     /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadataAdvanced"?: Record<string, unknown> | null;
-    /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "advancedData"?: Record<string, unknown> | null;
 }
 interface StorageFolderInput {
     /** Folder name. */
@@ -1349,12 +1345,8 @@ interface ServiceAccountUpdateInput {
     "name"?: string;
     /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadata"?: Record<string, unknown> | null;
-    /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "metaData"?: Record<string, unknown> | null;
     /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadataAdvanced"?: Record<string, unknown> | null;
-    /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "advancedData"?: Record<string, unknown> | null;
     "access"?: SwaggerUpdateServiceAccountAccessDto;
     /** Current account version for optimistic concurrency. */
     "version": number;
@@ -2358,11 +2350,7 @@ interface LoggedUser {
     groups: string[];
     roles: string[];
     metadata: LooseObject<any>;
-    /** @deprecated Use metadata instead. */
-    metaData: LooseObject<any>;
     metadataAdvanced: LooseObject<any>;
-    /** @deprecated Use metadataAdvanced instead. */
-    advancedData: LooseObject<any>;
     /** Avatar storage entry ID; `/me` separately returns a signed download URL. */
     avatar: string;
     platformAccess: boolean;
@@ -3510,12 +3498,8 @@ interface RevoApi {
     exit(): void;
     throw(code: number, body?: any): void;
     getCurrentInstance(): string;
-    getInstanceData(dataSource: 'Users' | 'Groups' | 'RoleGroups' | 'Keys' | 'Secrets' | 'SecretsData' | 'Templates' | 'Events' | 'Schedule' | 'Jobs' | 'Webhooks' | 'Components' | 'Logs' | 'Files' | 'EventsHistory' | 'Endpoints' | 'Databases' | 'DatabaseData', request?: InstanceData): Promise<any>;
+    getInstanceData(dataSource: 'Users' | 'Groups' | 'RoleGroups' | 'Keys' | 'Secrets' | 'SecretsData' | 'Templates' | 'Events' | 'Schedule' | 'Jobs' | 'Webhooks' | 'Components' | 'Logs' | 'EventsHistory' | 'Endpoints' | 'Databases' | 'DatabaseData', request?: InstanceData): Promise<any>;
     getInstanceDetails(): InstanceDetails;
-    getSecret(name: string): Promise<string>;
-    getSecrets(name: string[]): Promise<{
-        [key: string]: string;
-    }>;
     publishMessage(channel: string, message: any): Promise<void>;
     getInstanceCache(key: string): Promise<any>;
     setInstanceCache(key: string, value: any, seconds?: number): Promise<void>;

package/dist/{errors-DAkcmPyN.d.ts → errors-D_8Jrrt5.d.ts}

@@ -1,9 +1,9 @@
 import * as node_worker_threads from 'node:worker_threads';
 import { Buffer as Buffer$1 } from 'node:buffer';
 
-declare const SDK_VERSION: "1.6.8";
+declare const SDK_VERSION: "3.0.0";
 declare const PROTOCOL_VERSION: 1;
-declare const CONTRACT_REVISION: "cda216e308d857954aa46b31185a8b653015dd1e3d84996bdf3a93745e72bd43";
+declare const CONTRACT_REVISION: "a8b45833ea1fa202798a2c8c009e07955b31c0cce159767844f96b9ca85b500a";
 type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'vault' | 'serviceAccount' | 'agents' | 'lowCode';
 
 // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
@@ -422,7 +422,7 @@ interface SwaggerAssistantResponseFormatDto {
 }
 interface SwaggerAssistantThreadlessResponseContextDto {
     /** Current Revo UI component hint included in the response context. It does not automatically select tools or skills. */
-    "componentContext"?: "PREFERENCES" | "USERS" | "SERVICE_ACCOUNTS" | "GROUPS" | "ROLE_GROUPS" | "SECRETS" | "REVISIONS" | "DATABASES" | "DATABASE_OPERATIONS" | "DATABASE_VIEWS" | "DATA" | "DATA_ITEMS" | "ENDPOINTS" | "TEMPLATES" | "SCHEDULE" | "SCHEDULE_HISTORY" | "EVENTS" | "JOBS" | "AGENTS" | "AGENT_RUNS" | "AGENT_INBOX" | "AGENT_PLUGINS" | "AGENT_TERMINALS" | "WEBHOOKS" | "COMPONENTS" | "COMPONENT_ELEMENTS" | "EVENTS_HISTORY" | "USER_KEYS" | "FILES" | "STORAGE" | "REALTIME" | "LOGS" | "MONITORING" | "THREAD" | "SECURITY_SETTINGS" | "ME_SETTINGS" | "ME_KEYS" | "USER_DETAILS" | "PLAYGROUND" | "WEB_IDE";
+    "componentContext"?: "PREFERENCES" | "USERS" | "SERVICE_ACCOUNTS" | "GROUPS" | "ROLE_GROUPS" | "SECRETS" | "REVISIONS" | "DATABASES" | "DATABASE_OPERATIONS" | "DATABASE_VIEWS" | "DATA" | "DATA_ITEMS" | "ENDPOINTS" | "TEMPLATES" | "SCHEDULE" | "SCHEDULE_HISTORY" | "EVENTS" | "JOBS" | "AGENTS" | "AGENT_RUNS" | "AGENT_INBOX" | "AGENT_PLUGINS" | "AGENT_TERMINALS" | "WEBHOOKS" | "COMPONENTS" | "COMPONENT_ELEMENTS" | "EVENTS_HISTORY" | "USER_KEYS" | "STORAGE" | "REALTIME" | "LOGS" | "MONITORING" | "THREAD" | "SECURITY_SETTINGS" | "ME_SETTINGS" | "ME_KEYS" | "USER_DETAILS" | "PLAYGROUND" | "WEB_IDE";
     /** UI-level intent hint for the lightweight response. */
     "kind"?: "suggestion" | "code_refactor" | "code_explain" | "completion" | "generic";
     /** Additional UI instruction for this lightweight response. */
@@ -940,12 +940,8 @@ interface ServiceAccountCreateInput {
     "name": string;
     /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadata"?: Record<string, unknown> | null;
-    /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "metaData"?: Record<string, unknown> | null;
     /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadataAdvanced"?: Record<string, unknown> | null;
-    /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "advancedData"?: Record<string, unknown> | null;
 }
 interface StorageFolderInput {
     /** Folder name. */
@@ -1349,12 +1345,8 @@ interface ServiceAccountUpdateInput {
     "name"?: string;
     /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadata"?: Record<string, unknown> | null;
-    /** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "metaData"?: Record<string, unknown> | null;
     /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
     "metadataAdvanced"?: Record<string, unknown> | null;
-    /** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
-    "advancedData"?: Record<string, unknown> | null;
     "access"?: SwaggerUpdateServiceAccountAccessDto;
     /** Current account version for optimistic concurrency. */
     "version": number;
@@ -2358,11 +2350,7 @@ interface LoggedUser {
     groups: string[];
     roles: string[];
     metadata: LooseObject<any>;
-    /** @deprecated Use metadata instead. */
-    metaData: LooseObject<any>;
     metadataAdvanced: LooseObject<any>;
-    /** @deprecated Use metadataAdvanced instead. */
-    advancedData: LooseObject<any>;
     /** Avatar storage entry ID; `/me` separately returns a signed download URL. */
     avatar: string;
     platformAccess: boolean;
@@ -3510,12 +3498,8 @@ interface RevoApi {
     exit(): void;
     throw(code: number, body?: any): void;
     getCurrentInstance(): string;
-    getInstanceData(dataSource: 'Users' | 'Groups' | 'RoleGroups' | 'Keys' | 'Secrets' | 'SecretsData' | 'Templates' | 'Events' | 'Schedule' | 'Jobs' | 'Webhooks' | 'Components' | 'Logs' | 'Files' | 'EventsHistory' | 'Endpoints' | 'Databases' | 'DatabaseData', request?: InstanceData): Promise<any>;
+    getInstanceData(dataSource: 'Users' | 'Groups' | 'RoleGroups' | 'Keys' | 'Secrets' | 'SecretsData' | 'Templates' | 'Events' | 'Schedule' | 'Jobs' | 'Webhooks' | 'Components' | 'Logs' | 'EventsHistory' | 'Endpoints' | 'Databases' | 'DatabaseData', request?: InstanceData): Promise<any>;
     getInstanceDetails(): InstanceDetails;
-    getSecret(name: string): Promise<string>;
-    getSecrets(name: string[]): Promise<{
-        [key: string]: string;
-    }>;
     publishMessage(channel: string, message: any): Promise<void>;
     getInstanceCache(key: string): Promise<any>;
     setInstanceCache(key: string, value: any, seconds?: number): Promise<void>;