agent-remote / Exports
agent-remote
Table of contents
Classes
Interfaces
- IAssistantMessage
- ITokenUsage
- IChatExecutionRequest
- IStreamExecutionRequest
- IExecutor
- IRemoteExecutorConfig
- IHttpRequest
- IHttpResponse
- IHttpError
- IBasicMessage
- IRequestMessage
- IResponseMessage
Type Aliases
Functions
- toRequestMessage
- toResponseMessage
- createHttpRequest
- createHttpResponse
- extractContent
- generateId
- normalizeHeaders
- safeJsonParse
Type Aliases
TUniversalMessage
Ƭ TUniversalMessage: IUserMessage | IAssistantMessage | ISystemMessage | IToolMessage
Universal message union used across the SDK as the canonical contract.
Defined in
agent-core/dist/node/index.d.ts:85
THttpMethod
Ƭ THttpMethod: "GET" | "POST" | "PUT" | "DELETE"
Defined in
agent-remote/src/types/http-types.ts:10
Functions
toRequestMessage
▸ toRequestMessage<TUniversalMessage>(message, provider, model): IRequestMessage
Transform basic message to request message
Type parameters
| Name | Type |
|---|---|
TUniversalMessage | extends IBasicMessage |
Parameters
| Name | Type |
|---|---|
message | TUniversalMessage |
provider | string |
model | string |
Returns
Defined in
agent-remote/src/utils/transformers.ts:23
toResponseMessage
▸ toResponseMessage<TUniversalMessage>(message, provider?, model?): IResponseMessage
Transform basic message to response message
Type parameters
| Name | Type |
|---|---|
TUniversalMessage | extends IBasicMessage |
Parameters
| Name | Type |
|---|---|
message | TUniversalMessage |
provider? | string |
model? | string |
Returns
Defined in
agent-remote/src/utils/transformers.ts:39
createHttpRequest
▸ createHttpRequest<TData>(id, url, method, data?, headers?): IHttpRequest<TData>
Create HTTP request with type safety
Type parameters
| Name |
|---|
TData |
Parameters
| Name | Type |
|---|---|
id | string |
url | string |
method | THttpMethod |
data? | TData |
headers | Record<string, string> |
Returns
IHttpRequest<TData>
Defined in
agent-remote/src/utils/transformers.ts:70
createHttpResponse
▸ createHttpResponse<TData>(id, status, data, headers?): IHttpResponse<TData>
Create HTTP response with type safety
Type parameters
| Name |
|---|
TData |
Parameters
| Name | Type |
|---|---|
id | string |
status | number |
data | TData |
headers | Record<string, string> |
Returns
IHttpResponse<TData>
Defined in
agent-remote/src/utils/transformers.ts:97
extractContent
▸ extractContent(response): string
Extract content from response safely.
Canonical structure: response.data.data.content (nested data envelope). The server always wraps the payload in a { data: { content: ... } } envelope.
Parameters
| Name | Type |
|---|---|
response | IHttpResponse<TDefaultRequestData> |
Returns
string
Defined in
agent-remote/src/utils/transformers.ts:118
generateId
▸ generateId(prefix?): string
Generate unique ID
Parameters
| Name | Type | Default value |
|---|---|---|
prefix | string | 'id' |
Returns
string
Defined in
agent-remote/src/utils/transformers.ts:133
normalizeHeaders
▸ normalizeHeaders(headers): Record<string, string>
Normalize headers to ensure type safety
Parameters
| Name | Type |
|---|---|
headers | Record<string, string | number | boolean> |
Returns
Record<string, string>
Defined in
agent-remote/src/utils/transformers.ts:140
safeJsonParse
▸ safeJsonParse<T>(jsonString): T | null
Safe JSON parse with basic error handling.
Trust boundary: The generic parameter T is NOT validated at runtime. JSON.parse returns unknown and the cast to T is unchecked. Callers MUST validate the returned value before using it in domain logic.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
jsonString | string |
Returns
T | null