@runtypelabs/sdk 10.6.0 → 10.7.0

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/index.cjs CHANGED
@@ -5784,10 +5784,12 @@ var AgentsEndpoint = class AgentsEndpoint {
5784
5784
  return this.client.delete(`/agents/${id}`);
5785
5785
  }
5786
5786
  /**
5787
- * Export an agent as a self-contained runtime definition for @runtypelabs/runtime
5787
+ * Export an agent as a self-contained runtime definition for @runtypelabs/runtime.
5788
+ * Pass `versionId` or `alias` (at most one) to export a published version or the
5789
+ * version a release alias points at; the result's `release` records which one.
5788
5790
  */
5789
- async exportRuntime(id) {
5790
- return this.client.get(`/agents/${id}/export-runtime`);
5791
+ async exportRuntime(id, selector) {
5792
+ return this.client.get(`/agents/${id}/export-runtime`, selector);
5791
5793
  }
5792
5794
  /**
5793
5795
  * Roll up the agent's most recent runs: per-version and per-tool counts,
@@ -13481,7 +13483,7 @@ function transformQueryParams(params) {
13481
13483
  }
13482
13484
  //#endregion
13483
13485
  //#region src/version.ts
13484
- const SDK_VERSION = "10.6.0";
13486
+ const SDK_VERSION = "10.7.0";
13485
13487
  /**
13486
13488
  * Canonical client identity the API uses for attribution
13487
13489
  * (`detectActorSource` in apps/api/src/lib/audit-log.ts keys `'sdk'` off the
package/dist/index.d.cts CHANGED
@@ -5257,13 +5257,20 @@ interface paths {
5257
5257
  };
5258
5258
  /**
5259
5259
  * Export agent for runtime
5260
- * @description Export a fully-resolved, self-contained agent definition that the @runtypelabs/runtime package can consume directly at boot. Capabilities, flows, and nested sub-agents are inlined recursively (up to 3 levels). MCP credential values and external-agent auth credentials are replaced with secret-name references. Requires the `RUNTIME:EXPORT` scope and an Enterprise plan (the `byoc` entitlement); an unentitled account receives `403` with code `BYOC_PLAN_REQUIRED` in every environment.
5260
+ * @description Export a fully-resolved, self-contained agent definition that the @runtypelabs/runtime package can consume directly at boot. Capabilities, flows, and nested sub-agents are inlined recursively (up to 3 levels). Skills bound to the agent are snapshotted into `skills`, each with the skill version it resolved to, and the runtime loads them with no host wiring. MCP credential values and external-agent auth credentials are replaced with secret-name references. Requires the `RUNTIME:EXPORT` scope and an Enterprise plan (the `byoc` entitlement); an unentitled account receives `403` with code `BYOC_PLAN_REQUIRED` in every environment.
5261
5261
  *
5262
5262
  * The response carries `hostDependencies`: the runtime seams the exported artifact needs a host to wire before it can run everything it describes. A durable-class step (`wait-until` or `crawl`) anywhere in the agent's executable closure declares a `durable-pause-host` dependency; a detached-capable dynamic subagent pool or a detached inline subagent tool declares a `background-run-coordinator` dependency. The array is empty when nothing needs wiring.
5263
+ *
5264
+ * Pass at most one release selector. `versionId` exports that published version; `alias` exports the version a release alias (for example `staging`, `live` or `pr-42`) currently points at, resolved exactly as the execution selector `agent: { agentId, alias }` resolves it. With neither, the export follows the agent's default target: the version its `live` alias names when the org runs on release aliases, otherwise the agent's current definition. A version-backed export carries `release` with the resolved `versionId`, plus `alias` and `aliasRevision` when an alias selected it. An unknown version or alias, or an archived or expired alias, answers `404`.
5263
5265
  */
5264
5266
  get: {
5265
5267
  parameters: {
5266
- query?: never;
5268
+ query?: {
5269
+ /** @description Export this published agent version. Mutually exclusive with `alias`. */
5270
+ versionId?: string;
5271
+ /** @description Export the version this release alias currently points at. Mutually exclusive with `versionId`. */
5272
+ alias?: string;
5273
+ };
5267
5274
  header?: never;
5268
5275
  path: {
5269
5276
  id: string;
@@ -5294,10 +5301,18 @@ interface paths {
5294
5301
  hostDependencies: components["schemas"]["RuntimeHostDependency"][];
5295
5302
  id: string;
5296
5303
  name: string;
5304
+ /** @description The published version this export contains. `alias` and `aliasRevision` are present when a release alias selected it. Absent when the export read the agent's current definition. */
5305
+ release?: {
5306
+ alias?: string;
5307
+ aliasRevision?: number;
5308
+ versionId: string;
5309
+ };
5310
+ /** @description Skills bound to the agent, snapshotted with the skill version each resolved to. `executeAgent` loads them with no host wiring. Absent when the agent has no bound skills. */
5311
+ skills?: components["schemas"]["RuntimeExportedSkill"][];
5297
5312
  };
5298
5313
  };
5299
5314
  };
5300
- /** @description Invalid agent ID */
5315
+ /** @description Invalid agent ID, or both `versionId` and `alias` were supplied */
5301
5316
  400: {
5302
5317
  headers: {
5303
5318
  [name: string]: unknown;
@@ -5324,7 +5339,7 @@ interface paths {
5324
5339
  "application/json": components["schemas"]["Error"];
5325
5340
  };
5326
5341
  };
5327
- /** @description Agent not found */
5342
+ /** @description Agent not found, or the selected version or alias does not exist, is archived, or has expired */
5328
5343
  404: {
5329
5344
  headers: {
5330
5345
  [name: string]: unknown;
@@ -5333,6 +5348,15 @@ interface paths {
5333
5348
  "application/json": components["schemas"]["Error"];
5334
5349
  };
5335
5350
  };
5351
+ /** @description The agent type cannot export a selected version */
5352
+ 422: {
5353
+ headers: {
5354
+ [name: string]: unknown;
5355
+ };
5356
+ content: {
5357
+ "application/json": components["schemas"]["Error"];
5358
+ };
5359
+ };
5336
5360
  /** @description Internal server error */
5337
5361
  500: {
5338
5362
  headers: {
@@ -30220,7 +30244,9 @@ interface paths {
30220
30244
  data: {
30221
30245
  canvas?: unknown;
30222
30246
  capabilities: {
30247
+ agentId: string | null;
30223
30248
  capabilityName: string;
30249
+ flowId: string | null;
30224
30250
  }[];
30225
30251
  capabilityCount: number;
30226
30252
  createdAt: string;
@@ -51881,6 +51907,10 @@ interface components {
51881
51907
  };
51882
51908
  DispatchAgentJsonResponse: {
51883
51909
  agentExecutionId?: string;
51910
+ /** @description The published agent version the run executed. Absent when no stored version ran. */
51911
+ agentVersionId?: string;
51912
+ /** @description The release alias (for example `live`) the version was resolved through, when one was. */
51913
+ alias?: string;
51884
51914
  blockReason?: string;
51885
51915
  claudeManagedAgentId?: string;
51886
51916
  code?: string;
@@ -53886,6 +53916,19 @@ interface components {
53886
53916
  error: string;
53887
53917
  message?: string;
53888
53918
  };
53919
+ RuntimeExportedSkill: {
53920
+ approvalDelta: string[];
53921
+ body: string;
53922
+ description: string;
53923
+ resolvedTools: {
53924
+ [key: string]: unknown;
53925
+ }[];
53926
+ skillId?: string;
53927
+ /** @description The skill version this snapshot was resolved from. */
53928
+ skillVersionId?: string;
53929
+ /** @description Skill slug; the agent loads it as `skill:<slug>`. */
53930
+ slug: string;
53931
+ };
53889
53932
  RuntimeHostDependency: {
53890
53933
  interface: string;
53891
53934
  /** @enum {string} */
@@ -65148,9 +65191,14 @@ export declare class AgentsEndpoint {
65148
65191
  */
65149
65192
  delete(id: string): Promise<void>;
65150
65193
  /**
65151
- * Export an agent as a self-contained runtime definition for @runtypelabs/runtime
65194
+ * Export an agent as a self-contained runtime definition for @runtypelabs/runtime.
65195
+ * Pass `versionId` or `alias` (at most one) to export a published version or the
65196
+ * version a release alias points at; the result's `release` records which one.
65152
65197
  */
65153
- exportRuntime(id: string): Promise<any>;
65198
+ exportRuntime(id: string, selector?: {
65199
+ versionId?: string;
65200
+ alias?: string;
65201
+ }): Promise<any>;
65154
65202
  /**
65155
65203
  * Roll up the agent's most recent runs: per-version and per-tool counts,
65156
65204
  * average tokens and cost, and which attached tools were never called.
package/dist/index.d.ts CHANGED
@@ -5257,13 +5257,20 @@ interface paths {
5257
5257
  };
5258
5258
  /**
5259
5259
  * Export agent for runtime
5260
- * @description Export a fully-resolved, self-contained agent definition that the @runtypelabs/runtime package can consume directly at boot. Capabilities, flows, and nested sub-agents are inlined recursively (up to 3 levels). MCP credential values and external-agent auth credentials are replaced with secret-name references. Requires the `RUNTIME:EXPORT` scope and an Enterprise plan (the `byoc` entitlement); an unentitled account receives `403` with code `BYOC_PLAN_REQUIRED` in every environment.
5260
+ * @description Export a fully-resolved, self-contained agent definition that the @runtypelabs/runtime package can consume directly at boot. Capabilities, flows, and nested sub-agents are inlined recursively (up to 3 levels). Skills bound to the agent are snapshotted into `skills`, each with the skill version it resolved to, and the runtime loads them with no host wiring. MCP credential values and external-agent auth credentials are replaced with secret-name references. Requires the `RUNTIME:EXPORT` scope and an Enterprise plan (the `byoc` entitlement); an unentitled account receives `403` with code `BYOC_PLAN_REQUIRED` in every environment.
5261
5261
  *
5262
5262
  * The response carries `hostDependencies`: the runtime seams the exported artifact needs a host to wire before it can run everything it describes. A durable-class step (`wait-until` or `crawl`) anywhere in the agent's executable closure declares a `durable-pause-host` dependency; a detached-capable dynamic subagent pool or a detached inline subagent tool declares a `background-run-coordinator` dependency. The array is empty when nothing needs wiring.
5263
+ *
5264
+ * Pass at most one release selector. `versionId` exports that published version; `alias` exports the version a release alias (for example `staging`, `live` or `pr-42`) currently points at, resolved exactly as the execution selector `agent: { agentId, alias }` resolves it. With neither, the export follows the agent's default target: the version its `live` alias names when the org runs on release aliases, otherwise the agent's current definition. A version-backed export carries `release` with the resolved `versionId`, plus `alias` and `aliasRevision` when an alias selected it. An unknown version or alias, or an archived or expired alias, answers `404`.
5263
5265
  */
5264
5266
  get: {
5265
5267
  parameters: {
5266
- query?: never;
5268
+ query?: {
5269
+ /** @description Export this published agent version. Mutually exclusive with `alias`. */
5270
+ versionId?: string;
5271
+ /** @description Export the version this release alias currently points at. Mutually exclusive with `versionId`. */
5272
+ alias?: string;
5273
+ };
5267
5274
  header?: never;
5268
5275
  path: {
5269
5276
  id: string;
@@ -5294,10 +5301,18 @@ interface paths {
5294
5301
  hostDependencies: components["schemas"]["RuntimeHostDependency"][];
5295
5302
  id: string;
5296
5303
  name: string;
5304
+ /** @description The published version this export contains. `alias` and `aliasRevision` are present when a release alias selected it. Absent when the export read the agent's current definition. */
5305
+ release?: {
5306
+ alias?: string;
5307
+ aliasRevision?: number;
5308
+ versionId: string;
5309
+ };
5310
+ /** @description Skills bound to the agent, snapshotted with the skill version each resolved to. `executeAgent` loads them with no host wiring. Absent when the agent has no bound skills. */
5311
+ skills?: components["schemas"]["RuntimeExportedSkill"][];
5297
5312
  };
5298
5313
  };
5299
5314
  };
5300
- /** @description Invalid agent ID */
5315
+ /** @description Invalid agent ID, or both `versionId` and `alias` were supplied */
5301
5316
  400: {
5302
5317
  headers: {
5303
5318
  [name: string]: unknown;
@@ -5324,7 +5339,7 @@ interface paths {
5324
5339
  "application/json": components["schemas"]["Error"];
5325
5340
  };
5326
5341
  };
5327
- /** @description Agent not found */
5342
+ /** @description Agent not found, or the selected version or alias does not exist, is archived, or has expired */
5328
5343
  404: {
5329
5344
  headers: {
5330
5345
  [name: string]: unknown;
@@ -5333,6 +5348,15 @@ interface paths {
5333
5348
  "application/json": components["schemas"]["Error"];
5334
5349
  };
5335
5350
  };
5351
+ /** @description The agent type cannot export a selected version */
5352
+ 422: {
5353
+ headers: {
5354
+ [name: string]: unknown;
5355
+ };
5356
+ content: {
5357
+ "application/json": components["schemas"]["Error"];
5358
+ };
5359
+ };
5336
5360
  /** @description Internal server error */
5337
5361
  500: {
5338
5362
  headers: {
@@ -30220,7 +30244,9 @@ interface paths {
30220
30244
  data: {
30221
30245
  canvas?: unknown;
30222
30246
  capabilities: {
30247
+ agentId: string | null;
30223
30248
  capabilityName: string;
30249
+ flowId: string | null;
30224
30250
  }[];
30225
30251
  capabilityCount: number;
30226
30252
  createdAt: string;
@@ -51881,6 +51907,10 @@ interface components {
51881
51907
  };
51882
51908
  DispatchAgentJsonResponse: {
51883
51909
  agentExecutionId?: string;
51910
+ /** @description The published agent version the run executed. Absent when no stored version ran. */
51911
+ agentVersionId?: string;
51912
+ /** @description The release alias (for example `live`) the version was resolved through, when one was. */
51913
+ alias?: string;
51884
51914
  blockReason?: string;
51885
51915
  claudeManagedAgentId?: string;
51886
51916
  code?: string;
@@ -53886,6 +53916,19 @@ interface components {
53886
53916
  error: string;
53887
53917
  message?: string;
53888
53918
  };
53919
+ RuntimeExportedSkill: {
53920
+ approvalDelta: string[];
53921
+ body: string;
53922
+ description: string;
53923
+ resolvedTools: {
53924
+ [key: string]: unknown;
53925
+ }[];
53926
+ skillId?: string;
53927
+ /** @description The skill version this snapshot was resolved from. */
53928
+ skillVersionId?: string;
53929
+ /** @description Skill slug; the agent loads it as `skill:<slug>`. */
53930
+ slug: string;
53931
+ };
53889
53932
  RuntimeHostDependency: {
53890
53933
  interface: string;
53891
53934
  /** @enum {string} */
@@ -65148,9 +65191,14 @@ export declare class AgentsEndpoint {
65148
65191
  */
65149
65192
  delete(id: string): Promise<void>;
65150
65193
  /**
65151
- * Export an agent as a self-contained runtime definition for @runtypelabs/runtime
65194
+ * Export an agent as a self-contained runtime definition for @runtypelabs/runtime.
65195
+ * Pass `versionId` or `alias` (at most one) to export a published version or the
65196
+ * version a release alias points at; the result's `release` records which one.
65152
65197
  */
65153
- exportRuntime(id: string): Promise<any>;
65198
+ exportRuntime(id: string, selector?: {
65199
+ versionId?: string;
65200
+ alias?: string;
65201
+ }): Promise<any>;
65154
65202
  /**
65155
65203
  * Roll up the agent's most recent runs: per-version and per-tool counts,
65156
65204
  * average tokens and cost, and which attached tools were never called.
package/dist/index.mjs CHANGED
@@ -5783,10 +5783,12 @@ var AgentsEndpoint = class AgentsEndpoint {
5783
5783
  return this.client.delete(`/agents/${id}`);
5784
5784
  }
5785
5785
  /**
5786
- * Export an agent as a self-contained runtime definition for @runtypelabs/runtime
5786
+ * Export an agent as a self-contained runtime definition for @runtypelabs/runtime.
5787
+ * Pass `versionId` or `alias` (at most one) to export a published version or the
5788
+ * version a release alias points at; the result's `release` records which one.
5787
5789
  */
5788
- async exportRuntime(id) {
5789
- return this.client.get(`/agents/${id}/export-runtime`);
5790
+ async exportRuntime(id, selector) {
5791
+ return this.client.get(`/agents/${id}/export-runtime`, selector);
5790
5792
  }
5791
5793
  /**
5792
5794
  * Roll up the agent's most recent runs: per-version and per-tool counts,
@@ -13480,7 +13482,7 @@ function transformQueryParams(params) {
13480
13482
  }
13481
13483
  //#endregion
13482
13484
  //#region src/version.ts
13483
- const SDK_VERSION = "10.6.0";
13485
+ const SDK_VERSION = "10.7.0";
13484
13486
  /**
13485
13487
  * Canonical client identity the API uses for attribution
13486
13488
  * (`detectActorSource` in apps/api/src/lib/audit-log.ts keys `'sdk'` off the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@runtypelabs/sdk",
3
- "version": "10.6.0",
3
+ "version": "10.7.0",
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",
@@ -24,7 +24,7 @@
24
24
  ],
25
25
  "dependencies": {},
26
26
  "devDependencies": {
27
- "@runtypelabs/shared": "3.67.0",
27
+ "@runtypelabs/shared": "3.68.0",
28
28
  "openapi-typescript": "^7.13.0",
29
29
  "tsdown": "^0.23.0",
30
30
  "typescript": "^6.0.3",