@mastra/client-js 1.6.0 → 1.7.0-alpha.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/CHANGELOG.md +11 -0
- package/dist/client.d.ts +20 -2
- package/dist/client.d.ts.map +1 -1
- package/dist/index.cjs +208 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +208 -0
- package/dist/index.js.map +1 -1
- package/dist/resources/index.d.ts +1 -0
- package/dist/resources/index.d.ts.map +1 -1
- package/dist/resources/stored-prompt-block.d.ts +83 -0
- package/dist/resources/stored-prompt-block.d.ts.map +1 -0
- package/dist/types.d.ts +112 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +5 -5
- package/dist/docs/SKILL.md +0 -44
- package/dist/docs/assets/SOURCE_MAP.json +0 -6
- package/dist/docs/references/docs-server-auth-auth0.md +0 -222
- package/dist/docs/references/docs-server-auth-clerk.md +0 -132
- package/dist/docs/references/docs-server-auth-firebase.md +0 -272
- package/dist/docs/references/docs-server-auth-jwt.md +0 -110
- package/dist/docs/references/docs-server-auth-supabase.md +0 -117
- package/dist/docs/references/docs-server-auth-workos.md +0 -190
- package/dist/docs/references/docs-server-mastra-client.md +0 -243
- package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +0 -232
- package/dist/docs/references/reference-ai-sdk-to-ai-sdk-v4-messages.md +0 -79
- package/dist/docs/references/reference-ai-sdk-to-ai-sdk-v5-messages.md +0 -73
- package/dist/docs/references/reference-client-js-agents.md +0 -438
- package/dist/docs/references/reference-client-js-error-handling.md +0 -16
- package/dist/docs/references/reference-client-js-logs.md +0 -24
- package/dist/docs/references/reference-client-js-mastra-client.md +0 -63
- package/dist/docs/references/reference-client-js-memory.md +0 -225
- package/dist/docs/references/reference-client-js-observability.md +0 -72
- package/dist/docs/references/reference-client-js-telemetry.md +0 -20
- package/dist/docs/references/reference-client-js-tools.md +0 -44
- package/dist/docs/references/reference-client-js-vectors.md +0 -79
- package/dist/docs/references/reference-client-js-workflows.md +0 -199
package/dist/index.js
CHANGED
|
@@ -4097,6 +4097,159 @@ var StoredAgent = class extends BaseResource {
|
|
|
4097
4097
|
}
|
|
4098
4098
|
};
|
|
4099
4099
|
|
|
4100
|
+
// src/resources/stored-prompt-block.ts
|
|
4101
|
+
var StoredPromptBlock = class extends BaseResource {
|
|
4102
|
+
constructor(options, storedPromptBlockId) {
|
|
4103
|
+
super(options);
|
|
4104
|
+
this.storedPromptBlockId = storedPromptBlockId;
|
|
4105
|
+
}
|
|
4106
|
+
/**
|
|
4107
|
+
* Retrieves details about the stored prompt block
|
|
4108
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4109
|
+
* @param options - Optional options like status filter
|
|
4110
|
+
* @returns Promise containing stored prompt block details
|
|
4111
|
+
*/
|
|
4112
|
+
details(requestContext, options) {
|
|
4113
|
+
const contextString = requestContextQueryString(requestContext);
|
|
4114
|
+
const statusParam = options?.status ? `status=${options.status}` : "";
|
|
4115
|
+
const url = `/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}${contextString}${statusParam ? `${contextString ? "&" : "?"}${statusParam}` : ""}`;
|
|
4116
|
+
return this.request(url);
|
|
4117
|
+
}
|
|
4118
|
+
/**
|
|
4119
|
+
* Updates the stored prompt block with the provided fields
|
|
4120
|
+
* @param params - Fields to update
|
|
4121
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4122
|
+
* @returns Promise containing the updated stored prompt block
|
|
4123
|
+
*/
|
|
4124
|
+
update(params, requestContext) {
|
|
4125
|
+
return this.request(
|
|
4126
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}${requestContextQueryString(requestContext)}`,
|
|
4127
|
+
{
|
|
4128
|
+
method: "PATCH",
|
|
4129
|
+
body: params
|
|
4130
|
+
}
|
|
4131
|
+
);
|
|
4132
|
+
}
|
|
4133
|
+
/**
|
|
4134
|
+
* Deletes the stored prompt block
|
|
4135
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4136
|
+
* @returns Promise containing deletion confirmation
|
|
4137
|
+
*/
|
|
4138
|
+
delete(requestContext) {
|
|
4139
|
+
return this.request(
|
|
4140
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}${requestContextQueryString(requestContext)}`,
|
|
4141
|
+
{
|
|
4142
|
+
method: "DELETE"
|
|
4143
|
+
}
|
|
4144
|
+
);
|
|
4145
|
+
}
|
|
4146
|
+
// ==========================================================================
|
|
4147
|
+
// Version Methods
|
|
4148
|
+
// ==========================================================================
|
|
4149
|
+
/**
|
|
4150
|
+
* Lists all versions for this stored prompt block
|
|
4151
|
+
* @param params - Optional pagination and sorting parameters
|
|
4152
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4153
|
+
* @returns Promise containing paginated list of versions
|
|
4154
|
+
*/
|
|
4155
|
+
listVersions(params, requestContext) {
|
|
4156
|
+
const queryParams = new URLSearchParams();
|
|
4157
|
+
if (params?.page !== void 0) queryParams.set("page", String(params.page));
|
|
4158
|
+
if (params?.perPage !== void 0) queryParams.set("perPage", String(params.perPage));
|
|
4159
|
+
if (params?.orderBy) queryParams.set("orderBy", params.orderBy);
|
|
4160
|
+
if (params?.sortDirection) queryParams.set("sortDirection", params.sortDirection);
|
|
4161
|
+
const queryString = queryParams.toString();
|
|
4162
|
+
const contextString = requestContextQueryString(requestContext, queryString ? "&" : "?");
|
|
4163
|
+
return this.request(
|
|
4164
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}/versions${queryString ? `?${queryString}` : ""}${contextString}`
|
|
4165
|
+
);
|
|
4166
|
+
}
|
|
4167
|
+
/**
|
|
4168
|
+
* Creates a new version snapshot for this stored prompt block
|
|
4169
|
+
* @param params - Optional name and change message for the version
|
|
4170
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4171
|
+
* @returns Promise containing the created version
|
|
4172
|
+
*/
|
|
4173
|
+
createVersion(params, requestContext) {
|
|
4174
|
+
return this.request(
|
|
4175
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}/versions${requestContextQueryString(requestContext)}`,
|
|
4176
|
+
{
|
|
4177
|
+
method: "POST",
|
|
4178
|
+
body: params || {}
|
|
4179
|
+
}
|
|
4180
|
+
);
|
|
4181
|
+
}
|
|
4182
|
+
/**
|
|
4183
|
+
* Retrieves a specific version by its ID
|
|
4184
|
+
* @param versionId - The UUID of the version to retrieve
|
|
4185
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4186
|
+
* @returns Promise containing the version details
|
|
4187
|
+
*/
|
|
4188
|
+
getVersion(versionId, requestContext) {
|
|
4189
|
+
return this.request(
|
|
4190
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}/versions/${encodeURIComponent(versionId)}${requestContextQueryString(requestContext)}`
|
|
4191
|
+
);
|
|
4192
|
+
}
|
|
4193
|
+
/**
|
|
4194
|
+
* Activates a specific version, making it the active version for this prompt block
|
|
4195
|
+
* @param versionId - The UUID of the version to activate
|
|
4196
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4197
|
+
* @returns Promise containing activation confirmation with success status, message, and active version ID
|
|
4198
|
+
*/
|
|
4199
|
+
activateVersion(versionId, requestContext) {
|
|
4200
|
+
return this.request(
|
|
4201
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}/versions/${encodeURIComponent(versionId)}/activate${requestContextQueryString(requestContext)}`,
|
|
4202
|
+
{
|
|
4203
|
+
method: "POST"
|
|
4204
|
+
}
|
|
4205
|
+
);
|
|
4206
|
+
}
|
|
4207
|
+
/**
|
|
4208
|
+
* Restores a version by creating a new version with the same configuration
|
|
4209
|
+
* @param versionId - The UUID of the version to restore
|
|
4210
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4211
|
+
* @returns Promise containing the newly created version
|
|
4212
|
+
*/
|
|
4213
|
+
restoreVersion(versionId, requestContext) {
|
|
4214
|
+
return this.request(
|
|
4215
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}/versions/${encodeURIComponent(versionId)}/restore${requestContextQueryString(requestContext)}`,
|
|
4216
|
+
{
|
|
4217
|
+
method: "POST"
|
|
4218
|
+
}
|
|
4219
|
+
);
|
|
4220
|
+
}
|
|
4221
|
+
/**
|
|
4222
|
+
* Deletes a specific version
|
|
4223
|
+
* @param versionId - The UUID of the version to delete
|
|
4224
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4225
|
+
* @returns Promise that resolves with deletion response
|
|
4226
|
+
*/
|
|
4227
|
+
deleteVersion(versionId, requestContext) {
|
|
4228
|
+
return this.request(
|
|
4229
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}/versions/${encodeURIComponent(versionId)}${requestContextQueryString(requestContext)}`,
|
|
4230
|
+
{
|
|
4231
|
+
method: "DELETE"
|
|
4232
|
+
}
|
|
4233
|
+
);
|
|
4234
|
+
}
|
|
4235
|
+
/**
|
|
4236
|
+
* Compares two versions and returns their differences
|
|
4237
|
+
* @param fromId - The UUID of the source version
|
|
4238
|
+
* @param toId - The UUID of the target version
|
|
4239
|
+
* @param requestContext - Optional request context to pass as query parameter
|
|
4240
|
+
* @returns Promise containing the comparison results
|
|
4241
|
+
*/
|
|
4242
|
+
compareVersions(fromId, toId, requestContext) {
|
|
4243
|
+
const queryParams = new URLSearchParams();
|
|
4244
|
+
queryParams.set("from", fromId);
|
|
4245
|
+
queryParams.set("to", toId);
|
|
4246
|
+
const contextString = requestContextQueryString(requestContext, "&");
|
|
4247
|
+
return this.request(
|
|
4248
|
+
`/stored/prompt-blocks/${encodeURIComponent(this.storedPromptBlockId)}/versions/compare?${queryParams.toString()}${contextString}`
|
|
4249
|
+
);
|
|
4250
|
+
}
|
|
4251
|
+
};
|
|
4252
|
+
|
|
4100
4253
|
// src/resources/stored-mcp-client.ts
|
|
4101
4254
|
var StoredMCPClient = class extends BaseResource {
|
|
4102
4255
|
constructor(options, storedMCPClientId) {
|
|
@@ -5288,6 +5441,61 @@ var MastraClient = class extends BaseResource {
|
|
|
5288
5441
|
return new StoredAgent(this.options, storedAgentId);
|
|
5289
5442
|
}
|
|
5290
5443
|
// ============================================================================
|
|
5444
|
+
// Stored Prompt Blocks
|
|
5445
|
+
// ============================================================================
|
|
5446
|
+
/**
|
|
5447
|
+
* Lists all stored prompt blocks with optional pagination
|
|
5448
|
+
* @param params - Optional pagination and ordering parameters
|
|
5449
|
+
* @returns Promise containing paginated list of stored prompt blocks
|
|
5450
|
+
*/
|
|
5451
|
+
listStoredPromptBlocks(params) {
|
|
5452
|
+
const searchParams = new URLSearchParams();
|
|
5453
|
+
if (params?.page !== void 0) {
|
|
5454
|
+
searchParams.set("page", String(params.page));
|
|
5455
|
+
}
|
|
5456
|
+
if (params?.perPage !== void 0) {
|
|
5457
|
+
searchParams.set("perPage", String(params.perPage));
|
|
5458
|
+
}
|
|
5459
|
+
if (params?.orderBy) {
|
|
5460
|
+
if (params.orderBy.field) {
|
|
5461
|
+
searchParams.set("orderBy[field]", params.orderBy.field);
|
|
5462
|
+
}
|
|
5463
|
+
if (params.orderBy.direction) {
|
|
5464
|
+
searchParams.set("orderBy[direction]", params.orderBy.direction);
|
|
5465
|
+
}
|
|
5466
|
+
}
|
|
5467
|
+
if (params?.authorId) {
|
|
5468
|
+
searchParams.set("authorId", params.authorId);
|
|
5469
|
+
}
|
|
5470
|
+
if (params?.status) {
|
|
5471
|
+
searchParams.set("status", params.status);
|
|
5472
|
+
}
|
|
5473
|
+
if (params?.metadata) {
|
|
5474
|
+
searchParams.set("metadata", JSON.stringify(params.metadata));
|
|
5475
|
+
}
|
|
5476
|
+
const queryString = searchParams.toString();
|
|
5477
|
+
return this.request(`/stored/prompt-blocks${queryString ? `?${queryString}` : ""}`);
|
|
5478
|
+
}
|
|
5479
|
+
/**
|
|
5480
|
+
* Creates a new stored prompt block
|
|
5481
|
+
* @param params - Prompt block configuration including name, content, rules, etc.
|
|
5482
|
+
* @returns Promise containing the created stored prompt block
|
|
5483
|
+
*/
|
|
5484
|
+
createStoredPromptBlock(params) {
|
|
5485
|
+
return this.request("/stored/prompt-blocks", {
|
|
5486
|
+
method: "POST",
|
|
5487
|
+
body: params
|
|
5488
|
+
});
|
|
5489
|
+
}
|
|
5490
|
+
/**
|
|
5491
|
+
* Gets a stored prompt block instance by ID for further operations (details, update, delete)
|
|
5492
|
+
* @param storedPromptBlockId - ID of the stored prompt block to retrieve
|
|
5493
|
+
* @returns StoredPromptBlock instance
|
|
5494
|
+
*/
|
|
5495
|
+
getStoredPromptBlock(storedPromptBlockId) {
|
|
5496
|
+
return new StoredPromptBlock(this.options, storedPromptBlockId);
|
|
5497
|
+
}
|
|
5498
|
+
// ============================================================================
|
|
5291
5499
|
// Stored Scorer Definitions
|
|
5292
5500
|
// ============================================================================
|
|
5293
5501
|
/**
|