deepline 0.1.91 → 0.1.94
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/dist/cli/index.js +4012 -705
- package/dist/cli/index.mjs +4028 -714
- package/dist/index.d.mts +232 -108
- package/dist/index.d.ts +232 -108
- package/dist/index.js +1145 -99
- package/dist/index.mjs +1134 -99
- package/dist/repo/apps/play-runner-workers/src/coordinator-entry.ts +87 -20
- package/dist/repo/apps/play-runner-workers/src/entry.ts +75 -22
- package/dist/repo/sdk/src/client.ts +412 -40
- package/dist/repo/sdk/src/index.ts +1 -0
- package/dist/repo/sdk/src/play.ts +51 -0
- package/dist/repo/sdk/src/release.ts +2 -2
- package/dist/repo/sdk/src/runs/observe-transport.ts +481 -0
- package/dist/repo/sdk/src/stream-reconnect.ts +44 -0
- package/dist/repo/sdk/src/types.ts +10 -3
- package/dist/repo/shared_libs/play-runtime/email-status.ts +10 -36
- package/dist/repo/shared_libs/play-runtime/extractor-targets.ts +3 -3
- package/dist/repo/shared_libs/play-runtime/live-events.ts +217 -0
- package/dist/repo/shared_libs/play-runtime/run-ledger.ts +1074 -0
- package/dist/repo/shared_libs/play-runtime/run-snapshot-stream.ts +581 -0
- package/dist/repo/shared_libs/play-runtime/tool-result.ts +44 -0
- package/dist/repo/shared_libs/plays/secret-guardrails.ts +22 -11
- package/package.json +5 -2
package/dist/index.d.mts
CHANGED
|
@@ -717,12 +717,19 @@ type PlayLiveEvent = LiveEventEnvelope<unknown> & {
|
|
|
717
717
|
* Result returned by {@link DeeplineClient.stopPlay}.
|
|
718
718
|
*/
|
|
719
719
|
interface StopPlayRunResult {
|
|
720
|
-
/** Public play-run identifier
|
|
720
|
+
/** Public play-run identifier the stop request targeted. */
|
|
721
721
|
runId: string;
|
|
722
|
-
/**
|
|
723
|
-
stopped:
|
|
722
|
+
/** Whether the server confirmed the run was stopped. */
|
|
723
|
+
stopped: boolean;
|
|
724
724
|
/** Number of open HITL interactions marked cancelled. */
|
|
725
725
|
hitlCancelledCount: number;
|
|
726
|
+
/**
|
|
727
|
+
* True when the scheduler state for the run was stale and the stop could
|
|
728
|
+
* not be confirmed. Absent on older servers (treated as confirmed).
|
|
729
|
+
*/
|
|
730
|
+
staleSchedulerState?: boolean;
|
|
731
|
+
/** Server-side error detail when the stop was not confirmed. */
|
|
732
|
+
error?: string;
|
|
726
733
|
}
|
|
727
734
|
/**
|
|
728
735
|
* Summary of a single play run, returned by {@link DeeplineClient.listPlayRuns}.
|
|
@@ -1187,6 +1194,10 @@ type EnrichStepCommand = {
|
|
|
1187
1194
|
alias: string;
|
|
1188
1195
|
tool: string;
|
|
1189
1196
|
operation?: string;
|
|
1197
|
+
play?: {
|
|
1198
|
+
ref: string;
|
|
1199
|
+
mode?: 'scalar';
|
|
1200
|
+
};
|
|
1190
1201
|
payload: Record<string, unknown>;
|
|
1191
1202
|
extract_js?: string;
|
|
1192
1203
|
run_if_js?: string;
|
|
@@ -1251,10 +1262,28 @@ type RunsListOptions = {
|
|
|
1251
1262
|
/** Streaming options for `client.runs.tail(...)`. */
|
|
1252
1263
|
type RunsTailOptions = {
|
|
1253
1264
|
signal?: AbortSignal;
|
|
1265
|
+
/**
|
|
1266
|
+
* Called before each stream reconnect. Server stream windows are finite, so
|
|
1267
|
+
* long runs reconnect with backoff until a terminal status is observed.
|
|
1268
|
+
*/
|
|
1269
|
+
onReconnect?: (info: {
|
|
1270
|
+
attempt: number;
|
|
1271
|
+
delayMs: number;
|
|
1272
|
+
reason: string;
|
|
1273
|
+
}) => void;
|
|
1274
|
+
/**
|
|
1275
|
+
* Display-only transport notices: subscription-transport reconnects,
|
|
1276
|
+
* staleness warnings, and the one-time fallback notice when the server
|
|
1277
|
+
* cannot serve the Convex subscription transport (ADR-0008).
|
|
1278
|
+
*/
|
|
1279
|
+
onNotice?: (message: string) => void;
|
|
1254
1280
|
};
|
|
1255
1281
|
/** Log fetch options for `client.runs.logs(...)`. */
|
|
1256
1282
|
type RunsLogsOptions = {
|
|
1283
|
+
/** Return the LAST `limit` stored log lines (default 200). */
|
|
1257
1284
|
limit?: number;
|
|
1285
|
+
/** Fetch every stored log line, paginating to the full totalCount. */
|
|
1286
|
+
all?: boolean;
|
|
1258
1287
|
};
|
|
1259
1288
|
/** Persisted log response for one play run. */
|
|
1260
1289
|
type RunsLogsResult = {
|
|
@@ -1266,6 +1295,11 @@ type RunsLogsResult = {
|
|
|
1266
1295
|
truncated: boolean;
|
|
1267
1296
|
hasMore: boolean;
|
|
1268
1297
|
entries: string[];
|
|
1298
|
+
/**
|
|
1299
|
+
* True when the run crossed the Run Log Stream retention cap: `totalCount`
|
|
1300
|
+
* keeps counting, but stored line bodies end at a loud truncation marker.
|
|
1301
|
+
*/
|
|
1302
|
+
logsTruncated?: boolean;
|
|
1269
1303
|
};
|
|
1270
1304
|
/** One persisted runtime-sheet row returned by `client.runs.exportDatasetRows(...)`. */
|
|
1271
1305
|
type PlaySheetRow = {
|
|
@@ -1608,6 +1642,7 @@ declare class DeeplineClient {
|
|
|
1608
1642
|
compileEnrichPlan(input: {
|
|
1609
1643
|
plan_args?: string[];
|
|
1610
1644
|
config?: unknown;
|
|
1645
|
+
native_play_materialization?: 'macro' | 'inline_prebuilt';
|
|
1611
1646
|
}): Promise<{
|
|
1612
1647
|
config: EnrichCompiledConfig;
|
|
1613
1648
|
}>;
|
|
@@ -1782,6 +1817,56 @@ declare class DeeplineClient {
|
|
|
1782
1817
|
* ```
|
|
1783
1818
|
*/
|
|
1784
1819
|
listPlayRuns(playName: string): Promise<PlayRunListItem[]>;
|
|
1820
|
+
/** List the org's workflows. `GET /api/v2/workflows`. */
|
|
1821
|
+
listWorkflows(options?: {
|
|
1822
|
+
limit?: number;
|
|
1823
|
+
}): Promise<{
|
|
1824
|
+
workflows: Array<{
|
|
1825
|
+
id: string;
|
|
1826
|
+
name: string;
|
|
1827
|
+
status: string;
|
|
1828
|
+
current_published_version: number | null;
|
|
1829
|
+
}>;
|
|
1830
|
+
}>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Fetch a single workflow (including its published-revision config — the
|
|
1833
|
+
* input to `compileWorkflowConfigToPlay`). `GET /api/v2/workflows/:id`.
|
|
1834
|
+
*/
|
|
1835
|
+
getWorkflow(id: string): Promise<{
|
|
1836
|
+
workflow: {
|
|
1837
|
+
id: string;
|
|
1838
|
+
name: string;
|
|
1839
|
+
status: string;
|
|
1840
|
+
current_published_version: number | null;
|
|
1841
|
+
current_published_revision: {
|
|
1842
|
+
version: number;
|
|
1843
|
+
config: unknown;
|
|
1844
|
+
} | null;
|
|
1845
|
+
} | null;
|
|
1846
|
+
validation?: unknown;
|
|
1847
|
+
}>;
|
|
1848
|
+
/** Delete a workflow. `DELETE /api/v2/workflows/:id`. */
|
|
1849
|
+
deleteWorkflow(id: string): Promise<unknown>;
|
|
1850
|
+
/** Turn a workflow off. `POST /api/v2/workflows/:id/disable`. */
|
|
1851
|
+
disableWorkflow(id: string): Promise<unknown>;
|
|
1852
|
+
/** Turn a workflow back on. `POST /api/v2/workflows/:id/enable`. */
|
|
1853
|
+
enableWorkflow(id: string): Promise<unknown>;
|
|
1854
|
+
/** Create/update a workflow from config. `POST /api/v2/workflows/apply`. */
|
|
1855
|
+
applyWorkflow(body: Record<string, unknown>): Promise<unknown>;
|
|
1856
|
+
/** Validate a workflow config without saving. `POST /api/v2/workflows/lint`. */
|
|
1857
|
+
lintWorkflow(body: Record<string, unknown>): Promise<unknown>;
|
|
1858
|
+
/** Fetch live workflow request schemas. `GET /api/v2/workflows/schema`. */
|
|
1859
|
+
getWorkflowSchema(subject?: string): Promise<unknown>;
|
|
1860
|
+
/** Queue a workflow run. `POST /api/v2/workflows/call`. */
|
|
1861
|
+
callWorkflow(body: Record<string, unknown>): Promise<unknown>;
|
|
1862
|
+
/** List a workflow's runs. `GET /api/v2/workflows/:id/runs`. */
|
|
1863
|
+
listWorkflowRuns(id: string, options?: {
|
|
1864
|
+
limit?: number;
|
|
1865
|
+
}): Promise<unknown>;
|
|
1866
|
+
/** Fetch one workflow run. `GET /api/v2/workflows/:id/runs/:runId`. */
|
|
1867
|
+
getWorkflowRun(id: string, runId: string): Promise<unknown>;
|
|
1868
|
+
/** Cancel a workflow run. `POST /api/v2/workflows/:id/runs/:runId/cancel`. */
|
|
1869
|
+
cancelWorkflowRun(id: string, runId: string): Promise<unknown>;
|
|
1785
1870
|
/**
|
|
1786
1871
|
* Get a run by id using the public runs resource model.
|
|
1787
1872
|
*
|
|
@@ -1804,7 +1889,37 @@ declare class DeeplineClient {
|
|
|
1804
1889
|
* ```
|
|
1805
1890
|
*/
|
|
1806
1891
|
listRuns(options: RunsListOptions): Promise<PlayRunListItem[]>;
|
|
1807
|
-
/**
|
|
1892
|
+
/**
|
|
1893
|
+
* Observe one run's live events through the Convex Run Snapshot
|
|
1894
|
+
* subscription transport (ADR-0008). Yields the same `play.*` event
|
|
1895
|
+
* envelopes as {@link streamPlayRunEvents} and ends after the terminal
|
|
1896
|
+
* snapshot. Throws {@link RunObserveTransportUnavailableError} when this
|
|
1897
|
+
* server cannot serve the transport (older server, unconfigured grants, or
|
|
1898
|
+
* unreachable Convex) — callers fall back to the SSE stream with a notice.
|
|
1899
|
+
*/
|
|
1900
|
+
observeRunEvents(runId: string, options?: {
|
|
1901
|
+
signal?: AbortSignal;
|
|
1902
|
+
onNotice?: (message: string) => void;
|
|
1903
|
+
}): AsyncGenerator<PlayLiveEvent>;
|
|
1904
|
+
/**
|
|
1905
|
+
* Tail one run through the subscription transport until terminal, then
|
|
1906
|
+
* return one durable REST status read (the final Run Response Package).
|
|
1907
|
+
*/
|
|
1908
|
+
private tailRunViaObserveTransport;
|
|
1909
|
+
/**
|
|
1910
|
+
* Read the canonical run stream until a terminal run status is observed.
|
|
1911
|
+
*
|
|
1912
|
+
* Tries the Convex Run Snapshot subscription transport first (ADR-0008);
|
|
1913
|
+
* when the server cannot serve it (grant endpoint missing/unconfigured or
|
|
1914
|
+
* Convex unreachable) it falls back — with one `onNotice` message — to the
|
|
1915
|
+
* support-window SSE stream below.
|
|
1916
|
+
*
|
|
1917
|
+
* Server stream windows are finite: they end cleanly at the function
|
|
1918
|
+
* ceiling even while the run keeps executing. A window that ends (cleanly
|
|
1919
|
+
* or via transient network error) without a terminal event triggers one
|
|
1920
|
+
* durable-status re-check followed by a backed-off reconnect, so long runs
|
|
1921
|
+
* tail to completion. Abort via `options.signal` to stop waiting.
|
|
1922
|
+
*/
|
|
1808
1923
|
tailRun(runId: string, options?: RunsTailOptions): Promise<PlayStatus>;
|
|
1809
1924
|
/**
|
|
1810
1925
|
* Fetch persisted logs for a run using the public runs resource model.
|
|
@@ -2034,6 +2149,15 @@ declare class DeeplineClient {
|
|
|
2034
2149
|
}>;
|
|
2035
2150
|
}
|
|
2036
2151
|
|
|
2152
|
+
/**
|
|
2153
|
+
* Bootstrap failure: this server/deployment cannot serve the subscription
|
|
2154
|
+
* transport. Callers fall back to the support-window SSE stream (ADR-0008).
|
|
2155
|
+
*/
|
|
2156
|
+
declare class RunObserveTransportUnavailableError extends Error {
|
|
2157
|
+
readonly reason: string;
|
|
2158
|
+
constructor(message: string, reason: string);
|
|
2159
|
+
}
|
|
2160
|
+
|
|
2037
2161
|
declare const SDK_VERSION: string;
|
|
2038
2162
|
declare const SDK_API_CONTRACT: string;
|
|
2039
2163
|
|
|
@@ -2157,107 +2281,6 @@ declare const PROD_URL = "https://code.deepline.com";
|
|
|
2157
2281
|
*/
|
|
2158
2282
|
declare function resolveConfig(options?: DeeplineClientOptions): ResolvedConfig;
|
|
2159
2283
|
|
|
2160
|
-
interface PlayR2FileRef {
|
|
2161
|
-
storageKind: 'r2';
|
|
2162
|
-
storageKey: string;
|
|
2163
|
-
logicalPath: string;
|
|
2164
|
-
fileName: string;
|
|
2165
|
-
contentHash: string;
|
|
2166
|
-
contentType: string;
|
|
2167
|
-
bytes: number;
|
|
2168
|
-
}
|
|
2169
|
-
type PlayExecutionFileRef = PlayR2FileRef;
|
|
2170
|
-
|
|
2171
|
-
declare const PLAY_DATASET_BRAND: unique symbol;
|
|
2172
|
-
type PlayDatasetKind = 'csv' | 'map';
|
|
2173
|
-
type PlayDatasetBacking = {
|
|
2174
|
-
storage: 'neon_sheet';
|
|
2175
|
-
sheet: {
|
|
2176
|
-
playName: string;
|
|
2177
|
-
tableNamespace: string;
|
|
2178
|
-
};
|
|
2179
|
-
} | {
|
|
2180
|
-
storage: 'r2_file';
|
|
2181
|
-
file: PlayExecutionFileRef;
|
|
2182
|
-
};
|
|
2183
|
-
type PlayDatasetWorkProgressSummary = {
|
|
2184
|
-
total: number;
|
|
2185
|
-
executed: number;
|
|
2186
|
-
reused: number;
|
|
2187
|
-
skipped: number;
|
|
2188
|
-
pending: number;
|
|
2189
|
-
failed: number;
|
|
2190
|
-
degraded?: boolean;
|
|
2191
|
-
duplicates?: {
|
|
2192
|
-
exact?: number;
|
|
2193
|
-
semantic?: number;
|
|
2194
|
-
rejected?: number;
|
|
2195
|
-
};
|
|
2196
|
-
};
|
|
2197
|
-
type PlayDatasetInput<T> = ReadonlyArray<T> | Iterable<T> | AsyncIterable<T> | PlayDataset<T>;
|
|
2198
|
-
type PlayDatasetTransformOptions = {
|
|
2199
|
-
key?: string;
|
|
2200
|
-
sourceLabel?: string | null;
|
|
2201
|
-
};
|
|
2202
|
-
/**
|
|
2203
|
-
* Durable handle for rows produced by `ctx.csv(...)` or `ctx.dataset(...).run()`.
|
|
2204
|
-
*
|
|
2205
|
-
* A `PlayDataset` is not a normal in-memory array. It points at runtime-managed
|
|
2206
|
-
* rows, usually backed by persisted sheet storage, and carries metadata such as
|
|
2207
|
-
* dataset kind, dataset id, table namespace, count, and preview rows.
|
|
2208
|
-
*
|
|
2209
|
-
* Pass dataset handles directly into later `ctx.dataset(...)` stages by default so
|
|
2210
|
-
* Deepline keeps row progress, retries, memory use, and table output under
|
|
2211
|
-
* runtime control. Use `count()` and `peek()` for bounded inspection. Use
|
|
2212
|
-
* `materialize(limit)` or async iteration only when the dataset is intentionally
|
|
2213
|
-
* small and bounded. `PlayDataset` intentionally does not expose `.rows`,
|
|
2214
|
-
* `.toArray()`, or other array aliases; those hide the runtime cost of loading
|
|
2215
|
-
* persisted rows into memory.
|
|
2216
|
-
*
|
|
2217
|
-
* @sdkReference runtime 190
|
|
2218
|
-
*/
|
|
2219
|
-
interface PlayDataset<T> extends AsyncIterable<T> {
|
|
2220
|
-
readonly [PLAY_DATASET_BRAND]: true;
|
|
2221
|
-
/** Dataset kind. */
|
|
2222
|
-
readonly datasetKind: PlayDatasetKind;
|
|
2223
|
-
/** Dataset id. */
|
|
2224
|
-
readonly datasetId: string;
|
|
2225
|
-
/** Backing store info. */
|
|
2226
|
-
readonly backing?: PlayDatasetBacking;
|
|
2227
|
-
/** Display label. */
|
|
2228
|
-
readonly sourceLabel?: string | null;
|
|
2229
|
-
/** Runtime table name. */
|
|
2230
|
-
readonly tableNamespace?: string | null;
|
|
2231
|
-
/** Row count. */
|
|
2232
|
-
count(): Promise<number>;
|
|
2233
|
-
/** Preview rows. */
|
|
2234
|
-
peek(limit?: number): Promise<T[]>;
|
|
2235
|
-
map<U>(mapper: (row: T, index: number) => U | Promise<U>, options?: PlayDatasetTransformOptions): PlayDataset<U>;
|
|
2236
|
-
filter(predicate: (row: T, index: number) => boolean | Promise<boolean>, options?: PlayDatasetTransformOptions): PlayDataset<T>;
|
|
2237
|
-
slice(start?: number, end?: number, options?: PlayDatasetTransformOptions): PlayDataset<T>;
|
|
2238
|
-
take(limit: number, options?: PlayDatasetTransformOptions): PlayDataset<T>;
|
|
2239
|
-
/**
|
|
2240
|
-
* Explicit escape hatch for bounded result sets.
|
|
2241
|
-
* Large datasets should flow by handle through Neon-backed storage, not
|
|
2242
|
-
* through worker memory as giant arrays.
|
|
2243
|
-
*/
|
|
2244
|
-
materialize(limit?: number): Promise<T[]>;
|
|
2245
|
-
toJSON(): {
|
|
2246
|
-
kind: 'dataset';
|
|
2247
|
-
datasetKind: PlayDatasetKind;
|
|
2248
|
-
datasetId: string;
|
|
2249
|
-
count: number;
|
|
2250
|
-
backing?: PlayDatasetBacking;
|
|
2251
|
-
sourceLabel?: string | null;
|
|
2252
|
-
tableNamespace?: string | null;
|
|
2253
|
-
columns?: string[];
|
|
2254
|
-
_metadata?: {
|
|
2255
|
-
workProgress?: PlayDatasetWorkProgressSummary;
|
|
2256
|
-
};
|
|
2257
|
-
preview: T[];
|
|
2258
|
-
};
|
|
2259
|
-
}
|
|
2260
|
-
|
|
2261
2284
|
type EmailStatusVerdict = 'send' | 'send_with_caution' | 'verify_next' | 'hold' | 'drop';
|
|
2262
2285
|
type EmailStatusValue = 'valid' | 'invalid' | 'catch_all' | 'valid_catch_all' | 'unknown' | 'do_not_mail' | 'spamtrap' | 'abuse' | 'disposable';
|
|
2263
2286
|
type EmailDeliverability = 'high' | 'medium' | 'low' | 'unknown';
|
|
@@ -2434,7 +2457,7 @@ declare const DEEPLINE_EXTRACTOR_TARGET_DEFINITIONS: {
|
|
|
2434
2457
|
};
|
|
2435
2458
|
type DeeplineExtractorTarget = keyof typeof DEEPLINE_EXTRACTOR_TARGET_DEFINITIONS;
|
|
2436
2459
|
declare const DEEPLINE_EXTRACTOR_TARGETS: DeeplineExtractorTarget[];
|
|
2437
|
-
type DeeplineEmailStatusGetterValue = EmailStatus
|
|
2460
|
+
type DeeplineEmailStatusGetterValue = EmailStatus;
|
|
2438
2461
|
type DeeplineGetterValueMap = {
|
|
2439
2462
|
id: string;
|
|
2440
2463
|
name: string;
|
|
@@ -2459,7 +2482,7 @@ type DeeplineGetterValueMap = {
|
|
|
2459
2482
|
status: string;
|
|
2460
2483
|
job_change: JobChangeGetterValue;
|
|
2461
2484
|
job_change_status: JobChangeStatus;
|
|
2462
|
-
email_status:
|
|
2485
|
+
email_status: EmailStatus;
|
|
2463
2486
|
phone_status: PhoneStatus;
|
|
2464
2487
|
};
|
|
2465
2488
|
type DeeplineGetterValue<TTarget extends DeeplineExtractorTarget = DeeplineExtractorTarget> = DeeplineGetterValueMap[TTarget];
|
|
@@ -2553,6 +2576,107 @@ type ToolExecuteResultAccessors<TExtracted extends Record<string, unknown> = Par
|
|
|
2553
2576
|
*/
|
|
2554
2577
|
type ToolExecuteResult<TResult = unknown, TMeta = Record<string, unknown>, TExtracted extends Record<string, unknown> = Partial<DeeplineGetterValueMap>, TLists extends Record<string, Record<string, unknown>> = Record<string, Record<string, unknown>>> = ToolExecuteResultBase<TResult, TMeta> & ToolExecuteResultAccessors<TExtracted, TLists>;
|
|
2555
2578
|
|
|
2579
|
+
interface PlayR2FileRef {
|
|
2580
|
+
storageKind: 'r2';
|
|
2581
|
+
storageKey: string;
|
|
2582
|
+
logicalPath: string;
|
|
2583
|
+
fileName: string;
|
|
2584
|
+
contentHash: string;
|
|
2585
|
+
contentType: string;
|
|
2586
|
+
bytes: number;
|
|
2587
|
+
}
|
|
2588
|
+
type PlayExecutionFileRef = PlayR2FileRef;
|
|
2589
|
+
|
|
2590
|
+
declare const PLAY_DATASET_BRAND: unique symbol;
|
|
2591
|
+
type PlayDatasetKind = 'csv' | 'map';
|
|
2592
|
+
type PlayDatasetBacking = {
|
|
2593
|
+
storage: 'neon_sheet';
|
|
2594
|
+
sheet: {
|
|
2595
|
+
playName: string;
|
|
2596
|
+
tableNamespace: string;
|
|
2597
|
+
};
|
|
2598
|
+
} | {
|
|
2599
|
+
storage: 'r2_file';
|
|
2600
|
+
file: PlayExecutionFileRef;
|
|
2601
|
+
};
|
|
2602
|
+
type PlayDatasetWorkProgressSummary = {
|
|
2603
|
+
total: number;
|
|
2604
|
+
executed: number;
|
|
2605
|
+
reused: number;
|
|
2606
|
+
skipped: number;
|
|
2607
|
+
pending: number;
|
|
2608
|
+
failed: number;
|
|
2609
|
+
degraded?: boolean;
|
|
2610
|
+
duplicates?: {
|
|
2611
|
+
exact?: number;
|
|
2612
|
+
semantic?: number;
|
|
2613
|
+
rejected?: number;
|
|
2614
|
+
};
|
|
2615
|
+
};
|
|
2616
|
+
type PlayDatasetInput<T> = ReadonlyArray<T> | Iterable<T> | AsyncIterable<T> | PlayDataset<T>;
|
|
2617
|
+
type PlayDatasetTransformOptions = {
|
|
2618
|
+
key?: string;
|
|
2619
|
+
sourceLabel?: string | null;
|
|
2620
|
+
};
|
|
2621
|
+
/**
|
|
2622
|
+
* Durable handle for rows produced by `ctx.csv(...)` or `ctx.dataset(...).run()`.
|
|
2623
|
+
*
|
|
2624
|
+
* A `PlayDataset` is not a normal in-memory array. It points at runtime-managed
|
|
2625
|
+
* rows, usually backed by persisted sheet storage, and carries metadata such as
|
|
2626
|
+
* dataset kind, dataset id, table namespace, count, and preview rows.
|
|
2627
|
+
*
|
|
2628
|
+
* Pass dataset handles directly into later `ctx.dataset(...)` stages by default so
|
|
2629
|
+
* Deepline keeps row progress, retries, memory use, and table output under
|
|
2630
|
+
* runtime control. Use `count()` and `peek()` for bounded inspection. Use
|
|
2631
|
+
* `materialize(limit)` or async iteration only when the dataset is intentionally
|
|
2632
|
+
* small and bounded. `PlayDataset` intentionally does not expose `.rows`,
|
|
2633
|
+
* `.toArray()`, or other array aliases; those hide the runtime cost of loading
|
|
2634
|
+
* persisted rows into memory.
|
|
2635
|
+
*
|
|
2636
|
+
* @sdkReference runtime 190
|
|
2637
|
+
*/
|
|
2638
|
+
interface PlayDataset<T> extends AsyncIterable<T> {
|
|
2639
|
+
readonly [PLAY_DATASET_BRAND]: true;
|
|
2640
|
+
/** Dataset kind. */
|
|
2641
|
+
readonly datasetKind: PlayDatasetKind;
|
|
2642
|
+
/** Dataset id. */
|
|
2643
|
+
readonly datasetId: string;
|
|
2644
|
+
/** Backing store info. */
|
|
2645
|
+
readonly backing?: PlayDatasetBacking;
|
|
2646
|
+
/** Display label. */
|
|
2647
|
+
readonly sourceLabel?: string | null;
|
|
2648
|
+
/** Runtime table name. */
|
|
2649
|
+
readonly tableNamespace?: string | null;
|
|
2650
|
+
/** Row count. */
|
|
2651
|
+
count(): Promise<number>;
|
|
2652
|
+
/** Preview rows. */
|
|
2653
|
+
peek(limit?: number): Promise<T[]>;
|
|
2654
|
+
map<U>(mapper: (row: T, index: number) => U | Promise<U>, options?: PlayDatasetTransformOptions): PlayDataset<U>;
|
|
2655
|
+
filter(predicate: (row: T, index: number) => boolean | Promise<boolean>, options?: PlayDatasetTransformOptions): PlayDataset<T>;
|
|
2656
|
+
slice(start?: number, end?: number, options?: PlayDatasetTransformOptions): PlayDataset<T>;
|
|
2657
|
+
take(limit: number, options?: PlayDatasetTransformOptions): PlayDataset<T>;
|
|
2658
|
+
/**
|
|
2659
|
+
* Explicit escape hatch for bounded result sets.
|
|
2660
|
+
* Large datasets should flow by handle through Neon-backed storage, not
|
|
2661
|
+
* through worker memory as giant arrays.
|
|
2662
|
+
*/
|
|
2663
|
+
materialize(limit?: number): Promise<T[]>;
|
|
2664
|
+
toJSON(): {
|
|
2665
|
+
kind: 'dataset';
|
|
2666
|
+
datasetKind: PlayDatasetKind;
|
|
2667
|
+
datasetId: string;
|
|
2668
|
+
count: number;
|
|
2669
|
+
backing?: PlayDatasetBacking;
|
|
2670
|
+
sourceLabel?: string | null;
|
|
2671
|
+
tableNamespace?: string | null;
|
|
2672
|
+
columns?: string[];
|
|
2673
|
+
_metadata?: {
|
|
2674
|
+
workProgress?: PlayDatasetWorkProgressSummary;
|
|
2675
|
+
};
|
|
2676
|
+
preview: T[];
|
|
2677
|
+
};
|
|
2678
|
+
}
|
|
2679
|
+
|
|
2556
2680
|
/**
|
|
2557
2681
|
* Previous durable cell value passed to object-column resolvers.
|
|
2558
2682
|
*
|
|
@@ -3791,4 +3915,4 @@ declare function writeCsvOutputFile(rows: Array<Record<string, unknown>>, stem:
|
|
|
3791
3915
|
*/
|
|
3792
3916
|
declare function extractSummaryFields(payload: unknown): Record<string, Scalar>;
|
|
3793
3917
|
|
|
3794
|
-
export { AuthError, type ClearPlayHistoryRequest, type ClearPlayHistoryResult, type ColumnMap, type ColumnResolver, type ConditionalStepResolver, ConfigError, type CsvInput, type CsvOptions, type CustomerDbQueryResult, DEEPLINE_EXTRACTOR_TARGETS, DEEPLINE_EXTRACTOR_TARGET_DEFINITIONS, DEEPLINE_TOOL_CATEGORIES, type DatasetBuilder, type DatasetColumnDefinition, type DatasetColumnRunInput, Deepline, DeeplineClient, type DeeplineClientOptions, DeeplineContext, type DeeplineEmailStatusGetterValue, DeeplineError, type DeeplineExtractorTarget, type DeeplineGetterValue, type DeeplineGetterValueMap, type DeeplineNamedPlay, type DeeplinePlayRuntimeContext, type DeeplinePlaysNamespace, type DeeplineToolCategory, type DeeplineToolsNamespace, type DefinePlayConfig, type DefinedPlay, type FileInput, JOB_CHANGE_STATUS_VALUES, type JobChangeStatus, type LiveEventEnvelope, PHONE_STATUS_VALUES, PLAY_BOOTSTRAP_COMPANY_FIELDS, PLAY_BOOTSTRAP_COMPANY_PROVIDER_CATEGORY, PLAY_BOOTSTRAP_CONTACT_FIELDS, PLAY_BOOTSTRAP_FINDER_KINDS, PLAY_BOOTSTRAP_OUTPUT_FIELD_BY_FINDER, PLAY_BOOTSTRAP_PEOPLE_PROVIDER_CATEGORY, PLAY_BOOTSTRAP_PROVIDER_CATEGORY_BY_FINDER, PLAY_BOOTSTRAP_SOURCE_KINDS, PLAY_BOOTSTRAP_STAGE_KINDS, PLAY_BOOTSTRAP_TEMPLATES, PROD_URL, type PhoneStatus, type PlayBindings, type PlayBootstrapEntityKind, type PlayBootstrapFinderKind, type PlayDataset, type PlayDatasetInput, type PlayInputContract, type PlayJob, type PlayListItem, type PlayLiveEvent, type PlayRevisionSummary, type PlayRunResult, type PlayRunStart, type PlaySheetRow, type PlaySheetRowsResult, type PlayStatus, type PlayStepProgramStep, type PrebuiltPlayRef, type PreviousCell, type PublishPlayVersionRequest, type PublishPlayVersionResult, RateLimitError, type ResolvedConfig, type RunsListOptions, type RunsLogsOptions, type RunsLogsResult, type RunsNamespace, type RunsTailOptions, SDK_API_CONTRACT, SDK_VERSION, type StaleAfterSeconds, type StartPlayRunRequest, type StepOptions, type StepProgram, type StepProgramResolver, type StepResolver, type StopPlayRunResult, type ToolDefinition, type ToolExecuteResult, type ToolExecution, type ToolExecutionRequest, type ToolMetadata, type ToolSearchOptions, type ToolSearchResult, defineInput, definePlay, defineWorkflow, extractSummaryFields, formatPlayBootstrapFinderKinds, formatPlayBootstrapFinderKindsForSentence, formatPlayBootstrapTemplates, getDefinedPlayMetadata, isDeeplineExtractorTarget, isPlayBootstrapFinderKind, isPlayBootstrapTemplate, resolveConfig, runIf, steps, tryConvertToList, writeCsvOutputFile, writeJsonOutputFile };
|
|
3918
|
+
export { AuthError, type ClearPlayHistoryRequest, type ClearPlayHistoryResult, type ColumnMap, type ColumnResolver, type ConditionalStepResolver, ConfigError, type CsvInput, type CsvOptions, type CustomerDbQueryResult, DEEPLINE_EXTRACTOR_TARGETS, DEEPLINE_EXTRACTOR_TARGET_DEFINITIONS, DEEPLINE_TOOL_CATEGORIES, type DatasetBuilder, type DatasetColumnDefinition, type DatasetColumnRunInput, Deepline, DeeplineClient, type DeeplineClientOptions, DeeplineContext, type DeeplineEmailStatusGetterValue, DeeplineError, type DeeplineExtractorTarget, type DeeplineGetterValue, type DeeplineGetterValueMap, type DeeplineNamedPlay, type DeeplinePlayRuntimeContext, type DeeplinePlaysNamespace, type DeeplineToolCategory, type DeeplineToolsNamespace, type DefinePlayConfig, type DefinedPlay, type FileInput, JOB_CHANGE_STATUS_VALUES, type JobChangeStatus, type LiveEventEnvelope, PHONE_STATUS_VALUES, PLAY_BOOTSTRAP_COMPANY_FIELDS, PLAY_BOOTSTRAP_COMPANY_PROVIDER_CATEGORY, PLAY_BOOTSTRAP_CONTACT_FIELDS, PLAY_BOOTSTRAP_FINDER_KINDS, PLAY_BOOTSTRAP_OUTPUT_FIELD_BY_FINDER, PLAY_BOOTSTRAP_PEOPLE_PROVIDER_CATEGORY, PLAY_BOOTSTRAP_PROVIDER_CATEGORY_BY_FINDER, PLAY_BOOTSTRAP_SOURCE_KINDS, PLAY_BOOTSTRAP_STAGE_KINDS, PLAY_BOOTSTRAP_TEMPLATES, PROD_URL, type PhoneStatus, type PlayBindings, type PlayBootstrapEntityKind, type PlayBootstrapFinderKind, type PlayDataset, type PlayDatasetInput, type PlayInputContract, type PlayJob, type PlayListItem, type PlayLiveEvent, type PlayRevisionSummary, type PlayRunResult, type PlayRunStart, type PlaySheetRow, type PlaySheetRowsResult, type PlayStatus, type PlayStepProgramStep, type PrebuiltPlayRef, type PreviousCell, type PublishPlayVersionRequest, type PublishPlayVersionResult, RateLimitError, type ResolvedConfig, RunObserveTransportUnavailableError, type RunsListOptions, type RunsLogsOptions, type RunsLogsResult, type RunsNamespace, type RunsTailOptions, SDK_API_CONTRACT, SDK_VERSION, type StaleAfterSeconds, type StartPlayRunRequest, type StepOptions, type StepProgram, type StepProgramResolver, type StepResolver, type StopPlayRunResult, type ToolDefinition, type ToolExecuteResult, type ToolExecution, type ToolExecutionRequest, type ToolMetadata, type ToolSearchOptions, type ToolSearchResult, defineInput, definePlay, defineWorkflow, extractSummaryFields, formatPlayBootstrapFinderKinds, formatPlayBootstrapFinderKindsForSentence, formatPlayBootstrapTemplates, getDefinedPlayMetadata, isDeeplineExtractorTarget, isPlayBootstrapFinderKind, isPlayBootstrapTemplate, resolveConfig, runIf, steps, tryConvertToList, writeCsvOutputFile, writeJsonOutputFile };
|