@revoengine/sdk 1.5.5 → 1.5.6

package/README.md

@@ -1,14 +1,14 @@
 # @revoengine/sdk
 
 Official Node.js SDK for RevoEngine. It provides the modern `api`, `utils`,
-`storage`, and `agents` namespaces, top-level `execute()`, and the `batch` controller in both
+`storage`, `transport`, and `agents` namespaces, top-level `execute()`, and the `batch` controller in both
 Revo-hosted `CUSTOM_NODEJS` components and standalone Node.js applications.
 
 Requirements: Node.js 22 or newer.
 
-## SDK 2.0.0 compatibility
+## SDK 1.5.6 compatibility
 
-This major release synchronizes the complete public SDK contract with the current
+This release synchronizes the complete public SDK contract with the current
 platform low-code declarations. Remote calls require a platform runtime that admits
 the bundled contract revision; publishing the SDK alone does not deploy that runtime.
 Use SDK 1.0.1 with older deployments until their platform contract is upgraded.
@@ -21,6 +21,13 @@ network or hosted bridge dispatch. Automation schedules use `{ scheduleFor }`
 options instead of positional dates. Regenerated types also include the current
 Storage and database contracts; use those declarations when migrating callers.
 
+The `transport` namespace exposes `sftpImport`, `sftpExport`, and `sftpCommands`
+with active Secret names or IDs instead of inline credentials. Storage references
+use the same namespace and effective access rules as other file operations.
+Legacy SFTP helpers and the removed thread-goal methods are not exposed by the
+current SDK contract. Refer to the [transfer guide](https://docs.revoengine.com/build/transport)
+for Secret formats and file-transfer examples.
+
 ## Choose your runtime
 
 | Environment | How to start | Authentication |
@@ -28,7 +35,7 @@ Storage and database contracts; use those declarations when migrating callers.
 | Revo-hosted `CUSTOM_NODEJS` | Export `async function init(runtime)` | Revo injects an execution-bound runtime; user code receives no API key. |
 | Standalone Node.js | Create `new RevoClient(options)` | Supply a RevoEngine API key explicitly or through an environment variable. |
 
-Both modes expose the same `api`, `utils`, `storage`, `agents`, `execute`, and `batch`
+Both modes expose the same `api`, `utils`, `storage`, `transport`, `agents`, `execute`, and `batch`
 properties, but return types reflect where the work happens:
 
 | Call kind | Revo-hosted | Standalone |
@@ -52,7 +59,7 @@ RevoEngine pins that version again in the deployment package and injects the
 runtime into the component entrypoint. Component code does not construct a
 `RevoClient`.
 
-The platform chooses the hosted package version; publishing SDK 2.0.0 does not
+The platform chooses the hosted package version; publishing SDK 1.5.6 does not
 upgrade existing hosted deployments or their generated package pins.
 
 Hosted user code receives neither a tenant API key nor the private runtime

package/dist/{errors-BmtftjgL.d.cts → errors-XTYAxN-H.d.cts}

@@ -1,9 +1,9 @@
 import * as node_worker_threads from 'node:worker_threads';
 
-declare const SDK_VERSION: "1.5.5";
+declare const SDK_VERSION: "1.5.6";
 declare const PROTOCOL_VERSION: 1;
-declare const CONTRACT_REVISION: "b98c007dbeaf81bb88ab29f6b4b699e85a4f8b1eb5a36f08701ec1cbd553089f";
-type RuntimeSurfaceName = 'api' | 'storage' | 'agents' | 'lowCode';
+declare const CONTRACT_REVISION: "8a1f8936cd7f3b2e9d418a0676e02024b3dd54c3d2aa721d698b0c3ea66bbf04";
+type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'agents' | 'lowCode';
 
 // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
 // Sources: api.swagger-contracts.generated.d.ts, api.public.d.ts
@@ -922,20 +922,6 @@ interface StorageEntryUpdateInput {
     /** Current entity version. */
     "version"?: number;
 }
-interface AssistantThreadGoalInput {
-    /** Durable thread-level objective used to validate assistant completion across turns, tool loops, approval resumes, and compaction. */
-    "objective": string;
-    /** Optional concrete criteria the goal reviewer should require before marking the goal satisfied. */
-    "successCriteria"?: Array<string>;
-    /** Optional exclusions that should not be treated as required work for this goal. */
-    "nonGoals"?: Array<string>;
-    /** Optional evidence the reviewer should expect, such as tests, lint, screenshots, API results, or changed resources. */
-    "requiredEvidence"?: Array<string>;
-    /** Optional validation commands or checks relevant to this goal. */
-    "validationCommands"?: Array<string>;
-    /** Optional concise definition of done used by the reviewer when evaluating candidate completion. */
-    "doneDefinition"?: string;
-}
 interface AssistantThreadTitleInput {
     /** New user-defined title for the thread. */
     "title": string;
@@ -2098,26 +2084,22 @@ interface InstanceData {
         id: string;
     };
 }
-interface SFTPClient {
-    host: string;
-    port: number;
-    username: string;
-    password?: string;
-    privateKey?: string;
-    passphrase?: string;
-}
 interface StorageFileTargetRequest extends Omit<StorageUploadSessionInput, 'replaceStorageEntryId' | 'uploadMode'> {
     name: string;
 }
-type SFTPFileSourceRef = {
+/** Storage destination for transport.sftpImport. Uses the same namespace and ACL contract as storage.* and HTTP targets. */
+type SFTPImportStorage = (StorageFileTargetRequest & {
+    namespace?: string;
+}) | {
     storageEntryId: string;
+    namespace?: string;
+    replace: true;
 };
-type SFTPFileTargetRef = {
+/** Existing Storage file used by transport.sftpExport. */
+interface SFTPExportStorage {
     storageEntryId: string;
-    replace?: true;
-} | {
-    storage: StorageFileTargetRequest;
-};
+    namespace?: string;
+}
 interface JWTHeader {
     alg: string | 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' | 'ES256' | 'ES384' | 'ES512' | 'PS256' | 'PS384' | 'PS512' | 'none';
     typ?: string | undefined;
@@ -2592,7 +2574,6 @@ interface AssistantThread {
     actionRequired?: AssistantActionRequired | null;
     executionPlan?: AssistantPublicExecutionPlan | null;
     workerProgress?: AssistantWorkerProgress[] | null;
-    goal?: AssistantThreadGoal | null;
     share?: AssistantThreadShare | null;
     createdBy?: string;
     createdAt?: Date | string;
@@ -2602,23 +2583,6 @@ interface AssistantThread {
     deletedAt?: Date | string | null;
     version?: number;
 }
-interface AssistantThreadGoal {
-    version: 1;
-    assistantThreadId: string;
-    revision: number;
-    status: 'active' | 'paused' | 'completed' | 'blocked' | 'cleared';
-    objective: string | null;
-    source: 'user' | 'api' | 'message' | 'system';
-    createdAt: string;
-    updatedAt: string;
-    updatedBy: string | null;
-    validation: {
-        status: 'satisfied' | 'unsatisfied' | 'partial' | 'skipped';
-        reviewedAt: string;
-        rationale: string | null;
-        evidenceRefs?: string[];
-    } | null;
-}
 interface AssistantMessage {
     assistantMessageId: string;
     assistantThreadId: string;
@@ -2635,7 +2599,6 @@ interface AssistantThreadState {
     actionRequired: AssistantActionRequired | null;
     executionPlan: AssistantPublicExecutionPlan | null;
     workerProgress?: AssistantWorkerProgress[] | null;
-    goal?: AssistantThreadGoal | null;
 }
 interface AssistantThreadShare {
     shareId: string;
@@ -2809,12 +2772,6 @@ interface RevoApi {
             };
         };
     }>;
-    sftpExec(commands: any[], config: SFTPClient): Promise<any>;
-    sftpPut(source: SFTPFileSourceRef, path: string, config: SFTPClient): Promise<void>;
-    sftpGet(target: SFTPFileTargetRef, path: string, config: SFTPClient): Promise<void | {
-        session: StorageUploadSession;
-        entry: StorageEntryView;
-    }>;
 }
 interface RevoStorage {
     explore(query?: StorageExploreRequest): Promise<StorageExploreResult>;
@@ -2876,6 +2833,14 @@ interface RevoStorage {
     getDocument(storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
     getDocument(namespace: string, storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
 }
+interface RevoTransport {
+    sftpImport(path: string, storage: SFTPImportStorage, secretNameOrId: string): Promise<{
+        session: StorageUploadSession;
+        entry: StorageEntryView;
+    }>;
+    sftpExport(path: string, storage: SFTPExportStorage, secretNameOrId: string): Promise<void>;
+    sftpCommands(commands: any[], secretNameOrId: string): Promise<any>;
+}
 interface RevoAgents {
     list(): Promise<Agent[]>;
     get(agentId: string): Promise<Agent>;
@@ -2903,11 +2868,6 @@ interface RevoAgents {
         hideDeleted?: boolean;
     }): Promise<AssistantThread>;
     getThreadState(assistantThreadId: string): Promise<AssistantThreadState>;
-    getThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal | null>;
-    setThreadGoal(assistantThreadId: string, data: AssistantThreadGoalInput): Promise<AssistantThreadGoal>;
-    pauseThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
-    resumeThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
-    clearThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
     getThreadShare(assistantThreadId: string): Promise<AssistantThreadShare | null>;
     enableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
     disableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
@@ -3119,6 +3079,7 @@ interface RevoRuntime {
     readonly api: RevoApi;
     readonly utils: RevoUtils;
     readonly storage: RevoStorage;
+    readonly transport: RevoTransport;
     readonly agents: RevoAgents;
     readonly execute: RevoExecute;
     readonly batch: RevoBatchController;
@@ -3216,4 +3177,4 @@ declare class RevoHttpResponseError extends RevoError {
     constructor(statusCode: number, body?: unknown);
 }
 
-export { RevoTransportError as A, type BatchFailureMode as B, CONTRACT_REVISION as C, type RuntimeBatchRequest as D, type RuntimeBatchResponse as E, type RuntimeCall as F, type RuntimeCallResult as G, type HostedRuntimeBootstrap as H, type SerializedRevoError as I, PROTOCOL_VERSION as P, type RevoRuntime as R, SDK_VERSION as S, RevoExecutionExit as a, RevoHttpResponseError as b, type RevoRuntimeBridgeRequest as c, type RevoRuntimeBridgeResponse as d, type RevoRuntimeBridgeTransportError as e, type RevoStandaloneApi as f, type RevoUtils as g, type RevoStorage as h, type RevoAgents as i, type RevoExecute as j, type RevoBatchController as k, type RevoClientOptions as l, type RevoApi as m, RevoAuthenticationError as n, RevoBatchConfigurationError as o, RevoBatchLimitError as p, type RevoBatchLimits as q, type RevoBatchOptions as r, RevoConfigurationError as s, RevoError as t, type RevoExecuteOptions as u, type RevoExecutionDefaults as v, RevoPermissionDeniedError as w, RevoProtocolError as x, RevoRemoteError as y, RevoRuntimeContextUnavailableError as z };
+export { RevoRuntimeContextUnavailableError as A, type BatchFailureMode as B, CONTRACT_REVISION as C, RevoTransportError as D, type RuntimeBatchRequest as E, type RuntimeBatchResponse as F, type RuntimeCall as G, type HostedRuntimeBootstrap as H, type RuntimeCallResult as I, type SerializedRevoError as J, PROTOCOL_VERSION as P, type RevoRuntime as R, SDK_VERSION as S, RevoExecutionExit as a, RevoHttpResponseError as b, type RevoRuntimeBridgeRequest as c, type RevoRuntimeBridgeResponse as d, type RevoRuntimeBridgeTransportError as e, type RevoStandaloneApi as f, type RevoUtils as g, type RevoStorage as h, type RevoTransport as i, type RevoAgents as j, type RevoExecute as k, type RevoBatchController as l, type RevoClientOptions as m, type RevoApi as n, RevoAuthenticationError as o, RevoBatchConfigurationError as p, RevoBatchLimitError as q, type RevoBatchLimits as r, type RevoBatchOptions as s, RevoConfigurationError as t, RevoError as u, type RevoExecuteOptions as v, type RevoExecutionDefaults as w, RevoPermissionDeniedError as x, RevoProtocolError as y, RevoRemoteError as z };

package/dist/{errors-BmtftjgL.d.ts → errors-XTYAxN-H.d.ts}

@@ -1,9 +1,9 @@
 import * as node_worker_threads from 'node:worker_threads';
 
-declare const SDK_VERSION: "1.5.5";
+declare const SDK_VERSION: "1.5.6";
 declare const PROTOCOL_VERSION: 1;
-declare const CONTRACT_REVISION: "b98c007dbeaf81bb88ab29f6b4b699e85a4f8b1eb5a36f08701ec1cbd553089f";
-type RuntimeSurfaceName = 'api' | 'storage' | 'agents' | 'lowCode';
+declare const CONTRACT_REVISION: "8a1f8936cd7f3b2e9d418a0676e02024b3dd54c3d2aa721d698b0c3ea66bbf04";
+type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'agents' | 'lowCode';
 
 // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
 // Sources: api.swagger-contracts.generated.d.ts, api.public.d.ts
@@ -922,20 +922,6 @@ interface StorageEntryUpdateInput {
     /** Current entity version. */
     "version"?: number;
 }
-interface AssistantThreadGoalInput {
-    /** Durable thread-level objective used to validate assistant completion across turns, tool loops, approval resumes, and compaction. */
-    "objective": string;
-    /** Optional concrete criteria the goal reviewer should require before marking the goal satisfied. */
-    "successCriteria"?: Array<string>;
-    /** Optional exclusions that should not be treated as required work for this goal. */
-    "nonGoals"?: Array<string>;
-    /** Optional evidence the reviewer should expect, such as tests, lint, screenshots, API results, or changed resources. */
-    "requiredEvidence"?: Array<string>;
-    /** Optional validation commands or checks relevant to this goal. */
-    "validationCommands"?: Array<string>;
-    /** Optional concise definition of done used by the reviewer when evaluating candidate completion. */
-    "doneDefinition"?: string;
-}
 interface AssistantThreadTitleInput {
     /** New user-defined title for the thread. */
     "title": string;
@@ -2098,26 +2084,22 @@ interface InstanceData {
         id: string;
     };
 }
-interface SFTPClient {
-    host: string;
-    port: number;
-    username: string;
-    password?: string;
-    privateKey?: string;
-    passphrase?: string;
-}
 interface StorageFileTargetRequest extends Omit<StorageUploadSessionInput, 'replaceStorageEntryId' | 'uploadMode'> {
     name: string;
 }
-type SFTPFileSourceRef = {
+/** Storage destination for transport.sftpImport. Uses the same namespace and ACL contract as storage.* and HTTP targets. */
+type SFTPImportStorage = (StorageFileTargetRequest & {
+    namespace?: string;
+}) | {
     storageEntryId: string;
+    namespace?: string;
+    replace: true;
 };
-type SFTPFileTargetRef = {
+/** Existing Storage file used by transport.sftpExport. */
+interface SFTPExportStorage {
     storageEntryId: string;
-    replace?: true;
-} | {
-    storage: StorageFileTargetRequest;
-};
+    namespace?: string;
+}
 interface JWTHeader {
     alg: string | 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' | 'ES256' | 'ES384' | 'ES512' | 'PS256' | 'PS384' | 'PS512' | 'none';
     typ?: string | undefined;
@@ -2592,7 +2574,6 @@ interface AssistantThread {
     actionRequired?: AssistantActionRequired | null;
     executionPlan?: AssistantPublicExecutionPlan | null;
     workerProgress?: AssistantWorkerProgress[] | null;
-    goal?: AssistantThreadGoal | null;
     share?: AssistantThreadShare | null;
     createdBy?: string;
     createdAt?: Date | string;
@@ -2602,23 +2583,6 @@ interface AssistantThread {
     deletedAt?: Date | string | null;
     version?: number;
 }
-interface AssistantThreadGoal {
-    version: 1;
-    assistantThreadId: string;
-    revision: number;
-    status: 'active' | 'paused' | 'completed' | 'blocked' | 'cleared';
-    objective: string | null;
-    source: 'user' | 'api' | 'message' | 'system';
-    createdAt: string;
-    updatedAt: string;
-    updatedBy: string | null;
-    validation: {
-        status: 'satisfied' | 'unsatisfied' | 'partial' | 'skipped';
-        reviewedAt: string;
-        rationale: string | null;
-        evidenceRefs?: string[];
-    } | null;
-}
 interface AssistantMessage {
     assistantMessageId: string;
     assistantThreadId: string;
@@ -2635,7 +2599,6 @@ interface AssistantThreadState {
     actionRequired: AssistantActionRequired | null;
     executionPlan: AssistantPublicExecutionPlan | null;
     workerProgress?: AssistantWorkerProgress[] | null;
-    goal?: AssistantThreadGoal | null;
 }
 interface AssistantThreadShare {
     shareId: string;
@@ -2809,12 +2772,6 @@ interface RevoApi {
             };
         };
     }>;
-    sftpExec(commands: any[], config: SFTPClient): Promise<any>;
-    sftpPut(source: SFTPFileSourceRef, path: string, config: SFTPClient): Promise<void>;
-    sftpGet(target: SFTPFileTargetRef, path: string, config: SFTPClient): Promise<void | {
-        session: StorageUploadSession;
-        entry: StorageEntryView;
-    }>;
 }
 interface RevoStorage {
     explore(query?: StorageExploreRequest): Promise<StorageExploreResult>;
@@ -2876,6 +2833,14 @@ interface RevoStorage {
     getDocument(storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
     getDocument(namespace: string, storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
 }
+interface RevoTransport {
+    sftpImport(path: string, storage: SFTPImportStorage, secretNameOrId: string): Promise<{
+        session: StorageUploadSession;
+        entry: StorageEntryView;
+    }>;
+    sftpExport(path: string, storage: SFTPExportStorage, secretNameOrId: string): Promise<void>;
+    sftpCommands(commands: any[], secretNameOrId: string): Promise<any>;
+}
 interface RevoAgents {
     list(): Promise<Agent[]>;
     get(agentId: string): Promise<Agent>;
@@ -2903,11 +2868,6 @@ interface RevoAgents {
         hideDeleted?: boolean;
     }): Promise<AssistantThread>;
     getThreadState(assistantThreadId: string): Promise<AssistantThreadState>;
-    getThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal | null>;
-    setThreadGoal(assistantThreadId: string, data: AssistantThreadGoalInput): Promise<AssistantThreadGoal>;
-    pauseThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
-    resumeThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
-    clearThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
     getThreadShare(assistantThreadId: string): Promise<AssistantThreadShare | null>;
     enableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
     disableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
@@ -3119,6 +3079,7 @@ interface RevoRuntime {
     readonly api: RevoApi;
     readonly utils: RevoUtils;
     readonly storage: RevoStorage;
+    readonly transport: RevoTransport;
     readonly agents: RevoAgents;
     readonly execute: RevoExecute;
     readonly batch: RevoBatchController;
@@ -3216,4 +3177,4 @@ declare class RevoHttpResponseError extends RevoError {
     constructor(statusCode: number, body?: unknown);
 }
 
-export { RevoTransportError as A, type BatchFailureMode as B, CONTRACT_REVISION as C, type RuntimeBatchRequest as D, type RuntimeBatchResponse as E, type RuntimeCall as F, type RuntimeCallResult as G, type HostedRuntimeBootstrap as H, type SerializedRevoError as I, PROTOCOL_VERSION as P, type RevoRuntime as R, SDK_VERSION as S, RevoExecutionExit as a, RevoHttpResponseError as b, type RevoRuntimeBridgeRequest as c, type RevoRuntimeBridgeResponse as d, type RevoRuntimeBridgeTransportError as e, type RevoStandaloneApi as f, type RevoUtils as g, type RevoStorage as h, type RevoAgents as i, type RevoExecute as j, type RevoBatchController as k, type RevoClientOptions as l, type RevoApi as m, RevoAuthenticationError as n, RevoBatchConfigurationError as o, RevoBatchLimitError as p, type RevoBatchLimits as q, type RevoBatchOptions as r, RevoConfigurationError as s, RevoError as t, type RevoExecuteOptions as u, type RevoExecutionDefaults as v, RevoPermissionDeniedError as w, RevoProtocolError as x, RevoRemoteError as y, RevoRuntimeContextUnavailableError as z };
+export { RevoRuntimeContextUnavailableError as A, type BatchFailureMode as B, CONTRACT_REVISION as C, RevoTransportError as D, type RuntimeBatchRequest as E, type RuntimeBatchResponse as F, type RuntimeCall as G, type HostedRuntimeBootstrap as H, type RuntimeCallResult as I, type SerializedRevoError as J, PROTOCOL_VERSION as P, type RevoRuntime as R, SDK_VERSION as S, RevoExecutionExit as a, RevoHttpResponseError as b, type RevoRuntimeBridgeRequest as c, type RevoRuntimeBridgeResponse as d, type RevoRuntimeBridgeTransportError as e, type RevoStandaloneApi as f, type RevoUtils as g, type RevoStorage as h, type RevoTransport as i, type RevoAgents as j, type RevoExecute as k, type RevoBatchController as l, type RevoClientOptions as m, type RevoApi as n, RevoAuthenticationError as o, RevoBatchConfigurationError as p, RevoBatchLimitError as q, type RevoBatchLimits as r, type RevoBatchOptions as s, RevoConfigurationError as t, RevoError as u, type RevoExecuteOptions as v, type RevoExecutionDefaults as w, RevoPermissionDeniedError as x, RevoProtocolError as y, RevoRemoteError as z };