deepline 0.1.186 → 0.1.187
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/play.ts +24 -3
- package/dist/bundling-sources/sdk/src/release.ts +2 -2
- package/dist/bundling-sources/sdk/src/types.ts +88 -0
- package/dist/cli/index.js +1084 -197
- package/dist/cli/index.mjs +1030 -143
- package/dist/index.d.mts +113 -3
- package/dist/index.d.ts +113 -3
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +1 -1
|
@@ -117,9 +117,16 @@ import type { ToolExecution } from './client.js';
|
|
|
117
117
|
/**
|
|
118
118
|
* Optional trigger bindings for a play.
|
|
119
119
|
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
120
|
+
* A play can be triggered three ways, declared as the third argument to
|
|
121
|
+
* {@link definePlay}:
|
|
122
|
+
* - `webhook` — an inbound HTTP call (with optional HMAC signature verification);
|
|
123
|
+
* - `cron` — a schedule; or
|
|
124
|
+
* - `sqlListeners` — a **monitor**: the play runs whenever a monitor writes a new
|
|
125
|
+
* row to its output stream. This is how you build a play "on top of" a monitor
|
|
126
|
+
* (e.g. run enrichment every time a watched company posts a new job). Each
|
|
127
|
+
* listener binds to a monitor tool id + one of its output stream keys (see
|
|
128
|
+
* `deepline monitors available <id>` for a tool's streams and row columns).
|
|
129
|
+
* The changed row is delivered to the handler as the listener event's `after`.
|
|
123
130
|
*
|
|
124
131
|
* @example Webhook with HMAC verification
|
|
125
132
|
* ```typescript
|
|
@@ -141,6 +148,20 @@ import type { ToolExecution } from './client.js';
|
|
|
141
148
|
* });
|
|
142
149
|
* ```
|
|
143
150
|
*
|
|
151
|
+
* @example Monitor-triggered (run a play on a monitor's output)
|
|
152
|
+
* ```typescript
|
|
153
|
+
* definePlay('on-new-job-opening', handler, {
|
|
154
|
+
* sqlListeners: [
|
|
155
|
+
* {
|
|
156
|
+
* id: 'jobs',
|
|
157
|
+
* tool: 'tamradar.company_radar',
|
|
158
|
+
* stream: 'company_job_openings',
|
|
159
|
+
* operations: ['INSERT'],
|
|
160
|
+
* },
|
|
161
|
+
* ],
|
|
162
|
+
* });
|
|
163
|
+
* ```
|
|
164
|
+
*
|
|
144
165
|
* @sdkReference runtime 030
|
|
145
166
|
*/
|
|
146
167
|
export type PlayBindings = {
|
|
@@ -105,10 +105,10 @@ export const SDK_RELEASE = {
|
|
|
105
105
|
// 0.1.154 removes the short-lived generated enrich StepOptions recompute
|
|
106
106
|
// fields shipped in 0.1.153.
|
|
107
107
|
// 0.1.175 ships loud `deepline enrich` empty-waterfall reporting.
|
|
108
|
-
version: '0.1.
|
|
108
|
+
version: '0.1.187',
|
|
109
109
|
apiContract: '2026-06-dataset-handle-results-hard-cutover',
|
|
110
110
|
supportPolicy: {
|
|
111
|
-
latest: '0.1.
|
|
111
|
+
latest: '0.1.187',
|
|
112
112
|
minimumSupported: '0.1.53',
|
|
113
113
|
deprecatedBelow: '0.1.53',
|
|
114
114
|
commandMinimumSupported: [
|
|
@@ -922,10 +922,98 @@ export interface PlayCheckResult {
|
|
|
922
922
|
warnings?: string[];
|
|
923
923
|
staticPipeline?: Record<string, unknown> | null;
|
|
924
924
|
toolGetterHints?: PlayCheckToolGetterHint[];
|
|
925
|
+
/**
|
|
926
|
+
* Recognized trigger bindings parsed from the play source (`sqlListeners` /
|
|
927
|
+
* cron / webhook). Present only when the play declares at least one trigger,
|
|
928
|
+
* so an author can confirm the binding was recognized rather than silently
|
|
929
|
+
* dropped. Field names mirror the `definePlay` binding contract.
|
|
930
|
+
*/
|
|
931
|
+
triggers?: PlayCheckTriggersSummary | null;
|
|
932
|
+
/**
|
|
933
|
+
* Structured, machine-actionable issues surfaced by the check. An ADDITIVE
|
|
934
|
+
* channel alongside `errors[]`: every `error`-severity issue is also present
|
|
935
|
+
* in `errors[]` (so string-level tooling keeps working), while an agent can
|
|
936
|
+
* read `code` / `validOptions` / `docsHint` to self-correct. `warning`
|
|
937
|
+
* severity issues do NOT make the check invalid.
|
|
938
|
+
*/
|
|
939
|
+
issues?: PlayCheckIssue[];
|
|
940
|
+
/**
|
|
941
|
+
* Affirmative echo of what Deepline recognized — triggers, tools,
|
|
942
|
+
* datasets/columns, inputs, outputs — so a valid check reflects the parsed
|
|
943
|
+
* shape rather than a bare "ok".
|
|
944
|
+
*/
|
|
945
|
+
recognized?: PlayCheckRecognizedSummary;
|
|
946
|
+
/**
|
|
947
|
+
* Human one-liner over {@link PlayCheckResult.recognized}, e.g.
|
|
948
|
+
* `1 trigger · 2 tools · 1 dataset · 14 columns`.
|
|
949
|
+
*/
|
|
950
|
+
summary?: string;
|
|
925
951
|
artifactHash?: string | null;
|
|
926
952
|
graphHash?: string | null;
|
|
927
953
|
}
|
|
928
954
|
|
|
955
|
+
/** Severity of a {@link PlayCheckIssue}. `error` fails the check; `warning` does not. */
|
|
956
|
+
export type PlayCheckIssueSeverity = 'error' | 'warning';
|
|
957
|
+
|
|
958
|
+
/**
|
|
959
|
+
* One structured, machine-actionable issue surfaced by `deepline plays check`.
|
|
960
|
+
* Mirrors the server-side `PlayCheckIssue` contract. `code` is a stable machine
|
|
961
|
+
* code from a closed server-side set; `validOptions` enumerates the valid values
|
|
962
|
+
* (tool ids / stream keys / columns / operators) so an agent self-corrects by
|
|
963
|
+
* reading the structure instead of brute-forcing the compiler.
|
|
964
|
+
*/
|
|
965
|
+
export interface PlayCheckIssue {
|
|
966
|
+
code: string;
|
|
967
|
+
severity: PlayCheckIssueSeverity;
|
|
968
|
+
message: string;
|
|
969
|
+
path?: string;
|
|
970
|
+
hint?: string;
|
|
971
|
+
validOptions?: string[];
|
|
972
|
+
docsHint?: string;
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
/**
|
|
976
|
+
* Affirmative "here's what Deepline recognized" echo returned alongside a
|
|
977
|
+
* check's issues. Field names reuse the public play binding contract.
|
|
978
|
+
*/
|
|
979
|
+
export interface PlayCheckRecognizedSummary {
|
|
980
|
+
triggers?: PlayCheckTriggersSummary;
|
|
981
|
+
tools?: string[];
|
|
982
|
+
datasets?: { name: string; columns?: string[] }[];
|
|
983
|
+
inputs?: string[];
|
|
984
|
+
outputs?: string[];
|
|
985
|
+
}
|
|
986
|
+
|
|
987
|
+
/**
|
|
988
|
+
* One recognized SQL-listener trigger echoed back by {@link DeeplineClient.checkPlayArtifact}.
|
|
989
|
+
*/
|
|
990
|
+
export interface PlayCheckSqlListenerTrigger {
|
|
991
|
+
id: string;
|
|
992
|
+
tool?: string;
|
|
993
|
+
stream?: string;
|
|
994
|
+
operations: string[];
|
|
995
|
+
/**
|
|
996
|
+
* The recognized `sqlListeners.where` row filter, echoed back so an author can
|
|
997
|
+
* confirm Deepline bound it. Mirrors the server `StoredSqlListenerWhere` shape
|
|
998
|
+
* (`before` / `after` maps of column → operator filter). Absent when the
|
|
999
|
+
* listener declares no `where`.
|
|
1000
|
+
*/
|
|
1001
|
+
where?: {
|
|
1002
|
+
before?: Record<string, Record<string, unknown>>;
|
|
1003
|
+
after?: Record<string, Record<string, unknown>>;
|
|
1004
|
+
};
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
/**
|
|
1008
|
+
* Concise summary of the trigger bindings the server recognized for a play.
|
|
1009
|
+
* Only present triggers are populated.
|
|
1010
|
+
*/
|
|
1011
|
+
export interface PlayCheckTriggersSummary {
|
|
1012
|
+
sqlListeners?: PlayCheckSqlListenerTrigger[];
|
|
1013
|
+
cron?: { schedule: string; timezone?: string };
|
|
1014
|
+
webhook?: true;
|
|
1015
|
+
}
|
|
1016
|
+
|
|
929
1017
|
export interface PlayCheckToolGetterHint {
|
|
930
1018
|
toolId: string;
|
|
931
1019
|
lists: Array<{
|