@alpic-ai/api 0.0.0-dev.gf05d192 → 0.0.0-dev.gf0989d8
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.d.mts +5823 -122
- package/dist/index.mjs +651 -128
- package/package.json +9 -9
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.32.1_supports-color@8.1.1_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -119,7 +119,12 @@ z$1.object({
|
|
|
119
119
|
token_type: z$1.string(),
|
|
120
120
|
expires_in: z$1.coerce.number().optional(),
|
|
121
121
|
scope: z$1.string().optional(),
|
|
122
|
-
refresh_token: z$1.string().optional()
|
|
122
|
+
refresh_token: z$1.string().optional(),
|
|
123
|
+
/**
|
|
124
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
125
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
126
|
+
*/
|
|
127
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
123
128
|
}).strip();
|
|
124
129
|
z$1.object({
|
|
125
130
|
error: z$1.string(),
|
|
@@ -158,7 +163,12 @@ const OAuthClientInformationSchema = z$1.object({
|
|
|
158
163
|
client_id: z$1.string(),
|
|
159
164
|
client_secret: z$1.string().optional(),
|
|
160
165
|
client_id_issued_at: z$1.number().optional(),
|
|
161
|
-
client_secret_expires_at: z$1.number().optional()
|
|
166
|
+
client_secret_expires_at: z$1.number().optional(),
|
|
167
|
+
/**
|
|
168
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
169
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
170
|
+
*/
|
|
171
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
162
172
|
}).strip();
|
|
163
173
|
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
174
|
z$1.object({
|
|
@@ -179,6 +189,7 @@ const PLATFORM_LABELS = {
|
|
|
179
189
|
};
|
|
180
190
|
const WAF_PLATFORMS = [
|
|
181
191
|
"akamai",
|
|
192
|
+
"cato",
|
|
182
193
|
"cloudflare",
|
|
183
194
|
"fastly"
|
|
184
195
|
];
|
|
@@ -256,6 +267,25 @@ z.object({
|
|
|
256
267
|
clientSecret: z.string(),
|
|
257
268
|
clientScopes: z.array(z.string())
|
|
258
269
|
});
|
|
270
|
+
const creditEntryReasonSchema = z.enum([
|
|
271
|
+
"free_seed",
|
|
272
|
+
"paid_conversion_floor",
|
|
273
|
+
"top_up",
|
|
274
|
+
"usage",
|
|
275
|
+
"admin_adjustment"
|
|
276
|
+
]);
|
|
277
|
+
z.enum(["playground"]);
|
|
278
|
+
z.number().int().min(500);
|
|
279
|
+
const creditActivityEntrySchema = z.object({
|
|
280
|
+
reason: creditEntryReasonSchema,
|
|
281
|
+
day: z.number(),
|
|
282
|
+
amountInNanoUSD: z.number(),
|
|
283
|
+
messageCount: z.number().nullable()
|
|
284
|
+
});
|
|
285
|
+
z.object({
|
|
286
|
+
balanceInNanoUSD: z.number(),
|
|
287
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
288
|
+
});
|
|
259
289
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
290
|
"ongoing",
|
|
261
291
|
"deployed",
|
|
@@ -316,7 +346,8 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
316
346
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
317
347
|
allowsAnonymous: z.literal(false),
|
|
318
348
|
oAuthMetadata: z.strictObject({}),
|
|
319
|
-
scope: z.string().optional()
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
320
351
|
});
|
|
321
352
|
const legacyPublicEnvironmentSchema = z.object({
|
|
322
353
|
isPublic: z.literal(true),
|
|
@@ -361,10 +392,13 @@ z.union([
|
|
|
361
392
|
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
362
393
|
]);
|
|
363
394
|
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
364
396
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
365
|
-
"global.anthropic.claude-sonnet-
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
366
398
|
"openai.gpt-5.4",
|
|
367
|
-
"openai.gpt-5.5"
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
368
402
|
]);
|
|
369
403
|
const environmentDomainSchema = z.object({
|
|
370
404
|
name: z.string(),
|
|
@@ -400,14 +434,16 @@ z.object({
|
|
|
400
434
|
collectResponsePayload: z.boolean(),
|
|
401
435
|
collectErrorMessage: z.boolean(),
|
|
402
436
|
collectUserData: z.boolean(),
|
|
403
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
404
439
|
});
|
|
405
|
-
z.object({
|
|
440
|
+
const feedbackSchema = z.object({
|
|
406
441
|
id: z.string(),
|
|
407
442
|
createdAt: z.coerce.date(),
|
|
408
443
|
environmentId: z.string(),
|
|
409
444
|
content: z.string(),
|
|
410
|
-
source: z.enum(["model", "user"])
|
|
445
|
+
source: z.enum(["model", "user"]),
|
|
446
|
+
clientName: z.string().nullable()
|
|
411
447
|
});
|
|
412
448
|
z.object({
|
|
413
449
|
content: z.string(),
|
|
@@ -423,7 +459,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
423
459
|
"pink",
|
|
424
460
|
"gray"
|
|
425
461
|
]);
|
|
426
|
-
intentCategoryColorSchema.options;
|
|
462
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
427
463
|
const intentCategorySchema = z.object({
|
|
428
464
|
id: z.string(),
|
|
429
465
|
createdAt: z.coerce.date(),
|
|
@@ -431,7 +467,7 @@ const intentCategorySchema = z.object({
|
|
|
431
467
|
name: z.string(),
|
|
432
468
|
color: intentCategoryColorSchema
|
|
433
469
|
});
|
|
434
|
-
z.object({
|
|
470
|
+
const intentCategorySummarySchema = z.object({
|
|
435
471
|
id: z.string(),
|
|
436
472
|
name: z.string(),
|
|
437
473
|
color: intentCategoryColorSchema,
|
|
@@ -443,6 +479,7 @@ z.object({
|
|
|
443
479
|
environmentId: z.string(),
|
|
444
480
|
toolName: z.string(),
|
|
445
481
|
message: z.string(),
|
|
482
|
+
clientName: z.string().nullable(),
|
|
446
483
|
categories: z.array(intentCategorySchema)
|
|
447
484
|
});
|
|
448
485
|
const signalCategorySchema = z.object({
|
|
@@ -501,12 +538,30 @@ z.object({
|
|
|
501
538
|
createdAt: z.coerce.date(),
|
|
502
539
|
updatedAt: z.coerce.date()
|
|
503
540
|
});
|
|
541
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
542
|
+
type: z.literal("mcp_request"),
|
|
543
|
+
method: z.string()
|
|
544
|
+
});
|
|
545
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
546
|
+
type: z.literal("mcp_error"),
|
|
547
|
+
method: z.string(),
|
|
548
|
+
error: z.string()
|
|
549
|
+
});
|
|
550
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
504
551
|
z.enum([
|
|
505
552
|
"INFO",
|
|
506
553
|
"WARNING",
|
|
507
554
|
"DEBUG",
|
|
508
555
|
"ERROR"
|
|
509
556
|
]);
|
|
557
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
558
|
+
function escapeLogSearchTerm(search) {
|
|
559
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
560
|
+
const character = String.fromCharCode(byte);
|
|
561
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
562
|
+
}).join("");
|
|
563
|
+
}
|
|
564
|
+
const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
|
|
510
565
|
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
511
566
|
const MCP_CLIENT_GROUPS = [
|
|
512
567
|
{
|
|
@@ -832,6 +887,10 @@ const clampStringField = (field) => {
|
|
|
832
887
|
const withMin = field.minLength === null ? clamped : clamped.min(field.minLength);
|
|
833
888
|
return field.description ? withMin.describe(field.description) : withMin;
|
|
834
889
|
};
|
|
890
|
+
const unboundedArrayField = (field) => {
|
|
891
|
+
const unbounded = z.array(field.element);
|
|
892
|
+
return field.description ? unbounded.describe(field.description) : unbounded;
|
|
893
|
+
};
|
|
835
894
|
const toolDefinitionSchema = z.object({
|
|
836
895
|
name: z.string(),
|
|
837
896
|
title: z.string().optional().describe("Human-friendly name for the tool, used in the UI. If not provided, `name` will be used."),
|
|
@@ -844,11 +903,22 @@ const toolDefinitionSchema = z.object({
|
|
|
844
903
|
}).optional()
|
|
845
904
|
});
|
|
846
905
|
const positiveTestCaseSchema = z.object({
|
|
847
|
-
scenario: z.string().describe("Short label for what this case demonstrates."),
|
|
848
|
-
userPrompt: z.string().describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
906
|
+
scenario: z.string().min(1).describe("Short label for what this case demonstrates."),
|
|
907
|
+
userPrompt: z.string().min(1).describe("A realistic, standalone user message a reviewer can paste and run with no prior state or multi-turn setup. Vary phrasing and tone across cases."),
|
|
849
908
|
toolTriggered: z.string().optional().describe("The tool this prompt should invoke."),
|
|
850
909
|
expectedOutput: z.string().optional().describe("What the user should see, including post-interaction behaviour where relevant.")
|
|
851
|
-
}).
|
|
910
|
+
}).describe("Each case: Scenario, User prompt, Tool triggered, Expected output.");
|
|
911
|
+
const positiveTestCaseDraftSchema = positiveTestCaseSchema.partial().extend({
|
|
912
|
+
scenario: z.string().optional(),
|
|
913
|
+
userPrompt: z.string().optional()
|
|
914
|
+
});
|
|
915
|
+
const blankPositiveTestCase = () => ({
|
|
916
|
+
scenario: "",
|
|
917
|
+
userPrompt: "",
|
|
918
|
+
toolTriggered: "",
|
|
919
|
+
expectedOutput: ""
|
|
920
|
+
});
|
|
921
|
+
const toFixedLength = (entries, length, blank) => Array.from({ length }, (_, index) => entries[index] ?? blank());
|
|
852
922
|
const screenshotEntrySchema = z.object({
|
|
853
923
|
prompt: z.string(),
|
|
854
924
|
url: z.url()
|
|
@@ -1161,9 +1231,18 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1161
1231
|
"zh-TW"
|
|
1162
1232
|
]);
|
|
1163
1233
|
const negativeTestCaseSchema = z.object({
|
|
1164
|
-
scenario: z.string(),
|
|
1165
|
-
userPrompt: z.string()
|
|
1166
|
-
}).
|
|
1234
|
+
scenario: z.string().min(1),
|
|
1235
|
+
userPrompt: z.string().min(1)
|
|
1236
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1237
|
+
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1238
|
+
scenario: z.string().optional(),
|
|
1239
|
+
userPrompt: z.string().optional()
|
|
1240
|
+
});
|
|
1241
|
+
const blankNegativeTestCase = () => ({
|
|
1242
|
+
scenario: "",
|
|
1243
|
+
userPrompt: ""
|
|
1244
|
+
});
|
|
1245
|
+
const chatgptSkillSchema = z.object({ name: z.string() }).describe("A skill discovered on the MCP server, by name.");
|
|
1167
1246
|
const chatgptToolJustificationSchema = z.object({
|
|
1168
1247
|
toolName: z.string(),
|
|
1169
1248
|
readOnlyJustification: z.string().describe("One sentence on what the tool reads and returns."),
|
|
@@ -1183,27 +1262,28 @@ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema
|
|
|
1183
1262
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
1184
1263
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1185
1264
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
1186
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1265
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
1187
1266
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1188
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1267
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the plugin does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the plugin does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
1189
1268
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1190
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1269
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
1191
1270
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1192
1271
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1193
1272
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1194
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
1195
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
1196
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1273
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1274
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the plugin, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
1275
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My plugin links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the plugin does not offer digital goods."),
|
|
1197
1276
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1198
1277
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1199
1278
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1200
1279
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1280
|
+
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1281
|
+
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1282
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the plugin should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the plugin does not carry, the right brand or domain but an intent the plugin does not serve, or a boundary with a sibling plugin."),
|
|
1283
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-plugin screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget plugins must show the widget UI; non-widget plugins show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1204
1284
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1205
1285
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1206
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1286
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1207
1287
|
});
|
|
1208
1288
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1209
1289
|
tagline: z.string().optional(),
|
|
@@ -1214,23 +1294,35 @@ const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().e
|
|
|
1214
1294
|
demoRecordingUrl: z.string().optional(),
|
|
1215
1295
|
serverUrl: z.string().optional(),
|
|
1216
1296
|
screenshots: z.array(screenshotDraftEntrySchema).optional(),
|
|
1297
|
+
testCases: z.array(positiveTestCaseDraftSchema).optional(),
|
|
1298
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).optional(),
|
|
1217
1299
|
translations: z.array(chatgptTranslationSchema.extend({ tagline: z.string() })).optional()
|
|
1218
1300
|
});
|
|
1219
|
-
|
|
1301
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "chatgpt" })` can populate. */
|
|
1302
|
+
const chatgptPrefillFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1220
1303
|
appName: true,
|
|
1221
1304
|
developerName: true,
|
|
1222
1305
|
serverUrl: true,
|
|
1223
1306
|
tools: true,
|
|
1307
|
+
skills: true,
|
|
1224
1308
|
authentication: true
|
|
1225
1309
|
});
|
|
1226
|
-
|
|
1310
|
+
/** Source of truth for `SubmissionPrefillService.generate({ platform: "chatgpt" })`. */
|
|
1311
|
+
const chatgptAiGeneratedFormDataSchema = chatgptSubmissionFormDataSchema.pick({
|
|
1227
1312
|
tagline: true,
|
|
1228
1313
|
description: true,
|
|
1229
1314
|
category: true,
|
|
1230
1315
|
testCases: true,
|
|
1231
1316
|
negativeTestCases: true,
|
|
1232
1317
|
toolJustifications: true
|
|
1233
|
-
}).extend({
|
|
1318
|
+
}).extend({
|
|
1319
|
+
testCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.testCases),
|
|
1320
|
+
negativeTestCases: unboundedArrayField(chatgptSubmissionFormDataSchema.shape.negativeTestCases)
|
|
1321
|
+
}).extend({
|
|
1322
|
+
tagline: clampStringField(chatgptSubmissionFormDataSchema.shape.tagline),
|
|
1323
|
+
testCases: z.array(positiveTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 5, blankPositiveTestCase)),
|
|
1324
|
+
negativeTestCases: z.array(negativeTestCaseDraftSchema).transform((cases) => toFixedLength(cases, 3, blankNegativeTestCase))
|
|
1325
|
+
});
|
|
1234
1326
|
const claudeCategorySchema = z.enum([
|
|
1235
1327
|
"Productivity",
|
|
1236
1328
|
"Communication",
|
|
@@ -1353,7 +1445,8 @@ const claudeSubmissionDraftSchema = claudeSubmissionFormDataSchema.partial().ext
|
|
|
1353
1445
|
categories: z.array(claudeCategorySchema).optional(),
|
|
1354
1446
|
screenshots: z.array(screenshotDraftEntrySchema).optional()
|
|
1355
1447
|
});
|
|
1356
|
-
|
|
1448
|
+
/** Source of truth for the fields `SubmissionPrefillService.prefill({ platform: "claudeai" })` can populate. */
|
|
1449
|
+
const claudePrefillFormDataSchema = claudeSubmissionFormDataSchema.pick({
|
|
1357
1450
|
serverUrl: true,
|
|
1358
1451
|
name: true,
|
|
1359
1452
|
slug: true,
|
|
@@ -1375,27 +1468,86 @@ const claudeAiGeneratedFormDataRawSchema = z.object({
|
|
|
1375
1468
|
categories: z.array(claudeCategorySchema).describe(claudeCategoryDescription),
|
|
1376
1469
|
primaryUseCases: claudeSubmissionFormDataSchema.shape.primaryUseCases
|
|
1377
1470
|
});
|
|
1378
|
-
claudeAiGeneratedFormDataRawSchema.extend({
|
|
1471
|
+
const claudeAiGeneratedFormDataSchema = claudeAiGeneratedFormDataRawSchema.extend({
|
|
1379
1472
|
oneLiner: clampStringField(claudeSubmissionFormDataSchema.shape.oneLiner),
|
|
1380
1473
|
categories: claudeAiGeneratedFormDataRawSchema.shape.categories.transform((categories) => categories.slice(0, 5))
|
|
1381
1474
|
});
|
|
1475
|
+
function provenanceByField(prefillShape, aiGeneratedShape) {
|
|
1476
|
+
const byField = {};
|
|
1477
|
+
for (const field of Object.keys(prefillShape)) byField[field] = "prefilled";
|
|
1478
|
+
for (const field of Object.keys(aiGeneratedShape)) byField[field] = "ai-generated";
|
|
1479
|
+
return byField;
|
|
1480
|
+
}
|
|
1481
|
+
provenanceByField(claudePrefillFormDataSchema.shape, claudeAiGeneratedFormDataSchema.shape), provenanceByField(chatgptPrefillFormDataSchema.shape, chatgptAiGeneratedFormDataSchema.shape);
|
|
1482
|
+
const urlVerificationOutcomeSchema = z.enum([
|
|
1483
|
+
"pass",
|
|
1484
|
+
"fail",
|
|
1485
|
+
"unverified"
|
|
1486
|
+
]);
|
|
1487
|
+
const VERIFIABLE_URL_FIELDS = {
|
|
1488
|
+
chatgpt: ["privacyPolicyUrl", "termsOfServiceUrl"],
|
|
1489
|
+
claudeai: ["privacyPolicy"]
|
|
1490
|
+
};
|
|
1491
|
+
const verifiableUrlFieldSchema = z.enum([...VERIFIABLE_URL_FIELDS.chatgpt, ...VERIFIABLE_URL_FIELDS.claudeai]);
|
|
1492
|
+
const policyDisclosureSchema = z.enum([
|
|
1493
|
+
"dataCategories",
|
|
1494
|
+
"purposesOfUse",
|
|
1495
|
+
"recipients",
|
|
1496
|
+
"retention"
|
|
1497
|
+
]);
|
|
1498
|
+
const urlVerificationFieldResultSchema = z.object({
|
|
1499
|
+
field: verifiableUrlFieldSchema,
|
|
1500
|
+
url: z.string(),
|
|
1501
|
+
outcome: urlVerificationOutcomeSchema,
|
|
1502
|
+
reason: z.string(),
|
|
1503
|
+
concerns: z.array(z.string()).optional(),
|
|
1504
|
+
scrapedWith: z.enum(["fetch", "firecrawl"]).optional()
|
|
1505
|
+
});
|
|
1506
|
+
const urlVerificationSchema = z.object({
|
|
1507
|
+
verifiedAt: z.coerce.date(),
|
|
1508
|
+
results: z.array(urlVerificationFieldResultSchema)
|
|
1509
|
+
});
|
|
1510
|
+
const pageKindSchema = z.enum([
|
|
1511
|
+
"expectedDocument",
|
|
1512
|
+
"errorPage",
|
|
1513
|
+
"loginWall",
|
|
1514
|
+
"parkedDomain",
|
|
1515
|
+
"comingSoon",
|
|
1516
|
+
"marketingPage",
|
|
1517
|
+
"unrelatedDocument"
|
|
1518
|
+
]);
|
|
1519
|
+
z.object({
|
|
1520
|
+
pageKind: pageKindSchema.describe("What the page actually is. Use 'expectedDocument' only when it is genuinely the document the field claims."),
|
|
1521
|
+
reason: z.string().max(200).describe("One sentence naming what the page is, addressed to the developer who entered the URL."),
|
|
1522
|
+
missingDisclosures: z.array(policyDisclosureSchema).describe("For a privacy policy only: which of the four required disclosures the text does not cover. Empty for every other page kind.")
|
|
1523
|
+
});
|
|
1382
1524
|
const submissionMetaFieldsSchema = z.object({
|
|
1383
1525
|
id: z.string(),
|
|
1384
1526
|
environmentId: z.string(),
|
|
1385
1527
|
auditId: z.string().nullable(),
|
|
1528
|
+
urlVerification: urlVerificationSchema.nullable().default(null),
|
|
1386
1529
|
createdAt: z.coerce.date(),
|
|
1387
1530
|
updatedAt: z.coerce.date()
|
|
1388
1531
|
});
|
|
1389
1532
|
const claudeSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1390
1533
|
platform: z.literal("claudeai"),
|
|
1391
|
-
formData: claudeSubmissionDraftSchema
|
|
1534
|
+
formData: claudeSubmissionDraftSchema,
|
|
1535
|
+
prefillSnapshot: claudeSubmissionDraftSchema.nullable().default(null)
|
|
1392
1536
|
});
|
|
1393
1537
|
const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
1394
1538
|
platform: z.literal("chatgpt"),
|
|
1395
|
-
formData: chatgptSubmissionDraftSchema
|
|
1539
|
+
formData: chatgptSubmissionDraftSchema,
|
|
1540
|
+
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1396
1541
|
});
|
|
1397
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1542
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1398
1543
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1544
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1545
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1546
|
+
z.literal([
|
|
1547
|
+
100,
|
|
1548
|
+
75,
|
|
1549
|
+
50
|
|
1550
|
+
]);
|
|
1399
1551
|
const subscriptionPlanSchema = z.enum([
|
|
1400
1552
|
"pro",
|
|
1401
1553
|
"business",
|
|
@@ -1407,17 +1559,78 @@ const customerCreditsSchema = z.object({
|
|
|
1407
1559
|
expiresAt: z.number().nullable(),
|
|
1408
1560
|
currency: z.string()
|
|
1409
1561
|
});
|
|
1410
|
-
const customerUsageSchema = z.object({
|
|
1411
|
-
amountInCents: z.number(),
|
|
1412
|
-
currency: z.string(),
|
|
1413
|
-
periodEnd: z.number()
|
|
1414
|
-
});
|
|
1415
1562
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1416
1563
|
z.object({
|
|
1417
1564
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1418
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1419
1565
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1420
1566
|
});
|
|
1567
|
+
const metricsQueueEventSchema = z.object({
|
|
1568
|
+
ts: z.number().int(),
|
|
1569
|
+
method: z.string(),
|
|
1570
|
+
tool: z.string().nullable(),
|
|
1571
|
+
client: z.string(),
|
|
1572
|
+
sessionId: z.string().nullable(),
|
|
1573
|
+
conversationId: z.string().nullable().optional(),
|
|
1574
|
+
durationMs: z.number().int(),
|
|
1575
|
+
outputTokens: z.number().int().nullable(),
|
|
1576
|
+
errorType: z.enum([
|
|
1577
|
+
"mcp_error",
|
|
1578
|
+
"tool_error",
|
|
1579
|
+
"timeout"
|
|
1580
|
+
]).nullable(),
|
|
1581
|
+
errorCode: z.number().int().nullable()
|
|
1582
|
+
});
|
|
1583
|
+
z.object({
|
|
1584
|
+
v: z.literal(1),
|
|
1585
|
+
envId: z.string(),
|
|
1586
|
+
events: z.array(metricsQueueEventSchema)
|
|
1587
|
+
});
|
|
1588
|
+
z.object({ v: z.number() });
|
|
1589
|
+
const TELEMETRY_SIGNALS = [
|
|
1590
|
+
"logs",
|
|
1591
|
+
"metrics",
|
|
1592
|
+
"traces"
|
|
1593
|
+
];
|
|
1594
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1595
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1596
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1597
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1598
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1599
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1600
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1601
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1602
|
+
id: z.string(),
|
|
1603
|
+
name: otlpHeaderNameSchema,
|
|
1604
|
+
value: otlpHeaderValueSchema,
|
|
1605
|
+
isSecret: z.boolean()
|
|
1606
|
+
});
|
|
1607
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1608
|
+
"credentials",
|
|
1609
|
+
"wrong-path",
|
|
1610
|
+
"wrong-protocol",
|
|
1611
|
+
"invalid-payload",
|
|
1612
|
+
"partial-rejection",
|
|
1613
|
+
"blocked-target",
|
|
1614
|
+
"timeout",
|
|
1615
|
+
"unreachable",
|
|
1616
|
+
"receiver-error",
|
|
1617
|
+
"unexpected-status"
|
|
1618
|
+
]);
|
|
1619
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1620
|
+
z.object({
|
|
1621
|
+
id: z.string(),
|
|
1622
|
+
signal: telemetrySignalSchema,
|
|
1623
|
+
endpoint: otlpEndpointSchema,
|
|
1624
|
+
protocol: otlpProtocolSchema,
|
|
1625
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1626
|
+
status: telemetryDestinationStatusSchema,
|
|
1627
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1628
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1629
|
+
});
|
|
1630
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1631
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1632
|
+
return new Set(names).size !== names.length;
|
|
1633
|
+
};
|
|
1421
1634
|
//#endregion
|
|
1422
1635
|
//#region src/auth-scope.ts
|
|
1423
1636
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1516,6 +1729,14 @@ const serverFieldsSchema = z.object({
|
|
|
1516
1729
|
});
|
|
1517
1730
|
//#endregion
|
|
1518
1731
|
//#region src/api.contract.ts
|
|
1732
|
+
const isValidIanaTimeZone = (timeZone) => {
|
|
1733
|
+
try {
|
|
1734
|
+
new Intl.DateTimeFormat("en-US", { timeZone });
|
|
1735
|
+
return true;
|
|
1736
|
+
} catch {
|
|
1737
|
+
return false;
|
|
1738
|
+
}
|
|
1739
|
+
};
|
|
1519
1740
|
const deploymentStatusSchema = z.enum([
|
|
1520
1741
|
"ongoing",
|
|
1521
1742
|
"deployed",
|
|
@@ -1544,21 +1765,20 @@ const deploymentSchema = z.object({
|
|
|
1544
1765
|
isCurrent: z.boolean(),
|
|
1545
1766
|
deploymentPageUrl: z.url().nullable()
|
|
1546
1767
|
});
|
|
1547
|
-
const
|
|
1768
|
+
const isValidTimeInput = (value) => {
|
|
1548
1769
|
if (ms(value) !== void 0) return true;
|
|
1549
1770
|
return !Number.isNaN(new Date(value).getTime());
|
|
1550
1771
|
};
|
|
1551
|
-
const
|
|
1772
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1773
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1774
|
+
const createEnvironmentContractV1 = base.route({
|
|
1552
1775
|
path: "/v1/environments",
|
|
1553
1776
|
method: "POST",
|
|
1554
1777
|
summary: "Create an environment",
|
|
1555
1778
|
description: "Create an environment for a project",
|
|
1556
1779
|
tags: ["environments"],
|
|
1557
1780
|
successDescription: "The environment has been created successfully"
|
|
1558
|
-
}).errors({
|
|
1559
|
-
NOT_FOUND: {},
|
|
1560
|
-
BAD_REQUEST: {}
|
|
1561
|
-
}).input(z.object({
|
|
1781
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1562
1782
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1563
1783
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1564
1784
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1571,7 +1791,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1571
1791
|
createdAt: z.coerce.date(),
|
|
1572
1792
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1573
1793
|
}));
|
|
1574
|
-
const getEnvironmentContractV1 =
|
|
1794
|
+
const getEnvironmentContractV1 = base.route({
|
|
1575
1795
|
path: "/v1/environments/{environmentId}",
|
|
1576
1796
|
method: "GET",
|
|
1577
1797
|
summary: "Get an environment",
|
|
@@ -1587,6 +1807,14 @@ const getEnvironmentContractV1 = oc.route({
|
|
|
1587
1807
|
createdAt: z.coerce.date(),
|
|
1588
1808
|
projectId: z.string()
|
|
1589
1809
|
}));
|
|
1810
|
+
const deleteEnvironmentContractV1 = base.route({
|
|
1811
|
+
path: "/v1/environments/{environmentId}",
|
|
1812
|
+
method: "DELETE",
|
|
1813
|
+
summary: "Delete an environment",
|
|
1814
|
+
description: "All environments can be deleted except the production environment. This operation is not reversible: associated logs, analytics, and metrics are deleted as well.",
|
|
1815
|
+
tags: ["environments"],
|
|
1816
|
+
successDescription: "The environment has been deleted successfully"
|
|
1817
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.object({ success: z.literal(true) }));
|
|
1590
1818
|
const domainSchema = z.object({
|
|
1591
1819
|
domain: z.string(),
|
|
1592
1820
|
status: z.enum([
|
|
@@ -1628,7 +1856,7 @@ const projectOutputSchema = z.object({
|
|
|
1628
1856
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1629
1857
|
environments: z.array(environmentSchema)
|
|
1630
1858
|
});
|
|
1631
|
-
const getProjectContractV1 =
|
|
1859
|
+
const getProjectContractV1 = base.route({
|
|
1632
1860
|
path: "/v1/projects/{projectId}",
|
|
1633
1861
|
method: "GET",
|
|
1634
1862
|
summary: "Get a project",
|
|
@@ -1636,18 +1864,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1636
1864
|
tags: ["projects"],
|
|
1637
1865
|
successDescription: "The project details"
|
|
1638
1866
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1639
|
-
const listProjectsContractV1 =
|
|
1867
|
+
const listProjectsContractV1 = base.route({
|
|
1640
1868
|
path: "/v1/projects",
|
|
1641
1869
|
method: "GET",
|
|
1642
1870
|
summary: "List projects",
|
|
1643
1871
|
description: "List all projects for a team",
|
|
1644
1872
|
tags: ["projects"],
|
|
1645
1873
|
successDescription: "The list of projects"
|
|
1646
|
-
}).errors({
|
|
1647
|
-
|
|
1648
|
-
BAD_REQUEST: {}
|
|
1649
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1650
|
-
const createProjectContractV1 = oc.route({
|
|
1874
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1875
|
+
const createProjectContractV1 = base.route({
|
|
1651
1876
|
path: "/v1/projects",
|
|
1652
1877
|
method: "POST",
|
|
1653
1878
|
summary: "Create a project",
|
|
@@ -1656,7 +1881,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1656
1881
|
successDescription: "The project has been created successfully"
|
|
1657
1882
|
}).errors({
|
|
1658
1883
|
NOT_FOUND: {},
|
|
1659
|
-
BAD_REQUEST: {},
|
|
1660
1884
|
FORBIDDEN: {}
|
|
1661
1885
|
}).input(z.object({
|
|
1662
1886
|
teamId: z.string().optional(),
|
|
@@ -1697,7 +1921,101 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1697
1921
|
isSecret: z.boolean(),
|
|
1698
1922
|
createdAt: z.coerce.date()
|
|
1699
1923
|
});
|
|
1700
|
-
const
|
|
1924
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1925
|
+
id: z.string(),
|
|
1926
|
+
name: otlpHeaderNameSchema,
|
|
1927
|
+
value: z.null(),
|
|
1928
|
+
isSecret: z.literal(true)
|
|
1929
|
+
}), z.object({
|
|
1930
|
+
id: z.string(),
|
|
1931
|
+
name: otlpHeaderNameSchema,
|
|
1932
|
+
value: otlpHeaderValueSchema,
|
|
1933
|
+
isSecret: z.literal(false)
|
|
1934
|
+
})]);
|
|
1935
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1936
|
+
id: z.string(),
|
|
1937
|
+
signal: telemetrySignalSchema,
|
|
1938
|
+
endpoint: otlpEndpointSchema,
|
|
1939
|
+
protocol: otlpProtocolSchema,
|
|
1940
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1941
|
+
status: telemetryDestinationStatusSchema,
|
|
1942
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1943
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1944
|
+
});
|
|
1945
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1946
|
+
name: otlpHeaderNameSchema,
|
|
1947
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1948
|
+
isSecret: z.boolean()
|
|
1949
|
+
});
|
|
1950
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
1951
|
+
id: z.string().optional(),
|
|
1952
|
+
name: otlpHeaderNameSchema,
|
|
1953
|
+
value: otlpHeaderValueSchema.optional(),
|
|
1954
|
+
isSecret: z.boolean()
|
|
1955
|
+
});
|
|
1956
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
1957
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
1958
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1959
|
+
method: "GET",
|
|
1960
|
+
summary: "List telemetry destinations",
|
|
1961
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
1962
|
+
tags: ["telemetry"],
|
|
1963
|
+
successDescription: "The list of telemetry destinations"
|
|
1964
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
1965
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
1966
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1967
|
+
method: "POST",
|
|
1968
|
+
summary: "Create a telemetry destination",
|
|
1969
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
1970
|
+
tags: ["telemetry"],
|
|
1971
|
+
successDescription: "The telemetry destination has been created"
|
|
1972
|
+
}).errors({
|
|
1973
|
+
NOT_FOUND: {},
|
|
1974
|
+
FORBIDDEN: {},
|
|
1975
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
1976
|
+
INTERNAL_SERVER_ERROR: {}
|
|
1977
|
+
}).input(z.object({
|
|
1978
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1979
|
+
signal: telemetrySignalSchema,
|
|
1980
|
+
endpoint: otlpEndpointSchema,
|
|
1981
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
1982
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
1983
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
1984
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1985
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
1986
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
1987
|
+
method: "PATCH",
|
|
1988
|
+
summary: "Update a telemetry destination",
|
|
1989
|
+
description: "Verify and save changes to an OTLP destination. Omit headers to keep them unchanged; omit the value of an existing header to preserve it. A secret header value must be re-entered when the endpoint changes.",
|
|
1990
|
+
tags: ["telemetry"],
|
|
1991
|
+
successDescription: "The telemetry destination has been updated"
|
|
1992
|
+
}).errors({
|
|
1993
|
+
NOT_FOUND: {},
|
|
1994
|
+
FORBIDDEN: {},
|
|
1995
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
1996
|
+
}).input(z.object({
|
|
1997
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1998
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
1999
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
2000
|
+
protocol: otlpProtocolSchema.optional(),
|
|
2001
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
2002
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
2003
|
+
})).output(telemetryDestinationOutputSchema);
|
|
2004
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
2005
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2006
|
+
method: "DELETE",
|
|
2007
|
+
summary: "Delete a telemetry destination",
|
|
2008
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2009
|
+
tags: ["telemetry"],
|
|
2010
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2011
|
+
}).errors({
|
|
2012
|
+
NOT_FOUND: {},
|
|
2013
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2014
|
+
}).input(z.object({
|
|
2015
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2016
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2017
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2018
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1701
2019
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1702
2020
|
method: "GET",
|
|
1703
2021
|
summary: "List environment variables",
|
|
@@ -1705,48 +2023,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1705
2023
|
tags: ["environments"],
|
|
1706
2024
|
successDescription: "The list of environment variables"
|
|
1707
2025
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1708
|
-
const createEnvironmentVariablesContractV1 =
|
|
2026
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1709
2027
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1710
2028
|
method: "POST",
|
|
1711
2029
|
summary: "Add environment variables",
|
|
1712
2030
|
description: "Add one or more environment variables to an environment",
|
|
1713
2031
|
tags: ["environments"],
|
|
1714
2032
|
successDescription: "The environment variables have been added successfully"
|
|
1715
|
-
}).errors({
|
|
1716
|
-
NOT_FOUND: {},
|
|
1717
|
-
BAD_REQUEST: {}
|
|
1718
|
-
}).input(z.object({
|
|
2033
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1719
2034
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1720
2035
|
environmentVariables: environmentVariablesSchema
|
|
1721
2036
|
})).output(z.object({ success: z.literal(true) }));
|
|
1722
|
-
const updateEnvironmentVariableContractV1 =
|
|
2037
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1723
2038
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1724
2039
|
method: "PATCH",
|
|
1725
2040
|
summary: "Update an environment variable",
|
|
1726
2041
|
description: "Update an environment variable by ID",
|
|
1727
2042
|
tags: ["environments"],
|
|
1728
2043
|
successDescription: "The environment variable has been updated successfully"
|
|
1729
|
-
}).errors({
|
|
1730
|
-
NOT_FOUND: {},
|
|
1731
|
-
BAD_REQUEST: {}
|
|
1732
|
-
}).input(z.object({
|
|
2044
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1733
2045
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1734
2046
|
key: environmentVariableSchema.shape.key,
|
|
1735
2047
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1736
2048
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1737
2049
|
})).output(z.object({ success: z.literal(true) }));
|
|
1738
|
-
const deleteEnvironmentVariableContractV1 =
|
|
2050
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1739
2051
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1740
2052
|
method: "DELETE",
|
|
1741
2053
|
summary: "Delete an environment variable",
|
|
1742
2054
|
description: "Delete an environment variable by ID",
|
|
1743
2055
|
tags: ["environments"],
|
|
1744
2056
|
successDescription: "The environment variable has been deleted successfully"
|
|
1745
|
-
}).errors({
|
|
1746
|
-
|
|
1747
|
-
BAD_REQUEST: {}
|
|
1748
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1749
|
-
const deleteProjectContractV1 = oc.route({
|
|
2057
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
2058
|
+
const deleteProjectContractV1 = base.route({
|
|
1750
2059
|
path: "/v1/projects/{projectId}",
|
|
1751
2060
|
method: "DELETE",
|
|
1752
2061
|
summary: "Delete a project",
|
|
@@ -1754,7 +2063,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1754
2063
|
tags: ["projects"],
|
|
1755
2064
|
successDescription: "The project has been deleted successfully"
|
|
1756
2065
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1757
|
-
const updateProjectContractV1 =
|
|
2066
|
+
const updateProjectContractV1 = base.route({
|
|
1758
2067
|
path: "/v1/projects/{projectId}",
|
|
1759
2068
|
method: "PATCH",
|
|
1760
2069
|
summary: "Update a project",
|
|
@@ -1763,14 +2072,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1763
2072
|
successDescription: "The project has been updated successfully"
|
|
1764
2073
|
}).errors({
|
|
1765
2074
|
NOT_FOUND: {},
|
|
1766
|
-
BAD_REQUEST: {},
|
|
1767
2075
|
FORBIDDEN: {}
|
|
1768
2076
|
}).input(z.object({
|
|
1769
2077
|
projectId: z.string().describe("The ID of the project"),
|
|
1770
2078
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1771
2079
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1772
2080
|
})).output(projectOutputSchema);
|
|
1773
|
-
const deployEnvironmentContractV1 =
|
|
2081
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1774
2082
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1775
2083
|
method: "POST",
|
|
1776
2084
|
summary: "Deploy an environment",
|
|
@@ -1779,29 +2087,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1779
2087
|
successDescription: "The environment has been deployed successfully"
|
|
1780
2088
|
}).errors({
|
|
1781
2089
|
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {},
|
|
1783
2090
|
CONFLICT: {}
|
|
1784
2091
|
}).input(z.object({
|
|
1785
2092
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1786
2093
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1787
2094
|
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1788
2095
|
})).output(deploymentSchema);
|
|
1789
|
-
const uploadDeploymentArtifactContractV1 =
|
|
2096
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1790
2097
|
path: "/v1/deployments/upload",
|
|
1791
2098
|
method: "POST",
|
|
1792
2099
|
summary: "Upload deployment artifacts",
|
|
1793
2100
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1794
2101
|
tags: ["deployments"],
|
|
1795
2102
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1796
|
-
}).errors({
|
|
1797
|
-
NOT_FOUND: {},
|
|
1798
|
-
BAD_REQUEST: {}
|
|
1799
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
2103
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1800
2104
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1801
2105
|
token: z.string().describe("Token to identify the source archive"),
|
|
1802
2106
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1803
2107
|
}));
|
|
1804
|
-
const listDeploymentsContractV1 =
|
|
2108
|
+
const listDeploymentsContractV1 = base.route({
|
|
1805
2109
|
path: "/v1/projects/{projectId}/deployments",
|
|
1806
2110
|
method: "GET",
|
|
1807
2111
|
summary: "List project deployments",
|
|
@@ -1813,7 +2117,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1813
2117
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1814
2118
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1815
2119
|
})).output(z.array(deploymentSchema));
|
|
1816
|
-
const getDeploymentContractV1 =
|
|
2120
|
+
const getDeploymentContractV1 = base.route({
|
|
1817
2121
|
path: "/v1/deployments/{deploymentId}",
|
|
1818
2122
|
method: "GET",
|
|
1819
2123
|
summary: "Get a deployment",
|
|
@@ -1836,20 +2140,17 @@ const logEntrySchema = z.object({
|
|
|
1836
2140
|
method: z.string().optional(),
|
|
1837
2141
|
durationInMs: z.number().optional()
|
|
1838
2142
|
});
|
|
1839
|
-
const getLogsContractV1 =
|
|
2143
|
+
const getLogsContractV1 = base.route({
|
|
1840
2144
|
path: "/v1/environments/{environmentId}/logs",
|
|
1841
2145
|
method: "GET",
|
|
1842
2146
|
summary: "Get logs",
|
|
1843
2147
|
description: "Get logs for an environment",
|
|
1844
2148
|
tags: ["environments"],
|
|
1845
2149
|
successDescription: "The logs"
|
|
1846
|
-
}).errors({
|
|
1847
|
-
NOT_FOUND: {},
|
|
1848
|
-
BAD_REQUEST: {}
|
|
1849
|
-
}).input(z.object({
|
|
2150
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1850
2151
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1851
|
-
since:
|
|
1852
|
-
until:
|
|
2152
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2153
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1853
2154
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1854
2155
|
level: z.array(z.enum([
|
|
1855
2156
|
"INFO",
|
|
@@ -1857,23 +2158,20 @@ const getLogsContractV1 = oc.route({
|
|
|
1857
2158
|
"WARNING",
|
|
1858
2159
|
"DEBUG"
|
|
1859
2160
|
])).optional().describe("Filter by log level"),
|
|
1860
|
-
search:
|
|
2161
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
1861
2162
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
1862
2163
|
})).output(z.object({
|
|
1863
2164
|
logs: z.array(logEntrySchema),
|
|
1864
2165
|
nextToken: z.string().nullable()
|
|
1865
2166
|
}));
|
|
1866
|
-
const getLatestLogsContractV1 =
|
|
2167
|
+
const getLatestLogsContractV1 = base.route({
|
|
1867
2168
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1868
2169
|
method: "GET",
|
|
1869
2170
|
summary: "Get latest logs",
|
|
1870
2171
|
description: "Get the N most recent logs for an environment",
|
|
1871
2172
|
tags: ["environments"],
|
|
1872
2173
|
successDescription: "The latest logs"
|
|
1873
|
-
}).errors({
|
|
1874
|
-
NOT_FOUND: {},
|
|
1875
|
-
BAD_REQUEST: {}
|
|
1876
|
-
}).input(z.object({
|
|
2174
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1877
2175
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1878
2176
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1879
2177
|
level: z.array(z.enum([
|
|
@@ -1882,9 +2180,9 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1882
2180
|
"WARNING",
|
|
1883
2181
|
"DEBUG"
|
|
1884
2182
|
])).optional().describe("Filter by log level"),
|
|
1885
|
-
search:
|
|
2183
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
1886
2184
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1887
|
-
const getDeploymentLogsContractV1 =
|
|
2185
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1888
2186
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1889
2187
|
method: "GET",
|
|
1890
2188
|
summary: "Get deployment logs",
|
|
@@ -1911,22 +2209,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1911
2209
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1912
2210
|
task_count: z.array(analyticsDataPointSchema)
|
|
1913
2211
|
});
|
|
1914
|
-
const getProjectAnalyticsContractV1 =
|
|
2212
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1915
2213
|
path: "/v1/analytics/{projectId}",
|
|
1916
2214
|
method: "GET",
|
|
1917
2215
|
summary: "Get project analytics",
|
|
1918
2216
|
description: "Get analytics data for a project over a time range",
|
|
1919
2217
|
tags: ["analytics"],
|
|
1920
2218
|
successDescription: "The project analytics data"
|
|
1921
|
-
}).errors({
|
|
1922
|
-
NOT_FOUND: {},
|
|
1923
|
-
BAD_REQUEST: {}
|
|
1924
|
-
}).input(z.object({
|
|
2219
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1925
2220
|
projectId: z.string().describe("The ID of the project"),
|
|
1926
2221
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1927
2222
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1928
2223
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1929
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
2224
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => isValidIanaTimeZone(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1930
2225
|
metadata: z.object({
|
|
1931
2226
|
startTimestamp: z.number(),
|
|
1932
2227
|
endTimestamp: z.number(),
|
|
@@ -1936,7 +2231,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1936
2231
|
}),
|
|
1937
2232
|
timeSeries: analyticsTimeSeriesSchema
|
|
1938
2233
|
}));
|
|
1939
|
-
const
|
|
2234
|
+
const paginatedInsightsInputShape = {
|
|
2235
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2236
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2237
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2238
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2239
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2240
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2241
|
+
};
|
|
2242
|
+
const listIntentsContractV1 = base.route({
|
|
2243
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2244
|
+
method: "GET",
|
|
2245
|
+
summary: "List intents",
|
|
2246
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2247
|
+
tags: ["insights"],
|
|
2248
|
+
successDescription: "The grouped user intents"
|
|
2249
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2250
|
+
...paginatedInsightsInputShape,
|
|
2251
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2252
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2253
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2254
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2255
|
+
})).output(z.object({
|
|
2256
|
+
intents: z.array(z.object({
|
|
2257
|
+
id: z.string(),
|
|
2258
|
+
intentIds: z.array(z.string()).min(1),
|
|
2259
|
+
environmentId: z.string(),
|
|
2260
|
+
message: z.string(),
|
|
2261
|
+
toolName: z.string(),
|
|
2262
|
+
createdAt: z.coerce.date(),
|
|
2263
|
+
occurrenceCount: z.number().int().positive(),
|
|
2264
|
+
clientName: z.string().nullable(),
|
|
2265
|
+
clientId: z.string().nullable(),
|
|
2266
|
+
categories: z.array(z.object({
|
|
2267
|
+
id: z.string(),
|
|
2268
|
+
name: z.string(),
|
|
2269
|
+
color: intentCategoryColorSchema
|
|
2270
|
+
}))
|
|
2271
|
+
})),
|
|
2272
|
+
totalCount: z.number().int().nonnegative()
|
|
2273
|
+
}));
|
|
2274
|
+
const listFeedbacksContractV1 = base.route({
|
|
2275
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2276
|
+
method: "GET",
|
|
2277
|
+
summary: "List feedbacks",
|
|
2278
|
+
description: "List user feedback for an environment over a time range",
|
|
2279
|
+
tags: ["insights"],
|
|
2280
|
+
successDescription: "The user feedback"
|
|
2281
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2282
|
+
...paginatedInsightsInputShape,
|
|
2283
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2284
|
+
})).output(z.object({
|
|
2285
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2286
|
+
totalCount: z.number().int().nonnegative()
|
|
2287
|
+
}));
|
|
2288
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2289
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2290
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2291
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2292
|
+
method: "GET",
|
|
2293
|
+
summary: "List intent categories",
|
|
2294
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2295
|
+
tags: ["insights"],
|
|
2296
|
+
successDescription: "The intent categories"
|
|
2297
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2298
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2299
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2300
|
+
method: "POST",
|
|
2301
|
+
summary: "Create an intent category",
|
|
2302
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2303
|
+
tags: ["insights"],
|
|
2304
|
+
successDescription: "The created intent category"
|
|
2305
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2306
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2307
|
+
name: intentCategoryNameSchema,
|
|
2308
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2309
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2310
|
+
})).output(intentCategorySchema);
|
|
2311
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2312
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2313
|
+
method: "PATCH",
|
|
2314
|
+
summary: "Update an intent category",
|
|
2315
|
+
description: "Rename or recolor an intent category",
|
|
2316
|
+
tags: ["insights"],
|
|
2317
|
+
successDescription: "The updated intent category"
|
|
2318
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2319
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2320
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2321
|
+
name: intentCategoryNameSchema.optional(),
|
|
2322
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2323
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2324
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2325
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2326
|
+
method: "DELETE",
|
|
2327
|
+
summary: "Delete an intent category",
|
|
2328
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2329
|
+
tags: ["insights"],
|
|
2330
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2331
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2332
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2333
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2334
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2335
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2336
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2337
|
+
method: "POST",
|
|
2338
|
+
summary: "Link an intent category",
|
|
2339
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2340
|
+
tags: ["insights"],
|
|
2341
|
+
successDescription: "The intents have been linked successfully"
|
|
2342
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2343
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2344
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2345
|
+
intentIds: categorizableIntentIdsSchema
|
|
2346
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2347
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2348
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2349
|
+
method: "POST",
|
|
2350
|
+
summary: "Unlink an intent category",
|
|
2351
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2352
|
+
tags: ["insights"],
|
|
2353
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2354
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2355
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2356
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2357
|
+
intentIds: categorizableIntentIdsSchema
|
|
2358
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2359
|
+
const listTeamsContractV1 = base.route({
|
|
1940
2360
|
path: "/v1/teams",
|
|
1941
2361
|
method: "GET",
|
|
1942
2362
|
summary: "List teams",
|
|
@@ -1949,7 +2369,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1949
2369
|
createdAt: z.coerce.date(),
|
|
1950
2370
|
hasStripeAccount: z.boolean()
|
|
1951
2371
|
})));
|
|
1952
|
-
const
|
|
2372
|
+
const getTeamUsageContractV1 = base.route({
|
|
2373
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2374
|
+
method: "GET",
|
|
2375
|
+
summary: "Get team usage",
|
|
2376
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2377
|
+
tags: ["teams"],
|
|
2378
|
+
successDescription: "The current billing window usage"
|
|
2379
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2380
|
+
teamId: z.string(),
|
|
2381
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2382
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2383
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2384
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2385
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2386
|
+
}));
|
|
2387
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1953
2388
|
path: "/v1/tunnels/ticket",
|
|
1954
2389
|
method: "GET",
|
|
1955
2390
|
summary: "Get a tunnel ticket",
|
|
@@ -1961,16 +2396,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1961
2396
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1962
2397
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1963
2398
|
}));
|
|
1964
|
-
const publishServerContractV1 =
|
|
2399
|
+
const publishServerContractV1 = base.route({
|
|
1965
2400
|
path: "/v1/distribution/publish",
|
|
1966
2401
|
method: "POST",
|
|
1967
2402
|
summary: "Publish a server to the MCP registry",
|
|
1968
2403
|
tags: ["distribution"],
|
|
1969
2404
|
successDescription: "The server has been published successfully"
|
|
1970
|
-
}).errors({
|
|
1971
|
-
NOT_FOUND: {},
|
|
1972
|
-
BAD_REQUEST: {}
|
|
1973
|
-
}).input(z.object({
|
|
2405
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1974
2406
|
projectId: z.string(),
|
|
1975
2407
|
domain: z.string(),
|
|
1976
2408
|
title: z.string().min(1).max(100),
|
|
@@ -1979,17 +2411,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1979
2411
|
iconSrc: z.url().max(255).optional(),
|
|
1980
2412
|
dryRun: z.boolean().optional()
|
|
1981
2413
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1982
|
-
const getServerInfoContractV1 =
|
|
2414
|
+
const getServerInfoContractV1 = base.route({
|
|
1983
2415
|
path: "/v1/distribution/get",
|
|
1984
2416
|
method: "GET",
|
|
1985
2417
|
summary: "Get server info",
|
|
1986
2418
|
description: "Get info about a server",
|
|
1987
2419
|
tags: ["distribution"],
|
|
1988
2420
|
successDescription: "The server info"
|
|
1989
|
-
}).errors({
|
|
1990
|
-
NOT_FOUND: {},
|
|
1991
|
-
BAD_REQUEST: {}
|
|
1992
|
-
}).input(z.object({
|
|
2421
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1993
2422
|
projectId: z.string(),
|
|
1994
2423
|
domain: z.string()
|
|
1995
2424
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -2008,7 +2437,7 @@ const playgroundOutputSchema = z.object({
|
|
|
2008
2437
|
isPlaygroundEnabled: z.boolean(),
|
|
2009
2438
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2010
2439
|
});
|
|
2011
|
-
const getPlaygroundContractV1 =
|
|
2440
|
+
const getPlaygroundContractV1 = base.route({
|
|
2012
2441
|
path: "/v1/environments/{environmentId}/playground",
|
|
2013
2442
|
method: "GET",
|
|
2014
2443
|
summary: "Get playground configuration",
|
|
@@ -2016,17 +2445,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
2016
2445
|
tags: ["environments"],
|
|
2017
2446
|
successDescription: "The playground configuration"
|
|
2018
2447
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2019
|
-
const upsertPlaygroundContractV1 =
|
|
2448
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2020
2449
|
path: "/v1/environments/{environmentId}/playground",
|
|
2021
2450
|
method: "PUT",
|
|
2022
2451
|
summary: "Update playground configuration",
|
|
2023
2452
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2024
2453
|
tags: ["environments"],
|
|
2025
2454
|
successDescription: "The updated playground configuration"
|
|
2026
|
-
}).errors({
|
|
2027
|
-
NOT_FOUND: {},
|
|
2028
|
-
BAD_REQUEST: {}
|
|
2029
|
-
}).input(z.object({
|
|
2455
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2030
2456
|
environmentId: z.string().describe("The ID of the environment"),
|
|
2031
2457
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
2032
2458
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -2034,7 +2460,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
2034
2460
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2035
2461
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2036
2462
|
})).output(playgroundOutputSchema);
|
|
2037
|
-
const createBeaconContractV1 =
|
|
2463
|
+
const createBeaconContractV1 = base.route({
|
|
2038
2464
|
path: "/v1/beacon/audits",
|
|
2039
2465
|
method: "POST",
|
|
2040
2466
|
summary: "Create a beacon audit",
|
|
@@ -2043,7 +2469,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
2043
2469
|
successDescription: "The audit has been created"
|
|
2044
2470
|
}).errors({
|
|
2045
2471
|
NOT_FOUND: {},
|
|
2046
|
-
BAD_REQUEST: {},
|
|
2047
2472
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
2048
2473
|
}).input(z.object({
|
|
2049
2474
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -2051,7 +2476,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
2051
2476
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2052
2477
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
2053
2478
|
})).output(z.object({ id: z.string() }));
|
|
2054
|
-
const getBeaconContractV1 =
|
|
2479
|
+
const getBeaconContractV1 = base.route({
|
|
2055
2480
|
path: "/v1/beacon/audits/{auditId}",
|
|
2056
2481
|
method: "GET",
|
|
2057
2482
|
summary: "Get a beacon audit",
|
|
@@ -2066,9 +2491,73 @@ const getBeaconContractV1 = oc.route({
|
|
|
2066
2491
|
createdAt: z.coerce.date(),
|
|
2067
2492
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2068
2493
|
}));
|
|
2494
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2495
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2496
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2497
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2498
|
+
const createSubmissionContractV1 = base.route({
|
|
2499
|
+
path: "/v1/submissions",
|
|
2500
|
+
method: "POST",
|
|
2501
|
+
summary: "Create a submission package",
|
|
2502
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2503
|
+
tags: ["submissions"],
|
|
2504
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2505
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2506
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2507
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2508
|
+
})).output(submissionSchema);
|
|
2509
|
+
const listSubmissionsContractV1 = base.route({
|
|
2510
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2511
|
+
method: "GET",
|
|
2512
|
+
summary: "List submission packages",
|
|
2513
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2514
|
+
tags: ["submissions"],
|
|
2515
|
+
successDescription: "The list of submission packages"
|
|
2516
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2517
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2518
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2519
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2520
|
+
})).output(z.array(submissionSchema));
|
|
2521
|
+
const getSubmissionContractV1 = base.route({
|
|
2522
|
+
path: "/v1/submissions/{submissionId}",
|
|
2523
|
+
method: "GET",
|
|
2524
|
+
summary: "Get a submission package",
|
|
2525
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2526
|
+
tags: ["submissions"],
|
|
2527
|
+
successDescription: "The submission package"
|
|
2528
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2529
|
+
const updateSubmissionContractV1 = base.route({
|
|
2530
|
+
path: "/v1/submissions/{submissionId}",
|
|
2531
|
+
method: "PUT",
|
|
2532
|
+
summary: "Update a submission package",
|
|
2533
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2534
|
+
tags: ["submissions"],
|
|
2535
|
+
successDescription: "The updated submission package"
|
|
2536
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2537
|
+
submissionId: submissionIdSchema,
|
|
2538
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2539
|
+
formData: claudeSubmissionUpdateSchema
|
|
2540
|
+
}), z.object({
|
|
2541
|
+
submissionId: submissionIdSchema,
|
|
2542
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2543
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2544
|
+
})])).output(submissionSchema);
|
|
2069
2545
|
const contract = {
|
|
2070
|
-
teams: {
|
|
2546
|
+
teams: {
|
|
2547
|
+
list: { v1: listTeamsContractV1 },
|
|
2548
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2549
|
+
},
|
|
2071
2550
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2551
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2552
|
+
intentCategories: {
|
|
2553
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2554
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2555
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2556
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2557
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2558
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2559
|
+
},
|
|
2560
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
2072
2561
|
deployments: {
|
|
2073
2562
|
list: { v1: listDeploymentsContractV1 },
|
|
2074
2563
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -2078,6 +2567,7 @@ const contract = {
|
|
|
2078
2567
|
environments: {
|
|
2079
2568
|
create: { v1: createEnvironmentContractV1 },
|
|
2080
2569
|
get: { v1: getEnvironmentContractV1 },
|
|
2570
|
+
delete: { v1: deleteEnvironmentContractV1 },
|
|
2081
2571
|
deploy: { v1: deployEnvironmentContractV1 },
|
|
2082
2572
|
getLogs: { v1: getLogsContractV1 },
|
|
2083
2573
|
getLatestLogs: { v1: getLatestLogsContractV1 }
|
|
@@ -2088,6 +2578,12 @@ const contract = {
|
|
|
2088
2578
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
2089
2579
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
2090
2580
|
},
|
|
2581
|
+
telemetryDestinations: {
|
|
2582
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2583
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2584
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2585
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2586
|
+
},
|
|
2091
2587
|
projects: {
|
|
2092
2588
|
update: { v1: updateProjectContractV1 },
|
|
2093
2589
|
get: { v1: getProjectContractV1 },
|
|
@@ -2107,6 +2603,12 @@ const contract = {
|
|
|
2107
2603
|
beacon: {
|
|
2108
2604
|
create: { v1: createBeaconContractV1 },
|
|
2109
2605
|
get: { v1: getBeaconContractV1 }
|
|
2606
|
+
},
|
|
2607
|
+
submissions: {
|
|
2608
|
+
create: { v1: createSubmissionContractV1 },
|
|
2609
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2610
|
+
get: { v1: getSubmissionContractV1 },
|
|
2611
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2110
2612
|
}
|
|
2111
2613
|
};
|
|
2112
2614
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2114,5 +2616,26 @@ const contractForDocs = {
|
|
|
2114
2616
|
...contract,
|
|
2115
2617
|
deployments: deploymentsForDocs
|
|
2116
2618
|
};
|
|
2619
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2620
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2621
|
+
info: {
|
|
2622
|
+
title: "Alpic API",
|
|
2623
|
+
version: "1.0.0"
|
|
2624
|
+
},
|
|
2625
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2626
|
+
security: [{ bearerAuth: [] }],
|
|
2627
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2628
|
+
type: "http",
|
|
2629
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2630
|
+
scheme: "bearer"
|
|
2631
|
+
} } },
|
|
2632
|
+
commonSchemas: {
|
|
2633
|
+
Submission: { schema: submissionSchema },
|
|
2634
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2635
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2636
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2637
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2638
|
+
}
|
|
2639
|
+
};
|
|
2117
2640
|
//#endregion
|
|
2118
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2641
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, OTLP_PROTOCOLS, PLATFORM_LABELS, TELEMETRY_SIGNALS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, otlpProtocolSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, telemetrySignalSchema, transportSchema, updateEnvironmentVariableSchema };
|