@runtypelabs/sdk 11.20.0 → 11.20.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.
package/dist/index.cjs CHANGED
@@ -14832,7 +14832,7 @@ function transformQueryParams(params) {
14832
14832
  return result;
14833
14833
  }
14834
14834
  // src/version.ts
14835
- const SDK_VERSION = "11.20.0";
14835
+ const SDK_VERSION = "11.20.1";
14836
14836
  /**
14837
14837
  * Canonical client identity the API uses for attribution
14838
14838
  * (`detectActorSource` in apps/api/src/lib/audit-log.ts keys `'sdk'` off the
package/dist/index.d.cts CHANGED
@@ -41119,6 +41119,129 @@ interface paths {
41119
41119
  patch?: never;
41120
41120
  trace?: never;
41121
41121
  };
41122
+ "/v1/products/{productId}/surfaces/{surfaceId}/cli/preview": {
41123
+ parameters: {
41124
+ query?: never;
41125
+ header?: never;
41126
+ path?: never;
41127
+ cookie?: never;
41128
+ };
41129
+ /**
41130
+ * Preview a CLI surface
41131
+ * @description Renders the saved `cli` surface the way a publish would build it: the exact `--help` text of the CLI and of each command, each command's flags and an example, and the SKILL.md. Compares that build with the version the install host serves, listing added, removed and changed commands and changed settings. Reads the install host's bucket and never writes to it; a surface that is turned off still previews.
41132
+ */
41133
+ get: {
41134
+ parameters: {
41135
+ query?: never;
41136
+ header?: never;
41137
+ path: {
41138
+ productId: string;
41139
+ surfaceId: string;
41140
+ };
41141
+ cookie?: never;
41142
+ };
41143
+ requestBody?: never;
41144
+ responses: {
41145
+ /** @description Preview */
41146
+ 200: {
41147
+ headers: {
41148
+ [name: string]: unknown;
41149
+ };
41150
+ content: {
41151
+ "application/json": components["schemas"]["CliPreview"];
41152
+ };
41153
+ };
41154
+ /** @description Invalid IDs, no valid command name (`CLI_BIN_NAME_REQUIRED`) or a name the publish refuses (`CLI_NAME_REJECTED`) */
41155
+ 400: {
41156
+ headers: {
41157
+ [name: string]: unknown;
41158
+ };
41159
+ content: {
41160
+ "application/json": {
41161
+ code?: string;
41162
+ error: string;
41163
+ issues?: {
41164
+ code: string;
41165
+ message: string;
41166
+ /** @enum {string} */
41167
+ verdict: "review" | "reject";
41168
+ }[];
41169
+ };
41170
+ };
41171
+ };
41172
+ /** @description Insufficient permissions, `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account, or `CLI_INSTALL_DOMAIN_DISABLED` for an install domain while custom install domains are off */
41173
+ 403: {
41174
+ headers: {
41175
+ [name: string]: unknown;
41176
+ };
41177
+ content: {
41178
+ "application/json": {
41179
+ code?: string;
41180
+ error: string;
41181
+ issues?: {
41182
+ code: string;
41183
+ message: string;
41184
+ /** @enum {string} */
41185
+ verdict: "review" | "reject";
41186
+ }[];
41187
+ };
41188
+ };
41189
+ };
41190
+ /** @description Product or CLI surface not found */
41191
+ 404: {
41192
+ headers: {
41193
+ [name: string]: unknown;
41194
+ };
41195
+ content: {
41196
+ "application/json": components["schemas"]["Error"];
41197
+ };
41198
+ };
41199
+ /** @description `CLI_DIST_UNAVAILABLE`: the install host's storage failed */
41200
+ 502: {
41201
+ headers: {
41202
+ [name: string]: unknown;
41203
+ };
41204
+ content: {
41205
+ "application/json": {
41206
+ code?: string;
41207
+ error: string;
41208
+ issues?: {
41209
+ code: string;
41210
+ message: string;
41211
+ /** @enum {string} */
41212
+ verdict: "review" | "reject";
41213
+ }[];
41214
+ };
41215
+ };
41216
+ };
41217
+ /** @description `CLI_DIST_NOT_CONFIGURED`: this deployment has no `CLI_DIST` bucket or install host */
41218
+ 503: {
41219
+ headers: {
41220
+ [name: string]: unknown;
41221
+ };
41222
+ content: {
41223
+ "application/json": {
41224
+ code?: string;
41225
+ error: string;
41226
+ issues?: {
41227
+ code: string;
41228
+ message: string;
41229
+ /** @enum {string} */
41230
+ verdict: "review" | "reject";
41231
+ }[];
41232
+ };
41233
+ };
41234
+ };
41235
+ };
41236
+ };
41237
+ put?: never;
41238
+ post?: never;
41239
+ delete?: never;
41240
+ options?: never;
41241
+ head?: never;
41242
+ patch?: never;
41243
+ trace?: never;
41244
+ };
41122
41245
  "/v1/products/{productId}/surfaces/{surfaceId}/cli/publish": {
41123
41246
  parameters: {
41124
41247
  query?: never;
@@ -61667,6 +61790,99 @@ interface components {
61667
61790
  recordValue: string;
61668
61791
  } | null;
61669
61792
  } | null;
61793
+ CliPreview: {
61794
+ /** @description The command name the preview renders, which is also the install slug */
61795
+ binName: string;
61796
+ /** @description The built-in commands every CLI has, as `--help` lists them */
61797
+ builtins: {
61798
+ command: string;
61799
+ description: string;
61800
+ }[];
61801
+ /** @description One entry per tool command, hidden ones included, sorted by command path */
61802
+ commands: components["schemas"]["CliPreviewCommand"][];
61803
+ /** @description The name `--help` opens with: the product name */
61804
+ displayName: string;
61805
+ /** @description The exact text `<bin> --help` prints */
61806
+ help: string;
61807
+ publish: components["schemas"]["CliPreviewPublish"];
61808
+ /** @description The SKILL.md a publish writes and `<bin> skill install` installs */
61809
+ skill: string;
61810
+ };
61811
+ CliPreviewCommand: {
61812
+ /** @description Other paths that reach the command, e.g. the hyphenated name */
61813
+ aliases: string[];
61814
+ /** @description The tool shares its name with a built-in, so only `<bin> call <tool>` reaches it */
61815
+ callOnly: boolean;
61816
+ /** @description The command path after the command name, e.g. `search_tickets` or `call login` */
61817
+ command: string;
61818
+ /** @description A runnable example invocation with every required flag */
61819
+ example: string;
61820
+ /** @description The flags `<bin> <command> --help` lists, in order */
61821
+ flags: components["schemas"]["CliPreviewFlag"][];
61822
+ /** @description The exact text `<bin> <command> --help` prints */
61823
+ help: string;
61824
+ /** @description A command override hides it from `--help`; it still runs */
61825
+ hidden: boolean;
61826
+ /** @description The description is the `Execute the <tool> capability` default a capability without a description gets */
61827
+ placeholderDescription: boolean;
61828
+ /** @description The first sentence of the description, as `--help` lists it */
61829
+ summary: string;
61830
+ /** @description The MCP tool the command calls */
61831
+ tool: string;
61832
+ /** @description The usage line, e.g. `acme search_tickets <query> [flags]` */
61833
+ usage: string;
61834
+ };
61835
+ CliPreviewFlag: {
61836
+ /** @description The schema default, when it declares one */
61837
+ default?: unknown;
61838
+ /** @description The first sentence of the argument's description; empty when it has none */
61839
+ description: string;
61840
+ /** @description The accepted values of an enum argument */
61841
+ enum?: unknown[];
61842
+ /** @description The flag without its leading `--`, e.g. `ticket-id` */
61843
+ name: string;
61844
+ /** @description Also accepted as a positional argument */
61845
+ positional: boolean;
61846
+ /** @description Takes the flag more than once, one value each time */
61847
+ repeatable: boolean;
61848
+ required: boolean;
61849
+ /** @description A TypeScript-style type, as the signature line prints it, e.g. `"open" | "closed"` */
61850
+ type: string;
61851
+ /** @description The tool argument the flag sets, e.g. `ticketId` */
61852
+ wire: string;
61853
+ };
61854
+ CliPreviewPublish: {
61855
+ /** @description What a publish would change; null while unpublished */
61856
+ changes: {
61857
+ commandsAdded: {
61858
+ command: string;
61859
+ tool: string;
61860
+ }[];
61861
+ commandsChanged: {
61862
+ command: string;
61863
+ fields: ("name" | "aliases" | "hidden" | "description" | "flags")[];
61864
+ tool: string;
61865
+ }[];
61866
+ commandsRemoved: {
61867
+ command: string;
61868
+ tool: string;
61869
+ }[];
61870
+ /** @description `binName`: the published version is under another command name. `installDomain`: the requested install domain differs from the last publish. `other`: the files differ in a way no listed setting or command explains, such as a newer installer. */
61871
+ settings: ("binName" | "displayName" | "authMode" | "installDomain" | "other")[];
61872
+ } | null;
61873
+ /** @description The digest a publish of the saved surface would record */
61874
+ digest: string;
61875
+ publishedAt: string | null;
61876
+ /** @description The digest the published version recorded; null while unpublished */
61877
+ publishedDigest: string | null;
61878
+ /**
61879
+ * @description `unpublished`: the install host serves nothing for this surface. `published`: it serves exactly what a publish would write now. `changesNotPublished`: the saved surface differs from the published version.
61880
+ * @enum {string}
61881
+ */
61882
+ state: "unpublished" | "published" | "changesNotPublished";
61883
+ /** @description The published version; null while unpublished */
61884
+ version: string | null;
61885
+ };
61670
61886
  CliPublishResult: {
61671
61887
  install: components["schemas"]["CliInstallCommands"];
61672
61888
  installDomain: components["schemas"]["CliInstallDomain"];
package/dist/index.d.ts CHANGED
@@ -41119,6 +41119,129 @@ interface paths {
41119
41119
  patch?: never;
41120
41120
  trace?: never;
41121
41121
  };
41122
+ "/v1/products/{productId}/surfaces/{surfaceId}/cli/preview": {
41123
+ parameters: {
41124
+ query?: never;
41125
+ header?: never;
41126
+ path?: never;
41127
+ cookie?: never;
41128
+ };
41129
+ /**
41130
+ * Preview a CLI surface
41131
+ * @description Renders the saved `cli` surface the way a publish would build it: the exact `--help` text of the CLI and of each command, each command's flags and an example, and the SKILL.md. Compares that build with the version the install host serves, listing added, removed and changed commands and changed settings. Reads the install host's bucket and never writes to it; a surface that is turned off still previews.
41132
+ */
41133
+ get: {
41134
+ parameters: {
41135
+ query?: never;
41136
+ header?: never;
41137
+ path: {
41138
+ productId: string;
41139
+ surfaceId: string;
41140
+ };
41141
+ cookie?: never;
41142
+ };
41143
+ requestBody?: never;
41144
+ responses: {
41145
+ /** @description Preview */
41146
+ 200: {
41147
+ headers: {
41148
+ [name: string]: unknown;
41149
+ };
41150
+ content: {
41151
+ "application/json": components["schemas"]["CliPreview"];
41152
+ };
41153
+ };
41154
+ /** @description Invalid IDs, no valid command name (`CLI_BIN_NAME_REQUIRED`) or a name the publish refuses (`CLI_NAME_REJECTED`) */
41155
+ 400: {
41156
+ headers: {
41157
+ [name: string]: unknown;
41158
+ };
41159
+ content: {
41160
+ "application/json": {
41161
+ code?: string;
41162
+ error: string;
41163
+ issues?: {
41164
+ code: string;
41165
+ message: string;
41166
+ /** @enum {string} */
41167
+ verdict: "review" | "reject";
41168
+ }[];
41169
+ };
41170
+ };
41171
+ };
41172
+ /** @description Insufficient permissions, `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account, or `CLI_INSTALL_DOMAIN_DISABLED` for an install domain while custom install domains are off */
41173
+ 403: {
41174
+ headers: {
41175
+ [name: string]: unknown;
41176
+ };
41177
+ content: {
41178
+ "application/json": {
41179
+ code?: string;
41180
+ error: string;
41181
+ issues?: {
41182
+ code: string;
41183
+ message: string;
41184
+ /** @enum {string} */
41185
+ verdict: "review" | "reject";
41186
+ }[];
41187
+ };
41188
+ };
41189
+ };
41190
+ /** @description Product or CLI surface not found */
41191
+ 404: {
41192
+ headers: {
41193
+ [name: string]: unknown;
41194
+ };
41195
+ content: {
41196
+ "application/json": components["schemas"]["Error"];
41197
+ };
41198
+ };
41199
+ /** @description `CLI_DIST_UNAVAILABLE`: the install host's storage failed */
41200
+ 502: {
41201
+ headers: {
41202
+ [name: string]: unknown;
41203
+ };
41204
+ content: {
41205
+ "application/json": {
41206
+ code?: string;
41207
+ error: string;
41208
+ issues?: {
41209
+ code: string;
41210
+ message: string;
41211
+ /** @enum {string} */
41212
+ verdict: "review" | "reject";
41213
+ }[];
41214
+ };
41215
+ };
41216
+ };
41217
+ /** @description `CLI_DIST_NOT_CONFIGURED`: this deployment has no `CLI_DIST` bucket or install host */
41218
+ 503: {
41219
+ headers: {
41220
+ [name: string]: unknown;
41221
+ };
41222
+ content: {
41223
+ "application/json": {
41224
+ code?: string;
41225
+ error: string;
41226
+ issues?: {
41227
+ code: string;
41228
+ message: string;
41229
+ /** @enum {string} */
41230
+ verdict: "review" | "reject";
41231
+ }[];
41232
+ };
41233
+ };
41234
+ };
41235
+ };
41236
+ };
41237
+ put?: never;
41238
+ post?: never;
41239
+ delete?: never;
41240
+ options?: never;
41241
+ head?: never;
41242
+ patch?: never;
41243
+ trace?: never;
41244
+ };
41122
41245
  "/v1/products/{productId}/surfaces/{surfaceId}/cli/publish": {
41123
41246
  parameters: {
41124
41247
  query?: never;
@@ -61667,6 +61790,99 @@ interface components {
61667
61790
  recordValue: string;
61668
61791
  } | null;
61669
61792
  } | null;
61793
+ CliPreview: {
61794
+ /** @description The command name the preview renders, which is also the install slug */
61795
+ binName: string;
61796
+ /** @description The built-in commands every CLI has, as `--help` lists them */
61797
+ builtins: {
61798
+ command: string;
61799
+ description: string;
61800
+ }[];
61801
+ /** @description One entry per tool command, hidden ones included, sorted by command path */
61802
+ commands: components["schemas"]["CliPreviewCommand"][];
61803
+ /** @description The name `--help` opens with: the product name */
61804
+ displayName: string;
61805
+ /** @description The exact text `<bin> --help` prints */
61806
+ help: string;
61807
+ publish: components["schemas"]["CliPreviewPublish"];
61808
+ /** @description The SKILL.md a publish writes and `<bin> skill install` installs */
61809
+ skill: string;
61810
+ };
61811
+ CliPreviewCommand: {
61812
+ /** @description Other paths that reach the command, e.g. the hyphenated name */
61813
+ aliases: string[];
61814
+ /** @description The tool shares its name with a built-in, so only `<bin> call <tool>` reaches it */
61815
+ callOnly: boolean;
61816
+ /** @description The command path after the command name, e.g. `search_tickets` or `call login` */
61817
+ command: string;
61818
+ /** @description A runnable example invocation with every required flag */
61819
+ example: string;
61820
+ /** @description The flags `<bin> <command> --help` lists, in order */
61821
+ flags: components["schemas"]["CliPreviewFlag"][];
61822
+ /** @description The exact text `<bin> <command> --help` prints */
61823
+ help: string;
61824
+ /** @description A command override hides it from `--help`; it still runs */
61825
+ hidden: boolean;
61826
+ /** @description The description is the `Execute the <tool> capability` default a capability without a description gets */
61827
+ placeholderDescription: boolean;
61828
+ /** @description The first sentence of the description, as `--help` lists it */
61829
+ summary: string;
61830
+ /** @description The MCP tool the command calls */
61831
+ tool: string;
61832
+ /** @description The usage line, e.g. `acme search_tickets <query> [flags]` */
61833
+ usage: string;
61834
+ };
61835
+ CliPreviewFlag: {
61836
+ /** @description The schema default, when it declares one */
61837
+ default?: unknown;
61838
+ /** @description The first sentence of the argument's description; empty when it has none */
61839
+ description: string;
61840
+ /** @description The accepted values of an enum argument */
61841
+ enum?: unknown[];
61842
+ /** @description The flag without its leading `--`, e.g. `ticket-id` */
61843
+ name: string;
61844
+ /** @description Also accepted as a positional argument */
61845
+ positional: boolean;
61846
+ /** @description Takes the flag more than once, one value each time */
61847
+ repeatable: boolean;
61848
+ required: boolean;
61849
+ /** @description A TypeScript-style type, as the signature line prints it, e.g. `"open" | "closed"` */
61850
+ type: string;
61851
+ /** @description The tool argument the flag sets, e.g. `ticketId` */
61852
+ wire: string;
61853
+ };
61854
+ CliPreviewPublish: {
61855
+ /** @description What a publish would change; null while unpublished */
61856
+ changes: {
61857
+ commandsAdded: {
61858
+ command: string;
61859
+ tool: string;
61860
+ }[];
61861
+ commandsChanged: {
61862
+ command: string;
61863
+ fields: ("name" | "aliases" | "hidden" | "description" | "flags")[];
61864
+ tool: string;
61865
+ }[];
61866
+ commandsRemoved: {
61867
+ command: string;
61868
+ tool: string;
61869
+ }[];
61870
+ /** @description `binName`: the published version is under another command name. `installDomain`: the requested install domain differs from the last publish. `other`: the files differ in a way no listed setting or command explains, such as a newer installer. */
61871
+ settings: ("binName" | "displayName" | "authMode" | "installDomain" | "other")[];
61872
+ } | null;
61873
+ /** @description The digest a publish of the saved surface would record */
61874
+ digest: string;
61875
+ publishedAt: string | null;
61876
+ /** @description The digest the published version recorded; null while unpublished */
61877
+ publishedDigest: string | null;
61878
+ /**
61879
+ * @description `unpublished`: the install host serves nothing for this surface. `published`: it serves exactly what a publish would write now. `changesNotPublished`: the saved surface differs from the published version.
61880
+ * @enum {string}
61881
+ */
61882
+ state: "unpublished" | "published" | "changesNotPublished";
61883
+ /** @description The published version; null while unpublished */
61884
+ version: string | null;
61885
+ };
61670
61886
  CliPublishResult: {
61671
61887
  install: components["schemas"]["CliInstallCommands"];
61672
61888
  installDomain: components["schemas"]["CliInstallDomain"];
package/dist/index.mjs CHANGED
@@ -14831,7 +14831,7 @@ function transformQueryParams(params) {
14831
14831
  return result;
14832
14832
  }
14833
14833
  // src/version.ts
14834
- const SDK_VERSION = "11.20.0";
14834
+ const SDK_VERSION = "11.20.1";
14835
14835
  /**
14836
14836
  * Canonical client identity the API uses for attribution
14837
14837
  * (`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": "11.20.0",
3
+ "version": "11.20.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",
@@ -24,7 +24,7 @@
24
24
  ],
25
25
  "dependencies": {},
26
26
  "devDependencies": {
27
- "@runtypelabs/shared": "3.116.0",
27
+ "@runtypelabs/shared": "3.117.0",
28
28
  "openapi-typescript": "^7.13.0",
29
29
  "tsdown": "^0.23.2",
30
30
  "typescript": "^6.0.3",
@@ -67,6 +67,7 @@
67
67
  "clean": "rm -rf dist",
68
68
  "test": "vitest run",
69
69
  "test:watch": "vitest watch",
70
+ "test:live": "vitest run --config vitest.live.config.ts",
70
71
  "generate:types": "openapi-typescript ../../apps/api/openapi/public/v1/openapi.json -o src/generated/openapi-types.ts",
71
72
  "generate:types:check": "pnpm run generate:types && git diff --exit-code src/generated/openapi-types.ts",
72
73
  "lint": "oxlint ."