@truefoundry/trueforge-sdk 0.1.0 → 0.1.2

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/README.md CHANGED
@@ -1,15 +1,16 @@
1
- # Truefoundry TypeScript Library
1
+ # TrueForge TypeScript Library
2
2
 
3
3
  [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Truefoundry%2FTypeScript)
4
4
  [![npm shield](https://img.shields.io/npm/v/@truefoundry/trueforge-sdk)](https://www.npmjs.com/package/@truefoundry/trueforge-sdk)
5
5
 
6
- TypeScript client for the TrueForge agent harness server: a self-hosted runtime that executes agent turns and streams them over Server-Sent Events.
6
+ TypeScript client for the TrueForge Agent Harness Server: a self-hosted runtime that executes agent turns and streams them over Server-Sent Events.
7
7
 
8
8
  When auth is enabled on the server, pass an ID token via the optional `token` client option (`Authorization: Bearer`).
9
9
 
10
10
 
11
11
  ## Table of Contents
12
12
 
13
+ - [Documentation](#documentation)
13
14
  - [Installation](#installation)
14
15
  - [Reference](#reference)
15
16
  - [Usage](#usage)
@@ -31,6 +32,10 @@ When auth is enabled on the server, pass an ID token via the optional `token` cl
31
32
  - [Runtime Compatibility](#runtime-compatibility)
32
33
  - [Contributing](#contributing)
33
34
 
35
+ ## Documentation
36
+
37
+ API reference documentation is available [here](https://trueforge.dev/api/use-agent).
38
+
34
39
  ## Installation
35
40
 
36
41
  ```sh
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@truefoundry/trueforge-sdk",
46
- "X-Fern-SDK-Version": "0.1.0",
47
- "User-Agent": "@truefoundry/trueforge-sdk/0.1.0",
46
+ "X-Fern-SDK-Version": "0.1.2",
47
+ "User-Agent": "@truefoundry/trueforge-sdk/0.1.2",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -25,7 +25,7 @@ export declare class McpServersClient {
25
25
  list(requestOptions?: McpServersClient.RequestOptions): core.HttpResponsePromise<TrueForge.ListAvailableMcpServersResponse>;
26
26
  private __list;
27
27
  /**
28
- * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional redirect_url is where the OAuth callback then redirects the browser; without it the callback returns JSON.
28
+ * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional return_to is where the OAuth callback then redirects the browser; without it the callback returns JSON.
29
29
  *
30
30
  * @param {string} name - MCP server name.
31
31
  * @param {TrueForge.AuthorizeMcpServersRequest} request
@@ -55,8 +55,8 @@ export declare class McpServersClient {
55
55
  * @throws {@link errors.TrueForgeTimeoutError}
56
56
  *
57
57
  * @example
58
- * await client.mcpServers.deleteAuthorize("name")
58
+ * await client.mcpServers.deleteAuthorization("name")
59
59
  */
60
- deleteAuthorize(name: string, requestOptions?: McpServersClient.RequestOptions): core.HttpResponsePromise<TrueForge.GetMcpServerResponse>;
61
- private __deleteAuthorize;
60
+ deleteAuthorization(name: string, requestOptions?: McpServersClient.RequestOptions): core.HttpResponsePromise<TrueForge.GetMcpServerResponse>;
61
+ private __deleteAuthorization;
62
62
  }
@@ -120,7 +120,7 @@ class McpServersClient {
120
120
  });
121
121
  }
122
122
  /**
123
- * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional redirect_url is where the OAuth callback then redirects the browser; without it the callback returns JSON.
123
+ * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional return_to is where the OAuth callback then redirects the browser; without it the callback returns JSON.
124
124
  *
125
125
  * @param {string} name - MCP server name.
126
126
  * @param {TrueForge.AuthorizeMcpServersRequest} request
@@ -143,9 +143,9 @@ class McpServersClient {
143
143
  __authorize(name_1) {
144
144
  return __awaiter(this, arguments, void 0, function* (name, request = {}, requestOptions) {
145
145
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
146
- const { redirectUrl } = request;
146
+ const { returnTo } = request;
147
147
  const _queryParams = {
148
- redirect_url: redirectUrl,
148
+ return_to: returnTo,
149
149
  };
150
150
  const _authRequest = yield this._options.authProvider.getAuthRequest();
151
151
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -240,12 +240,12 @@ class McpServersClient {
240
240
  * @throws {@link errors.TrueForgeTimeoutError}
241
241
  *
242
242
  * @example
243
- * await client.mcpServers.deleteAuthorize("name")
243
+ * await client.mcpServers.deleteAuthorization("name")
244
244
  */
245
- deleteAuthorize(name, requestOptions) {
246
- return core.HttpResponsePromise.fromPromise(this.__deleteAuthorize(name, requestOptions));
245
+ deleteAuthorization(name, requestOptions) {
246
+ return core.HttpResponsePromise.fromPromise(this.__deleteAuthorization(name, requestOptions));
247
247
  }
248
- __deleteAuthorize(name, requestOptions) {
248
+ __deleteAuthorization(name, requestOptions) {
249
249
  return __awaiter(this, void 0, void 0, function* () {
250
250
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
251
251
  const _authRequest = yield this._options.authProvider.getAuthRequest();
@@ -3,6 +3,6 @@
3
3
  * {}
4
4
  */
5
5
  export interface AuthorizeMcpServersRequest {
6
- /** Optional FE landing URL the OAuth callback redirects to, with `isSuccess`/`reason` appended. */
7
- redirectUrl?: string;
6
+ /** Optional path to return to after OAuth. Must be a same-origin relative path; the OAuth callback redirects here with `isSuccess`/`reason` appended. */
7
+ returnTo?: string;
8
8
  }
@@ -171,6 +171,7 @@ export declare class SessionsClient {
171
171
  * @throws {@link TrueForge.ForbiddenError}
172
172
  * @throws {@link TrueForge.NotFoundError}
173
173
  * @throws {@link TrueForge.PreconditionFailedError}
174
+ * @throws {@link TrueForge.ContentTooLargeError}
174
175
  * @throws {@link TrueForge.UnprocessableEntityError}
175
176
  * @throws {@link errors.TrueForgeError}
176
177
  * @throws {@link errors.TrueForgeTimeoutError}
@@ -866,6 +866,14 @@ class SessionsClient {
866
866
  skipValidation: true,
867
867
  breadcrumbsPrefix: ["response"],
868
868
  }), _response.rawResponse);
869
+ case 413:
870
+ throw new TrueForge.ContentTooLargeError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
871
+ unrecognizedObjectKeys: "passthrough",
872
+ allowUnrecognizedUnionMembers: true,
873
+ allowUnrecognizedEnumValues: true,
874
+ skipValidation: true,
875
+ breadcrumbsPrefix: ["response"],
876
+ }), _response.rawResponse);
869
877
  case 422:
870
878
  throw new TrueForge.UnprocessableEntityError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
871
879
  unrecognizedObjectKeys: "passthrough",
@@ -900,6 +908,7 @@ class SessionsClient {
900
908
  * @throws {@link TrueForge.ForbiddenError}
901
909
  * @throws {@link TrueForge.NotFoundError}
902
910
  * @throws {@link TrueForge.PreconditionFailedError}
911
+ * @throws {@link TrueForge.ContentTooLargeError}
903
912
  * @throws {@link TrueForge.UnprocessableEntityError}
904
913
  * @throws {@link errors.TrueForgeError}
905
914
  * @throws {@link errors.TrueForgeTimeoutError}
@@ -980,6 +989,14 @@ class SessionsClient {
980
989
  skipValidation: true,
981
990
  breadcrumbsPrefix: ["response"],
982
991
  }), _response.rawResponse);
992
+ case 413:
993
+ throw new TrueForge.ContentTooLargeError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
994
+ unrecognizedObjectKeys: "passthrough",
995
+ allowUnrecognizedUnionMembers: true,
996
+ allowUnrecognizedEnumValues: true,
997
+ skipValidation: true,
998
+ breadcrumbsPrefix: ["response"],
999
+ }), _response.rawResponse);
983
1000
  case 422:
984
1001
  throw new TrueForge.UnprocessableEntityError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
985
1002
  unrecognizedObjectKeys: "passthrough",
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.1.0";
1
+ export declare const SDK_VERSION = "0.1.2";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.1.0";
4
+ exports.SDK_VERSION = "0.1.2";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@truefoundry/trueforge-sdk",
9
- "X-Fern-SDK-Version": "0.1.0",
10
- "User-Agent": "@truefoundry/trueforge-sdk/0.1.0",
9
+ "X-Fern-SDK-Version": "0.1.2",
10
+ "User-Agent": "@truefoundry/trueforge-sdk/0.1.2",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -25,7 +25,7 @@ export declare class McpServersClient {
25
25
  list(requestOptions?: McpServersClient.RequestOptions): core.HttpResponsePromise<TrueForge.ListAvailableMcpServersResponse>;
26
26
  private __list;
27
27
  /**
28
- * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional redirect_url is where the OAuth callback then redirects the browser; without it the callback returns JSON.
28
+ * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional return_to is where the OAuth callback then redirects the browser; without it the callback returns JSON.
29
29
  *
30
30
  * @param {string} name - MCP server name.
31
31
  * @param {TrueForge.AuthorizeMcpServersRequest} request
@@ -55,8 +55,8 @@ export declare class McpServersClient {
55
55
  * @throws {@link errors.TrueForgeTimeoutError}
56
56
  *
57
57
  * @example
58
- * await client.mcpServers.deleteAuthorize("name")
58
+ * await client.mcpServers.deleteAuthorization("name")
59
59
  */
60
- deleteAuthorize(name: string, requestOptions?: McpServersClient.RequestOptions): core.HttpResponsePromise<TrueForge.GetMcpServerResponse>;
61
- private __deleteAuthorize;
60
+ deleteAuthorization(name: string, requestOptions?: McpServersClient.RequestOptions): core.HttpResponsePromise<TrueForge.GetMcpServerResponse>;
61
+ private __deleteAuthorization;
62
62
  }
@@ -84,7 +84,7 @@ export class McpServersClient {
84
84
  });
85
85
  }
86
86
  /**
87
- * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional redirect_url is where the OAuth callback then redirects the browser; without it the callback returns JSON.
87
+ * For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional return_to is where the OAuth callback then redirects the browser; without it the callback returns JSON.
88
88
  *
89
89
  * @param {string} name - MCP server name.
90
90
  * @param {TrueForge.AuthorizeMcpServersRequest} request
@@ -107,9 +107,9 @@ export class McpServersClient {
107
107
  __authorize(name_1) {
108
108
  return __awaiter(this, arguments, void 0, function* (name, request = {}, requestOptions) {
109
109
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
110
- const { redirectUrl } = request;
110
+ const { returnTo } = request;
111
111
  const _queryParams = {
112
- redirect_url: redirectUrl,
112
+ return_to: returnTo,
113
113
  };
114
114
  const _authRequest = yield this._options.authProvider.getAuthRequest();
115
115
  const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -204,12 +204,12 @@ export class McpServersClient {
204
204
  * @throws {@link errors.TrueForgeTimeoutError}
205
205
  *
206
206
  * @example
207
- * await client.mcpServers.deleteAuthorize("name")
207
+ * await client.mcpServers.deleteAuthorization("name")
208
208
  */
209
- deleteAuthorize(name, requestOptions) {
210
- return core.HttpResponsePromise.fromPromise(this.__deleteAuthorize(name, requestOptions));
209
+ deleteAuthorization(name, requestOptions) {
210
+ return core.HttpResponsePromise.fromPromise(this.__deleteAuthorization(name, requestOptions));
211
211
  }
212
- __deleteAuthorize(name, requestOptions) {
212
+ __deleteAuthorization(name, requestOptions) {
213
213
  return __awaiter(this, void 0, void 0, function* () {
214
214
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
215
215
  const _authRequest = yield this._options.authProvider.getAuthRequest();
@@ -3,6 +3,6 @@
3
3
  * {}
4
4
  */
5
5
  export interface AuthorizeMcpServersRequest {
6
- /** Optional FE landing URL the OAuth callback redirects to, with `isSuccess`/`reason` appended. */
7
- redirectUrl?: string;
6
+ /** Optional path to return to after OAuth. Must be a same-origin relative path; the OAuth callback redirects here with `isSuccess`/`reason` appended. */
7
+ returnTo?: string;
8
8
  }
@@ -171,6 +171,7 @@ export declare class SessionsClient {
171
171
  * @throws {@link TrueForge.ForbiddenError}
172
172
  * @throws {@link TrueForge.NotFoundError}
173
173
  * @throws {@link TrueForge.PreconditionFailedError}
174
+ * @throws {@link TrueForge.ContentTooLargeError}
174
175
  * @throws {@link TrueForge.UnprocessableEntityError}
175
176
  * @throws {@link errors.TrueForgeError}
176
177
  * @throws {@link errors.TrueForgeTimeoutError}
@@ -830,6 +830,14 @@ export class SessionsClient {
830
830
  skipValidation: true,
831
831
  breadcrumbsPrefix: ["response"],
832
832
  }), _response.rawResponse);
833
+ case 413:
834
+ throw new TrueForge.ContentTooLargeError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
835
+ unrecognizedObjectKeys: "passthrough",
836
+ allowUnrecognizedUnionMembers: true,
837
+ allowUnrecognizedEnumValues: true,
838
+ skipValidation: true,
839
+ breadcrumbsPrefix: ["response"],
840
+ }), _response.rawResponse);
833
841
  case 422:
834
842
  throw new TrueForge.UnprocessableEntityError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
835
843
  unrecognizedObjectKeys: "passthrough",
@@ -864,6 +872,7 @@ export class SessionsClient {
864
872
  * @throws {@link TrueForge.ForbiddenError}
865
873
  * @throws {@link TrueForge.NotFoundError}
866
874
  * @throws {@link TrueForge.PreconditionFailedError}
875
+ * @throws {@link TrueForge.ContentTooLargeError}
867
876
  * @throws {@link TrueForge.UnprocessableEntityError}
868
877
  * @throws {@link errors.TrueForgeError}
869
878
  * @throws {@link errors.TrueForgeTimeoutError}
@@ -944,6 +953,14 @@ export class SessionsClient {
944
953
  skipValidation: true,
945
954
  breadcrumbsPrefix: ["response"],
946
955
  }), _response.rawResponse);
956
+ case 413:
957
+ throw new TrueForge.ContentTooLargeError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
958
+ unrecognizedObjectKeys: "passthrough",
959
+ allowUnrecognizedUnionMembers: true,
960
+ allowUnrecognizedEnumValues: true,
961
+ skipValidation: true,
962
+ breadcrumbsPrefix: ["response"],
963
+ }), _response.rawResponse);
947
964
  case 422:
948
965
  throw new TrueForge.UnprocessableEntityError(serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
949
966
  unrecognizedObjectKeys: "passthrough",
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.1.0";
1
+ export declare const SDK_VERSION = "0.1.2";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.1.0";
1
+ export const SDK_VERSION = "0.1.2";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@truefoundry/trueforge-sdk",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "private": false,
5
5
  "type": "commonjs",
6
6
  "main": "./dist/cjs/index.js",
@@ -242,7 +242,7 @@
242
242
  "crypto": false
243
243
  },
244
244
  "engines": {
245
- "node": ">=18.0.0"
245
+ "node": ">=22"
246
246
  },
247
247
  "sideEffects": false,
248
248
  "license": "MIT",
@@ -250,15 +250,15 @@
250
250
  "repository": {
251
251
  "type": "git",
252
252
  "url": "git+https://github.com/truefoundry/trueforge.git",
253
- "directory": "packages/sdk"
253
+ "directory": "packages/trueforge-sdk"
254
254
  },
255
- "homepage": "https://github.com/truefoundry/trueforge/tree/main/packages/sdk#readme",
255
+ "homepage": "https://github.com/truefoundry/trueforge/tree/main/packages/trueforge-sdk#readme",
256
256
  "bugs": {
257
257
  "url": "https://github.com/truefoundry/trueforge/issues"
258
258
  },
259
259
  "publishConfig": {
260
260
  "access": "public",
261
- "provenance": false
261
+ "provenance": true
262
262
  },
263
263
  "scripts": {
264
264
  "format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
package/reference.md CHANGED
@@ -563,7 +563,7 @@ await client.mcpServers.list();
563
563
  <dl>
564
564
  <dd>
565
565
 
566
- For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional redirect_url is where the OAuth callback then redirects the browser; without it the callback returns JSON.
566
+ For servers without auth returns not_required, and for header credentials returns authenticated (no browser flow). For auth.type dcr, returns authenticated when a usable (or refreshable) token exists; otherwise runs DCR if needed and returns auth_required with an authorization URL. Optional return_to is where the OAuth callback then redirects the browser; without it the callback returns JSON.
567
567
  </dd>
568
568
  </dl>
569
569
  </dd>
@@ -622,7 +622,7 @@ await client.mcpServers.authorize("name");
622
622
  </dl>
623
623
  </details>
624
624
 
625
- <details><summary><code>client.mcpServers.<a href="/src/api/resources/mcpServers/client/Client.ts">deleteAuthorize</a>(name) -> TrueForge.GetMcpServerResponse</code></summary>
625
+ <details><summary><code>client.mcpServers.<a href="/src/api/resources/mcpServers/client/Client.ts">deleteAuthorization</a>(name) -> TrueForge.GetMcpServerResponse</code></summary>
626
626
  <dl>
627
627
  <dd>
628
628
 
@@ -649,7 +649,7 @@ For auth.type dcr, deletes the stored OAuth token and returns the server with au
649
649
  <dd>
650
650
 
651
651
  ```typescript
652
- await client.mcpServers.deleteAuthorize("name");
652
+ await client.mcpServers.deleteAuthorization("name");
653
653
 
654
654
  ```
655
655
  </dd>