@revoengine/sdk 1.5.7 → 1.5.8

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,7 +6,7 @@ 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.5.8 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
@@ -59,7 +59,7 @@ RevoEngine pins that version again in the deployment package and injects the
59
59
  runtime into the component entrypoint. Component code does not construct a
60
60
  `RevoClient`.
61
61
 
62
- The platform chooses the hosted package version; publishing SDK 1.5.7 does not
62
+ The platform chooses the hosted package version; publishing SDK 1.5.8 does not
63
63
  upgrade existing hosted deployments or their generated package pins.
64
64
 
65
65
  Hosted user code receives neither a tenant API key nor the private runtime
@@ -1,8 +1,8 @@
1
1
  import * as node_worker_threads from 'node:worker_threads';
2
2
 
3
- declare const SDK_VERSION: "1.5.7";
3
+ declare const SDK_VERSION: "1.5.8";
4
4
  declare const PROTOCOL_VERSION: 1;
5
- declare const CONTRACT_REVISION: "6e40b0c7b8650b52573b3ea81cb1b0b67e62cdb4c342c6b33c3021c26af496d0";
5
+ declare const CONTRACT_REVISION: "a73e7d84863d5a511a6f5569a72ab8d156bd11f84471fabdee9b8b633c11e58d";
6
6
  type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'agents' | 'lowCode';
7
7
 
8
8
  // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
@@ -1567,14 +1567,20 @@ interface HttpRequestOptionsInterface {
1567
1567
  /**
1568
1568
  * JSON handling is the default. `requestType: 'json'` and `responseType: 'json'` may be stated together
1569
1569
  * when an integration should expose an explicit, self-documenting JSON contract.
1570
+ * Use `buffer` explicitly for binary data: requests accept Buffer/Uint8Array and responses return Buffer.
1571
+ * `base64buffer` retains its string contract. Keep JSON as JSON; converting it to bytes is unnecessary.
1570
1572
  */
1571
1573
  //@default: 'json'
1572
- responseType?: 'json' | 'base64buffer' | 'document' | 'text' | 'storage';
1574
+ responseType?: 'json' | 'buffer' | 'base64buffer' | 'document' | 'text' | 'storage';
1573
1575
  //@default: 'json'
1574
- requestType?: 'json' | 'base64buffer' | 'form-data' | 'text' | 'storage';
1576
+ requestType?: 'json' | 'buffer' | 'base64buffer' | 'form-data' | 'text' | 'storage';
1575
1577
  //@default: false
1576
1578
  currentCredentials?: boolean;
1577
1579
  }
1580
+ interface HttpRevoResponseScope {
1581
+ sameInstance: boolean;
1582
+ operationId?: string;
1583
+ }
1578
1584
  interface HttpRequestInterface {
1579
1585
  url: string;
1580
1586
  method: 'POST' | 'PUT' | 'DELETE' | 'GET' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'PURGE' | 'LINK' | 'UNLINK';
@@ -1687,6 +1693,8 @@ interface StorageUploadSessionPart {
1687
1693
  interface StorageUploadPartResult {
1688
1694
  storageUploadSessionId: string;
1689
1695
  partNumber: number;
1696
+ /** UPLOADED after provider acceptance; RETRY_WAIT/UPLOADING remains durably queued by the platform. */
1697
+ status: 'UPLOADED' | 'UPLOADING' | 'RETRY_WAIT' | null;
1690
1698
  size: number;
1691
1699
  checksumMd5: string | null;
1692
1700
  }
@@ -2729,9 +2737,7 @@ interface RevoApi {
2729
2737
  setCache(key: string, value: any): void;
2730
2738
  getContext(): Context;
2731
2739
  getErrors(): ProcessLog[];
2732
- getWarnings(): ProcessLog[];
2733
2740
  getExecutionId(): string;
2734
- getLogs(): LooseObject<any>[];
2735
2741
  getOperationId(): string;
2736
2742
  executeComponent<T = LooseObject<any>>(request: ComponentExecuteRequest): Promise<ComponentExecuteResult<T>>;
2737
2743
  input(name?: string): Input;
@@ -2780,6 +2786,7 @@ interface RevoApi {
2780
2786
  statusText: string;
2781
2787
  time: number;
2782
2788
  headers: LooseObject<string>;
2789
+ revo?: HttpRevoResponseScope;
2783
2790
  request: {
2784
2791
  config: HttpRequestInterface;
2785
2792
  options: HttpRequestOptionsInterface;
@@ -2802,6 +2809,7 @@ interface RevoApi {
2802
2809
  statusText: string;
2803
2810
  time: number;
2804
2811
  headers: LooseObject<string>;
2812
+ revo?: HttpRevoResponseScope;
2805
2813
  data: any;
2806
2814
  storage?: {
2807
2815
  session: StorageUploadSession;
@@ -2835,8 +2843,8 @@ interface RevoStorage {
2835
2843
  getEntry(namespace: string, storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
2836
2844
  createFolder(data: StorageFolderInput): Promise<StorageEntryView>;
2837
2845
  createFolder(namespace: string, data: StorageFolderInput): Promise<StorageEntryView>;
2838
- putObject(data: StoragePutObjectInput): Promise<StorageEntryView>;
2839
- putObject(namespace: string, data: StoragePutObjectInput): Promise<StorageEntryView>;
2846
+ putObject(data: StorageBinaryPutObjectInput): Promise<StorageEntryView>;
2847
+ putObject(namespace: string, data: StorageBinaryPutObjectInput): Promise<StorageEntryView>;
2840
2848
  createUploadSession(data: StorageUploadSessionInput): Promise<{
2841
2849
  session: StorageUploadSession;
2842
2850
  upload: StorageUploadTarget;
@@ -2849,8 +2857,8 @@ interface RevoStorage {
2849
2857
  extendUploadSession(namespace: string, storageUploadSessionId: string): Promise<StorageUploadSession>;
2850
2858
  getUploadSession(storageUploadSessionId: string): Promise<StorageUploadSessionView>;
2851
2859
  getUploadSession(namespace: string, storageUploadSessionId: string): Promise<StorageUploadSessionView>;
2852
- uploadPart(storageUploadSessionId: string, partNumber: number | StorageUploadPartInput, data?: StorageUploadPartInput): Promise<StorageUploadPartResult>;
2853
- uploadPart(namespace: string, storageUploadSessionId: string, partNumber: number | StorageUploadPartInput, data?: StorageUploadPartInput): Promise<StorageUploadPartResult>;
2860
+ uploadPart(storageUploadSessionId: string, partNumber: number | StorageBinaryUploadPartInput, data?: StorageBinaryUploadPartInput): Promise<StorageUploadPartResult>;
2861
+ uploadPart(namespace: string, storageUploadSessionId: string, partNumber: number | StorageBinaryUploadPartInput, data?: StorageBinaryUploadPartInput): Promise<StorageUploadPartResult>;
2854
2862
  finalizeUploadSession(storageUploadSessionId: string, data?: StorageUploadSessionFinalizeInput): Promise<{
2855
2863
  session: StorageUploadSession;
2856
2864
  entry: StorageEntryView;
@@ -3019,6 +3027,15 @@ interface RevoUtils {
3019
3027
  rsaSign(privateKey: string, payload: string, passphrase?: string): Promise<string>;
3020
3028
  rsaVerify(publicKey: string, payload: string, signature: string): Promise<boolean>;
3021
3029
  }
3030
+ /** Low-code byte payloads; REST JSON callers retain the base64 option. */
3031
+ /** Text arrays retain their existing joining rules; bytes are snapshotted before asynchronous upload. */
3032
+ type StorageBinaryPutObjectInput = Omit<StoragePutObjectInput, 'data'> & {
3033
+ data: string | string[] | Uint8Array | Buffer;
3034
+ };
3035
+ /** Bytes need no base64 encoding. One call remains one logical part, including retry/checksum/finalize. */
3036
+ type StorageBinaryUploadPartInput = Omit<StorageUploadPartInput, 'data'> & {
3037
+ data?: string | string[] | Uint8Array | Buffer;
3038
+ };
3022
3039
  /**
3023
3040
  * Source language for an ad-hoc low-code execution.
3024
3041
  */
@@ -1,8 +1,8 @@
1
1
  import * as node_worker_threads from 'node:worker_threads';
2
2
 
3
- declare const SDK_VERSION: "1.5.7";
3
+ declare const SDK_VERSION: "1.5.8";
4
4
  declare const PROTOCOL_VERSION: 1;
5
- declare const CONTRACT_REVISION: "6e40b0c7b8650b52573b3ea81cb1b0b67e62cdb4c342c6b33c3021c26af496d0";
5
+ declare const CONTRACT_REVISION: "a73e7d84863d5a511a6f5569a72ab8d156bd11f84471fabdee9b8b633c11e58d";
6
6
  type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'agents' | 'lowCode';
7
7
 
8
8
  // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
@@ -1567,14 +1567,20 @@ interface HttpRequestOptionsInterface {
1567
1567
  /**
1568
1568
  * JSON handling is the default. `requestType: 'json'` and `responseType: 'json'` may be stated together
1569
1569
  * when an integration should expose an explicit, self-documenting JSON contract.
1570
+ * Use `buffer` explicitly for binary data: requests accept Buffer/Uint8Array and responses return Buffer.
1571
+ * `base64buffer` retains its string contract. Keep JSON as JSON; converting it to bytes is unnecessary.
1570
1572
  */
1571
1573
  //@default: 'json'
1572
- responseType?: 'json' | 'base64buffer' | 'document' | 'text' | 'storage';
1574
+ responseType?: 'json' | 'buffer' | 'base64buffer' | 'document' | 'text' | 'storage';
1573
1575
  //@default: 'json'
1574
- requestType?: 'json' | 'base64buffer' | 'form-data' | 'text' | 'storage';
1576
+ requestType?: 'json' | 'buffer' | 'base64buffer' | 'form-data' | 'text' | 'storage';
1575
1577
  //@default: false
1576
1578
  currentCredentials?: boolean;
1577
1579
  }
1580
+ interface HttpRevoResponseScope {
1581
+ sameInstance: boolean;
1582
+ operationId?: string;
1583
+ }
1578
1584
  interface HttpRequestInterface {
1579
1585
  url: string;
1580
1586
  method: 'POST' | 'PUT' | 'DELETE' | 'GET' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'PURGE' | 'LINK' | 'UNLINK';
@@ -1687,6 +1693,8 @@ interface StorageUploadSessionPart {
1687
1693
  interface StorageUploadPartResult {
1688
1694
  storageUploadSessionId: string;
1689
1695
  partNumber: number;
1696
+ /** UPLOADED after provider acceptance; RETRY_WAIT/UPLOADING remains durably queued by the platform. */
1697
+ status: 'UPLOADED' | 'UPLOADING' | 'RETRY_WAIT' | null;
1690
1698
  size: number;
1691
1699
  checksumMd5: string | null;
1692
1700
  }
@@ -2729,9 +2737,7 @@ interface RevoApi {
2729
2737
  setCache(key: string, value: any): void;
2730
2738
  getContext(): Context;
2731
2739
  getErrors(): ProcessLog[];
2732
- getWarnings(): ProcessLog[];
2733
2740
  getExecutionId(): string;
2734
- getLogs(): LooseObject<any>[];
2735
2741
  getOperationId(): string;
2736
2742
  executeComponent<T = LooseObject<any>>(request: ComponentExecuteRequest): Promise<ComponentExecuteResult<T>>;
2737
2743
  input(name?: string): Input;
@@ -2780,6 +2786,7 @@ interface RevoApi {
2780
2786
  statusText: string;
2781
2787
  time: number;
2782
2788
  headers: LooseObject<string>;
2789
+ revo?: HttpRevoResponseScope;
2783
2790
  request: {
2784
2791
  config: HttpRequestInterface;
2785
2792
  options: HttpRequestOptionsInterface;
@@ -2802,6 +2809,7 @@ interface RevoApi {
2802
2809
  statusText: string;
2803
2810
  time: number;
2804
2811
  headers: LooseObject<string>;
2812
+ revo?: HttpRevoResponseScope;
2805
2813
  data: any;
2806
2814
  storage?: {
2807
2815
  session: StorageUploadSession;
@@ -2835,8 +2843,8 @@ interface RevoStorage {
2835
2843
  getEntry(namespace: string, storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
2836
2844
  createFolder(data: StorageFolderInput): Promise<StorageEntryView>;
2837
2845
  createFolder(namespace: string, data: StorageFolderInput): Promise<StorageEntryView>;
2838
- putObject(data: StoragePutObjectInput): Promise<StorageEntryView>;
2839
- putObject(namespace: string, data: StoragePutObjectInput): Promise<StorageEntryView>;
2846
+ putObject(data: StorageBinaryPutObjectInput): Promise<StorageEntryView>;
2847
+ putObject(namespace: string, data: StorageBinaryPutObjectInput): Promise<StorageEntryView>;
2840
2848
  createUploadSession(data: StorageUploadSessionInput): Promise<{
2841
2849
  session: StorageUploadSession;
2842
2850
  upload: StorageUploadTarget;
@@ -2849,8 +2857,8 @@ interface RevoStorage {
2849
2857
  extendUploadSession(namespace: string, storageUploadSessionId: string): Promise<StorageUploadSession>;
2850
2858
  getUploadSession(storageUploadSessionId: string): Promise<StorageUploadSessionView>;
2851
2859
  getUploadSession(namespace: string, storageUploadSessionId: string): Promise<StorageUploadSessionView>;
2852
- uploadPart(storageUploadSessionId: string, partNumber: number | StorageUploadPartInput, data?: StorageUploadPartInput): Promise<StorageUploadPartResult>;
2853
- uploadPart(namespace: string, storageUploadSessionId: string, partNumber: number | StorageUploadPartInput, data?: StorageUploadPartInput): Promise<StorageUploadPartResult>;
2860
+ uploadPart(storageUploadSessionId: string, partNumber: number | StorageBinaryUploadPartInput, data?: StorageBinaryUploadPartInput): Promise<StorageUploadPartResult>;
2861
+ uploadPart(namespace: string, storageUploadSessionId: string, partNumber: number | StorageBinaryUploadPartInput, data?: StorageBinaryUploadPartInput): Promise<StorageUploadPartResult>;
2854
2862
  finalizeUploadSession(storageUploadSessionId: string, data?: StorageUploadSessionFinalizeInput): Promise<{
2855
2863
  session: StorageUploadSession;
2856
2864
  entry: StorageEntryView;
@@ -3019,6 +3027,15 @@ interface RevoUtils {
3019
3027
  rsaSign(privateKey: string, payload: string, passphrase?: string): Promise<string>;
3020
3028
  rsaVerify(publicKey: string, payload: string, signature: string): Promise<boolean>;
3021
3029
  }
3030
+ /** Low-code byte payloads; REST JSON callers retain the base64 option. */
3031
+ /** Text arrays retain their existing joining rules; bytes are snapshotted before asynchronous upload. */
3032
+ type StorageBinaryPutObjectInput = Omit<StoragePutObjectInput, 'data'> & {
3033
+ data: string | string[] | Uint8Array | Buffer;
3034
+ };
3035
+ /** Bytes need no base64 encoding. One call remains one logical part, including retry/checksum/finalize. */
3036
+ type StorageBinaryUploadPartInput = Omit<StorageUploadPartInput, 'data'> & {
3037
+ data?: string | string[] | Uint8Array | Buffer;
3038
+ };
3022
3039
  /**
3023
3040
  * Source language for an ad-hoc low-code execution.
3024
3041
  */