deepline 0.3.55 → 0.3.56
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/bundling-sources/sdk/src/client.ts +232 -0
- package/dist/bundling-sources/sdk/src/index.ts +29 -0
- package/dist/bundling-sources/sdk/src/monitor-fleet-contract.ts +556 -0
- package/dist/bundling-sources/sdk/src/monitor-fleets.ts +31 -0
- package/dist/bundling-sources/sdk/src/play.ts +2 -8
- package/dist/bundling-sources/sdk/src/release.ts +1 -1
- package/dist/bundling-sources/shared_libs/monitors/monitor-fleet-limits.ts +14 -0
- package/dist/bundling-sources/shared_libs/monitors/org-monitor-limits.ts +102 -0
- package/dist/bundling-sources/shared_libs/monitors/validation.ts +244 -0
- package/dist/cli/index.js +1680 -354
- package/dist/cli/index.mjs +1616 -290
- package/dist/index.d.mts +220 -9
- package/dist/index.d.ts +220 -9
- package/dist/index.js +474 -14
- package/dist/index.mjs +464 -14
- package/dist/install-integrity.json +5 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1900,6 +1900,134 @@ type MonitorControls = {
|
|
|
1900
1900
|
*/
|
|
1901
1901
|
declare function defineMonitor<TPayload extends MonitorPayload = MonitorPayload>(definition: MonitorDefinition<TPayload>): MonitorDefinition<TPayload>;
|
|
1902
1902
|
|
|
1903
|
+
/**
|
|
1904
|
+
* The fleet member ceiling, mirrored — deliberately a literal.
|
|
1905
|
+
*
|
|
1906
|
+
* The canonical declaration is shared_libs/monitors/monitor-fleet-limits.ts,
|
|
1907
|
+
* which the Convex commit mutation reads to size its transaction. This package
|
|
1908
|
+
* cannot import it: the workspace-architecture ratchet forbids NEW shared_libs
|
|
1909
|
+
* imports from packages absolutely (only relocations of pre-existing edges
|
|
1910
|
+
* pass CI), because shared_libs is being migrated into workspace packages.
|
|
1911
|
+
* Until a monitors package exists, the two copies are held equal by
|
|
1912
|
+
* tests/lib/monitors/monitor-fleet-limits-mirror.test.ts — change one without
|
|
1913
|
+
* the other and that test names both files.
|
|
1914
|
+
*/
|
|
1915
|
+
declare const MONITOR_FLEET_MAX_MEMBERS = 1000;
|
|
1916
|
+
declare const MONITOR_FLEET_FRONTIER_MAX_ROWS = 10000;
|
|
1917
|
+
/**
|
|
1918
|
+
* Fleet definitions are admitted once and executed many times. Keep the
|
|
1919
|
+
* edition beside the definition just as Plays keep their authoring-contract
|
|
1920
|
+
* edition: a future syntax change can add a reader without reinterpreting a
|
|
1921
|
+
* stored Fleet under new rules.
|
|
1922
|
+
*/
|
|
1923
|
+
declare const MONITOR_FLEET_AUTHORING_CONTRACT_EDITION: 1;
|
|
1924
|
+
declare const SUPPORTED_MONITOR_FLEET_AUTHORING_CONTRACT_EDITIONS: readonly [1];
|
|
1925
|
+
type MonitorFleetAuthoringContractEdition = (typeof SUPPORTED_MONITOR_FLEET_AUTHORING_CONTRACT_EDITIONS)[number];
|
|
1926
|
+
declare const MONITOR_FLEET_AUTHORING_CONTRACT_CHANGELOG: readonly [{
|
|
1927
|
+
readonly edition: 1;
|
|
1928
|
+
readonly changed: "Initial Fleet JSON contract: bounded sticky table membership, one daily sync, and a seven-day removal grace.";
|
|
1929
|
+
readonly compatibilityOwner: "Monitors Runtime";
|
|
1930
|
+
readonly newWritesEnd: null;
|
|
1931
|
+
readonly readerRemoval: null;
|
|
1932
|
+
}];
|
|
1933
|
+
/**
|
|
1934
|
+
* Public, machine-readable guidance for every Monitor Fleet authoring
|
|
1935
|
+
* surface. SDK clients may render this directly; the CLI uses the same fixed
|
|
1936
|
+
* policy values in its help rather than maintaining another contract.
|
|
1937
|
+
*/
|
|
1938
|
+
declare const MONITOR_FLEET_DOCUMENTATION: {
|
|
1939
|
+
readonly summary: "A Monitor Fleet keeps one bounded, sticky set of ordinary monitors aligned with Customer DB rows.";
|
|
1940
|
+
readonly authoredFields: {
|
|
1941
|
+
readonly id: "Stable lowercase fleet id used by sync, pause, resume, and deactivate.";
|
|
1942
|
+
readonly source: "Customer DB table, unique row key, and optional equality filters that select candidate rows.";
|
|
1943
|
+
readonly member: "Ordinary monitor tool, stable key template, and payload evaluated for each selected source row.";
|
|
1944
|
+
readonly selection: "Deterministic ranking and an active-member limit between 1 and 1,000.";
|
|
1945
|
+
};
|
|
1946
|
+
readonly fixedPolicy: {
|
|
1947
|
+
readonly cadence: "daily";
|
|
1948
|
+
readonly membership: "sticky";
|
|
1949
|
+
readonly removalGrace: "7d";
|
|
1950
|
+
readonly onRemoved: "deactivate";
|
|
1951
|
+
readonly ownership: "A Fleet may adopt a same-tool ordinary monitor with its deterministic member key. The first Fleet claim wins; another Fleet or a different tool receives a conflict.";
|
|
1952
|
+
readonly billing: "No Fleet fee, permit, or renewal. Dry-run reports ordinary monitor lifecycle charges due now.";
|
|
1953
|
+
};
|
|
1954
|
+
readonly stickyMembership: "Ranking fills vacancies but never replaces a current member merely because another row ranks higher.";
|
|
1955
|
+
readonly columnExpression: "Use { \"$fleet\": \"column\", \"name\": \"column_name\" } in a member key or payload to read a value from each source row.";
|
|
1956
|
+
};
|
|
1957
|
+
type MonitorFleetColumn = {
|
|
1958
|
+
$fleet: 'column';
|
|
1959
|
+
name: string;
|
|
1960
|
+
};
|
|
1961
|
+
type MonitorFleetTemplate = {
|
|
1962
|
+
$fleet: 'template';
|
|
1963
|
+
parts: Array<string | MonitorFleetColumn>;
|
|
1964
|
+
};
|
|
1965
|
+
type MonitorFleetExpression = MonitorFleetColumn | MonitorFleetTemplate;
|
|
1966
|
+
type MonitorFleetDefinition = {
|
|
1967
|
+
/** Stable lowercase fleet id, used by CLI and API lifecycle commands. */
|
|
1968
|
+
id: string;
|
|
1969
|
+
/** Customer DB rows that may become members. */
|
|
1970
|
+
source: {
|
|
1971
|
+
kind: 'customer_db_table';
|
|
1972
|
+
schema: string;
|
|
1973
|
+
table: string;
|
|
1974
|
+
key: {
|
|
1975
|
+
column: string;
|
|
1976
|
+
type: 'text' | 'uuid' | 'int4' | 'int8';
|
|
1977
|
+
};
|
|
1978
|
+
where?: Record<string, string | number | boolean | null>;
|
|
1979
|
+
};
|
|
1980
|
+
/** One ordinary monitor definition, evaluated once for each selected row. */
|
|
1981
|
+
member: {
|
|
1982
|
+
tool: string;
|
|
1983
|
+
key: MonitorFleetTemplate;
|
|
1984
|
+
payload: Record<string, unknown>;
|
|
1985
|
+
};
|
|
1986
|
+
/**
|
|
1987
|
+
* Bounded deterministic candidate selection. Membership is intentionally
|
|
1988
|
+
* sticky: ranking chooses vacant slots but does not replace existing members
|
|
1989
|
+
* merely because another row's score changed.
|
|
1990
|
+
*/
|
|
1991
|
+
selection: {
|
|
1992
|
+
limit: number;
|
|
1993
|
+
orderBy: Array<{
|
|
1994
|
+
column: string;
|
|
1995
|
+
direction: 'asc' | 'desc';
|
|
1996
|
+
}>;
|
|
1997
|
+
membership: 'sticky';
|
|
1998
|
+
};
|
|
1999
|
+
};
|
|
2000
|
+
type MonitorFleetContractIssue = {
|
|
2001
|
+
path: string;
|
|
2002
|
+
code: string;
|
|
2003
|
+
message: string;
|
|
2004
|
+
};
|
|
2005
|
+
/** The durable, validated snapshot that a Fleet sync is allowed to execute. */
|
|
2006
|
+
type AdmittedMonitorFleetAuthoringContract = {
|
|
2007
|
+
edition: MonitorFleetAuthoringContractEdition;
|
|
2008
|
+
definition: MonitorFleetDefinition;
|
|
2009
|
+
};
|
|
2010
|
+
type MonitorFleetAuthoringContractResult = {
|
|
2011
|
+
valid: boolean;
|
|
2012
|
+
contract?: AdmittedMonitorFleetAuthoringContract;
|
|
2013
|
+
issues: MonitorFleetContractIssue[];
|
|
2014
|
+
};
|
|
2015
|
+
declare function fleetColumn(name: string): MonitorFleetColumn;
|
|
2016
|
+
declare function fleetKey(...parts: Array<string | MonitorFleetColumn>): MonitorFleetTemplate;
|
|
2017
|
+
declare function defineMonitorFleet<const T extends MonitorFleetDefinition>(definition: T): T;
|
|
2018
|
+
declare function validateMonitorFleetDefinition(value: unknown): {
|
|
2019
|
+
valid: boolean;
|
|
2020
|
+
definition?: MonitorFleetDefinition;
|
|
2021
|
+
issues: MonitorFleetContractIssue[];
|
|
2022
|
+
};
|
|
2023
|
+
/**
|
|
2024
|
+
* Compile JSON into the exact authoring snapshot persisted by a Fleet. This
|
|
2025
|
+
* does not inspect the Customer DB or provider; use
|
|
2026
|
+
* `fleets sync --file <fleet.json> --dry-run` for that environment-aware
|
|
2027
|
+
* preflight, which returns the real plan and the credits due.
|
|
2028
|
+
*/
|
|
2029
|
+
declare function admitMonitorFleetAuthoringContract(value: unknown, edition?: number): MonitorFleetAuthoringContractResult;
|
|
2030
|
+
|
|
1903
2031
|
interface PlayStagedFileRef {
|
|
1904
2032
|
storageKind: 'r2';
|
|
1905
2033
|
storageKey: string;
|
|
@@ -2396,6 +2524,66 @@ type MonitorDeleteResult = Record<string, unknown>;
|
|
|
2396
2524
|
type MonitorReactivateResult = Record<string, unknown>;
|
|
2397
2525
|
type MonitorTestResult = Record<string, unknown>;
|
|
2398
2526
|
type MonitorValidateResult = Record<string, unknown>;
|
|
2527
|
+
/**
|
|
2528
|
+
* Server-owned fleet response envelope.
|
|
2529
|
+
*
|
|
2530
|
+
* The server computes `status` (`converging` | `converged` | `degraded` |
|
|
2531
|
+
* `deactivating` | `deactivated`) and the SDK never recomputes it: a client
|
|
2532
|
+
* that derives its own verdict from counts drifts from the control plane the
|
|
2533
|
+
* moment the server changes what "converged" means.
|
|
2534
|
+
*/
|
|
2535
|
+
type MonitorFleetResult = Record<string, unknown>;
|
|
2536
|
+
/** Server-computed fleet verdict. Never derived client-side. */
|
|
2537
|
+
type MonitorFleetStatus = 'converging' | 'converged' | 'degraded' | 'deactivating' | 'deactivated';
|
|
2538
|
+
type MonitorFleetSyncOptions = {
|
|
2539
|
+
/** Return the plan without changing fleet state (`dry_run: true`). */
|
|
2540
|
+
dryRun?: boolean;
|
|
2541
|
+
/** Optimistic concurrency: refuse the write unless the fleet is at this generation. */
|
|
2542
|
+
expectedGeneration?: number;
|
|
2543
|
+
/** Stable retry key; generated by the caller when omitted. */
|
|
2544
|
+
idempotencyKey?: string;
|
|
2545
|
+
};
|
|
2546
|
+
type MonitorFleetGetOptions = {
|
|
2547
|
+
/** Include bounded per-member drift rows. */
|
|
2548
|
+
drift?: boolean;
|
|
2549
|
+
/** Maximum drift rows to return. */
|
|
2550
|
+
limit?: number;
|
|
2551
|
+
};
|
|
2552
|
+
type MonitorFleetDeactivateOptions = {
|
|
2553
|
+
/** Return the blast radius without deactivating anything. */
|
|
2554
|
+
dryRun?: boolean;
|
|
2555
|
+
idempotencyKey?: string;
|
|
2556
|
+
};
|
|
2557
|
+
type MonitorFleetWaitOptions = {
|
|
2558
|
+
/** Give up after this long. Default 10 minutes. */
|
|
2559
|
+
timeoutMs?: number;
|
|
2560
|
+
/** Poll cadence. Default 2 seconds. */
|
|
2561
|
+
pollIntervalMs?: number;
|
|
2562
|
+
/** Called with every polled snapshot, including the terminal one. */
|
|
2563
|
+
onProgress?: (payload: MonitorFleetResult) => void;
|
|
2564
|
+
/**
|
|
2565
|
+
* Which terminal state ends the wait. `converged` (default) also stops on
|
|
2566
|
+
* `degraded` and `deactivated`; `deactivated` stops on `deactivated` and
|
|
2567
|
+
* `degraded`. A timeout is not an error: the last snapshot is returned and
|
|
2568
|
+
* the caller reads `status` to decide the verdict.
|
|
2569
|
+
*/
|
|
2570
|
+
until?: 'converged' | 'deactivated';
|
|
2571
|
+
};
|
|
2572
|
+
type MonitorFleetsNamespace = {
|
|
2573
|
+
/**
|
|
2574
|
+
* Create, update, or re-plan a fleet. Pass a definition to admit new source
|
|
2575
|
+
* of truth; pass a fleet id to re-plan from the stored definition.
|
|
2576
|
+
*/
|
|
2577
|
+
sync: (definitionOrId: string | MonitorFleetDefinition, options?: MonitorFleetSyncOptions) => Promise<MonitorFleetResult>;
|
|
2578
|
+
/** One fleet by id, or every fleet in the workspace when the id is omitted. */
|
|
2579
|
+
get: (fleetId?: string, options?: MonitorFleetGetOptions) => Promise<MonitorFleetResult>;
|
|
2580
|
+
/** Every fleet in the workspace. */
|
|
2581
|
+
list: () => Promise<MonitorFleetResult>;
|
|
2582
|
+
/** Deactivate a fleet and the monitors it owns. */
|
|
2583
|
+
deactivate: (fleetId: string, options?: MonitorFleetDeactivateOptions) => Promise<MonitorFleetResult>;
|
|
2584
|
+
/** Poll the fleet until the server reports a terminal status (or the timeout elapses). */
|
|
2585
|
+
waitForConvergence: (fleetId: string, options?: MonitorFleetWaitOptions) => Promise<MonitorFleetResult>;
|
|
2586
|
+
};
|
|
2399
2587
|
/**
|
|
2400
2588
|
* Public monitors namespace exposed as `client.monitors`.
|
|
2401
2589
|
*
|
|
@@ -2449,6 +2637,8 @@ type MonitorsNamespace = {
|
|
|
2449
2637
|
reactivate: (key: string, options?: {
|
|
2450
2638
|
dryRun?: boolean;
|
|
2451
2639
|
}) => Promise<MonitorReactivateResult>;
|
|
2640
|
+
/** Define, reconcile, and control table-backed monitor fleets. */
|
|
2641
|
+
fleets: MonitorFleetsNamespace;
|
|
2452
2642
|
};
|
|
2453
2643
|
/** One credit grant pool reported by the billing subscription status endpoint. */
|
|
2454
2644
|
type BillingCreditPool = {
|
|
@@ -3820,6 +4010,33 @@ declare class DeeplineClient {
|
|
|
3820
4010
|
reactivateMonitor(key: string, options?: {
|
|
3821
4011
|
dryRun?: boolean;
|
|
3822
4012
|
}): Promise<MonitorReactivateResult>;
|
|
4013
|
+
private monitorFleetIdempotencyKey;
|
|
4014
|
+
private monitorFleetHeaders;
|
|
4015
|
+
private monitorFleetPath;
|
|
4016
|
+
/**
|
|
4017
|
+
* Create, update, or re-plan one fleet.
|
|
4018
|
+
*
|
|
4019
|
+
* The fleet id is always the resource path, so the same definition PUT twice
|
|
4020
|
+
* is the same operation and the server can answer `replayed: true` instead of
|
|
4021
|
+
* building a second set of monitors. Re-planning an existing fleet from its
|
|
4022
|
+
* stored definition sends an EMPTY body: there is no second definition to
|
|
4023
|
+
* send, and an empty body cannot be mistaken for "replace the definition with
|
|
4024
|
+
* nothing".
|
|
4025
|
+
*/
|
|
4026
|
+
syncMonitorFleet(definitionOrId: string | MonitorFleetDefinition, options?: MonitorFleetSyncOptions): Promise<MonitorFleetResult>;
|
|
4027
|
+
listMonitorFleets(): Promise<MonitorFleetResult>;
|
|
4028
|
+
getMonitorFleet(fleetId: string, options?: MonitorFleetGetOptions): Promise<MonitorFleetResult>;
|
|
4029
|
+
deactivateMonitorFleet(fleetId: string, options?: MonitorFleetDeactivateOptions): Promise<MonitorFleetResult>;
|
|
4030
|
+
/**
|
|
4031
|
+
* Poll one fleet until the server reports a terminal status.
|
|
4032
|
+
*
|
|
4033
|
+
* Convergence is the server's verdict, read from `status`. The timeout is not
|
|
4034
|
+
* a failure and does not throw: a fleet still `converging` after ten minutes
|
|
4035
|
+
* is healthy and slow, not broken, so the caller gets the last snapshot and
|
|
4036
|
+
* decides what that means. Throwing here would have made "still working" look
|
|
4037
|
+
* identical to "the request failed".
|
|
4038
|
+
*/
|
|
4039
|
+
waitForMonitorFleetConvergence(fleetId: string, options?: MonitorFleetWaitOptions): Promise<MonitorFleetResult>;
|
|
3823
4040
|
/**
|
|
3824
4041
|
* Check API connectivity and server health.
|
|
3825
4042
|
*
|
|
@@ -4286,8 +4503,7 @@ type PlayMetadata = {
|
|
|
4286
4503
|
/**
|
|
4287
4504
|
* High-level SDK context with tool shortcuts and play handles.
|
|
4288
4505
|
*
|
|
4289
|
-
* Created by {@link Deepline.connect}. Wraps a {@link DeeplineClient} with
|
|
4290
|
-
* a friendlier API for common operations.
|
|
4506
|
+
* Created by {@link Deepline.connect}. Wraps a {@link DeeplineClient} with a friendlier API for common operations.
|
|
4291
4507
|
*
|
|
4292
4508
|
* @example
|
|
4293
4509
|
* ```typescript
|
|
@@ -4414,12 +4630,7 @@ declare function defineInput<TInput>(schema: Record<string, unknown>): PlayInput
|
|
|
4414
4630
|
/**
|
|
4415
4631
|
* Define a play — a composable TypeScript workflow for the Deepline platform.
|
|
4416
4632
|
*
|
|
4417
|
-
* The returned value is both
|
|
4418
|
-
* 1. **A callable function** — invoked by the Temporal worker with a runtime context
|
|
4419
|
-
* 2. **A named play handle** — with `.run()`, `.versions()`, `.get()`, `.publish()`, etc. for remote lifecycle management
|
|
4420
|
-
*
|
|
4421
|
-
* Plays are the primary abstraction for building repeatable data pipelines.
|
|
4422
|
-
* They run on Temporal for durable execution with automatic retries and timeouts.
|
|
4633
|
+
* The returned value is both a callable function, invoked by the Deepline runtime with a runtime context, and a named play handle carrying `.run()`, `.versions()`, `.get()` and `.publish()` for remote lifecycle management. Plays are the primary abstraction for repeatable data pipelines and execute durably, with automatic retries and timeouts.
|
|
4423
4634
|
*
|
|
4424
4635
|
* @typeParam TInput - The input type accepted by the play
|
|
4425
4636
|
* @typeParam TOutput - The return type of the play
|
|
@@ -4824,4 +5035,4 @@ declare function writeCsvOutputFile(rows: Array<Record<string, unknown>>, stem:
|
|
|
4824
5035
|
*/
|
|
4825
5036
|
declare function extractSummaryFields(payload: unknown): Record<string, Scalar>;
|
|
4826
5037
|
|
|
4827
|
-
export { AuthError, type BillingCreditPool, type BillingInvoiceEntry, type BillingInvoicesResult, type BillingNamespace, type BillingPaymentMethodSummary, type BillingSubscriptionCancelResult, type BillingSubscriptionStatus, type BillingTopUpResult, type ClearPlayHistoryRequest, type ClearPlayHistoryResult, type ColumnMap, type ColumnResolver, type ConditionalStepResolver, ConfigError, type CsvInput, type CsvOptions, type CustomerDbQueryResult, DEEPLINE_TOOL_CATEGORIES, type DatasetBuilder, type DatasetColumnDefinition, type DatasetColumnRunInput, type DbNamespace, Deepline, DeeplineClient, type DeeplineClientOptions, DeeplineContext, DeeplineError, type DeeplineNamedPlay, type DeeplinePlayRuntimeContext, type DeeplinePlaysNamespace, type DeeplineToolCategory, type DeeplineToolsNamespace, type DefinePlayConfig, type DefinedPlay, type FetchOptions, type FileInput, type IngestionStorageRepairResult, type LiveEventEnvelope, type MonitorCheckResult, type MonitorControls, type MonitorDefinition, type MonitorDeleteResult, type MonitorDependents, type MonitorDeployResult, type MonitorDetail, type MonitorListEntry, type MonitorPayload, type MonitorReactivateResult, type MonitorSpec, type MonitorUpdateChangeSummary, type MonitorUpdateResult, type MonitorsAccessStatus, type MonitorsAvailableOptions, type MonitorsAvailableResult, type MonitorsListOptions, type MonitorsListResult, type MonitorsNamespace, 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 PlayActivityObservation, type PlayActivityState, type PlayActivityTarget, type PlayBindings, type PlayBootstrapEntityKind, type PlayBootstrapFinderKind, type PlayCallExecution, type PlayCallOptions, type PlayFetchResponse, type PlayInputContract, type PlayJob, type PlayListItem, type PlayLiveEvent, type PlayRevisionSummary, type PlayRunActionPackage, type PlayRunActivityProjection, type PlayRunDatasetActions, type PlayRunPackage, type PlayRunResult, type PlayRunStart, type PlaySheetRow, type PlaySheetRowsResult, type PlayStatus, type PlayStepProgramStep, type PrebuiltPlayRef, type PublishPlayVersionRequest, type PublishPlayVersionResult, RateLimitError, type ResolvedConfig, RunObserveTransportUnavailableError, type RunsListOptions, type RunsLogsOptions, type RunsLogsResult, type RunsNamespace, type RunsTailOptions, type RuntimeStepOptions, SDK_API_CONTRACT, SDK_VERSION, type SqlListenerDeclaration, type SqlListenerEvent, type SqlListenerOperation, type SqlQuery, type StartPlayRunRequest, type StepOptions, type StepProgram, type StepProgramResolver, type StepResolver, type StopPlayRunResult, type ToolDefinition, ToolExecuteResult, type ToolExecution, ToolExecutionError, ToolExecutionErrorOptions, type ToolExecutionRequest, type ToolMetadata, ToolRateLimitError, type ToolSearchOptions, type ToolSearchResult, defineInput, defineMonitor, definePlay, defineWorkflow, extractSummaryFields, formatPlayBootstrapFinderKinds, formatPlayBootstrapFinderKindsForSentence, formatPlayBootstrapTemplates, getDefinedPlayMetadata, isPlayBootstrapFinderKind, isPlayBootstrapTemplate, resolveConfig, runIf, steps, tryConvertToList, writeCsvOutputFile, writeJsonOutputFile };
|
|
5038
|
+
export { type AdmittedMonitorFleetAuthoringContract, AuthError, type BillingCreditPool, type BillingInvoiceEntry, type BillingInvoicesResult, type BillingNamespace, type BillingPaymentMethodSummary, type BillingSubscriptionCancelResult, type BillingSubscriptionStatus, type BillingTopUpResult, type ClearPlayHistoryRequest, type ClearPlayHistoryResult, type ColumnMap, type ColumnResolver, type ConditionalStepResolver, ConfigError, type CsvInput, type CsvOptions, type CustomerDbQueryResult, DEEPLINE_TOOL_CATEGORIES, type DatasetBuilder, type DatasetColumnDefinition, type DatasetColumnRunInput, type DbNamespace, Deepline, DeeplineClient, type DeeplineClientOptions, DeeplineContext, DeeplineError, type DeeplineNamedPlay, type DeeplinePlayRuntimeContext, type DeeplinePlaysNamespace, type DeeplineToolCategory, type DeeplineToolsNamespace, type DefinePlayConfig, type DefinedPlay, type FetchOptions, type FileInput, type IngestionStorageRepairResult, type LiveEventEnvelope, MONITOR_FLEET_AUTHORING_CONTRACT_CHANGELOG, MONITOR_FLEET_AUTHORING_CONTRACT_EDITION, MONITOR_FLEET_DOCUMENTATION, MONITOR_FLEET_FRONTIER_MAX_ROWS, MONITOR_FLEET_MAX_MEMBERS, type MonitorCheckResult, type MonitorControls, type MonitorDefinition, type MonitorDeleteResult, type MonitorDependents, type MonitorDeployResult, type MonitorDetail, type MonitorFleetAuthoringContractEdition, type MonitorFleetAuthoringContractResult, type MonitorFleetColumn, type MonitorFleetContractIssue, type MonitorFleetDeactivateOptions, type MonitorFleetDefinition, type MonitorFleetExpression, type MonitorFleetGetOptions, type MonitorFleetResult, type MonitorFleetStatus, type MonitorFleetSyncOptions, type MonitorFleetTemplate, type MonitorFleetWaitOptions, type MonitorFleetsNamespace, type MonitorListEntry, type MonitorPayload, type MonitorReactivateResult, type MonitorSpec, type MonitorUpdateChangeSummary, type MonitorUpdateResult, type MonitorsAccessStatus, type MonitorsAvailableOptions, type MonitorsAvailableResult, type MonitorsListOptions, type MonitorsListResult, type MonitorsNamespace, 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 PlayActivityObservation, type PlayActivityState, type PlayActivityTarget, type PlayBindings, type PlayBootstrapEntityKind, type PlayBootstrapFinderKind, type PlayCallExecution, type PlayCallOptions, type PlayFetchResponse, type PlayInputContract, type PlayJob, type PlayListItem, type PlayLiveEvent, type PlayRevisionSummary, type PlayRunActionPackage, type PlayRunActivityProjection, type PlayRunDatasetActions, type PlayRunPackage, type PlayRunResult, type PlayRunStart, type PlaySheetRow, type PlaySheetRowsResult, type PlayStatus, type PlayStepProgramStep, type PrebuiltPlayRef, type PublishPlayVersionRequest, type PublishPlayVersionResult, RateLimitError, type ResolvedConfig, RunObserveTransportUnavailableError, type RunsListOptions, type RunsLogsOptions, type RunsLogsResult, type RunsNamespace, type RunsTailOptions, type RuntimeStepOptions, SDK_API_CONTRACT, SDK_VERSION, type SqlListenerDeclaration, type SqlListenerEvent, type SqlListenerOperation, type SqlQuery, type StartPlayRunRequest, type StepOptions, type StepProgram, type StepProgramResolver, type StepResolver, type StopPlayRunResult, type ToolDefinition, ToolExecuteResult, type ToolExecution, ToolExecutionError, ToolExecutionErrorOptions, type ToolExecutionRequest, type ToolMetadata, ToolRateLimitError, type ToolSearchOptions, type ToolSearchResult, admitMonitorFleetAuthoringContract, defineInput, defineMonitor, defineMonitorFleet, definePlay, defineWorkflow, extractSummaryFields, fleetColumn, fleetKey, formatPlayBootstrapFinderKinds, formatPlayBootstrapFinderKindsForSentence, formatPlayBootstrapTemplates, getDefinedPlayMetadata, isPlayBootstrapFinderKind, isPlayBootstrapTemplate, resolveConfig, runIf, steps, tryConvertToList, validateMonitorFleetDefinition, writeCsvOutputFile, writeJsonOutputFile };
|
package/dist/index.d.ts
CHANGED
|
@@ -1900,6 +1900,134 @@ type MonitorControls = {
|
|
|
1900
1900
|
*/
|
|
1901
1901
|
declare function defineMonitor<TPayload extends MonitorPayload = MonitorPayload>(definition: MonitorDefinition<TPayload>): MonitorDefinition<TPayload>;
|
|
1902
1902
|
|
|
1903
|
+
/**
|
|
1904
|
+
* The fleet member ceiling, mirrored — deliberately a literal.
|
|
1905
|
+
*
|
|
1906
|
+
* The canonical declaration is shared_libs/monitors/monitor-fleet-limits.ts,
|
|
1907
|
+
* which the Convex commit mutation reads to size its transaction. This package
|
|
1908
|
+
* cannot import it: the workspace-architecture ratchet forbids NEW shared_libs
|
|
1909
|
+
* imports from packages absolutely (only relocations of pre-existing edges
|
|
1910
|
+
* pass CI), because shared_libs is being migrated into workspace packages.
|
|
1911
|
+
* Until a monitors package exists, the two copies are held equal by
|
|
1912
|
+
* tests/lib/monitors/monitor-fleet-limits-mirror.test.ts — change one without
|
|
1913
|
+
* the other and that test names both files.
|
|
1914
|
+
*/
|
|
1915
|
+
declare const MONITOR_FLEET_MAX_MEMBERS = 1000;
|
|
1916
|
+
declare const MONITOR_FLEET_FRONTIER_MAX_ROWS = 10000;
|
|
1917
|
+
/**
|
|
1918
|
+
* Fleet definitions are admitted once and executed many times. Keep the
|
|
1919
|
+
* edition beside the definition just as Plays keep their authoring-contract
|
|
1920
|
+
* edition: a future syntax change can add a reader without reinterpreting a
|
|
1921
|
+
* stored Fleet under new rules.
|
|
1922
|
+
*/
|
|
1923
|
+
declare const MONITOR_FLEET_AUTHORING_CONTRACT_EDITION: 1;
|
|
1924
|
+
declare const SUPPORTED_MONITOR_FLEET_AUTHORING_CONTRACT_EDITIONS: readonly [1];
|
|
1925
|
+
type MonitorFleetAuthoringContractEdition = (typeof SUPPORTED_MONITOR_FLEET_AUTHORING_CONTRACT_EDITIONS)[number];
|
|
1926
|
+
declare const MONITOR_FLEET_AUTHORING_CONTRACT_CHANGELOG: readonly [{
|
|
1927
|
+
readonly edition: 1;
|
|
1928
|
+
readonly changed: "Initial Fleet JSON contract: bounded sticky table membership, one daily sync, and a seven-day removal grace.";
|
|
1929
|
+
readonly compatibilityOwner: "Monitors Runtime";
|
|
1930
|
+
readonly newWritesEnd: null;
|
|
1931
|
+
readonly readerRemoval: null;
|
|
1932
|
+
}];
|
|
1933
|
+
/**
|
|
1934
|
+
* Public, machine-readable guidance for every Monitor Fleet authoring
|
|
1935
|
+
* surface. SDK clients may render this directly; the CLI uses the same fixed
|
|
1936
|
+
* policy values in its help rather than maintaining another contract.
|
|
1937
|
+
*/
|
|
1938
|
+
declare const MONITOR_FLEET_DOCUMENTATION: {
|
|
1939
|
+
readonly summary: "A Monitor Fleet keeps one bounded, sticky set of ordinary monitors aligned with Customer DB rows.";
|
|
1940
|
+
readonly authoredFields: {
|
|
1941
|
+
readonly id: "Stable lowercase fleet id used by sync, pause, resume, and deactivate.";
|
|
1942
|
+
readonly source: "Customer DB table, unique row key, and optional equality filters that select candidate rows.";
|
|
1943
|
+
readonly member: "Ordinary monitor tool, stable key template, and payload evaluated for each selected source row.";
|
|
1944
|
+
readonly selection: "Deterministic ranking and an active-member limit between 1 and 1,000.";
|
|
1945
|
+
};
|
|
1946
|
+
readonly fixedPolicy: {
|
|
1947
|
+
readonly cadence: "daily";
|
|
1948
|
+
readonly membership: "sticky";
|
|
1949
|
+
readonly removalGrace: "7d";
|
|
1950
|
+
readonly onRemoved: "deactivate";
|
|
1951
|
+
readonly ownership: "A Fleet may adopt a same-tool ordinary monitor with its deterministic member key. The first Fleet claim wins; another Fleet or a different tool receives a conflict.";
|
|
1952
|
+
readonly billing: "No Fleet fee, permit, or renewal. Dry-run reports ordinary monitor lifecycle charges due now.";
|
|
1953
|
+
};
|
|
1954
|
+
readonly stickyMembership: "Ranking fills vacancies but never replaces a current member merely because another row ranks higher.";
|
|
1955
|
+
readonly columnExpression: "Use { \"$fleet\": \"column\", \"name\": \"column_name\" } in a member key or payload to read a value from each source row.";
|
|
1956
|
+
};
|
|
1957
|
+
type MonitorFleetColumn = {
|
|
1958
|
+
$fleet: 'column';
|
|
1959
|
+
name: string;
|
|
1960
|
+
};
|
|
1961
|
+
type MonitorFleetTemplate = {
|
|
1962
|
+
$fleet: 'template';
|
|
1963
|
+
parts: Array<string | MonitorFleetColumn>;
|
|
1964
|
+
};
|
|
1965
|
+
type MonitorFleetExpression = MonitorFleetColumn | MonitorFleetTemplate;
|
|
1966
|
+
type MonitorFleetDefinition = {
|
|
1967
|
+
/** Stable lowercase fleet id, used by CLI and API lifecycle commands. */
|
|
1968
|
+
id: string;
|
|
1969
|
+
/** Customer DB rows that may become members. */
|
|
1970
|
+
source: {
|
|
1971
|
+
kind: 'customer_db_table';
|
|
1972
|
+
schema: string;
|
|
1973
|
+
table: string;
|
|
1974
|
+
key: {
|
|
1975
|
+
column: string;
|
|
1976
|
+
type: 'text' | 'uuid' | 'int4' | 'int8';
|
|
1977
|
+
};
|
|
1978
|
+
where?: Record<string, string | number | boolean | null>;
|
|
1979
|
+
};
|
|
1980
|
+
/** One ordinary monitor definition, evaluated once for each selected row. */
|
|
1981
|
+
member: {
|
|
1982
|
+
tool: string;
|
|
1983
|
+
key: MonitorFleetTemplate;
|
|
1984
|
+
payload: Record<string, unknown>;
|
|
1985
|
+
};
|
|
1986
|
+
/**
|
|
1987
|
+
* Bounded deterministic candidate selection. Membership is intentionally
|
|
1988
|
+
* sticky: ranking chooses vacant slots but does not replace existing members
|
|
1989
|
+
* merely because another row's score changed.
|
|
1990
|
+
*/
|
|
1991
|
+
selection: {
|
|
1992
|
+
limit: number;
|
|
1993
|
+
orderBy: Array<{
|
|
1994
|
+
column: string;
|
|
1995
|
+
direction: 'asc' | 'desc';
|
|
1996
|
+
}>;
|
|
1997
|
+
membership: 'sticky';
|
|
1998
|
+
};
|
|
1999
|
+
};
|
|
2000
|
+
type MonitorFleetContractIssue = {
|
|
2001
|
+
path: string;
|
|
2002
|
+
code: string;
|
|
2003
|
+
message: string;
|
|
2004
|
+
};
|
|
2005
|
+
/** The durable, validated snapshot that a Fleet sync is allowed to execute. */
|
|
2006
|
+
type AdmittedMonitorFleetAuthoringContract = {
|
|
2007
|
+
edition: MonitorFleetAuthoringContractEdition;
|
|
2008
|
+
definition: MonitorFleetDefinition;
|
|
2009
|
+
};
|
|
2010
|
+
type MonitorFleetAuthoringContractResult = {
|
|
2011
|
+
valid: boolean;
|
|
2012
|
+
contract?: AdmittedMonitorFleetAuthoringContract;
|
|
2013
|
+
issues: MonitorFleetContractIssue[];
|
|
2014
|
+
};
|
|
2015
|
+
declare function fleetColumn(name: string): MonitorFleetColumn;
|
|
2016
|
+
declare function fleetKey(...parts: Array<string | MonitorFleetColumn>): MonitorFleetTemplate;
|
|
2017
|
+
declare function defineMonitorFleet<const T extends MonitorFleetDefinition>(definition: T): T;
|
|
2018
|
+
declare function validateMonitorFleetDefinition(value: unknown): {
|
|
2019
|
+
valid: boolean;
|
|
2020
|
+
definition?: MonitorFleetDefinition;
|
|
2021
|
+
issues: MonitorFleetContractIssue[];
|
|
2022
|
+
};
|
|
2023
|
+
/**
|
|
2024
|
+
* Compile JSON into the exact authoring snapshot persisted by a Fleet. This
|
|
2025
|
+
* does not inspect the Customer DB or provider; use
|
|
2026
|
+
* `fleets sync --file <fleet.json> --dry-run` for that environment-aware
|
|
2027
|
+
* preflight, which returns the real plan and the credits due.
|
|
2028
|
+
*/
|
|
2029
|
+
declare function admitMonitorFleetAuthoringContract(value: unknown, edition?: number): MonitorFleetAuthoringContractResult;
|
|
2030
|
+
|
|
1903
2031
|
interface PlayStagedFileRef {
|
|
1904
2032
|
storageKind: 'r2';
|
|
1905
2033
|
storageKey: string;
|
|
@@ -2396,6 +2524,66 @@ type MonitorDeleteResult = Record<string, unknown>;
|
|
|
2396
2524
|
type MonitorReactivateResult = Record<string, unknown>;
|
|
2397
2525
|
type MonitorTestResult = Record<string, unknown>;
|
|
2398
2526
|
type MonitorValidateResult = Record<string, unknown>;
|
|
2527
|
+
/**
|
|
2528
|
+
* Server-owned fleet response envelope.
|
|
2529
|
+
*
|
|
2530
|
+
* The server computes `status` (`converging` | `converged` | `degraded` |
|
|
2531
|
+
* `deactivating` | `deactivated`) and the SDK never recomputes it: a client
|
|
2532
|
+
* that derives its own verdict from counts drifts from the control plane the
|
|
2533
|
+
* moment the server changes what "converged" means.
|
|
2534
|
+
*/
|
|
2535
|
+
type MonitorFleetResult = Record<string, unknown>;
|
|
2536
|
+
/** Server-computed fleet verdict. Never derived client-side. */
|
|
2537
|
+
type MonitorFleetStatus = 'converging' | 'converged' | 'degraded' | 'deactivating' | 'deactivated';
|
|
2538
|
+
type MonitorFleetSyncOptions = {
|
|
2539
|
+
/** Return the plan without changing fleet state (`dry_run: true`). */
|
|
2540
|
+
dryRun?: boolean;
|
|
2541
|
+
/** Optimistic concurrency: refuse the write unless the fleet is at this generation. */
|
|
2542
|
+
expectedGeneration?: number;
|
|
2543
|
+
/** Stable retry key; generated by the caller when omitted. */
|
|
2544
|
+
idempotencyKey?: string;
|
|
2545
|
+
};
|
|
2546
|
+
type MonitorFleetGetOptions = {
|
|
2547
|
+
/** Include bounded per-member drift rows. */
|
|
2548
|
+
drift?: boolean;
|
|
2549
|
+
/** Maximum drift rows to return. */
|
|
2550
|
+
limit?: number;
|
|
2551
|
+
};
|
|
2552
|
+
type MonitorFleetDeactivateOptions = {
|
|
2553
|
+
/** Return the blast radius without deactivating anything. */
|
|
2554
|
+
dryRun?: boolean;
|
|
2555
|
+
idempotencyKey?: string;
|
|
2556
|
+
};
|
|
2557
|
+
type MonitorFleetWaitOptions = {
|
|
2558
|
+
/** Give up after this long. Default 10 minutes. */
|
|
2559
|
+
timeoutMs?: number;
|
|
2560
|
+
/** Poll cadence. Default 2 seconds. */
|
|
2561
|
+
pollIntervalMs?: number;
|
|
2562
|
+
/** Called with every polled snapshot, including the terminal one. */
|
|
2563
|
+
onProgress?: (payload: MonitorFleetResult) => void;
|
|
2564
|
+
/**
|
|
2565
|
+
* Which terminal state ends the wait. `converged` (default) also stops on
|
|
2566
|
+
* `degraded` and `deactivated`; `deactivated` stops on `deactivated` and
|
|
2567
|
+
* `degraded`. A timeout is not an error: the last snapshot is returned and
|
|
2568
|
+
* the caller reads `status` to decide the verdict.
|
|
2569
|
+
*/
|
|
2570
|
+
until?: 'converged' | 'deactivated';
|
|
2571
|
+
};
|
|
2572
|
+
type MonitorFleetsNamespace = {
|
|
2573
|
+
/**
|
|
2574
|
+
* Create, update, or re-plan a fleet. Pass a definition to admit new source
|
|
2575
|
+
* of truth; pass a fleet id to re-plan from the stored definition.
|
|
2576
|
+
*/
|
|
2577
|
+
sync: (definitionOrId: string | MonitorFleetDefinition, options?: MonitorFleetSyncOptions) => Promise<MonitorFleetResult>;
|
|
2578
|
+
/** One fleet by id, or every fleet in the workspace when the id is omitted. */
|
|
2579
|
+
get: (fleetId?: string, options?: MonitorFleetGetOptions) => Promise<MonitorFleetResult>;
|
|
2580
|
+
/** Every fleet in the workspace. */
|
|
2581
|
+
list: () => Promise<MonitorFleetResult>;
|
|
2582
|
+
/** Deactivate a fleet and the monitors it owns. */
|
|
2583
|
+
deactivate: (fleetId: string, options?: MonitorFleetDeactivateOptions) => Promise<MonitorFleetResult>;
|
|
2584
|
+
/** Poll the fleet until the server reports a terminal status (or the timeout elapses). */
|
|
2585
|
+
waitForConvergence: (fleetId: string, options?: MonitorFleetWaitOptions) => Promise<MonitorFleetResult>;
|
|
2586
|
+
};
|
|
2399
2587
|
/**
|
|
2400
2588
|
* Public monitors namespace exposed as `client.monitors`.
|
|
2401
2589
|
*
|
|
@@ -2449,6 +2637,8 @@ type MonitorsNamespace = {
|
|
|
2449
2637
|
reactivate: (key: string, options?: {
|
|
2450
2638
|
dryRun?: boolean;
|
|
2451
2639
|
}) => Promise<MonitorReactivateResult>;
|
|
2640
|
+
/** Define, reconcile, and control table-backed monitor fleets. */
|
|
2641
|
+
fleets: MonitorFleetsNamespace;
|
|
2452
2642
|
};
|
|
2453
2643
|
/** One credit grant pool reported by the billing subscription status endpoint. */
|
|
2454
2644
|
type BillingCreditPool = {
|
|
@@ -3820,6 +4010,33 @@ declare class DeeplineClient {
|
|
|
3820
4010
|
reactivateMonitor(key: string, options?: {
|
|
3821
4011
|
dryRun?: boolean;
|
|
3822
4012
|
}): Promise<MonitorReactivateResult>;
|
|
4013
|
+
private monitorFleetIdempotencyKey;
|
|
4014
|
+
private monitorFleetHeaders;
|
|
4015
|
+
private monitorFleetPath;
|
|
4016
|
+
/**
|
|
4017
|
+
* Create, update, or re-plan one fleet.
|
|
4018
|
+
*
|
|
4019
|
+
* The fleet id is always the resource path, so the same definition PUT twice
|
|
4020
|
+
* is the same operation and the server can answer `replayed: true` instead of
|
|
4021
|
+
* building a second set of monitors. Re-planning an existing fleet from its
|
|
4022
|
+
* stored definition sends an EMPTY body: there is no second definition to
|
|
4023
|
+
* send, and an empty body cannot be mistaken for "replace the definition with
|
|
4024
|
+
* nothing".
|
|
4025
|
+
*/
|
|
4026
|
+
syncMonitorFleet(definitionOrId: string | MonitorFleetDefinition, options?: MonitorFleetSyncOptions): Promise<MonitorFleetResult>;
|
|
4027
|
+
listMonitorFleets(): Promise<MonitorFleetResult>;
|
|
4028
|
+
getMonitorFleet(fleetId: string, options?: MonitorFleetGetOptions): Promise<MonitorFleetResult>;
|
|
4029
|
+
deactivateMonitorFleet(fleetId: string, options?: MonitorFleetDeactivateOptions): Promise<MonitorFleetResult>;
|
|
4030
|
+
/**
|
|
4031
|
+
* Poll one fleet until the server reports a terminal status.
|
|
4032
|
+
*
|
|
4033
|
+
* Convergence is the server's verdict, read from `status`. The timeout is not
|
|
4034
|
+
* a failure and does not throw: a fleet still `converging` after ten minutes
|
|
4035
|
+
* is healthy and slow, not broken, so the caller gets the last snapshot and
|
|
4036
|
+
* decides what that means. Throwing here would have made "still working" look
|
|
4037
|
+
* identical to "the request failed".
|
|
4038
|
+
*/
|
|
4039
|
+
waitForMonitorFleetConvergence(fleetId: string, options?: MonitorFleetWaitOptions): Promise<MonitorFleetResult>;
|
|
3823
4040
|
/**
|
|
3824
4041
|
* Check API connectivity and server health.
|
|
3825
4042
|
*
|
|
@@ -4286,8 +4503,7 @@ type PlayMetadata = {
|
|
|
4286
4503
|
/**
|
|
4287
4504
|
* High-level SDK context with tool shortcuts and play handles.
|
|
4288
4505
|
*
|
|
4289
|
-
* Created by {@link Deepline.connect}. Wraps a {@link DeeplineClient} with
|
|
4290
|
-
* a friendlier API for common operations.
|
|
4506
|
+
* Created by {@link Deepline.connect}. Wraps a {@link DeeplineClient} with a friendlier API for common operations.
|
|
4291
4507
|
*
|
|
4292
4508
|
* @example
|
|
4293
4509
|
* ```typescript
|
|
@@ -4414,12 +4630,7 @@ declare function defineInput<TInput>(schema: Record<string, unknown>): PlayInput
|
|
|
4414
4630
|
/**
|
|
4415
4631
|
* Define a play — a composable TypeScript workflow for the Deepline platform.
|
|
4416
4632
|
*
|
|
4417
|
-
* The returned value is both
|
|
4418
|
-
* 1. **A callable function** — invoked by the Temporal worker with a runtime context
|
|
4419
|
-
* 2. **A named play handle** — with `.run()`, `.versions()`, `.get()`, `.publish()`, etc. for remote lifecycle management
|
|
4420
|
-
*
|
|
4421
|
-
* Plays are the primary abstraction for building repeatable data pipelines.
|
|
4422
|
-
* They run on Temporal for durable execution with automatic retries and timeouts.
|
|
4633
|
+
* The returned value is both a callable function, invoked by the Deepline runtime with a runtime context, and a named play handle carrying `.run()`, `.versions()`, `.get()` and `.publish()` for remote lifecycle management. Plays are the primary abstraction for repeatable data pipelines and execute durably, with automatic retries and timeouts.
|
|
4423
4634
|
*
|
|
4424
4635
|
* @typeParam TInput - The input type accepted by the play
|
|
4425
4636
|
* @typeParam TOutput - The return type of the play
|
|
@@ -4824,4 +5035,4 @@ declare function writeCsvOutputFile(rows: Array<Record<string, unknown>>, stem:
|
|
|
4824
5035
|
*/
|
|
4825
5036
|
declare function extractSummaryFields(payload: unknown): Record<string, Scalar>;
|
|
4826
5037
|
|
|
4827
|
-
export { AuthError, type BillingCreditPool, type BillingInvoiceEntry, type BillingInvoicesResult, type BillingNamespace, type BillingPaymentMethodSummary, type BillingSubscriptionCancelResult, type BillingSubscriptionStatus, type BillingTopUpResult, type ClearPlayHistoryRequest, type ClearPlayHistoryResult, type ColumnMap, type ColumnResolver, type ConditionalStepResolver, ConfigError, type CsvInput, type CsvOptions, type CustomerDbQueryResult, DEEPLINE_TOOL_CATEGORIES, type DatasetBuilder, type DatasetColumnDefinition, type DatasetColumnRunInput, type DbNamespace, Deepline, DeeplineClient, type DeeplineClientOptions, DeeplineContext, DeeplineError, type DeeplineNamedPlay, type DeeplinePlayRuntimeContext, type DeeplinePlaysNamespace, type DeeplineToolCategory, type DeeplineToolsNamespace, type DefinePlayConfig, type DefinedPlay, type FetchOptions, type FileInput, type IngestionStorageRepairResult, type LiveEventEnvelope, type MonitorCheckResult, type MonitorControls, type MonitorDefinition, type MonitorDeleteResult, type MonitorDependents, type MonitorDeployResult, type MonitorDetail, type MonitorListEntry, type MonitorPayload, type MonitorReactivateResult, type MonitorSpec, type MonitorUpdateChangeSummary, type MonitorUpdateResult, type MonitorsAccessStatus, type MonitorsAvailableOptions, type MonitorsAvailableResult, type MonitorsListOptions, type MonitorsListResult, type MonitorsNamespace, 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 PlayActivityObservation, type PlayActivityState, type PlayActivityTarget, type PlayBindings, type PlayBootstrapEntityKind, type PlayBootstrapFinderKind, type PlayCallExecution, type PlayCallOptions, type PlayFetchResponse, type PlayInputContract, type PlayJob, type PlayListItem, type PlayLiveEvent, type PlayRevisionSummary, type PlayRunActionPackage, type PlayRunActivityProjection, type PlayRunDatasetActions, type PlayRunPackage, type PlayRunResult, type PlayRunStart, type PlaySheetRow, type PlaySheetRowsResult, type PlayStatus, type PlayStepProgramStep, type PrebuiltPlayRef, type PublishPlayVersionRequest, type PublishPlayVersionResult, RateLimitError, type ResolvedConfig, RunObserveTransportUnavailableError, type RunsListOptions, type RunsLogsOptions, type RunsLogsResult, type RunsNamespace, type RunsTailOptions, type RuntimeStepOptions, SDK_API_CONTRACT, SDK_VERSION, type SqlListenerDeclaration, type SqlListenerEvent, type SqlListenerOperation, type SqlQuery, type StartPlayRunRequest, type StepOptions, type StepProgram, type StepProgramResolver, type StepResolver, type StopPlayRunResult, type ToolDefinition, ToolExecuteResult, type ToolExecution, ToolExecutionError, ToolExecutionErrorOptions, type ToolExecutionRequest, type ToolMetadata, ToolRateLimitError, type ToolSearchOptions, type ToolSearchResult, defineInput, defineMonitor, definePlay, defineWorkflow, extractSummaryFields, formatPlayBootstrapFinderKinds, formatPlayBootstrapFinderKindsForSentence, formatPlayBootstrapTemplates, getDefinedPlayMetadata, isPlayBootstrapFinderKind, isPlayBootstrapTemplate, resolveConfig, runIf, steps, tryConvertToList, writeCsvOutputFile, writeJsonOutputFile };
|
|
5038
|
+
export { type AdmittedMonitorFleetAuthoringContract, AuthError, type BillingCreditPool, type BillingInvoiceEntry, type BillingInvoicesResult, type BillingNamespace, type BillingPaymentMethodSummary, type BillingSubscriptionCancelResult, type BillingSubscriptionStatus, type BillingTopUpResult, type ClearPlayHistoryRequest, type ClearPlayHistoryResult, type ColumnMap, type ColumnResolver, type ConditionalStepResolver, ConfigError, type CsvInput, type CsvOptions, type CustomerDbQueryResult, DEEPLINE_TOOL_CATEGORIES, type DatasetBuilder, type DatasetColumnDefinition, type DatasetColumnRunInput, type DbNamespace, Deepline, DeeplineClient, type DeeplineClientOptions, DeeplineContext, DeeplineError, type DeeplineNamedPlay, type DeeplinePlayRuntimeContext, type DeeplinePlaysNamespace, type DeeplineToolCategory, type DeeplineToolsNamespace, type DefinePlayConfig, type DefinedPlay, type FetchOptions, type FileInput, type IngestionStorageRepairResult, type LiveEventEnvelope, MONITOR_FLEET_AUTHORING_CONTRACT_CHANGELOG, MONITOR_FLEET_AUTHORING_CONTRACT_EDITION, MONITOR_FLEET_DOCUMENTATION, MONITOR_FLEET_FRONTIER_MAX_ROWS, MONITOR_FLEET_MAX_MEMBERS, type MonitorCheckResult, type MonitorControls, type MonitorDefinition, type MonitorDeleteResult, type MonitorDependents, type MonitorDeployResult, type MonitorDetail, type MonitorFleetAuthoringContractEdition, type MonitorFleetAuthoringContractResult, type MonitorFleetColumn, type MonitorFleetContractIssue, type MonitorFleetDeactivateOptions, type MonitorFleetDefinition, type MonitorFleetExpression, type MonitorFleetGetOptions, type MonitorFleetResult, type MonitorFleetStatus, type MonitorFleetSyncOptions, type MonitorFleetTemplate, type MonitorFleetWaitOptions, type MonitorFleetsNamespace, type MonitorListEntry, type MonitorPayload, type MonitorReactivateResult, type MonitorSpec, type MonitorUpdateChangeSummary, type MonitorUpdateResult, type MonitorsAccessStatus, type MonitorsAvailableOptions, type MonitorsAvailableResult, type MonitorsListOptions, type MonitorsListResult, type MonitorsNamespace, 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 PlayActivityObservation, type PlayActivityState, type PlayActivityTarget, type PlayBindings, type PlayBootstrapEntityKind, type PlayBootstrapFinderKind, type PlayCallExecution, type PlayCallOptions, type PlayFetchResponse, type PlayInputContract, type PlayJob, type PlayListItem, type PlayLiveEvent, type PlayRevisionSummary, type PlayRunActionPackage, type PlayRunActivityProjection, type PlayRunDatasetActions, type PlayRunPackage, type PlayRunResult, type PlayRunStart, type PlaySheetRow, type PlaySheetRowsResult, type PlayStatus, type PlayStepProgramStep, type PrebuiltPlayRef, type PublishPlayVersionRequest, type PublishPlayVersionResult, RateLimitError, type ResolvedConfig, RunObserveTransportUnavailableError, type RunsListOptions, type RunsLogsOptions, type RunsLogsResult, type RunsNamespace, type RunsTailOptions, type RuntimeStepOptions, SDK_API_CONTRACT, SDK_VERSION, type SqlListenerDeclaration, type SqlListenerEvent, type SqlListenerOperation, type SqlQuery, type StartPlayRunRequest, type StepOptions, type StepProgram, type StepProgramResolver, type StepResolver, type StopPlayRunResult, type ToolDefinition, ToolExecuteResult, type ToolExecution, ToolExecutionError, ToolExecutionErrorOptions, type ToolExecutionRequest, type ToolMetadata, ToolRateLimitError, type ToolSearchOptions, type ToolSearchResult, admitMonitorFleetAuthoringContract, defineInput, defineMonitor, defineMonitorFleet, definePlay, defineWorkflow, extractSummaryFields, fleetColumn, fleetKey, formatPlayBootstrapFinderKinds, formatPlayBootstrapFinderKindsForSentence, formatPlayBootstrapTemplates, getDefinedPlayMetadata, isPlayBootstrapFinderKind, isPlayBootstrapTemplate, resolveConfig, runIf, steps, tryConvertToList, validateMonitorFleetDefinition, writeCsvOutputFile, writeJsonOutputFile };
|