@runtypelabs/sdk 9.4.0 → 9.5.1

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.
Files changed (6) hide show
  1. package/dist/index.cjs +2 -5
  2. package/dist/index.d.cts +49 -37
  3. package/dist/index.d.ts +49 -37
  4. package/dist/index.mjs +2 -5
  5. package/package.json +1 -1
  6. package/CHANGELOG.md +0 -3469
package/dist/index.cjs CHANGED
@@ -5691,7 +5691,6 @@ var DEFINE_SURFACE_TOP_LEVEL_KEYS = /* @__PURE__ */ new Set([
5691
5691
  "outbound",
5692
5692
  "status"
5693
5693
  ]);
5694
- var DEFINE_SURFACE_RETIRED_KEYS = /* @__PURE__ */ new Set(["environment"]);
5695
5694
  var SURFACE_DEFINITION_TYPES = /* @__PURE__ */ new Set([
5696
5695
  "chat",
5697
5696
  "mcp",
@@ -5734,9 +5733,7 @@ function defineSurface(input) {
5734
5733
  if (input.status !== void 0 && !["draft", "active", "paused"].includes(input.status)) {
5735
5734
  throw new Error('defineSurface "status" must be one of: draft, active, paused');
5736
5735
  }
5737
- const unknownKeys = Object.keys(input).filter(
5738
- (key) => !DEFINE_SURFACE_TOP_LEVEL_KEYS.has(key) && !DEFINE_SURFACE_RETIRED_KEYS.has(key)
5739
- );
5736
+ const unknownKeys = Object.keys(input).filter((key) => !DEFINE_SURFACE_TOP_LEVEL_KEYS.has(key));
5740
5737
  if (unknownKeys.length > 0) {
5741
5738
  throw new Error(
5742
5739
  `defineSurface: unknown field(s): ${unknownKeys.join(", ")}. Allowed fields are name, type, behavior, inbound, outbound, status.`
@@ -6487,7 +6484,7 @@ var Runtype = class {
6487
6484
 
6488
6485
  // src/version.ts
6489
6486
  var FALLBACK_VERSION = "0.0.0";
6490
- var SDK_VERSION = "9.4.0".length > 0 ? "9.4.0" : FALLBACK_VERSION;
6487
+ var SDK_VERSION = "9.5.1".length > 0 ? "9.5.1" : FALLBACK_VERSION;
6491
6488
  var RUNTYPE_CLIENT_KIND = "sdk";
6492
6489
  var SDK_USER_AGENT = `runtype-sdk/${SDK_VERSION} (typescript)`;
6493
6490
 
package/dist/index.d.cts CHANGED
@@ -5245,7 +5245,23 @@ interface paths {
5245
5245
  requestBody?: {
5246
5246
  content: {
5247
5247
  "application/json": {
5248
- options?: {
5248
+ /** @description Agent to execute per record instead of a flow. Saved records are loaded and their conversation read from metadata.messages; inline records reach the agent only when their type is _agent_eval or _agent_schedule and metadata.messages carries the conversation. Any other inline record type fails per record. */
5249
+ agentId?: string | null;
5250
+ flowDefinition?: components["schemas"]["BatchFlowDefinition"];
5251
+ /** @description Saved flow to execute per record. One of flowId, flowDefinition, or agentId is required. */
5252
+ flowId?: string | null;
5253
+ /** @description Flow input variables applied to every record execution. */
5254
+ inputs?: {
5255
+ [key: string]: unknown;
5256
+ } | null;
5257
+ /** @description Conversation seed passed unchanged to every record execution. Records cannot see each other's history. */
5258
+ messages?: ({
5259
+ content?: unknown;
5260
+ role: string;
5261
+ } & {
5262
+ [key: string]: unknown;
5263
+ })[] | null;
5264
+ options?: ({
5249
5265
  /** @description Records admitted to one processing chunk before progress is flushed and batch gates are re-checked. */
5250
5266
  chunkSize?: number;
5251
5267
  /** @description Flow-wide deadline passed to every per-record flow execution. */
@@ -5266,7 +5282,11 @@ interface paths {
5266
5282
  timeoutMs?: number;
5267
5283
  } & {
5268
5284
  [key: string]: unknown;
5269
- };
5285
+ }) | null;
5286
+ /** @description Saved record ids to process. May be combined with records; the batch runs the union. At least one of recordIds or records must be non-empty. Maximum 50000 records per batch across both. */
5287
+ recordIds?: string[] | null;
5288
+ /** @description Inline records to process without saving them first. May be combined with recordIds. Maximum 50000 records per batch across both. */
5289
+ records?: components["schemas"]["BatchInlineRecord"][] | null;
5270
5290
  } & {
5271
5291
  [key: string]: unknown;
5272
5292
  };
@@ -28809,8 +28829,6 @@ interface paths {
28809
28829
  cursor?: string;
28810
28830
  type?: string;
28811
28831
  status?: string;
28812
- /** @description Retired; answers 400 SURFACE_ENVIRONMENT_RETIRED. */
28813
- environment?: string;
28814
28832
  };
28815
28833
  header?: never;
28816
28834
  path: {
@@ -28832,11 +28850,6 @@ interface paths {
28832
28850
  createdAt: string;
28833
28851
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
28834
28852
  endpoint: string | null;
28835
- /**
28836
- * @deprecated
28837
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
28838
- */
28839
- environment?: string;
28840
28853
  id: string;
28841
28854
  inbound?: unknown;
28842
28855
  name: string;
@@ -28917,8 +28930,6 @@ interface paths {
28917
28930
  "application/json": {
28918
28931
  behavior?: unknown;
28919
28932
  config?: unknown;
28920
- /** @enum {string} */
28921
- environment?: "production" | "development";
28922
28933
  inbound?: {
28923
28934
  [key: string]: unknown;
28924
28935
  };
@@ -28945,11 +28956,6 @@ interface paths {
28945
28956
  createdAt: string;
28946
28957
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
28947
28958
  endpoint: string | null;
28948
- /**
28949
- * @deprecated
28950
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
28951
- */
28952
- environment?: string;
28953
28959
  id: string;
28954
28960
  inbound?: unknown;
28955
28961
  items: unknown[];
@@ -29273,11 +29279,6 @@ interface paths {
29273
29279
  createdAt: string;
29274
29280
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
29275
29281
  endpoint: string | null;
29276
- /**
29277
- * @deprecated
29278
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
29279
- */
29280
- environment?: string;
29281
29282
  id: string;
29282
29283
  inbound?: unknown;
29283
29284
  items: {
@@ -29398,8 +29399,6 @@ interface paths {
29398
29399
  "application/json": {
29399
29400
  behavior?: unknown;
29400
29401
  config?: unknown;
29401
- /** @enum {string} */
29402
- environment?: "production" | "development";
29403
29402
  inbound?: {
29404
29403
  [key: string]: unknown;
29405
29404
  };
@@ -29424,11 +29423,6 @@ interface paths {
29424
29423
  createdAt: string;
29425
29424
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
29426
29425
  endpoint: string | null;
29427
- /**
29428
- * @deprecated
29429
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
29430
- */
29431
- environment?: string;
29432
29426
  id: string;
29433
29427
  inbound?: unknown;
29434
29428
  name: string;
@@ -42133,8 +42127,6 @@ interface paths {
42133
42127
  productId?: string;
42134
42128
  type?: string;
42135
42129
  status?: string;
42136
- /** @description Retired; answers 400 SURFACE_ENVIRONMENT_RETIRED. */
42137
- environment?: string;
42138
42130
  };
42139
42131
  header?: never;
42140
42132
  path?: never;
@@ -42153,11 +42145,6 @@ interface paths {
42153
42145
  createdAt: string;
42154
42146
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
42155
42147
  endpoint: string | null;
42156
- /**
42157
- * @deprecated
42158
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
42159
- */
42160
- environment?: string;
42161
42148
  id: string;
42162
42149
  inbound: {
42163
42150
  appId?: string;
@@ -44318,6 +44305,7 @@ interface paths {
44318
44305
  enableSelfServeOauthClients: boolean;
44319
44306
  enableVoice: boolean;
44320
44307
  enableWorkspaceModel: boolean;
44308
+ externalTelemetryAllowed?: boolean;
44321
44309
  modelCreditPromoMultiplier?: number;
44322
44310
  workspaceModelEligible: boolean;
44323
44311
  workspaceModelReady: boolean;
@@ -45122,6 +45110,32 @@ interface components {
45122
45110
  */
45123
45111
  targetKind: "flow" | "agent";
45124
45112
  };
45113
+ /** @description Inline flow definition executed per record without saving the flow. */
45114
+ BatchFlowDefinition: ({
45115
+ description?: string | null;
45116
+ /** @description Saved-flow identity retained when the definition is a pinned snapshot. */
45117
+ id?: string;
45118
+ name: string;
45119
+ /** @description Flow steps, in the same shape as a saved flow definition. */
45120
+ steps: {
45121
+ [key: string]: unknown;
45122
+ }[];
45123
+ } & {
45124
+ [key: string]: unknown;
45125
+ }) | null;
45126
+ /** @description An ad-hoc record processed in place of a saved record. Inline records never touch the records table; each is minted a synthetic id for the lifetime of the batch. */
45127
+ BatchInlineRecord: {
45128
+ /** @description Arbitrary JSON payload exposed to the flow as {{_record.metadata.*}}. Any shape is accepted; nothing is written to the records table. */
45129
+ metadata: {
45130
+ [key: string]: unknown;
45131
+ };
45132
+ /** @description Display name for the record. Batch results and step results are keyed by this name, so keep it unique within one batch. */
45133
+ name: string;
45134
+ /** @description Record type label exposed to the flow as {{_record.type}}. */
45135
+ type: string;
45136
+ } & {
45137
+ [key: string]: unknown;
45138
+ };
45125
45139
  CaptureExecutionPreview: {
45126
45140
  /** @description The recorded tool-call actions in invocation order — the fork-picker rows. */
45127
45141
  actions: components["schemas"]["CaptureExecutionPreviewAction"][];
@@ -52875,8 +52889,6 @@ interface DefineSurfaceInput {
52875
52889
  inbound?: Record<string, unknown>;
52876
52890
  outbound?: Record<string, unknown>;
52877
52891
  status?: SurfaceDefinitionStatus;
52878
- /** @deprecated Surface environment was retired (ADR 0023); accepted and dropped. */
52879
- environment?: 'production' | 'development';
52880
52892
  }
52881
52893
  /** The canonical (wire) definition produced by `defineSurface`. */
52882
52894
  interface SurfaceDefinition {
package/dist/index.d.ts CHANGED
@@ -5245,7 +5245,23 @@ interface paths {
5245
5245
  requestBody?: {
5246
5246
  content: {
5247
5247
  "application/json": {
5248
- options?: {
5248
+ /** @description Agent to execute per record instead of a flow. Saved records are loaded and their conversation read from metadata.messages; inline records reach the agent only when their type is _agent_eval or _agent_schedule and metadata.messages carries the conversation. Any other inline record type fails per record. */
5249
+ agentId?: string | null;
5250
+ flowDefinition?: components["schemas"]["BatchFlowDefinition"];
5251
+ /** @description Saved flow to execute per record. One of flowId, flowDefinition, or agentId is required. */
5252
+ flowId?: string | null;
5253
+ /** @description Flow input variables applied to every record execution. */
5254
+ inputs?: {
5255
+ [key: string]: unknown;
5256
+ } | null;
5257
+ /** @description Conversation seed passed unchanged to every record execution. Records cannot see each other's history. */
5258
+ messages?: ({
5259
+ content?: unknown;
5260
+ role: string;
5261
+ } & {
5262
+ [key: string]: unknown;
5263
+ })[] | null;
5264
+ options?: ({
5249
5265
  /** @description Records admitted to one processing chunk before progress is flushed and batch gates are re-checked. */
5250
5266
  chunkSize?: number;
5251
5267
  /** @description Flow-wide deadline passed to every per-record flow execution. */
@@ -5266,7 +5282,11 @@ interface paths {
5266
5282
  timeoutMs?: number;
5267
5283
  } & {
5268
5284
  [key: string]: unknown;
5269
- };
5285
+ }) | null;
5286
+ /** @description Saved record ids to process. May be combined with records; the batch runs the union. At least one of recordIds or records must be non-empty. Maximum 50000 records per batch across both. */
5287
+ recordIds?: string[] | null;
5288
+ /** @description Inline records to process without saving them first. May be combined with recordIds. Maximum 50000 records per batch across both. */
5289
+ records?: components["schemas"]["BatchInlineRecord"][] | null;
5270
5290
  } & {
5271
5291
  [key: string]: unknown;
5272
5292
  };
@@ -28809,8 +28829,6 @@ interface paths {
28809
28829
  cursor?: string;
28810
28830
  type?: string;
28811
28831
  status?: string;
28812
- /** @description Retired; answers 400 SURFACE_ENVIRONMENT_RETIRED. */
28813
- environment?: string;
28814
28832
  };
28815
28833
  header?: never;
28816
28834
  path: {
@@ -28832,11 +28850,6 @@ interface paths {
28832
28850
  createdAt: string;
28833
28851
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
28834
28852
  endpoint: string | null;
28835
- /**
28836
- * @deprecated
28837
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
28838
- */
28839
- environment?: string;
28840
28853
  id: string;
28841
28854
  inbound?: unknown;
28842
28855
  name: string;
@@ -28917,8 +28930,6 @@ interface paths {
28917
28930
  "application/json": {
28918
28931
  behavior?: unknown;
28919
28932
  config?: unknown;
28920
- /** @enum {string} */
28921
- environment?: "production" | "development";
28922
28933
  inbound?: {
28923
28934
  [key: string]: unknown;
28924
28935
  };
@@ -28945,11 +28956,6 @@ interface paths {
28945
28956
  createdAt: string;
28946
28957
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
28947
28958
  endpoint: string | null;
28948
- /**
28949
- * @deprecated
28950
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
28951
- */
28952
- environment?: string;
28953
28959
  id: string;
28954
28960
  inbound?: unknown;
28955
28961
  items: unknown[];
@@ -29273,11 +29279,6 @@ interface paths {
29273
29279
  createdAt: string;
29274
29280
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
29275
29281
  endpoint: string | null;
29276
- /**
29277
- * @deprecated
29278
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
29279
- */
29280
- environment?: string;
29281
29282
  id: string;
29282
29283
  inbound?: unknown;
29283
29284
  items: {
@@ -29398,8 +29399,6 @@ interface paths {
29398
29399
  "application/json": {
29399
29400
  behavior?: unknown;
29400
29401
  config?: unknown;
29401
- /** @enum {string} */
29402
- environment?: "production" | "development";
29403
29402
  inbound?: {
29404
29403
  [key: string]: unknown;
29405
29404
  };
@@ -29424,11 +29423,6 @@ interface paths {
29424
29423
  createdAt: string;
29425
29424
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
29426
29425
  endpoint: string | null;
29427
- /**
29428
- * @deprecated
29429
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
29430
- */
29431
- environment?: string;
29432
29426
  id: string;
29433
29427
  inbound?: unknown;
29434
29428
  name: string;
@@ -42133,8 +42127,6 @@ interface paths {
42133
42127
  productId?: string;
42134
42128
  type?: string;
42135
42129
  status?: string;
42136
- /** @description Retired; answers 400 SURFACE_ENVIRONMENT_RETIRED. */
42137
- environment?: string;
42138
42130
  };
42139
42131
  header?: never;
42140
42132
  path?: never;
@@ -42153,11 +42145,6 @@ interface paths {
42153
42145
  createdAt: string;
42154
42146
  /** @description Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, ...). Clients should use this instead of constructing the URL themselves. */
42155
42147
  endpoint: string | null;
42156
- /**
42157
- * @deprecated
42158
- * @description Always 'production'. Surface environment was retired (ADR 0023); the field is removed together with the retained column.
42159
- */
42160
- environment?: string;
42161
42148
  id: string;
42162
42149
  inbound: {
42163
42150
  appId?: string;
@@ -44318,6 +44305,7 @@ interface paths {
44318
44305
  enableSelfServeOauthClients: boolean;
44319
44306
  enableVoice: boolean;
44320
44307
  enableWorkspaceModel: boolean;
44308
+ externalTelemetryAllowed?: boolean;
44321
44309
  modelCreditPromoMultiplier?: number;
44322
44310
  workspaceModelEligible: boolean;
44323
44311
  workspaceModelReady: boolean;
@@ -45122,6 +45110,32 @@ interface components {
45122
45110
  */
45123
45111
  targetKind: "flow" | "agent";
45124
45112
  };
45113
+ /** @description Inline flow definition executed per record without saving the flow. */
45114
+ BatchFlowDefinition: ({
45115
+ description?: string | null;
45116
+ /** @description Saved-flow identity retained when the definition is a pinned snapshot. */
45117
+ id?: string;
45118
+ name: string;
45119
+ /** @description Flow steps, in the same shape as a saved flow definition. */
45120
+ steps: {
45121
+ [key: string]: unknown;
45122
+ }[];
45123
+ } & {
45124
+ [key: string]: unknown;
45125
+ }) | null;
45126
+ /** @description An ad-hoc record processed in place of a saved record. Inline records never touch the records table; each is minted a synthetic id for the lifetime of the batch. */
45127
+ BatchInlineRecord: {
45128
+ /** @description Arbitrary JSON payload exposed to the flow as {{_record.metadata.*}}. Any shape is accepted; nothing is written to the records table. */
45129
+ metadata: {
45130
+ [key: string]: unknown;
45131
+ };
45132
+ /** @description Display name for the record. Batch results and step results are keyed by this name, so keep it unique within one batch. */
45133
+ name: string;
45134
+ /** @description Record type label exposed to the flow as {{_record.type}}. */
45135
+ type: string;
45136
+ } & {
45137
+ [key: string]: unknown;
45138
+ };
45125
45139
  CaptureExecutionPreview: {
45126
45140
  /** @description The recorded tool-call actions in invocation order — the fork-picker rows. */
45127
45141
  actions: components["schemas"]["CaptureExecutionPreviewAction"][];
@@ -52875,8 +52889,6 @@ interface DefineSurfaceInput {
52875
52889
  inbound?: Record<string, unknown>;
52876
52890
  outbound?: Record<string, unknown>;
52877
52891
  status?: SurfaceDefinitionStatus;
52878
- /** @deprecated Surface environment was retired (ADR 0023); accepted and dropped. */
52879
- environment?: 'production' | 'development';
52880
52892
  }
52881
52893
  /** The canonical (wire) definition produced by `defineSurface`. */
52882
52894
  interface SurfaceDefinition {
package/dist/index.mjs CHANGED
@@ -5496,7 +5496,6 @@ var DEFINE_SURFACE_TOP_LEVEL_KEYS = /* @__PURE__ */ new Set([
5496
5496
  "outbound",
5497
5497
  "status"
5498
5498
  ]);
5499
- var DEFINE_SURFACE_RETIRED_KEYS = /* @__PURE__ */ new Set(["environment"]);
5500
5499
  var SURFACE_DEFINITION_TYPES = /* @__PURE__ */ new Set([
5501
5500
  "chat",
5502
5501
  "mcp",
@@ -5539,9 +5538,7 @@ function defineSurface(input) {
5539
5538
  if (input.status !== void 0 && !["draft", "active", "paused"].includes(input.status)) {
5540
5539
  throw new Error('defineSurface "status" must be one of: draft, active, paused');
5541
5540
  }
5542
- const unknownKeys = Object.keys(input).filter(
5543
- (key) => !DEFINE_SURFACE_TOP_LEVEL_KEYS.has(key) && !DEFINE_SURFACE_RETIRED_KEYS.has(key)
5544
- );
5541
+ const unknownKeys = Object.keys(input).filter((key) => !DEFINE_SURFACE_TOP_LEVEL_KEYS.has(key));
5545
5542
  if (unknownKeys.length > 0) {
5546
5543
  throw new Error(
5547
5544
  `defineSurface: unknown field(s): ${unknownKeys.join(", ")}. Allowed fields are name, type, behavior, inbound, outbound, status.`
@@ -6292,7 +6289,7 @@ var Runtype = class {
6292
6289
 
6293
6290
  // src/version.ts
6294
6291
  var FALLBACK_VERSION = "0.0.0";
6295
- var SDK_VERSION = "9.4.0".length > 0 ? "9.4.0" : FALLBACK_VERSION;
6292
+ var SDK_VERSION = "9.5.1".length > 0 ? "9.5.1" : FALLBACK_VERSION;
6296
6293
  var RUNTYPE_CLIENT_KIND = "sdk";
6297
6294
  var SDK_USER_AGENT = `runtype-sdk/${SDK_VERSION} (typescript)`;
6298
6295
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@runtypelabs/sdk",
3
- "version": "9.4.0",
3
+ "version": "9.5.1",
4
4
  "type": "module",
5
5
  "description": "TypeScript SDK for the Runtype API with fluent methods. Use it to quickly realize AI products, agents, and workflows.",
6
6
  "main": "dist/index.cjs",