@revoengine/sdk 1.6.6 → 1.6.7

package/README.md

@@ -8,13 +8,19 @@ 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.6 compatibility
+## SDK 1.6.7 compatibility
 
 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 the SDK version supported by the target platform deployment until its contract is upgraded.
 
+Storage declarations include physical-line reads, quote-disabled CSV dialects,
+per-record byte limits, and the opt-in `onError: 'skipRow'` read policy. That policy
+skips records with the wrong source column count and returns bounded locations in
+`csvReport`; syntax and record-size errors still abort. The report describes the
+whole source and must not be summed across pages.
+
 HTTP Storage requests/responses now use `requestType: 'storage'` and
 `responseType: 'storage'`, with flat Storage-only `source` / `target` objects.
 Legacy HTTP Files references and the old Storage `stream` mode are rejected.
@@ -30,7 +36,7 @@ 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/low-code/sftp)
 for Secret formats and file-transfer examples.
 
-SDK 1.6.6 retains portable Component digest declarations and one readable-relation
+SDK 1.6.7 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
@@ -81,7 +87,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 1.6.6 does not
+The platform chooses the hosted package version; publishing SDK 1.6.7 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-wZ8wrU3c.d.cts → errors-Cdksdvcb.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.6";
+declare const SDK_VERSION: "1.6.7";
 declare const PROTOCOL_VERSION: 1;
-declare const CONTRACT_REVISION: "d2b7e94d335d87dd070d2a97a043704b61b8c8d5c28435c20aceeda9581b70e4";
+declare const CONTRACT_REVISION: "a9de5c146fcadb896de690ab28be48926ff24e0ec0d518182763750fb8ce0453";
 type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'vault' | 'serviceAccount' | 'agents' | 'lowCode';
 
 // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
@@ -587,6 +587,8 @@ interface SwaggerStorageCellInputDto {
     "style"?: Record<string, unknown>;
 }
 interface SwaggerStorageCsvOptionsDto {
+    /** CSV read/index policy. abort rejects invalid records; skipRow skips only source field-count mismatches and reports their count and locations. Syntax and oversized-record errors always abort. */
+    "onError"?: "abort" | "skipRow";
     /** Output character encoding. Input encoding is detected when omitted. */
     "encoding"?: string;
     /** Emit a byte order mark at the start of the file. */
@@ -595,9 +597,11 @@ interface SwaggerStorageCsvOptionsDto {
     "delimiter"?: string;
     /** Record delimiter. */
     "recordDelimiter"?: "\n" | "\r" | "\r\n";
-    /** Quote character. */
-    "quote"?: string;
-    /** Quote escape character. */
+    /** Quote character, default double quote. Set false to disable CSV quoting; quotes and backslashes then remain literal and escape is ignored. */
+    "quote"?: string | false;
+    /** Maximum source bytes in one logical CSV record, including multiline quoted fields. Defaults to 64 MiB; independent of callback/read batch size. Larger records reject indexing with STORAGE_CSV_INVALID and a RecordTooLarge diagnostic. */
+    "maxRecordBytes"?: number;
+    /** Quote escape character. Ignored when quote is false. */
     "escape"?: string;
     /** Prefix spreadsheet formula-like values to prevent CSV formula injection. */
     "escapeFormulae"?: boolean;
@@ -654,7 +658,7 @@ interface SwaggerStorageSheetTableDto {
 interface SwaggerStorageTabularSchemaPolicyDto {
     /** How missing sheets or columns and invalid declared values are handled. fallback retains imperfect data with diagnostics; strict fails structured indexing. Defaults to fallback. */
     "profile"?: "fallback" | "strict";
-    /** How undeclared source columns are handled. allow retains them, strip omits them from structured rows, and reject fails indexing. Defaults to allow for fallback and reject for strict. The raw file is preserved. */
+    /** How undeclared source columns are handled. allow retains them, strip omits them from structured rows, and reject fails indexing. Defaults to allow for fallback and reject for strict. Already committed files retain their raw bytes; synchronous validation failures before publication do not create a readable entry. */
     "additionalProperties"?: "allow" | "strip" | "reject";
 }
 interface SwaggerUpdateServiceAccountAccessDto {
@@ -1939,6 +1943,10 @@ interface StorageEntryView extends StorageEntry {
     breadcrumbs: StorageBreadcrumb[];
 }
 interface StorageExploreRequest {
+    /** Disable implicit parent-folder scoping; ACL and namespace checks still apply. */
+    flat?: boolean;
+    filter?: SelectFilterNode;
+    sort?: string[] | Record<string, SortDir>;
     parentStorageEntryId?: string;
     storageProviderConfigId?: string | null;
     term?: string;
@@ -2055,7 +2063,27 @@ interface StorageDocument {
     totalLines?: number;
     truncated?: boolean;
 }
+/** Whole-source CSV mismatch report. Repeated on pages; do not sum page reports. No raw values. */
+interface StorageCsvReadReport {
+    skippedRows: number;
+    diagnostics: Array<{
+        code: string;
+        recordNumber: number;
+        lineStart: number;
+        lineEnd: number;
+        startByte: number;
+        expectedFieldCount?: number;
+        actualFieldCount?: number;
+        message: string;
+    }>;
+    diagnosticsTruncated: boolean;
+}
 interface StorageFileReadOptions {
+    /** CSV only. Default abort. skipRow drops wrong-width source records; syntax/size errors still abort. */
+    onError?: 'abort' | 'skipRow';
+    /** Physical lines include headers and the trailing empty line. Defaults to records. */
+    mode?: 'records' | 'lines';
+    separator?: string;
     batchNumber?: number;
     buffer?: boolean;
     start?: number;
@@ -2070,7 +2098,11 @@ interface StorageFileReadOptions {
     encoding?: string;
     delimiter?: string;
     recordDelimiter?: '\n' | '\r' | '\r\n';
-    quote?: string;
+    /** One quote character (default double quote), or false for literal quotes/backslashes. */
+    quote?: string | false;
+    /** Maximum bytes in one logical CSV record; positive integer, default 64 MiB. Independent of read/callback size. */
+    maxRecordBytes?: number;
+    /** Quote escape character; ignored when quote is false. */
     escape?: string;
     /** XML record path such as `Orders/Order`; required for XML row reads. */
     recordPath?: string;
@@ -2086,11 +2118,18 @@ interface StorageFileReadOptions {
     }>;
 }
 interface StorageFileStatsOptions {
+    /** CSV only. Default abort. skipRow drops wrong-width source records; syntax/size errors still abort. */
+    onError?: 'abort' | 'skipRow';
+    mode?: 'records' | 'lines';
     separator?: string;
     encoding?: string;
     delimiter?: string;
     recordDelimiter?: '\n' | '\r' | '\r\n';
-    quote?: string;
+    /** One quote character (default double quote), or false for literal quotes/backslashes. */
+    quote?: string | false;
+    /** Maximum bytes in one logical CSV record; positive integer, default 64 MiB. Independent of read/callback size. */
+    maxRecordBytes?: number;
+    /** Quote escape character; ignored when quote is false. */
     escape?: string;
     headerRow?: number | null;
     reloadStats?: boolean;
@@ -2122,7 +2161,16 @@ interface StorageTabularSchemaResult {
     issues: StorageTabularSchemaIssue[];
 }
 interface StorageFileStats {
+    /** Present for CSV indexed with onError: skipRow; describes the entire source. */
+    csvReport?: StorageCsvReadReport;
+    /** Legacy physical-window count, including the terminal empty window after a delimiter. */
     lineCount?: number;
+    /** Actual physical lines, including headers, blanks and multiline CSV field lines; no terminal synthetic empty line. */
+    physicalLineCount?: number;
+    /** Empty physical lines, excluding the synthetic terminal empty line. */
+    blankLineCount?: number;
+    /** Whether the source ends in its detected or explicit record delimiter. */
+    endsWithRecordDelimiter?: boolean;
     map?: LooseObject<number>;
     separator?: string;
     batches?: number;
@@ -2133,7 +2181,11 @@ interface StorageFileStats {
     bom?: boolean;
     delimiter?: string;
     recordDelimiter?: string;
-    quote?: string;
+    /** One quote character (default double quote), or false for literal quotes/backslashes. */
+    quote?: string | false;
+    /** Maximum bytes in one logical CSV record; positive integer, default 64 MiB. Independent of read/callback size. */
+    maxRecordBytes?: number;
+    /** Quote escape character; ignored when quote is false. */
     escape?: string;
     rowCount?: number;
     headers?: StorageTabularColumn[];
@@ -2148,6 +2200,7 @@ interface StorageFileStats {
     }>;
 }
 interface StorageStructuredFileDataPage {
+    csvReport?: StorageCsvReadReport;
     format: 'csv' | 'xlsx' | 'ndjson' | 'json-array' | 'xml';
     sheet: string | null;
     headers: StorageTabularColumn[];
@@ -3330,10 +3383,10 @@ interface RevoApi {
     acquireIdempotencyKey(key: string, ttl: number, value?: any): Promise<boolean>;
     getIdempotencyKey(key: string): Promise<any>;
     releaseIdempotencyKey(key: string): Promise<void>;
-    concurrencyLimit(key: string, limit: number, ttl: number): Promise<boolean>;
+    concurrencyLimit(key: string, limit: number, ttl: number, leaseOwnerId?: string): Promise<boolean>;
     rateLimit(key: string, limit: number, ttl: number): Promise<boolean>;
     releaseRateLimit(key: string): Promise<void>;
-    releaseConcurrencyLimit(key: string): Promise<void>;
+    releaseConcurrencyLimit(key: string, leaseOwnerId?: string): Promise<void>;
     triggerEvent(name: string, message: any, options?: TriggerEventOptions): Promise<string>;
     triggerTarget(targetType: ExecutionTargetType, targetId: string, input?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
     triggerJob(templateIdOrName: string, templateInputs?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
@@ -3463,8 +3516,8 @@ interface RevoStorage {
     restoreEntry(namespace: string, storageEntryId: string, data: StorageRestoreInput): Promise<StorageEntryView>;
     deleteEntry(storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
     deleteEntry(namespace: string, storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
-    getDownload(storageEntryId: string, preview?: boolean): Promise<StorageDownload>;
-    getDownload(namespace: string, storageEntryId: string, preview?: boolean): Promise<StorageDownload>;
+    getDownload(storageEntryId: string, preview?: boolean, ttlSeconds?: number): Promise<StorageDownload>;
+    getDownload(namespace: string, storageEntryId: string, preview?: boolean, ttlSeconds?: number): Promise<StorageDownload>;
     getDocument(storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
     getDocument(namespace: string, storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
 }

package/dist/{errors-wZ8wrU3c.d.ts → errors-Cdksdvcb.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.6";
+declare const SDK_VERSION: "1.6.7";
 declare const PROTOCOL_VERSION: 1;
-declare const CONTRACT_REVISION: "d2b7e94d335d87dd070d2a97a043704b61b8c8d5c28435c20aceeda9581b70e4";
+declare const CONTRACT_REVISION: "a9de5c146fcadb896de690ab28be48926ff24e0ec0d518182763750fb8ce0453";
 type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'vault' | 'serviceAccount' | 'agents' | 'lowCode';
 
 // AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
@@ -587,6 +587,8 @@ interface SwaggerStorageCellInputDto {
     "style"?: Record<string, unknown>;
 }
 interface SwaggerStorageCsvOptionsDto {
+    /** CSV read/index policy. abort rejects invalid records; skipRow skips only source field-count mismatches and reports their count and locations. Syntax and oversized-record errors always abort. */
+    "onError"?: "abort" | "skipRow";
     /** Output character encoding. Input encoding is detected when omitted. */
     "encoding"?: string;
     /** Emit a byte order mark at the start of the file. */
@@ -595,9 +597,11 @@ interface SwaggerStorageCsvOptionsDto {
     "delimiter"?: string;
     /** Record delimiter. */
     "recordDelimiter"?: "\n" | "\r" | "\r\n";
-    /** Quote character. */
-    "quote"?: string;
-    /** Quote escape character. */
+    /** Quote character, default double quote. Set false to disable CSV quoting; quotes and backslashes then remain literal and escape is ignored. */
+    "quote"?: string | false;
+    /** Maximum source bytes in one logical CSV record, including multiline quoted fields. Defaults to 64 MiB; independent of callback/read batch size. Larger records reject indexing with STORAGE_CSV_INVALID and a RecordTooLarge diagnostic. */
+    "maxRecordBytes"?: number;
+    /** Quote escape character. Ignored when quote is false. */
     "escape"?: string;
     /** Prefix spreadsheet formula-like values to prevent CSV formula injection. */
     "escapeFormulae"?: boolean;
@@ -654,7 +658,7 @@ interface SwaggerStorageSheetTableDto {
 interface SwaggerStorageTabularSchemaPolicyDto {
     /** How missing sheets or columns and invalid declared values are handled. fallback retains imperfect data with diagnostics; strict fails structured indexing. Defaults to fallback. */
     "profile"?: "fallback" | "strict";
-    /** How undeclared source columns are handled. allow retains them, strip omits them from structured rows, and reject fails indexing. Defaults to allow for fallback and reject for strict. The raw file is preserved. */
+    /** How undeclared source columns are handled. allow retains them, strip omits them from structured rows, and reject fails indexing. Defaults to allow for fallback and reject for strict. Already committed files retain their raw bytes; synchronous validation failures before publication do not create a readable entry. */
     "additionalProperties"?: "allow" | "strip" | "reject";
 }
 interface SwaggerUpdateServiceAccountAccessDto {
@@ -1939,6 +1943,10 @@ interface StorageEntryView extends StorageEntry {
     breadcrumbs: StorageBreadcrumb[];
 }
 interface StorageExploreRequest {
+    /** Disable implicit parent-folder scoping; ACL and namespace checks still apply. */
+    flat?: boolean;
+    filter?: SelectFilterNode;
+    sort?: string[] | Record<string, SortDir>;
     parentStorageEntryId?: string;
     storageProviderConfigId?: string | null;
     term?: string;
@@ -2055,7 +2063,27 @@ interface StorageDocument {
     totalLines?: number;
     truncated?: boolean;
 }
+/** Whole-source CSV mismatch report. Repeated on pages; do not sum page reports. No raw values. */
+interface StorageCsvReadReport {
+    skippedRows: number;
+    diagnostics: Array<{
+        code: string;
+        recordNumber: number;
+        lineStart: number;
+        lineEnd: number;
+        startByte: number;
+        expectedFieldCount?: number;
+        actualFieldCount?: number;
+        message: string;
+    }>;
+    diagnosticsTruncated: boolean;
+}
 interface StorageFileReadOptions {
+    /** CSV only. Default abort. skipRow drops wrong-width source records; syntax/size errors still abort. */
+    onError?: 'abort' | 'skipRow';
+    /** Physical lines include headers and the trailing empty line. Defaults to records. */
+    mode?: 'records' | 'lines';
+    separator?: string;
     batchNumber?: number;
     buffer?: boolean;
     start?: number;
@@ -2070,7 +2098,11 @@ interface StorageFileReadOptions {
     encoding?: string;
     delimiter?: string;
     recordDelimiter?: '\n' | '\r' | '\r\n';
-    quote?: string;
+    /** One quote character (default double quote), or false for literal quotes/backslashes. */
+    quote?: string | false;
+    /** Maximum bytes in one logical CSV record; positive integer, default 64 MiB. Independent of read/callback size. */
+    maxRecordBytes?: number;
+    /** Quote escape character; ignored when quote is false. */
     escape?: string;
     /** XML record path such as `Orders/Order`; required for XML row reads. */
     recordPath?: string;
@@ -2086,11 +2118,18 @@ interface StorageFileReadOptions {
     }>;
 }
 interface StorageFileStatsOptions {
+    /** CSV only. Default abort. skipRow drops wrong-width source records; syntax/size errors still abort. */
+    onError?: 'abort' | 'skipRow';
+    mode?: 'records' | 'lines';
     separator?: string;
     encoding?: string;
     delimiter?: string;
     recordDelimiter?: '\n' | '\r' | '\r\n';
-    quote?: string;
+    /** One quote character (default double quote), or false for literal quotes/backslashes. */
+    quote?: string | false;
+    /** Maximum bytes in one logical CSV record; positive integer, default 64 MiB. Independent of read/callback size. */
+    maxRecordBytes?: number;
+    /** Quote escape character; ignored when quote is false. */
     escape?: string;
     headerRow?: number | null;
     reloadStats?: boolean;
@@ -2122,7 +2161,16 @@ interface StorageTabularSchemaResult {
     issues: StorageTabularSchemaIssue[];
 }
 interface StorageFileStats {
+    /** Present for CSV indexed with onError: skipRow; describes the entire source. */
+    csvReport?: StorageCsvReadReport;
+    /** Legacy physical-window count, including the terminal empty window after a delimiter. */
     lineCount?: number;
+    /** Actual physical lines, including headers, blanks and multiline CSV field lines; no terminal synthetic empty line. */
+    physicalLineCount?: number;
+    /** Empty physical lines, excluding the synthetic terminal empty line. */
+    blankLineCount?: number;
+    /** Whether the source ends in its detected or explicit record delimiter. */
+    endsWithRecordDelimiter?: boolean;
     map?: LooseObject<number>;
     separator?: string;
     batches?: number;
@@ -2133,7 +2181,11 @@ interface StorageFileStats {
     bom?: boolean;
     delimiter?: string;
     recordDelimiter?: string;
-    quote?: string;
+    /** One quote character (default double quote), or false for literal quotes/backslashes. */
+    quote?: string | false;
+    /** Maximum bytes in one logical CSV record; positive integer, default 64 MiB. Independent of read/callback size. */
+    maxRecordBytes?: number;
+    /** Quote escape character; ignored when quote is false. */
     escape?: string;
     rowCount?: number;
     headers?: StorageTabularColumn[];
@@ -2148,6 +2200,7 @@ interface StorageFileStats {
     }>;
 }
 interface StorageStructuredFileDataPage {
+    csvReport?: StorageCsvReadReport;
     format: 'csv' | 'xlsx' | 'ndjson' | 'json-array' | 'xml';
     sheet: string | null;
     headers: StorageTabularColumn[];
@@ -3330,10 +3383,10 @@ interface RevoApi {
     acquireIdempotencyKey(key: string, ttl: number, value?: any): Promise<boolean>;
     getIdempotencyKey(key: string): Promise<any>;
     releaseIdempotencyKey(key: string): Promise<void>;
-    concurrencyLimit(key: string, limit: number, ttl: number): Promise<boolean>;
+    concurrencyLimit(key: string, limit: number, ttl: number, leaseOwnerId?: string): Promise<boolean>;
     rateLimit(key: string, limit: number, ttl: number): Promise<boolean>;
     releaseRateLimit(key: string): Promise<void>;
-    releaseConcurrencyLimit(key: string): Promise<void>;
+    releaseConcurrencyLimit(key: string, leaseOwnerId?: string): Promise<void>;
     triggerEvent(name: string, message: any, options?: TriggerEventOptions): Promise<string>;
     triggerTarget(targetType: ExecutionTargetType, targetId: string, input?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
     triggerJob(templateIdOrName: string, templateInputs?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
@@ -3463,8 +3516,8 @@ interface RevoStorage {
     restoreEntry(namespace: string, storageEntryId: string, data: StorageRestoreInput): Promise<StorageEntryView>;
     deleteEntry(storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
     deleteEntry(namespace: string, storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
-    getDownload(storageEntryId: string, preview?: boolean): Promise<StorageDownload>;
-    getDownload(namespace: string, storageEntryId: string, preview?: boolean): Promise<StorageDownload>;
+    getDownload(storageEntryId: string, preview?: boolean, ttlSeconds?: number): Promise<StorageDownload>;
+    getDownload(namespace: string, storageEntryId: string, preview?: boolean, ttlSeconds?: number): Promise<StorageDownload>;
     getDocument(storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
     getDocument(namespace: string, storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
 }